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

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

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

提供: WordPress Codex 日本語版
移動先: 案内検索
(en: Rewrite_API/flush_rules 22:43, 18 December 2013‎ Ggutenberg)
 
(クリーンアップ。)
 
(他の1人の利用者による、間の5版が非表示)
1行目: 1行目:
{{NeedTrans}}
+
{{CheckTrans}}
  
==Description==
+
<div id="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.
+
== 説明 ==
 +
</div>
  
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]].
+
このメソッドは、WordPress のリライトルールのキャッシュを更新するために使用できます。一般的に、これはプログラムでカスタムリライトルールを追加した後に使用する必要があります。
  
==Usage==
+
<p class="information">この機能はパフォーマンスの面で非常にコストがかかる可能性があるので、できるだけ使用を控える必要があります。たとえばプラグインやテーマの[[関数リファレンス/register_activation_hook|有効化]]または無効化時に限って使いましょう。[[プラグイン API/アクションフック一覧/init|init]] など、ページのロード時に毎回実行されるフック内では使わないようにあらゆる努力を払ってください。</p>
 +
 
 +
<div id="Usage">
 +
== 使い方 ==
 +
</div>
 
  $wp_rewrite->flush_rules( $hard );
 
  $wp_rewrite->flush_rules( $hard );
  
==Arguments==
+
<div id="Arguments">
{{Parameter|$hard|boolean|Whether to update .htaccess (hard flush) or just update rewrite_rules option (soft flush).|optional|true}}
+
== 引数 ==
 +
</div>
  
==What it does==
+
{{Parameter|$hard|真偽値|[[htaccess|.htaccess]] も更新するか(ハードフラッシュ)、それとも <tt>rewrite_rules</tt> オプションのみを更新するか(ソフトフラッシュ)。|オプション|<tt>true</tt>(ハードフラッシュ)}}
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 <tt>flush_rules()</tt>, you must first ensure you are using WordPress' <tt>$wp_rewrite</tt> global, and call it as a method (see "Usage" above for an example).
+
<div id="What_it_does">
 +
== やっていること ==
 +
</div>
  
'''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.
+
WordPress は全てのカスタマイズされたリライトルールのキャッシュを保持します。ときどきプラグインやテーマがそのルールを変更しますが、WordPress はキャッシュが再生成されるまでその変更を実際に認識しません。
  
'''WARNING:''' If this function is called without a parameter or with a parameter of <tt>true</tt>, your <tt>.htaccess</tt> will be overwritten and any custom rules will be lost!
+
これは手続き型の関数ではなく、WP_Rewrite クラスの動的メソッドです。<tt>flush_rules()</tt> を呼び出すには、まず WordPress のグローバル変数 <tt>$wp_rewrite</tt> を使用していることを確認し、そしてメソッドとして呼び出します([[#Usage|使い方]]の例を見てください)。
 +
 
 +
<p class="information">'''参考:''' このメソッドは WordPress の管理画面からパーマリンクの設定が変更もしくは保存されたときに、毎回呼び出されます。そのため WordPress の管理画面の 設定 > パーマリンク設定 の画面でリライトルールを手動で更新することができます。</p>
 +
 
 +
<p class="important">'''警告:''' もしこのメソッドがパラメーターなし、もしくは <tt>true</tt> を指定して呼び出された場合、<tt>.htaccess</tt> は上書きされてカスタマイズしたリライトルールがすべて失われます!</p>
 +
 
 +
<div id="Example">
 +
== 用例 ==
 +
</div>
  
==Example==
 
 
<pre>
 
<pre>
//Ensure the $wp_rewrite global is loaded
+
// 確実に $wp_rewrite グローバル変数を使う
 
global $wp_rewrite;
 
global $wp_rewrite;
//Call flush_rules() as a method of the $wp_rewrite object
+
// flush_rules() $wp_rewrite オブジェクトのメソッドとして呼び出す
 
$wp_rewrite->flush_rules( false );
 
$wp_rewrite->flush_rules( false );
 
</pre>
 
</pre>
  
==Related==
+
== 変更履歴 ==
 +
 
 +
新規導入: [[Version 2.1|2.0.1]]
 +
 
 +
== ソースファイル ==
 +
 
 +
flush_rules() メソッドは {{Trac|wp-includes/rewrite.php}} にあります。
 +
 
 +
<div id="Related">
 +
== 関連項目 ==
 +
</div>
 +
 
 
{{Rewrite API}}
 
{{Rewrite API}}
 +
 +
{{原文|Rewrite API/flush_rules|154060}} <!-- 01:26, 22 September 2015 Gblsm 版 -->
 +
 +
{{DEFAULTSORT:Flush_rules}}
 +
 +
[[en:Rewrite API/flush_rules]]

2015年9月22日 (火) 10:57時点における最新版

この項目「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最新版との差分