WP_REST_Application_Passwords_Controller::do_permissions_check( WP_REST_Request $request ): true|WP_Error
- Since
- 5.6.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-application-passwords-controller.php:549
Compatibility
Deprecated in WordPress 5.7.0. Use <code>edit_user</code> directly or one of the specific meta capabilities introduced in 5.7.0.
- 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
$requestWP_REST_Request
Return value
true|WP_Error
Performance profile
How much work a call to WP_REST_Application_Passwords_Controller::do_permissions_check() 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
- Scaling
- Constant
- Instructions
- 14–32
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
No loop in the body: the same number of instructions runs whatever you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 34.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What it touches
- hookthird-party callbacks
do_action()one call below WP_REST_Application_Passwords_Controller::do_permissions_check()
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 · 3 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Application_Passwords_Controller::do_permissions_check() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
is_wp_error() | 14 | _deprecated_function(), ->get_user(), is_wp_error() |
!is_wp_error() && current_user_can() | 21 | _deprecated_function(), ->get_user(), is_wp_error(), current_user_can() |
!is_wp_error() && !current_user_can() | 32 | _deprecated_function(), ->get_user(), is_wp_error(), current_user_can(), __(), rest_authorization_required_code(), 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: 34 instructions, 14–32 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.
Uses · 7
- _deprecated_function()Marks a function as deprecated and inform when it has been used.
- is_wp_error()Checks whether the given variable is a WordPress Error.
- current_user_can()Returns whether the current user has the specified capability.
- __()Retrieves the translation of $text.
- rest_authorization_required_code()Returns a contextual HTTP error code for authorization failure.
- WP_REST_Application_Passwords_Controller::get_user()Gets the requested user.
- WP_Error::__construct()Initializes the error.
Source code
protected function do_permissions_check( $request ) { _deprecated_function( __METHOD__, '5.7.0' ); $user = $this->get_user( $request ); if ( is_wp_error( $user ) ) { return $user; } if ( ! current_user_can( 'edit_user', $user->ID ) ) { return new WP_Error( 'rest_cannot_manage_application_passwords', __( 'Sorry, you are not allowed to manage application passwords for this user.' ), array( 'status' => rest_authorization_required_code() ) ); } return true; }Changelog
Introduced in 5.6.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
edit_user directly or one of the specific meta capabilities introduced in 5.7.0.from the docblockAbout this page
- Parsed data
- Generated from the wordpress-develop 7.0.4 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-application-passwords-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.