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

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

Rewrite API/flush rules

提供: WordPress Codex 日本語版
< Rewrite API
2015年9月2日 (水) 22:48時点におけるTorounit (トーク | 投稿記録)による版 (What it does)

移動先: 案内検索

このページ「Rewrite API/flush rules」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています

Description

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

この機能は、パフォーマンスの面で非常にコストがかかる可能性があるので、出来るだけ使用しないようにする必要があります。たとえば、プラグインやテーマの有効化または無効化時のようなときに使います。initなど、すべてのページのロード時に実行されるようなフックでは、使用しないようにして下さい。

Usage

$wp_rewrite->flush_rules( $hard );

引数

$hard
真偽値) (optional.htaccess も更新するか (ハードフラッシュ) or rewrite_rules のみを更新するか (ソフトフラッシュ).
初期値: true (hard flush)

What it does

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

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

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

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

Example

//Ensure the $wp_rewrite global is loaded
global $wp_rewrite;
//Call flush_rules() as a method of the $wp_rewrite object
$wp_rewrite->flush_rules( false );

Related

記事

フック

  • フィルター: 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 - すべてのルールが生成された後に実行される。

関数