• 赤色のリンクは、まだ日本語Codexに存在しないページ・画像です。英語版と併せてご覧ください。(詳細

このWikiはいつでも誰でも編集できます

Rewrite API/flush rules

提供: WordPress Codex 日本語版
移動先: 案内検索

この項目「Rewrite API/flush rules」は、翻訳チェック待ちの項目です。加筆、訂正などを通して、Codex ドキュメンテーションにご協力下さい。

このメソッドは、WordPress のリライトルールのキャッシュを更新するために使用できます。一般的に、これはプログラムでカスタムリライトルールを追加した後に使用する必要があります。

この機能はパフォーマンスの面で非常にコストがかかる可能性があるので、できるだけ使用を控える必要があります。たとえばプラグインやテーマの有効化または無効化時に限って使いましょう。init など、ページのロード時に毎回実行されるフック内では使わないようにあらゆる努力を払ってください。

使い方

$wp_rewrite->flush_rules( $hard );

引数

$hard
真偽値) (オプション.htaccess も更新するか(ハードフラッシュ)、それとも rewrite_rules オプションのみを更新するか(ソフトフラッシュ)。
初期値: true(ハードフラッシュ)

やっていること

WordPress は全てのカスタマイズされたリライトルールのキャッシュを保持します。ときどきプラグインやテーマがそのルールを変更しますが、WordPress はキャッシュが再生成されるまでその変更を実際に認識しません。

これは手続き型の関数ではなく、WP_Rewrite クラスの動的メソッドです。flush_rules() を呼び出すには、まず WordPress のグローバル変数 $wp_rewrite を使用していることを確認し、そしてメソッドとして呼び出します(使い方の例を見てください)。

参考: このメソッドは WordPress の管理画面からパーマリンクの設定が変更もしくは保存されたときに、毎回呼び出されます。そのため WordPress の管理画面の 設定 > パーマリンク設定 の画面でリライトルールを手動で更新することができます。

警告: もしこのメソッドがパラメーターなし、もしくは true を指定して呼び出された場合、.htaccess は上書きされてカスタマイズしたリライトルールがすべて失われます!

用例

// 確実に $wp_rewrite グローバル変数を使う
global $wp_rewrite;
// flush_rules() を $wp_rewrite オブジェクトのメソッドとして呼び出す
$wp_rewrite->flush_rules( false );

変更履歴

新規導入: 2.0.1

ソースファイル

flush_rules() メソッドは wp-includes/rewrite.php にあります。


記事

フック

  • フィルター: root_rewrite_rules /en - ブログのルート用に生成されたリライトルールをフィルターする。
  • フィルター: post_rewrite_rules /en - パーマリンク URL 向けに生成されたリライトルールをフィルターする。
  • フィルター: page_rewrite_rules /en - 固定ページ向けに生成されたリライトルールをフィルターする。
  • フィルター: date_rewrite_rules /en - 日付ごとのアーカイブ URL 向けに生成されたリライトルールをフィルターする。
  • フィルター: search_rewrite_rules /en - 検索 URL 向けに生成されたリライトルールをフィルターする。
  • フィルター: comments_rewrite_rules /en - 最新コメントフィード URL 向けに生成されたリライトルールをフィルターする。
  • フィルター: author_rewrite_rules /en - 投稿者アーカイブ URL 向けに生成されたリライトルールをフィルターする。
  • フィルター: rewrite_rules_array /en - すべてのリライトルールを一度にフィルターする。
  • フィルター: {$permastruct}_rewrite_rules /en - タクソノミーやカスタム投稿タイプなどのカスタムパーマストラクト向けのリライトルールを作成・編集するために使える。
  • アクション: generate_rewrite_rules /en - すべてのルールが生成された後に実行される。

関数


最新英語版: WordPress Codex » Rewrite API/flush_rules最新版との差分