redirect_canonical

説明

string|void redirect_canonical( [ string $requested_url = null [ , bool $do_redirect = true ] ] )
リクエストURLをサイトの基本ルールと比較してリダイレクトする。

パラメータ

  • $requested_url
    URLを指定(省略時はnull)。
  • $do_redirect
    リダイレクトする場合はtrueを指定(省略時はtrue)。

返り値

パラメータ$do_redirectがfalseでリダイレクトが必要な場合はそのURLを返す。

注意

本関数はテーマのテンプレートを適用する直前に実行される'template_redirect'アクションとして登録されている。WordPressでは1つのページにたいしていくつかのURLでアクセスできる。例えば、著者ページは「http://localhost/author/名前/」と「http://localhost/?author=番号」のどちらでも同じ内容となるが、標準の設定では後者のURLは前者のURLにリダイレクトされる。この仕組みを担っているのが、本関数である。


使用例

  • リクエストされたURLのリダイレクト先のURLを取得する。
    <?php $redirect = redirect_canonical( null, false ); ?>

フィルター

[2.3.0]値を返す直前で'redirect_canonical'フィルターを呼び出す。パラメータ$redirect_urlにはリダイレクトするURLが、$requested_urlにはリクエストURLが格納される。
$redirect_url = apply_filters( 'redirect_canonical', $redirect_url, $requested_url );

アクション

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

ソースファイル

/wp-includes/canonical.php

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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。