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.
1010functionuser_can($user,$capability,...$args){1011if(!is_object($user)){1012$user=get_userdata($user);1013}10141015if(empty($user)){1016// User is logged out, create anonymous user object.1017$user=newWP_User(0);1018$user->init(newstdClass());1019}10201021return$user->has_cap($capability,...$args);1022}
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 docblock
3.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.