automattic/jetpack-roles

Utilities, related with user roles and capabilities.

v3.0.1 2024-11-25 16:33 UTC

Requires

• php: >=7.2

Requires (Dev)

• automattic/jetpack-changelogger: ^5.1.0
• brain/monkey: ^2.6.2
• yoast/phpunit-polyfills: ^1.1.1

Suggests

• automattic/jetpack-autoloader: Allow for better interoperability with other plugins that use this package.

GPL-2.0-or-later

README

A user roles class for Jetpack.

Contains utilities for translating user roles to capabilities and vice versa.

Usage

Get the role of the current user:

use Automattic\Jetpack\Roles;

$roles = new Roles();
$current_user_role = $roles->translate_current_user_to_role();

Get the role of a particular user:

use Automattic\Jetpack\Roles;

$roles = new Roles();
$user  = get_user_by( '[e-mail]' );
$user_role = $roles->translate_user_to_role( $user );

Get the capability we require for a role:

use Automattic\Jetpack\Roles;

$roles = new Roles();
$capability = $roles->translate_role_to_cap( 'administrator' );

Using this package in your WordPress plugin

If you plan on using this package in your WordPress plugin, we would recommend that you use Jetpack Autoloader as your autoloader. This will allow for maximum interoperability with other plugins that use this package as well.

Security

Need to report a security vulnerability? Go to https://automattic.com/security/ or directly to our security bug bounty site https://hackerone.com/automattic.

License

jetpack-roles is licensed under GNU General Public License v2 (or later)