Skip to content

Use update_role method for display name only #3432

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
carlomanf wants to merge 5 commits into from
Closed

Use update_role method for display name only #3432

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
7717b13
Update class-wp-roles.php
carlomanf Oct 11, 2022
4fad93b
Update capabilities.php
carlomanf Oct 11, 2022
16708a8
Update capabilities.php
carlomanf Oct 11, 2022
85ed0bd
Update capabilities.php
carlomanf Oct 11, 2022
86f8d1d
Update class-wp-roles.php
carlomanf Oct 11, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 0 additions & 24 deletions src/wp-includes/capabilities.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1030,30 +1030,6 @@ function add_role( $role, $display_name, $capabilities = array() ) {
return wp_roles()->add_role( $role, $display_name, $capabilities );
}

/**
* Updates an existing role. Creates a new role if it doesn't exist.
*
* Modifies the display name and/or capabilities for an existing role.
* If the role does not exist then a new role is created.
*
* The capabilities are defined in the following format: `array( 'read' => true )`.
* To explicitly deny the role a capability, set the value for that capability to false.
*
* @since 6.1.0
*
* @param string $role Role name.
* @param string|null $display_name Optional. Role display name. If null, the display name
* is not modified. Default null.
* @param bool[]|null $capabilities Optional. List of capabilities keyed by the capability name,
* e.g. `array( 'edit_posts' => true, 'delete_posts' => false )`.
* If null, don't alter capabilities for the existing role and make
* empty capabilities for the new one. Default null.
* @return WP_Role|void WP_Role object, if the role is updated.
*/
function update_role( $role, $display_name = null, $capabilities = null ) {
return wp_roles()->update_role( $role, $display_name, $capabilities );
}

/**
* Removes a role, if it exists.
*
Expand Down
68 changes: 10 additions & 58 deletions src/wp-includes/class-wp-roles.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -173,73 +173,25 @@ public function add_role( $role, $display_name, $capabilities = array() ) {
}

/**
* Updates an existing role. Creates a new role if it doesn't exist.
* Updates an existing role name.
*
* Modifies the display name and/or capabilities for an existing role.
* If the role does not exist then a new role is created.
*
* The capabilities are defined in the following format: `array( 'read' => true )`.
* To explicitly deny the role a capability, set the value for that capability to false.
* Only modifies the display name for an existing role.
* Use WP_Roles::add_cap() and WP_Roles::remove_cap() to modify the capabilities for an existing role.
*
* @since 6.1.0
*
* @param string $role Role name.
* @param string|null $display_name Optional. Role display name. If null, the display name
* is not modified. Default null.
* @param bool[]|null $capabilities Optional. List of capabilities keyed by the capability name,
* e.g. `array( 'edit_posts' => true, 'delete_posts' => false )`.
* If null, don't alter capabilities for the existing role and make
* empty capabilities for the new one. Default null.
* @return WP_Role|void WP_Role object, if the role is updated.
* @param string $role Role name.
* @param string $display_name Role display name.
*/
public function update_role( $role, $display_name = null, $capabilities = null ) {
if ( ! is_string( $role ) || '' === trim( $role ) ) {
return;
}

if ( null !== $display_name && ( ! is_string( $display_name ) || '' === trim( $display_name ) ) ) {
return;
}

if ( null !== $capabilities && ! is_array( $capabilities ) ) {
public function update_role( $role, $display_name ) {
if ( ! is_string( $role ) || ! isset( $this->roles[ $role ] ) || ! is_string( $display_name ) ) {
return;
}

if ( null === $display_name && null === $capabilities ) {
if ( isset( $this->role_objects[ $role ] ) ) {
return $this->role_objects[ $role ];
}
return;
}

if ( null === $display_name ) {
if ( ! isset( $this->role_objects[ $role ] ) ) {
return;
}

$display_name = $this->roles[ $role ]['name'];
}

if ( null === $capabilities ) {
if ( isset( $this->role_objects[ $role ] ) ) {
$capabilities = $this->role_objects[ $role ]->capabilities;
} else {
$capabilities = array();
}
}

if ( isset( $this->roles[ $role ] ) ) {
if ( null === $capabilities ) {
$capabilities = $this->role_objects[ $role ]->capabilities;
}

unset( $this->role_objects[ $role ] );
unset( $this->role_names[ $role ] );
unset( $this->roles[ $role ] );
$this->roles[ $role ]['name'] = $display_name;
if ( $this->use_db ) {
update_option( $this->role_key, $this->roles );
}

// The roles database option will be updated in ::add_role().
return $this->add_role( $role, $display_name, $capabilities );
}

/**
Expand Down
Loading