wp_safe_redirect

説明

bool wp_safe_redirect( string $locaution [ , int $status = 302 [ , string $x_redirect_by = 'WordPress' ] ] )
指定されたURLが有効か調べ、リダイレクトする。

パラメータ

  • $locaution
    リダイレクト先のURLを指定。
  • $status
    リダイレクト時のステータスコードを指定(省略時は302)。
  • $x_redirect_by
    [5.1.0]ヘッダーX-Redirect-Byの値を指定(省略時は'WordPress')。

返り値

[5.1.0より前]返り値はありません。
[5.1.0以降] wp_redirect関数の返り値を返す。


注意

wp_redirect関数はURLの内容を検証しないが、このwp_safe_redirect関数はURLを内容を検証し、無効なURLの場合は admin_url関数で取得できる管理者向けページへリダイレクトする。


使用例

  • $urlへリダイレクトする。
    <?php wp_safe_redirect( $url ); ?>

フィルター

[4.3.0]パラメータ$locautionが無効なURLの場合にリダイレクト先として管理者向けページのURLを確定する前にwp_safe_redirect_fallbackフィルターを呼び出す。パラメータ$admin_urlには admin_url関数で取得した値が、$statusは本関数が受け取った内容が格納される。
$location = wp_validate_redirect( $location, apply_filters( 'wp_safe_redirect_fallback', $admin_url, $status ) );

アクション

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

ソースファイル

/wp-includes/pluggable.php

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



お勧め

ブロックエディターの色設定を変えてみる(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メソッドが興味深かったのでメモとして残しておく。