add_rewrite_rule

（2.1.0以降）
add_rewrite_rule - リライトルールを追加する

説明

void add_rewrite_rule( string $regex, string $redirect [ , string $after = 'bottom' ] )
リライトルールを追加する（リライトルール追加用のデータを登録する）。

パラメータ

  • $regex
    ルールを適用するパターンを指定。
  • $redirect
    ルールにマッチした場合に書き換えるパターンを指定。
  • $after
    ルールを追加する場所として'top'または'bottom'を指定（省略時は'bottom'）。

返り値

返り値はありません。

注意

本関数はテーマ（主にfunctions.php）やプラグインで使用可能だが、各phpファイルのロード時はグローバル変数wp_rewriteが存在しないため呼び出すことはできず（呼び出すとエラーになる）、initアクションなどを利用しなければならない。
パラメータ$regexにはリクエストURLからサイトアドレス部分を取り除いた正規表現パターンを指定する。$regex内のグループ化演算子は、パラメータ$redirect内の後方参照パターン（$matches[n]のこと。[]内のnは1以上の数）に適用される。

実際にルールを適用されるためには、管理者のパーマリンク設定ページで「変更を保存」ボタンを押す（ flush_rewrite_rules関数を呼び出す）。追加したリライトルールを削除したい場合は、そのルールを追加したadd_rewrite_rule関数の記述を削除し、管理者のパーマリンク設定ページで「変更を保存」ボタンを押すこと。

使用例

  • リライトルールを追加する。
    <?php
function custom_rewrite_rules() {
	add_rewrite_rule( '^topic\-([0-9]+)?', 'index.php?p=$matches[1]', 'top' );
}
add_action( 'init', 'custom_rewrite_rules' );
?>

フィルター

実行するフィルターはありません。

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/rewrite.php

最終更新 : 2018年05月27日 10:45

関連

参考

Code Reference: add_rewrite_rule

お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧（2018年5月27日 更新）

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ショートコードを使ってテーマ内の画像URLを簡単に指定する（2018年5月27日 更新）

投稿記事の中で画像パーツを使いたいときがある。画像パーツの配置場所は、/imgディレクトリのようなテーマ外の場合と、/wp-content/themes/mytheme/imagesディレクトリのようなテーマ内の場合があり、今回は後者のケース。ショートコードを使って投稿記事の画像ファイルのURLを記述する方法を紹介したい。

Gutenbergでカスタムフィールドを使う（2018年8月10日 更新）

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

Login rebuilder 2.4.0の新機能を紹介（2018年5月27日 更新）

昨日、約半年ぶりにLogin rebuilderをアップデートし、著者ページ（author page）の閲覧を制限できる機能を追加した。この機能は、著者ページの閲覧によってユーザーIDが類推されることを防ぐことが目的としている。

ブロックエディターで編集したページが出力した余分な改行を削除（2019年2月22日 更新）

ブロックエディターで編集したページのHTMLソースは、投稿本文部分の改行が目立った。Webページとしての表示は問題ないのだが、データとしては不要なので削除することにした。