概要
status_header関数は、HTTPステータスをセットするためのWordPressの関数です。この関数は、特定の条件に応じてHTTPレスポンスのステータスコードを設定するのに使われます。以下のような場合に頻繁に利用されます。
- ページが見つからない（404エラー）
- サーバーエラー（500エラー）
- 成功したリクエスト（200ステータス）
- 一時的なリダイレクト（302ステータス）
- 永続的なリダイレクト（301ステータス）
- 認証が必要なコンテンツ（401ステータス）
- 受け入れ可能なデータ形式でない場合のレスポンス（406ステータス）
- サイトメンテナンス中のステータス（503ステータス）
構文
status_header( $status, $text );
パラメータ
$status(int) – HTTPステータスコード。例えば、200、404など。$text(string) – オプションで、ステータスメッセージを指定可能。デフォルト値は空。
戻り値
この関数は、HTTPヘッダーを出力する際に、何も戻り値は返しません。ただし、HTTPヘッダーの出力を成功させていればtrueを返します。
関連する関数
http_response_code
wp_redirect
send_headers
使用可能なバージョン
status_header関数はWordPress 2.0以降のバージョンで使用可能です。
コアファイルのパス
wp-includes/pluggable.php
この関数のアクションでの使用可能性
| アクション | 使用可能性 |
|---|---|
| mu_plugin_loaded | |
| registered_post_type | |
| plugins_loaded | 〇 |
| wp_roles_init | |
| setup_theme | |
| after_setup_theme | |
| set_current_user | |
| init | 〇 |
| register_sidebar | |
| wp_loaded | 〇 |
| send_headers | 〇 |
| parse_query | |
| pre_get_posts | |
| wp | |
| template_redirect | 〇 |
| get_header | |
| wp_head |
非推奨または削除されたバージョン
現在のところ、status_header関数は特定のバージョンで非推奨または削除されていません。