[ Index ]

PHP Cross Reference of WordPress

title

Body

[close]

/wp-includes/ -> capabilities.php (summary)

Core User Role & Capabilities API

File Size: 1090 lines (36 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 16 functions

  map_meta_cap()
  current_user_can()
  current_user_can_for_blog()
  author_can()
  user_can()
  wp_roles()
  get_role()
  add_role()
  remove_role()
  get_super_admins()
  is_super_admin()
  grant_super_admin()
  revoke_super_admin()
  wp_maybe_grant_install_languages_cap()
  wp_maybe_grant_resume_extensions_caps()
  wp_maybe_grant_site_health_caps()

Functions
Functions that are not part of a class:

map_meta_cap( $cap, $user_id, ...$args )   X-Ref
Maps a capability to the primitive capabilities required of the given user to
satisfy the capability being checked.

This function also accepts an ID of an object to map against if the capability is a meta capability. Meta
capabilities such as `edit_post` and `edit_user` are capabilities used by this function to map to primitive
capabilities that a user or role requires, such as `edit_posts` and `edit_others_posts`.

Example usage:

map_meta_cap( 'edit_posts', $user->ID );
map_meta_cap( 'edit_post', $user->ID, $post->ID );
map_meta_cap( 'edit_post_meta', $user->ID, $post->ID, $meta_key );

This function does not check whether the user has the required capabilities,
it just returns what the required capabilities are.

param: string $cap     Capability being checked.
param: int    $user_id User ID.
param: mixed  ...$args Optional further parameters, typically starting with an object ID.
return: string[] Primitive capabilities required of the user.
since: 2.0.0
since: 4.9.6 Added the `export_others_personal_data`, `erase_others_personal_data`,
since: 5.1.0 Added the `update_php` capability.
since: 5.2.0 Added the `resume_plugin` and `resume_theme` capabilities.
since: 5.3.0 Formalized the existing and already documented `...$args` parameter
since: 5.7.0 Added the `create_app_password`, `list_app_passwords`, `read_app_password`,

current_user_can( $capability, ...$args )   X-Ref
Returns whether the current user 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:

current_user_can( 'edit_posts' );
current_user_can( 'edit_post', $post->ID );
current_user_can( 'edit_post_meta', $post->ID, $meta_key );

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

Note: Will always return true if the current user is a super admin, unless specifically denied.

param: string $capability Capability name.
param: mixed  ...$args    Optional further parameters, typically starting with an object ID.
return: bool Whether the current user has the given capability. If `$capability` is a meta cap and `$object_id` is
since: 2.0.0
since: 5.3.0 Formalized the existing and already documented `...$args` parameter
since: 5.8.0 Converted to wrapper for the user_can() function.

current_user_can_for_blog( $blog_id, $capability, ...$args )   X-Ref
Returns whether the current user has the specified capability for a given site.

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:

current_user_can_for_blog( $blog_id, 'edit_posts' );
current_user_can_for_blog( $blog_id, 'edit_post', $post->ID );
current_user_can_for_blog( $blog_id, 'edit_post_meta', $post->ID, $meta_key );

param: int    $blog_id    Site ID.
param: string $capability Capability name.
param: mixed  ...$args    Optional further parameters, typically starting with an object ID.
return: bool Whether the user has the given capability.
since: 3.0.0
since: 5.3.0 Formalized the existing and already documented `...$args` parameter
since: 5.8.0 Wraps current_user_can() after switching to blog.

author_can( $post, $capability, ...$args )   X-Ref
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 );

param: int|WP_Post $post       Post ID or post object.
param: string      $capability Capability name.
param: mixed       ...$args    Optional further parameters, typically starting with an object ID.
return: bool Whether the post author has the given capability.
since: 2.9.0
since: 5.3.0 Formalized the existing and already documented `...$args` parameter

user_can( $user, $capability, ...$args )   X-Ref
Returns whether a particular user 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:

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 );

param: int|WP_User $user       User ID or object.
param: string      $capability Capability name.
param: mixed       ...$args    Optional further parameters, typically starting with an object ID.
return: bool Whether the user has the given capability.
since: 3.1.0
since: 5.3.0 Formalized the existing and already documented `...$args` parameter

wp_roles()   X-Ref
Retrieves the global WP_Roles instance and instantiates it if necessary.

return: WP_Roles WP_Roles global instance if not already instantiated.
since: 4.3.0

get_role( $role )   X-Ref
Retrieve role object.

param: string $role Role name.
return: WP_Role|null WP_Role object if found, null if the role does not exist.
since: 2.0.0

add_role( $role, $display_name, $capabilities = array()   X-Ref
Add role, if it does not exist.

param: string $role         Role name.
param: string $display_name Display name for role.
param: bool[] $capabilities List of capabilities keyed by the capability name,
return: WP_Role|null WP_Role object if role is added, null if already exists.
since: 2.0.0

remove_role( $role )   X-Ref
Remove role, if it exists.

param: string $role Role name.
since: 2.0.0

get_super_admins()   X-Ref
Retrieve a list of super admins.

return: string[] List of super admin logins.
since: 3.0.0

is_super_admin( $user_id = false )   X-Ref
Determine if user is a site admin.

param: int|false $user_id Optional. The ID of a user. Defaults to false, to check the current user.
return: bool Whether the user is a site admin.
since: 3.0.0

grant_super_admin( $user_id )   X-Ref
Grants Super Admin privileges.

param: int $user_id ID of the user to be granted Super Admin privileges.
return: bool True on success, false on failure. This can fail when the user is
since: 3.0.0

revoke_super_admin( $user_id )   X-Ref
Revokes Super Admin privileges.

param: int $user_id ID of the user Super Admin privileges to be revoked from.
return: bool True on success, false on failure. This can fail when the user's email
since: 3.0.0

wp_maybe_grant_install_languages_cap( $allcaps )   X-Ref
Filters the user capabilities to grant the 'install_languages' capability as necessary.

A user must have at least one out of the 'update_core', 'install_plugins', and
'install_themes' capabilities to qualify for 'install_languages'.

param: bool[] $allcaps An array of all the user's capabilities.
return: bool[] Filtered array of the user's capabilities.
since: 4.9.0

wp_maybe_grant_resume_extensions_caps( $allcaps )   X-Ref
Filters the user capabilities to grant the 'resume_plugins' and 'resume_themes' capabilities as necessary.

param: bool[] $allcaps An array of all the user's capabilities.
return: bool[] Filtered array of the user's capabilities.
since: 5.2.0

wp_maybe_grant_site_health_caps( $allcaps, $caps, $args, $user )   X-Ref
Filters the user capabilities to grant the 'view_site_health_checks' capabilities as necessary.

param: bool[]   $allcaps An array of all the user's capabilities.
param: string[] $caps    Required primitive capabilities for the requested capability.
param: array    $args {
param: WP_User  $user    The user object.
return: bool[] Filtered array of the user's capabilities.
since: 5.2.2



Generated: Sat Mar 6 01:00:04 2021 Cross-referenced by PHPXref 0.7.1