On this page
user_can( int|WP_User $user, string $capability, mixed $args ): bool
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 Required-
User ID or object.
$capabilitystring Required-
Capability name.
$argsmixed Optional-
further parameters, typically starting with an object ID.
Return
bool Whether the user has the given capability.
Source
File: wp-includes/capabilities.php. View all references
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 );
}
Related
Uses
| Uses | Description |
|---|---|
| WP_User::__construct() wp-includes/class-wp-user.php | Constructor. |
| get_userdata() wp-includes/pluggable.php | Retrieves user info by user ID. |
Used By
| Used By | Description |
|---|---|
| WP_REST_Application_Passwords_Controller::get_user() wp-includes/rest-api/endpoints/class-wp-rest-application-passwords-controller.php | Gets the requested user. |
| wp_initialize_site() wp-includes/ms-site.php | Runs the initialization routine for a given site. |
| current_user_can() wp-includes/capabilities.php | Returns whether the current user has the specified capability. |
| map_meta_cap() wp-includes/capabilities.php | Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked. |
| wp_notify_postauthor() wp-includes/pluggable.php | Notifies an author (and/or others) of a comment/trackback/pingback on a post. |
| wp_notify_moderator() wp-includes/pluggable.php | Notifies the moderator of the site about a new comment that is awaiting approval. |
| get_allowed_mime_types() wp-includes/functions.php | Retrieves the list of allowed mime types and file extensions. |
| get_dashboard_url() wp-includes/link-template.php | Retrieves the URL to the user’s dashboard. |
| wp_update_comment() wp-includes/comment.php | Updates an existing comment in the database. |
Changelog
© 2003–2022 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/functions/user_can