WP_User::has_cap( string $cap, mixed $args )

Returns whether the 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->has_cap( 'edit_posts' );
$user->has_cap( 'edit_post', $post->ID );
$user->has_cap( 'edit_post_meta', $post->ID, $meta_key );

While checking against a role in place of a capability is supported in part, this practice is discouraged as it may produce unreliable results.

Parameters

$cap: (Required) Capability name.
$args: (Optional) further parameters, typically starting with an object ID.

Return

(bool) Whether the user has the given capability, or, if an object ID is passed, whether the user has the given capability for that object.

Source

File: wp-includes/class-wp-user.php

	public function has_cap( $cap ) {
		if ( is_numeric( $cap ) ) {
			_deprecated_argument( __FUNCTION__, 'WP-2.0.0', __( 'Usage of user levels is deprecated. Use capabilities instead.' ) );
			$cap = $this->translate_level_to_cap( $cap );
		}

		$args = array_slice( func_get_args(), 1 );
		$args = array_merge( array( $cap, $this->ID ), $args );
		$caps = call_user_func_array( 'map_meta_cap', $args );

		// Multisite super admin has all caps by definition, Unless specifically denied.
		if ( is_multisite() && is_super_admin( $this->ID ) ) {
			if ( in_array('do_not_allow', $caps) )
				return false;
			return true;
		}

		/**
		 * Dynamically filter a user's capabilities.
		 *
		 * @since WP-2.0.0
		 * @since WP-3.7.0 Added the user object.
		 *
		 * @param array   $allcaps An array of all the user's capabilities.
		 * @param array   $caps    Actual capabilities for meta capability.
		 * @param array   $args    Optional parameters passed to has_cap(), typically object ID.
		 * @param WP_User $user    The user object.
		 */
		$capabilities = apply_filters( 'user_has_cap', $this->allcaps, $caps, $args, $this );

		// Everyone is allowed to exist.
		$capabilities['exist'] = true;

		// Nobody is allowed to do things they are not allowed to do.
		unset( $capabilities['do_not_allow'] );

		// Must have ALL requested caps.
		foreach ( (array) $caps as $cap ) {
			if ( empty( $capabilities[ $cap ] ) )
				return false;
		}

		return true;
	}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/class-wp-user.php: WP_User::translate_level_to_cap()	Converts numeric level to level capability name.
wp-includes/class-wp-user.php: user_has_cap	Dynamically filter a user’s capabilities.
wp-includes/l10n.php: __()	Retrieves the translation of $text.
wp-includes/capabilities.php: is_super_admin()	Determines whether user is a site admin.
wp-includes/capabilities.php: map_meta_cap()	Maps a capability to the primitive capabilities required of the given user to satisfy the capability being checked.
wp-includes/plugin.php: apply_filters()	Calls the callback functions that have been added to a filter hook.
wp-includes/load.php: is_multisite()	If Multisite is enabled.
wp-includes/functions.php: _deprecated_argument()	Marks a function argument as deprecated and inform when it has been used.

Show 3 more uses Hide more uses

Changelog

Changelog
Version	Description
5.3.0	Formalized the existing and already documented `...$args` parameter by adding it to the function signature.
2.0.0	Introduced.