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



お勧め

the_date関数で投稿日を確実に表示する(2011年12月20日 更新)

投稿記事の投稿日時を表示する際、 the_date関数を使用することが多いだろう。このthe_date関数はphpのdate関数と同じパラメータを指定することで、好みの日時フォーマットで投稿日時を表示できるのだが、ある条件の場合に投稿日時を表示しない。最初にこの現象に遭遇したときは、ちょっと悩まされた。

3.8の「アクティビティ」ウィジェットに投稿以外の情報も表示する(2014年1月17日 更新)

ちょうど1月前の「ダッシュボードの「概要」にカスタム投稿タイプ件数を表示する」にて、WordPress 3.8新ダッシュボードの「概要」ウィジェットにカスタム投稿タイプの投稿数を表示する方法を紹介したが、今回のその続編で「アクティビティ」ウィジェットを拡張する方法を紹介する。

Gutenberg、初見です(2018年8月6日 更新)

先週末、WordPress 4.9.8がリリースされ、事前に告知されてたように「Gutenberg」がお披露目になった。投稿編集ページがガラリと変わり、影響範囲はそれなりに大きいと思われる。まずはこの週末に感じたことを整理してみた。

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

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

同じ名前のメタ情報をまとめて削除する(2014年3月21日 更新)

WordPressには、投稿情報、コメント情報、ユーザ情報のそれぞれを拡張できるメタ情報の仕組みが用意されている。投稿情報のメタ情報は「カスタムフィールド」として投稿画面に用意されているので投稿者自身が随時操作できるほか、テーマやプラグインからの操作も容易である。今回の中身はそんなメタ情報の一括削除の話だ。