説明
パラメータ
- $locautionリダイレクト先URLを指定。
- $statusHTTPステータスを指定(省略時は302)。
- $x_redirect_by[5.1.0]ヘッダーX-Redirect-Byの値を指定(省略時は'WordPress')。
返り値
リダイレクトした場合はtrueを、$locautionのURLが無効の場合はfalseを返す。
注意
リダイレクトはphpのheader関数を使用。IISの場合($is_IISがtrue)は"Refresh: 0;url=$locaution"を、それ以外は"Locatoin: $locaution"を使用する。
[5.1.0]パラメータ$x_redirect_byと'x_redirect_by'フィルターが追加された。'x_redirect_by'フィルターの返り値が文字列の場合、リダイレクトする前にヘッダーX-Redirect-Byが出力される。
[5.4.0]パラメータ$statusが300未満か400以上の場合は、リダイレクトせずに wp_die関数を呼ぶ。
使用例
- サイトトップへリダイレクトする。<?php wp_redirect( get_site_url(), 302 ); ?>
フィルター
[2.1.0]最初にwp_redirectフィルターを実行する。$locautionと$statusには本関数のパラメータの値が入る。$locaution = apply_filters( 'wp_redirect', $locaution, $status );
$status = apply_filters( 'wp_redirect_status', $status, $locaution );
$x_redirect_by = apply_filters( 'x_redirect_by', $x_redirect_by, $status, $location );
アクション
実行するアクションはありません。ソースファイル
/wp-includes/pluggable.php最終更新 : 2020年04月07日 11:41
関連
お勧め
5.5で非推奨になる関数名について(2020年8月12日 更新)
来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。
meta_compare_key使ってみた(2019年3月19日 更新)
ブロックエディターの登場により、標準のカスタムフィールドを使う機会はかなり減った気がする。そんな中、5.1.0で追加されたのが、カスタムフィールド名(メタキー)に含まれる文字列を指定する'meta_compare_key'キーだ。
プラグインの設定ページもレスポンシブ対応(2014年6月3日 更新)
レスポンシブ対応したWordPressの管理画面。プラグインやテーマのカスタマイズで管理画面を拡張しているなら、切り替わるタイミングはきっちり押さえておきたいところではないだろうか。
初期化に関連するアクションのおさらい(2013年11月27日 更新)
いつも何気なくfunctions.phpで使っているafter_setup_themeアクションやinitアクション。普段はあまり意識していなかったが、ふとしたことからどんな順番に呼び出されるのか気になってしまい、ちょっと調べてみた。全投稿を取得するのはnopaging=1でいい(2011年8月31日 更新)
query_posts関数(またはWP_Queryクラス)を使う場合、取得する件数の指定を省略すると管理者ページの「表示設定」-「1ページに表示する最大件数」の指定値分だけの投稿情報を取得する。それでは条件にマッチするすべての投稿情報を取得するには?