user_can( int|WP_User $user, string $capability, mixed $args ): bool
- Since
- 3.1.0, 5.3.0
- Source
wp-includes/capabilities.php:1010
Returns whether a particular user has the specified capability.
Description
This function also accepts an ID of an object to check against if the capability is a meta capability. Meta capabilities such as
edit_post and edit_user are capabilities used by the map_meta_cap() function to map to primitive capabilities that a user or role has, such as edit_posts and edit_others_posts. Example usage: user_can( $user->ID, 'edit_posts' );
user_can( $user->ID, 'edit_post', $post->ID );
user_can( $user->ID, 'edit_post_meta', $post->ID, $meta_key );Parameters
$userint|WP_User- User ID or object.
$capabilitystring- Capability name.
$argsmixed- Optional further parameters, typically starting with an object ID.
Return
bool- Whether the user has the given capability.
Uses · 3
- get_userdata()Retrieves user info by user ID.
- WP_User::__construct()Constructor.
- stdClass::__construct()
Used by · 11
- WP_REST_Application_Passwords_Controller::get_user()Gets the requested user.
- current_user_can()Returns whether the current user has the specified capability.
- get_allowed_mime_types()Retrieves the list of allowed mime types and file extensions.
- get_dashboard_url()Retrieves the URL to the user's dashboard.
- map_meta_cap()Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.
- user_can_for_site()Returns whether a particular user has the specified capability for a given site.
- wp_initialize_site()Runs the initialization routine for a given site.
- wp_notify_moderator()Notifies the moderator of the site about a new comment that is awaiting approval.
- wp_notify_note_mentions()Notifies mentioned users about a new note.
- wp_notify_postauthor()Notifies an author (and/or others) of a comment/trackback/pingback on a post.
- wp_update_comment()Updates an existing comment in the database.
Source
function user_can( $user, $capability, ...$args ) { if ( ! is_object( $user ) ) { $user = get_userdata( $user ); } if ( empty( $user ) ) { // User is logged out, create anonymous user object. $user = new WP_User( 0 ); $user->init( new stdClass() ); } return $user->has_cap( $capability, ...$args );}History
Introduced in 3.1.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
5.3.0
Formalized the existing and already documented
...$args parameter by adding it to the function signature.from the docblock3.1.0
Introduced.from the docblock
About this page
- Parsed data
- Generated from the wordpress-develop 7.1.0 tag, from
src/wp-includes/capabilities.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.