wp_redirect

パラメータ

• $locaution
  リダイレクト先URLを指定。
• $status
  HTTPステータスを指定（省略時は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 ); ?>

フィルター

$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 );

アクション

ソースファイル