wppaste
WordPress

WP_REST_Abilities_V1_Run_Controller::ensure_error_status( WP_Error $error, int $status ): WP_Error

Since
7.1.0
Source
wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-run-controller.php:197
Ensures a WP_Error object carries an HTTP status, adding a default when none is set.

Compatibility

WordPress
since 7.1.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

Present in 1 of the 5 tracked releases, added in 7.1.0, and compiles on PHP 7.4 through 8.6-dev.

Parameters

$errorWP_Error
Error object to update.
$statusint
HTTP status code to add if not already present.

Return value

WP_Error
The error object, with a default status when needed.

Performance profile

How much work a call to WP_REST_Abilities_V1_Run_Controller::ensure_error_status() 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–15

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
1

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

What one call costs · 2 distinct outcomes

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

WhenInstructionsCalls it makes
is_array($error_data) && isset($error_data)11->get_error_data()
always13–15->get_error_data(), status()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 15 instructions, 11–15 executed per call, 2 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Used by · 1

Source code

View on Trac View on GitHub 

	private function ensure_error_status( WP_Error $error, int $status ): WP_Error {		$error_data = $error->get_error_data();		if ( ! is_array( $error_data ) || ! isset( $error_data['status'] ) ) {			$error->add_data( array( 'status' => $status ) );		} 		return $error;	}

Changelog

Introduced in 7.1.0.

Signature, return type and hooks compared across 1 parsed release.

About this page

Parsed data
Generated from the wordpress-develop 7.1.0 tag, from src/wp-includes/rest-api/endpoints/class-wp-rest-abilities-v1-run-controller.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.