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

Set HTTP status header.


Description

Top ↑

See also


Top ↑

Parameters

$code int Required
HTTP status code.
$description string Optional
A custom description for the HTTP status.

Default: ''


Top ↑

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.


Top ↑

Source

File: wp-includes/functions.php. View all references

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

Top ↑

Hooks



Top ↑

Changelog

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

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.