status_header() – Function | Developer.WordPress.org

Sets HTTP status header.

Description

Parameters

$codeintrequired: HTTP status code.
$descriptionstringoptional: A custom description for the HTTP status.
Defaults to the result of get_status_header_desc() for the given code.
Default:''

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

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 );
	}
}

View all references View on Trac View on GitHub

Hooks

apply_filters( ‘status_header’, string $status_header, int $code, string $description, string $protocol ): Filters an HTTP status header.

Uses	Description
wp_get_server_protocol()`wp-includes/load.php`	Returns the HTTP protocol sent by the server.
get_status_header_desc()`wp-includes/functions.php`	Retrieves the description for the HTTP status.
apply_filters()`wp-includes/plugin.php`	Calls the callback functions that have been added to a filter hook.

Show 1 more Show less

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

Show 12 more Show less

Changelog

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

User Contributed Notes

Skip to note 2 content

Eckstein 1 year ago

You must log in to vote on the helpfulness of this noteVote results for this note: 0You must log in to vote on the helpfulness of this note

Note: Setting a custom description in the 2nd parameter will only have an affect if a default message for that status code is not already set. It will not override the defaults.

Log in to add feedback

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

In this article

Description

See also

Parameters

More Information

Usage:

Notes:

Source

Hooks

Changelog

User Contributed Notes