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



お勧め

5.3の新機能:クエリーログに任意の項目を追加できる新フィルター(2019年10月23日 更新)

5.3 RC2」が公開され、正式リリースまであと20日。公式ディレクトリにプラグインを公開していることもあり、5.3に関する開発者向けの情報「Miscellaneous Developer Focused Changes in 5.3」を読んでいる。

ログインページのタイトルを変更してみる(2018年5月27日 更新)

バージョン4.9では新しいフィルターやフィルターのパラメータの追加が多数行われている。ここではその一例としてログインページ関連で追加された2つのフィルターを紹介する。

プラグインで注意が必要な関数(2013年11月27日 更新)

先日「Login rebuilder」という自作プラグインをアップデートした際、ユーザーさんからエラーになると連絡をいただいた。標準環境では問題なく、どうやら何らかのプラグインが影響しているらしい。

ブロックエディターの色設定を変えてみる(2019年12月11日 更新)

バージョン5.3で機能強化されたブロックエディター。対応を考えて新テーマ「Twenty Twenty」のソースコードを眺めていく。

KUSANAGIでマルチサイト(サブドメイン)を試した(2019年8月6日 更新)

本サイトはサブディレクトリタイプのマルチサイト機能を採用して構築しているが、これまでサブドメインタイプは利用した経験はない。マルチサイト機能のサブドメインタイプは以前から1度は試してみたいと思っており、今回実際にサイトを構築してみた。