W3cubDocs

/WordPress

status_header( int $code, string $description = '' )

Set HTTP status header.

Description

Parameters

$code

(int) (Required) HTTP status code.

$description

(string) (Optional) A custom description for the HTTP status.

Default value: ''

More Information

Usage:

status_header( $header );

Notes:

Uses: apply_filters() Calls ‘status_header‘ on status header string, HTTP code, HTTP code description, and protocol string as separate parameters.

Source

File: wp-includes/functions.php

function status_header( $code, $description = '' ) {
	if ( ! $description ) {
		$description = get_status_header_desc( $code );
	}

	if ( empty( $description ) ) {
		return;
	}

	$protocol      = wp_get_server_protocol();
	$status_header = "$protocol $code $description";
	if ( function_exists( 'apply_filters' ) ) {

		/**
		 * Filters an HTTP status header.
		 *
		 * @since 2.2.0
		 *
		 * @param string $status_header HTTP status header.
		 * @param int    $code          HTTP status code.
		 * @param string $description   Description for the status code.
		 * @param string $protocol      Server protocol.
		 */
		$status_header = apply_filters( 'status_header', $status_header, $code, $description, $protocol );
	}

	if ( ! headers_sent() ) {
		header( $status_header, true, $code );
	}
}

Uses

Uses	Description
wp-includes/load.php: wp_get_server_protocol()	Return the HTTP protocol sent by the server.
wp-includes/functions.php: get_status_header_desc()	Retrieve the description for the HTTP status.
wp-includes/functions.php: status_header	Filters an HTTP status header.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.

Used By

Used By	Description
wp-includes/sitemaps/class-wp-sitemaps.php: WP_Sitemaps::render_sitemaps()	Renders sitemap templates based on rewrite rules.
wp-includes/functions.php: _jsonp_wp_die_handler()	Kills WordPress execution and displays JSONP response with an error message.
wp-includes/functions.php: _xml_wp_die_handler()	Kills WordPress execution and displays XML response with an error message.
wp-includes/functions.php: _json_wp_die_handler()	Kills WordPress execution and displays JSON response with an error message.
wp-includes/class-wp-customize-nav-menus.php: WP_Customize_Nav_Menus::ajax_insert_auto_draft_post()	Ajax handler for adding a new auto-draft post.
wp-includes/customize/class-wp-customize-selective-refresh.php: WP_Customize_Selective_Refresh::handle_render_partials_request()	Handles the Ajax request to return the rendered partials for the requested placements.
wp-includes/embed.php: _oembed_rest_pre_serve_request()	Hooks into the REST API output to print XML instead of JSON.
wp-includes/rest-api/class-wp-rest-server.php: WP_REST_Server::set_status()	Sends an HTTP status code.
wp-includes/pluggable.php: wp_redirect()	Redirects to another page.
wp-includes/class-wp.php: WP::handle_404()	Set the Headers for 404, if nothing is found for requested URL.
wp-includes/class-wp.php: WP::send_headers()	Sends additional HTTP headers for caching, content type, etc.
wp-includes/functions.php: wp_send_json()	Send a JSON response back to an Ajax request.
wp-includes/functions.php: _default_wp_die_handler()	Kills WordPress execution and displays HTML page with an error message.
wp-includes/functions.php: _ajax_wp_die_handler()	Kills WordPress execution and displays Ajax response with an error message.
wp-includes/http.php: send_origin_headers()	Send Access-Control-Allow-Origin and related headers if the current request is from an allowed origin.

Changelog

Version	Description
4.4.0	Added the `$description` parameter.
2.0.0	Introduced.

© 2003–2019 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/status_header