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



お勧め

個人データのエクスポートメール向けに追加された新フィルター(2020年4月2日 更新)

先週「WordPress 5.4 RC3」が公開され、正式リリースまであと1週間。ブロックエディターの機能強化が目立つわけですが、地味な変更点もちらほらと。今回はその中の1つ、「個人データのエクスポート」機能に関連するフィルターを紹介する。

決まった値を返すだけの関数群(2018年5月27日 更新)

WordPressのソースコードを眺めているとフィルター関数名で'__return_○○'が指定されている部分を時々見かけます。それらの関数定義を見てみると、すべて決まった値を単純に返すだけでした。これらの関数がちょっと気になったので、まとめてみました。

サイドバーの初期化はwidgets_initアクションで(2011年7月14日 更新)

ウィジェットを使ってみたくなり新テーマ「Twenty Eleven」を覗いてみると、codexに記載されていた内容と少し違っている。これって「Twenty Ten」ですでに変更されていたんだね。

Gutenbergでカスタムフィールドを使う(2018年8月10日 更新)

Gutenbergの新エディターではカスタムフィールドのウィジェットが表示されない。既存のカスタムフィールドのデータはなくなるわけでないので、新エディター上で編集・更新できないか調べてみた。

favicon.icoがWordPressロゴになる!?(2020年2月25日 更新)

先週「WordPress 5.4 Beta2」が公開され、来月末には正式リリース。タイミングよく三連休だったので、1つ前の「ニュース」で紹介されていた変更点から確認してみた。