wp_redirect

（1.5.1以降）
wp_redirect - 指定されたURLへリダイレクトする

説明

bool wp_redirect( string $locaution [ , int $status = 302 [ , string $x_redirect_by = 'WordPress' ] ] )
指定されたURLへリダイレクトする。

パラメータ

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

フィルター

[2.1.0]最初にwp_redirectフィルターを実行する。$locautionと$statusには本関数のパラメータの値が入る。 
$locaution = apply_filters( 'wp_redirect', $locaution, $status );
[2.3.0]wp_redirectフィルターの実行後、wp_redirect_statusフィルターを実行する。$statusには本関数の同名のパラメータが、$locautionにはwp_redirectフィルターの戻り値が入る。 
$status = apply_filters( 'wp_redirect_status', $status, $locaution );
[5.1.0]リダイレクトする前に'x_redirect_by'フィルターを呼び出す。パラメータ$x_redirect_byには本関数が受け取った内容が、$statusと$locationには上記のフィルターで処理した内容が格納されている。 
$x_redirect_by = apply_filters( 'x_redirect_by', $x_redirect_by, $status, $location );

アクション

実行するアクションはありません。

ソースファイル

/wp-includes/pluggable.php

最終更新 : 2020年04月07日 11:41

関連

参考

Code Reference: wp_redirect

お勧め

CSSやJavaScriptファイルのバージョン番号を変える（2018年5月27日 更新）

WordPress 4.7系の脆弱性をついた攻撃も落ち着いた感じなので、標準でヘッダーやフッター内に出力されるWordPressのバージョン番号について一考しました。

テーブルブロックを投稿メタ（カスタムフィールド）に保存する（2022年1月5日 更新）

ふと「テーブルブロックの内容を投稿メタ（カスタムフィールド）として保存できたら便利なのでは」と思い、投稿メタの使い方を調べてみた。

カスタム投稿タイプの投稿保存には専用アクションを使おう（2014年7月4日 更新）

カスタム投稿タイプを登録して、専用ウィジェット（meta_box）を使って拡張情報を入力させ、それらの情報をsave_postアクションで保存する。これまではこんな感じだったのだが、久しぶりにカスタム投稿タイプを使ったら、save_postアクションの前にsave_postに投稿タイプ名がくっついたアクションが追加されていた。

Fotepo：プラグイン作ってみました（2019年9月19日 更新）

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

5.3への準備：投稿写真を使っているサイトは準備しておこう（2019年10月10日 更新）

この記事は先日公開した「5.3の新機能：JPEG画像の向きを調整」の続きのようなものになる。高解像度の投稿写真を扱っているサイトは、5.3のリリースに合わせて対応を検討しておくべきことをまとめてみた。