wppaste
WordPress

rest_application_password_check_errors( WP_Error|null|true $result ): WP_Error|null|true

Since
5.6.0
Source
wp-includes/rest-api.php:1236
Checks for errors when using application password-based authentication.

Compatibility

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

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

Parameters

$resultWP_Error|null|true
Error from another authentication handler, null if we should handle it, or another value if not.

Return value

WP_Error|null|true
WP_Error if the application password is invalid, the $result, otherwise true.

Performance profile

How much work a call to rest_application_password_check_errors() 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
5–19

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

  • hookthird-party callbacksdo_action()one call below rest_application_password_check_errors()

What one call costs · 3 distinct outcomes

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

WhenInstructionsCalls it makes
!empty($result)5none
empty($result) && !is_wp_error()11is_wp_error()
empty($result) && is_wp_error()17–19is_wp_error(), ->get_error_data(), ->add_data()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 24 instructions, 5–19 executed per call, 4 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.

Uses · 1

  • is_wp_error()Checks whether the given variable is a WordPress Error.

Source code

function rest_application_password_check_errors( $result ) {	global $wp_rest_application_password_status; 	if ( ! empty( $result ) ) {		return $result;	} 	if ( is_wp_error( $wp_rest_application_password_status ) ) {		$data = $wp_rest_application_password_status->get_error_data(); 		if ( ! isset( $data['status'] ) ) {			$data['status'] = 401;		} 		$wp_rest_application_password_status->add_data( $data ); 		return $wp_rest_application_password_status;	} 	if ( $wp_rest_application_password_status instanceof WP_User ) {		return true;	} 	return $result;}

Changelog

Introduced in 5.6.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.9.7 tag, from src/wp-includes/rest-api.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.