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



お勧め

パスとURL(2011年10月6日 更新)

テーマやプラグインで、WordPressシステム関連のディレクトリやURLを使う時があり、それらの多くは関数や定数として定義されている。今回は、それらの関数や定数について整理していく。

ブロックエディターの文字サイズ設定を変えてみる(2019年12月12日 更新)

今回は「前回投稿した内容」の続きブロックエディターの文字サイズ設定を変えようと思う。参考にするテーマはもちろん「Twenty Twenty」である。

5.5で非推奨になる関数名について(2020年8月12日 更新)

来月にリリースされるWordPress 5.5に向けてBeta 1、2と公開が続いている。「WordPress 5.5 Beta 2(以降Beta 2)」のソースコードを見ていくと、いくつかの関数が非推奨になるようだ。

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

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

LevelとCapability(2018年5月27日 更新)

プラグインやテーマの管理ページを作成する際など、ユーザのレベルと権限を確認することがある。ここでは、権限グループ別のレベルと権限の有無を整理してみた。