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



お勧め

6.2に追加されるsearch_columnsパラメータが便利(2023年3月30日 更新)

バージョン6.2では記事検索機能を備えたWP_Queryクラスにsearch_columnsパラメータが追加される。標準のキーワード検索では、タイトル(post_title)、本文(post_content)、抜粋(post_excerpt)が対象になっているが、search_columnsパラメータを使うと対象を絞り込めるようになる。

固定ページのURLの拡張子をhtmlに変更する(2013年3月9日 更新)

固定ページについて、URLを静的ページっぽく拡張子htmlに変更したいという要望を受けることがある。これまでは「.html on PAGES」というプラグインを使っていて特に不満があったわけではないのだが、今回ひょんなことから簡単に対応できることがわかったので、メモ書きしておく。

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

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

Fotepo:プラグイン作ってみました(2019年9月19日 更新)

仕事柄、Chromeの「デベロッパーツール」を使ってページのフォントを変更することがある。そんな時、無効なフォント名を指定してしまったり、フォント名をまちがえることがあり、もう少しお手軽にできないかと思って作ったのが今回紹介するプラグイン「Fotepo」である。

カテゴリー専用の投稿一覧と新規投稿メニューを追加する(2012年1月23日 更新)

サイト更新の1クリックを省くため、特定カテゴリーの投稿に対して同じようにメニューを追加してみた。カスタム投稿タイプの専用投稿メニューみたいな感じである。