wp_is_authorize_application_password_request_valid( array $request, WP_User $user ): true|WP_Error

Compatibility

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

Parameters

$requestarray

The array of request data. All arguments are optional and may be empty.

• $app_namestring

  The suggested name of the application.

• $app_idstring

  A UUID provided by the application to uniquely identify it.

• $success_urlstring

  The URL the user will be redirected to after approving the application.

• $reject_urlstring

  The URL the user will be redirected to after rejecting the application.

$userWP_User

The user authorizing the application.

Return value

true|WP_Error

True if the request is valid, a WP_Error object contains errors if not.

Performance profile

How much work a call to wp_is_authorize_application_password_request_valid() 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

21–70

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

Plugin surface

1 hook

Third-party callbacks on 'wp_authorize_application_password_request_errors' run inside this call, and their cost is not bounded by anything here.

Called by

0

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

What it touches

• hookthird-party callbacksdo_action()called directly

Further down the call graph this can also reach query, option, cache, serialize and transient. Those are the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 21 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while wp_is_authorize_application_password_request_valid() runs, in this order:

1. 1
   do_action( wp_authorize_application_password_request_errors )actionline 698 (+39 into the body)

   Fires before application password errors are returned.

Uses · 6

• wp_is_authorize_application_redirect_url_valid()Validates the redirect URL protocol scheme.
• is_wp_error()Checks whether the given variable is a WordPress Error.
• wp_is_uuid()Validates that a UUID is valid.
• __()Retrieves the translation of $text.
• do_action()Calls the callback functions that have been added to an action hook.
• WP_Error::__construct()Initializes the error.

Source code

View on Trac ↗View on GitHub ↗

659function wp_is_authorize_application_password_request_valid( $request, $user ) {660	$error = new WP_Error();661 662	if ( isset( $request['success_url'] ) ) {663		$validated_success_url = wp_is_authorize_application_redirect_url_valid( $request['success_url'] );664		if ( is_wp_error( $validated_success_url ) ) {665			$error->add(666				$validated_success_url->get_error_code(),667				$validated_success_url->get_error_message()668			);669		}670	}671 672	if ( isset( $request['reject_url'] ) ) {673		$validated_reject_url = wp_is_authorize_application_redirect_url_valid( $request['reject_url'] );674		if ( is_wp_error( $validated_reject_url ) ) {675			$error->add(676				$validated_reject_url->get_error_code(),677				$validated_reject_url->get_error_message()678			);679		}680	}681 682	if ( ! empty( $request['app_id'] ) && ! wp_is_uuid( $request['app_id'] ) ) {683		$error->add(684			'invalid_app_id',685			__( 'The application ID must be a UUID.' )686		);687	}688 689	/**690	 * Fires before application password errors are returned.691	 *692	 * @since 5.6.0693	 *694	 * @param WP_Error $error   The error object.695	 * @param array    $request The array of request data.696	 * @param WP_User  $user    The user authorizing the application.697	 */698	do_action( 'wp_authorize_application_password_request_errors', $error, $request, $user );699 700	if ( $error->has_errors() ) {701		return $error;702	}703 704	return true;705}

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 7.0.4 tag, from src/wp-admin/includes/user.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.