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



お勧め

4.4では投稿ページも専用テンプレートが適用できる(2018年5月27日 更新)

従来、特定の固定ページには専用テンプレートを適用できるのですが、投稿ページに適用させるためにはアクションやフィルターを利用する必要がありました。4.4では特定の投稿ページに標準で専用テンプレートを適用できるようになりそうです。

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

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

タイトルのみをキーワード検索する(2014年4月3日 更新)

WordPressのキーワード検索は、投稿タイトルと本文のどちらかに指定したキーワードが含まれているかを調べるわけだが、時々タイトルだけとか、逆に本文だけ検索したいケースがある。

oEmbedについて考えてみた(2018年5月27日 更新)

本サイト向けにテーマをリニューアルしようと思い一から作っている最中、ふと生成されているHTMLの中にあるoEmbedの記述が目についた。「この記述いつからだっけ」くらいに思いながらリンク先を開き、ちょっとモヤモヤしてしまった。

一定時間でログアウトする(2013年5月23日 更新)

ログイン関係を調べている関係で、 wp_set_auth_cookie関数に行き着く。ログイン画面の「ログイン状態を保持する」がチェックされた場合、クッキーの有効期限は14日間。チェックされていない場合は、ブラウザが閉じるまで常に有効となっているんだね。