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 ↗

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

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 7.0.4 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.