wp_redirect

説明

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

パラメータ

  • $locaution
    リダイレクト先URLを指定。
  • $size
    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が出力される。


使用例

  • サイトトップへリダイレクトする。
    <?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

最終更新 : 2019年03月04日 14:13



お勧め

WordPressと組み込まれている主なJavaScriptライブラリのバージョン一覧(2018年5月27日 更新)

WordPressの更新が遅れていたサイトを少し前に更新したところ、jQuery UI sortableを使って拡張したページに不具合が発生しました。WordPressの更新に伴って内部のjQuery UIが更新されたことに起因すると思われ、これを機にWordPressとそれに組み込まれたJavaScriptライブラリのバージョンを確認してみました。

ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)

WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。

wp_titleからwp_get_document_titleへ(2018年5月27日 更新)

先週、WordPress 4.4 beta1(以降4.4 beta1)が公開されました。この4.4 beta1では新テーマ「Twenty Sixteen」が追加されたほか、wp-includesディレクトリ以下のファイルが大幅に変更された感じです。

検索ワード「-10,000円」を検索できるようにしたい(2018年5月27日 更新)

とあるサイトで「-10,000円」をキーワードに検索した際、予想と異なるページが表示され、ちょっと驚いた。今回はその原因調査と対策についてまとめてみた。

ダッシュボードのフィードボックスをカスタマイズ(2011年7月8日 更新)

管理者ページのトップページ「ダッシュボード」には、「WordPress 開発者ブログ」と「WordPress フォーラム」という2つのフィードボックスが表示されている。自分のような開発者には有益な情報をもたらしているが、一般の方には必要のない情報かもしれない。今回はこのフィードボックスをカスタマイズする方法を紹介する(管理者権限)。