wp_roles = $wp_roles; } private function __clone() { } /** * Get the instance of the RoleManager * * @return RoleManager */ public static function getInstance(): RoleManager { if (self::$instance === null) { self::$instance = new self(); } return self::$instance; } private function store_roles(): void { update_option($this->wp_roles->role_key, $this->wp_roles->roles); } /** * Check if a role is a default role * * @param string $slug * @return boolean */ public function is_default_role(string $slug): bool { /** @var ?(string|int)[] */ static $defaults; if ($defaults === null) { $config_defaults = config('default_capabilities', []); $defaults = is_array($config_defaults) ? array_keys($config_defaults) : []; } return in_array($slug, $defaults); } /** * Capability is default for role * * @param string $role * @param string $cap * @return boolean */ public function is_default_default_capabilitiy_for_role(string $role, string $cap) { $role_capabilities = config('default_capabilities.'. $role); if (!is_array($role_capabilities)) { return false; } return in_array($cap, $role_capabilities); } /** * Validate role slug * * @param mixed $slug The slug to validate * @return string|null The validated slug or null if invalid */ public function validate_role_slug(mixed $slug): ?string { if (!is_string($slug)) { return null; } $slug = sanitize_key($slug); return strlen($slug) > 2 ? $slug : null; } /** * Validate role name * * @param mixed $name * @return string|null */ public function validate_role_name(mixed $name): ?string { if (! is_string($name)) { return null; } $name = sanitize_text_field($name); return strlen($name) > 2 ? $name : null; } /** * Validate capability * * @param mixed $cap * @return string|null */ public function validate_capability(mixed $cap): ?string { return $this->validate_role_slug($cap); } /** * Get the current roles * * @return array}> */ public function current_roles(): array { /** @var array}> */ return $this->wp_roles->roles; } /** * Check if a role exists * * @param string $role * @return boolean */ public function role_exists(string $role): bool { return isset($this->current_roles()[$role]); } /** * Add a new role * * @param string $role * @param string $display_name * @param array $capabilities * @return void */ public function add_role(string $role, string $display_name, array $capabilities = []): void { add_role($role, $display_name, $capabilities); } /** * Add an array of roles to a user * * @param integer $user_id * @param string[] $role * @return void */ public function add_user_roles(int $user_id, array $role): void { $user = new \WP_User($user_id); foreach ($role as $r) { $user->add_role($r); } } /** * Update a role * * @param string $old_role_slug * @param string $display_name * @param string $slug * @return void */ public function update_role(string $old_role_slug, string $display_name, string $slug): void { if (! isset($this->wp_roles->roles[$old_role_slug])) { throw new \Exception('Role does not exist'); } if ($old_role_slug !== $slug && isset($this->wp_roles->roles[$slug])) { throw new \Exception('Role already exists'); } $this->wp_roles->roles[$old_role_slug]['name'] = $display_name; $this->wp_roles->role_names[$old_role_slug] = $display_name; if ($old_role_slug !== $slug) { // Query users before renaming — WP_User_Query and WP_User::is_role() // both rely on role_names being in sync, so the query must run while // the old slug still exists in all three WP_Roles properties. /** @var \WP_User_Query */ $query = new \WP_User_Query([ 'role' => $old_role_slug, ]); /** @var \WP_User[] */ $users = $query->get_results(); // Rename in all three WP_Roles properties so is_role() stays consistent $this->wp_roles->roles[$slug] = $this->wp_roles->roles[$old_role_slug]; $this->wp_roles->role_names[$slug] = $display_name; /** @var array $role_caps */ $role_caps = $this->wp_roles->roles[$slug]['capabilities'] ?? []; $this->wp_roles->role_objects[$slug] = new \WP_Role($slug, $role_caps); unset( $this->wp_roles->roles[$old_role_slug], $this->wp_roles->role_names[$old_role_slug], $this->wp_roles->role_objects[$old_role_slug] ); foreach ($users as $user) { $user->remove_role($old_role_slug); $user->add_role($slug); } } $this->store_roles(); } /** * Update roles and capabilities *@ param string $role< * @param array $updated_roles_caps * @return void */ public function update_role_capabilities(string $role, array $updated_roles_caps): void { if (!$this->role_exists($role)) { throw new \Exception('Role not found'); } $this->wp_roles->roles[$role]['capabilities'] = $updated_roles_caps; $this->store_roles(); } /** * Remove a role * - When removing a role from the system we also remove it from all users * * @param string $role * @return void */ public function remove_role(string $role): void { remove_role($role); // Clean up users with this role /** @var \WP_User_Query */ $query = new \WP_User_Query([ 'role' => $role, ]); /** @var \WP_User[] */ $users = $query->get_results(); foreach ($users as $user) { $user->remove_role($role); if (empty($user->roles)) { /** @var string */ $default_role = get_option('default_role', 'subscriber'); $user->add_role($default_role); } } } /** * Role has capability * * @param string $role * @param string $cap * @return boolean */ public function role_has_cap(string $role, string $cap): bool { return isset($this->current_roles()[$role]['capabilities'][$cap]); } /** * Get all capabilities * * @return string[] */ public function all_capabilities() { // Acumulate all capabilities $capabilities = []; // All current capabilities from roles foreach ($this->current_roles() as $role) { $capabilities = array_merge($capabilities, array_keys($role['capabilities'])); } /** @var array */ $default_capabilities = config('default_capabilities', []); foreach ($default_capabilities as $caps) { $capabilities = array_merge($capabilities, $caps); } /** @var array */ $args = config('post_type_query', [ 'show_ui' => true ]); /** @var \WP_Post_Type[] */ $post_types = get_post_types($args, 'objects'); foreach ($post_types as $post_type) { $capabilities = array_merge($capabilities, array_keys((array) $post_type->cap)); } return array_unique($capabilities); } /** * Add array of roles to a user * * @param int $user_id * @param string[] $roles * @return void */ public function add_roles_to_user(int $user_id, array $roles) { $user = get_user_by('id', $user_id); if (! $user) { return; } $user_roles = $user->roles; $primary_role = array_shift($user_roles); if (!is_string($primary_role)) { throw new \Exception('Primary role is not a string'); } $user->set_role($primary_role); foreach ($roles as $role) { $user->add_role($role); } } }