get_status_header_desc( int $code ): string

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$codeint

HTTP status code.

Return value

string

Status description if found, an empty string otherwise.

Performance profile

How much work a call to get_status_header_desc() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Trivial

Touches nothing outside its own arguments.

Scaling

Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions

11–13

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 14.

Plugin surface

None

Nothing here hands control to plugin code.

Called by

5

5 places in core call this, so the cost is paid more often than your own code shows.

What one call costs · 1 distinct outcome

One number would be a lie: the work depends on which branch runs. These are every distinct cost get_status_header_desc() can have, taken from its control-flow graph on PHP 8.5.

Uses · 1

• absint()Converts a value to non-negative integer.

Used by · 5

• WP_HTTP_Requests_Response::to_array()Converts the object to a WP_Http response array.
• WP_oEmbed_Controller::get_item()Callback for the embed API endpoint.
• WP_oEmbed_Controller::get_proxy_item()Callback for the proxy API endpoint.
• _oembed_rest_pre_serve_request()Hooks into the REST API output to print XML instead of JSON.
• status_header()Sets HTTP status header.

Source code

View on Trac ↗View on GitHub ↗

1357function get_status_header_desc( $code ) {1358	global $wp_header_to_desc;1359 1360	$code = absint( $code );1361 1362	if ( ! isset( $wp_header_to_desc ) ) {1363		$wp_header_to_desc = array(1364			100 => 'Continue',1365			101 => 'Switching Protocols',1366			102 => 'Processing',1367			103 => 'Early Hints',1368 1369			200 => 'OK',1370			201 => 'Created',1371			202 => 'Accepted',1372			203 => 'Non-Authoritative Information',1373			204 => 'No Content',1374			205 => 'Reset Content',1375			206 => 'Partial Content',1376			207 => 'Multi-Status',1377			226 => 'IM Used',1378 1379			300 => 'Multiple Choices',1380			301 => 'Moved Permanently',1381			302 => 'Found',1382			303 => 'See Other',1383			304 => 'Not Modified',1384			305 => 'Use Proxy',1385			306 => 'Reserved',1386			307 => 'Temporary Redirect',1387			308 => 'Permanent Redirect',1388 1389			400 => 'Bad Request',1390			401 => 'Unauthorized',1391			402 => 'Payment Required',1392			403 => 'Forbidden',1393			404 => 'Not Found',1394			405 => 'Method Not Allowed',1395			406 => 'Not Acceptable',1396			407 => 'Proxy Authentication Required',1397			408 => 'Request Timeout',1398			409 => 'Conflict',1399			410 => 'Gone',1400			411 => 'Length Required',1401			412 => 'Precondition Failed',1402			413 => 'Request Entity Too Large',1403			414 => 'Request-URI Too Long',1404			415 => 'Unsupported Media Type',1405			416 => 'Requested Range Not Satisfiable',1406			417 => 'Expectation Failed',1407			418 => 'I\'m a teapot',1408			421 => 'Misdirected Request',1409			422 => 'Unprocessable Entity',1410			423 => 'Locked',1411			424 => 'Failed Dependency',1412			425 => 'Too Early',1413			426 => 'Upgrade Required',1414			428 => 'Precondition Required',1415			429 => 'Too Many Requests',1416			431 => 'Request Header Fields Too Large',1417			451 => 'Unavailable For Legal Reasons',1418 1419			500 => 'Internal Server Error',1420			501 => 'Not Implemented',1421			502 => 'Bad Gateway',1422			503 => 'Service Unavailable',1423			504 => 'Gateway Timeout',1424			505 => 'HTTP Version Not Supported',1425			506 => 'Variant Also Negotiates',1426			507 => 'Insufficient Storage',1427			510 => 'Not Extended',1428			511 => 'Network Authentication Required',1429		);1430	}1431 1432	if ( isset( $wp_header_to_desc[ $code ] ) ) {1433		return $wp_header_to_desc[ $code ];1434	} else {1435		return '';1436	}

Changelog

Introduced in 2.3.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.