status_header( int $code, string $description = '' )
Sets HTTP status header.
Contents
Description
See also
Parameters
-
$codeint Required -
HTTP status code.
-
$descriptionstring Optional -
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
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 );
}
}
Hooks
-
apply_filters( 'status_header',
string $status_header ,int $code ,string $description ,string $protocol ) -
Filters an HTTP status header.
Changelog
| Version | Description |
|---|---|
| 4.4.0 | Added the $description parameter. |
| 2.0.0 | Introduced. |
User Contributed Notes
You must log in before being able to contribute a note or feedback.
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.