ドキュメント

Document

自分のための備忘録です。

パーマリンク構造

WordPressの表示フローは概ね以下のようになります。

パーマリンク生成

設定 > パーマリンクからリライトルールを設定
WordPressはパーマリンクを作成
- 新規投稿時や記事/アーカイブ表示時にget_permalink関数で1で設定したリライトルールに沿ってprettyパーマリンクを生成

投稿表示

WordPressは↑のprettyパーマリンクをリライトルールに応じてuglyパーマリンクに変換
uglyパーマリンクのquery_varsに応じて対象を抽出して表示する

Ref

概要

WordPressのパーマリンクは大きく2つに分けられます。

デフォルト：Uglyパーマリンク（例 https://example.com/index.php?p=12345&cat=123）
mod_rewrite: Prettyパーマリンク”（例：https://example.com/sample/12345）

本記事ではPrettyパーマリンクがUglyパーマリンクに変換されるフローを記載しています。

※ Prettyパーマリンクの構造は基本的に設定 > パーマリンクから指定します。
※ パーマリンクはDBに格納されていません。↑の設定に応じて動的に作成されます。

リライトの流れ

設定 > パーマリンクで設定を変更
上記設定によってwp_options.option_nameのrewrite_rules（WP_Rewrite::rules）が決まる

アクセス

Prettyパーマリンクでアクセス（例：https://example.com/category-sample/1）
PrettyパーマリンクをWP_Rewrite::rulesをもとにUglyパーマリンクに変換（例：https://example.com?p=1&category-name=category-sample&page=）
Uglyパーマリンクのパブリッククエリをもとに投稿抽出クエリの条件であるWP_Query:query_varsが設定されて投稿抽出SQL発行

Webサイト表示の場合HTTPリクエストを受け取って起動したWordPressは、HTTPリクエストに含まれるクエリ文字列またはURLの一部をWordPressのリクエスト変数として解釈し、WordPressクエリ文字列を実行します。HTTPリクエストに含めることができるクエリ変数をパブリッククエリ変数といいます。

O'Reilly 詳解WordPress プライム・ストラテジー株式会社 p95

パブリック変数はwp-includes/class-wp.phpで定義されている。

<?php
/**
 * WordPress environment setup class.
 *
 * @package WordPress
 * @since 2.0.0
 */
class WP {
    /**
     * Public query variables.
     *
     * Long list of public query variables.
     *
     * @since 2.0.0
     * @var string[]
     */
    public $public_query_vars = array( 'm', 'p', 'posts', 'w', 'cat', 'withcomments', 'withoutcomments', 's', 'search', 'exact', 'sentence', 'calendar', 'page', 'paged', 'more', 'tb', 'pb', 'author', 'order', 'orderby', 'year', 'monthnum', 'day', 'hour', 'minute', 'second', 'name', 'category_name', 'tag', 'feed', 'author_name', 'pagename', 'page_id', 'error', 'attachment', 'attachment_id', 'subpost', 'subpost_id', 'preview', 'robots', 'favicon', 'taxonomy', 'term', 'cpage', 'post_type', 'embed' );

リライトルール

パブリッククエリをリライトルールに沿って解釈して、問合せを（SQL）発行して投稿を取得する。

アクセス時のパブリッククエリは、WP_Query::query_varsに格納される

wp-setting.phpの中に、WordPressによるURLの解釈、リライトのために重要な2つのオブジェクト、$wp_queryと$wp_rewriteが初期化されます。

Rewrite APIその1 「Rewriteとパーマリンク」（WordPressプラグイン開発のバイブルのボツ原稿から）

WordPressのリライトルールは、グローバル変数$wp_rewriteに格納されている。

DBテーブル

リライト関連の情報は、wp_optionsに格納されている。以下に代表的なレコードを記載する。

option_name	option_value
permalink_structure	`/%category%/%post_id%`
rewrite_rules	マッチ規則の正規表現がシリアライズされて保存

リライトルールを追加

ref. WordPress パーマリンクリライトルール

add_rewrite_rule
add_rewrite_tag
pre_post_link ・・・ get_permalinkの中でapplyされる
add permastruct
rewrite_rules_array
flush_rewrite_rules
- リライトルールはflush_rewrite_ruleをコードで呼び出すか、管理画面のパーマリンク画面を開くと自動で反映される

プラグインによるリライトルールの追加時に、WordPressのデータベースにtransientキャッシュとして登録されているリライトルールを変更する処理を加えなければなりません。

Rewrite APIその1 「Rewriteとパーマリンク」（WordPressプラグイン開発のバイブルのボツ原稿から）

備考

wp_rewrite

WordPress パーマリンクリライトルール

// カスタム投稿タイプmanualのrewriteルールを追加
add_filter( 'rewrite_rules_array', function($rules) {
    $new_rules = [
        'manual/([0-9]+)/?$' => 'index.php?post_type=manual&p=$matches[1]',
    ];

    return $new_rules + $rules;
});


add_filter( 'pre_post_link', function($permalink, $post, $leavename) {
    if ( $post->ID !== $post->post_name ) {
        return '/%category%/%postname%';
    }
    //$permalink をカスタマイズ
    return $permalink;
}, 10, 3 );

add_filter( 'rewrite_rules_array', function($rules) {
    $new_rules = [
        'info/.+/([0-9a-zA-Z-_]+)$' => 'index.php?name=matches[1]',
    ];

    return $rules + $new_rules;
});