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



お勧め

管理画面でツールバー(Admin bar)を非表示にする(2013年3月5日 更新)

WordPress使ってちょっと変わったサイトを構築する際、管理画面のツールバーを表示させたくないケースがある。一般に公開するサイト側であれば、 show_admin_bar関数で非表示にできるのだが、管理画面ではこれを使ってもツールバーは消えてくれない。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

タイトルが一致する投稿を検索する(2014年2月20日 更新)

WordPressが提供する投稿ページの文字列検索機能の実現には、 query_posts関数(WP_Queryクラス)が大きな役割を担っている。ここで紹介するのは、高機能ゆえに使いこなすのが難しいquery_posts関数(WP_Queryクラス)の使用法の一例である。

投稿ページでユニークなテンプレートを選択しよう(2018年5月27日 更新)

4.7の変更点に「投稿タイプテンプレート」がある。これは従来固定ページ('page')向けに任意のテンプレートを適用できる機能が拡張されたもので、投稿ページ('post')はもちろんカスタム投稿タイプのページにも適用可能になっている。

WordPressの鼓動(2013年10月1日 更新)

WordPressでは、Ajaxを利用する方法の1つとして add_action関数を利用することができる。この方法を調べている過程で、'heartbeat'というおもしろそうなAjaxアクションがあったので、紹介しておく。