説明
パラメータ
- $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
関連
お勧め
ブロックエディターの色設定を変えてみる(2019年12月11日 更新)
バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。
「姓」の後に「名」を(2013年11月6日 更新)
WordPressのユーザー情報設定ページでは、「名(First name)」の後に「姓(Last name)」を入力するようになっている。日本向けのユーザー登録できるサイトの場合、この並び順はちょっと違和感があるので、「姓」「名」の順に入力できるようにした。
ホームディレクトリから過去のファイルを削除する(2013年1月27日 更新)
WordPressで構築したサイトのホームディレクトリには、現在使われていないファイルが残っている時がある。3.5.1もリリースされたことだし、これを機にホームディレクトリを整理整頓した。Login rebuilder 2.6.5の新機能紹介(2021年3月8日 更新)
今回追加したものは、管理者のダッシュボードに表示されるログウィジェットの日時について任意の書式を設定する機能である。これまで日時の書式はサイト設定を利用していたが、ログの日時については揃えた方が見やすいと思ったので、今回の機能で対応することにしました。
投稿情報を連想配列で参照する(2018年5月27日 更新)
投稿情報は、タイトルや本文、投稿日時といったいくつかのデータが含んでおり、多くの場合オブジェクトになっている。これを連想配列で扱いたい場合はキャストして型変換することが多かった。基本的にはキャストで問題ないのだが、ふと目に留まったto_arrayメソッドが興味深かったのでメモとして残しておく。