user_can

Advertisement

Summery Summery

Whether a particular user has a specific capability.

Syntax Syntax

user_can( int|WP_User $user, string $capability )

Parameters Parameters

$user

(int|WP_User) (Required) User ID or object.

$capability

(string) (Required) Capability name.

Return Return

(bool) Whether the user has the given capability.

Source Source

File: wp-includes/capabilities.php

/**
 * Returns whether the author of the supplied post has the specified capability.
 *
 * 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:
 *
 *     author_can( $post, 'edit_posts' );
 *     author_can( $post, 'edit_post', $post->ID );
 *     author_can( $post, 'edit_post_meta', $post->ID, $meta_key );
 *
 * @since 2.9.0

Advertisement

Changelog Changelog

Changelog
Version Description
3.1.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.