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

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

「Rewrite API/flush rules」の版間の差分

提供: WordPress Codex 日本語版
移動先: 案内検索
(en: Rewrite_API/flush_rules 22:43, 18 December 2013‎ Ggutenberg)
 
(Description)
3行目: 3行目:
 
==Description==
 
==Description==
 
This method can be used to refresh WordPress' rewrite rule cache. Generally, this should be used after programmatically adding one or more custom rewrite rules.
 
This method can be used to refresh WordPress' rewrite rule cache. Generally, this should be used after programmatically adding one or more custom rewrite rules.
 +
WordPressのリライトルールのキャッシュをリフレッシュするために使用することができます。一般的に、これは、プログラムでカスタムリライトルールを追加した後に使用する必要があります。
  
Because this function can be extremely costly in terms of performance, it should be used as sparingly as possible - such as during [[Function_Reference/register_activation_hook|activation]] or deactivation of plugins or themes. Every attempt should be made to avoid using it in hooks that execute on each page load, such as [[Plugin_API/Action_Reference/init|init]].
+
この機能は、パフォーマンスの面で非常にコストがかかる可能性があるので、出来るだけ使用しないようにする必要があります。たとえば、プラグインやテーマの[[関数リファレンス/register_activation_hook|有効化]]または無効化時のようなときに使います。[[Plugin_API/Action_Reference/init|init]]など、すべてのページのロード時に実行されるようなフックでは、使用しないようにして下さい。
  
 
==Usage==
 
==Usage==

2015年9月2日 (水) 22:25時点における版

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

Description

This method can be used to refresh WordPress' rewrite rule cache. Generally, this should be used after programmatically adding one or more custom rewrite rules. WordPressのリライトルールのキャッシュをリフレッシュするために使用することができます。一般的に、これは、プログラムでカスタムリライトルールを追加した後に使用する必要があります。

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

Usage

$wp_rewrite->flush_rules( $hard );

Arguments

$hard
boolean) (optional) Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush).
初期値: true

What it does

WordPress keeps a cache of all custom rewrite rules. Sometimes plugins or themes make modifications to those rules, however WordPress will not actually recognize the changes until the cache is regenerated.

This is not a procedural function, but a non-static method of the WP_Rewrite class. To call flush_rules(), you must first ensure you are using WordPress' $wp_rewrite global, and call it as a method (see "Usage" above for an example).

Note: This same method is called whenever permalink settings are changed or saved in the WordPress admin, so rewrite rules can be manually refreshed by visiting the Settings > Permalinks screen in WordPress's admin.

WARNING: If this function is called without a parameter or with a parameter of true, your .htaccess will be overwritten and any custom rules will be lost!

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

関数