WP_REST_Users_Controller::get_items_permissions_check( WP_REST_Request $request ): true|WP_Error
- Since
- 4.7.0
- Source
wp-includes/rest-api/endpoints/class-wp-rest-users-controller.php:201
Compatibility
- WordPress
- since 4.7.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- Full details about the request.
Return value
true|WP_Error- True if the request has read access, otherwise WP_Error object.
Performance profile
How much work a call to WP_REST_Users_Controller::get_items_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
- Light
- Scaling
- Scales with input
- Instructions
- 15–53
- Plugin surface
- None
- Called by
- 0
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 115.
Nothing here hands control to plugin code.
Nothing in core calls this; the cost is only what you spend yourself.
What one call costs · 19 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost WP_REST_Users_Controller::get_items_permissions_check() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
empty($request) | 15 | none |
empty($request) && current_user_can() | 19 | current_user_can() |
!current_user_can() | 19–27 | current_user_can(), __(), rest_authorization_required_code(), status() |
current_user_can() | 23 | current_user_can(), current_user_can() |
| always | 25–31 | current_user_can(), current_user_can(), __(), rest_authorization_required_code(), status() |
!empty($request) && current_user_can() | 27 | current_user_can(), current_user_can(), current_user_can() |
!empty($request) && current_user_can() | 31 | current_user_can(), current_user_can(), current_user_can(), current_user_can() |
!empty($request) | 32–35 | current_user_can(), current_user_can(), current_user_can(), __(), rest_authorization_required_code(), status() |
empty($request) | 33–34 | get_post_types(), __(), rest_authorization_required_code(), status() |
empty($request) && !$types && post_type_supports() && current_user_can() | 37 | get_post_types(), post_type_supports(), current_user_can() |
empty($request) && current_user_can() | 37–38 | current_user_can(), get_post_types(), __(), rest_authorization_required_code(), status() |
!empty($request) | 39 | current_user_can(), current_user_can(), current_user_can(), current_user_can(), __(), rest_authorization_required_code(), status() |
7 further outcomes, up to 53 instructions
empty($request) && current_user_can() && !$types && post_type_supports() | 41 | current_user_can(), get_post_types(), post_type_supports(), current_user_can() |
current_user_can() | 41–42 | current_user_can(), current_user_can(), get_post_types(), __(), rest_authorization_required_code(), status() |
current_user_can() && !$types && post_type_supports() | 45 | current_user_can(), current_user_can(), get_post_types(), post_type_supports(), current_user_can() |
!empty($request) && current_user_can() | 45–46 | current_user_can(), current_user_can(), current_user_can(), get_post_types(), __(), rest_authorization_required_code(), status() |
!empty($request) && current_user_can() && !$types && post_type_supports() | 49 | current_user_can(), current_user_can(), current_user_can(), get_post_types(), post_type_supports(), current_user_can() |
!empty($request) && current_user_can() | 49–50 | current_user_can(), current_user_can(), current_user_can(), current_user_can(), get_post_types(), __(), rest_authorization_required_code(), status() |
!empty($request) && current_user_can() && !$types && post_type_supports() | 53 | current_user_can(), current_user_can(), current_user_can(), current_user_can(), get_post_types(), post_type_supports(), current_user_can() |
Across PHP versions
Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 115 instructions, 15–53 executed per call, 13 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 · 6
- 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.
- get_post_types()Gets a list of all registered post type objects.
- post_type_supports()Checks a post type's support for a given feature.
- WP_Error::__construct()Initializes the error.
Source code
public function get_items_permissions_check( $request ) { // Check if roles is specified in GET request and if user can list users. if ( ! empty( $request['roles'] ) && ! current_user_can( 'list_users' ) ) { return new WP_Error( 'rest_user_cannot_view', __( 'Sorry, you are not allowed to filter users by role.' ), array( 'status' => rest_authorization_required_code() ) ); } // Check if capabilities is specified in GET request and if user can list users. if ( ! empty( $request['capabilities'] ) && ! current_user_can( 'list_users' ) ) { return new WP_Error( 'rest_user_cannot_view', __( 'Sorry, you are not allowed to filter users by capability.' ), array( 'status' => rest_authorization_required_code() ) ); } if ( 'edit' === $request['context'] && ! current_user_can( 'list_users' ) ) { return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit users.' ), array( 'status' => rest_authorization_required_code() ) ); } if ( in_array( $request['orderby'], array( 'email', 'registered_date' ), true ) && ! current_user_can( 'list_users' ) ) { return new WP_Error( 'rest_forbidden_orderby', __( 'Sorry, you are not allowed to order users by this parameter.' ), array( 'status' => rest_authorization_required_code() ) ); } if ( 'authors' === $request['who'] ) { $types = get_post_types( array( 'show_in_rest' => true ), 'objects' ); foreach ( $types as $type ) { if ( post_type_supports( $type->name, 'author' ) && current_user_can( $type->cap->edit_posts ) ) { return true; } } return new WP_Error( 'rest_forbidden_who', __( 'Sorry, you are not allowed to query users by this parameter.' ), array( 'status' => rest_authorization_required_code() ) ); } return true; }Changelog
Introduced in 4.7.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/rest-api/endpoints/class-wp-rest-users-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.