automattic/jetpack-roles

Utilities, related with user roles and capabilities.

Maintainers

Details

github.com/Automattic/jetpack-roles

Source

Installs: 428 322

Dependents: 4

Suggesters: 0

Security: 0

Stars: 1

Watchers: 3

Forks: 1

Type:jetpack-library

v1.4.13 2022-01-04 21:11 UTC

Requires (Dev)

GPL-2.0-or-later 5d0a94f52de1e44a4537bc736af940f6b178c107

This package is auto-updated.

Last update: 2022-01-18 20:48:14 UTC

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( 'contact@yourjetpack.blog' );
$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' );