W3cubDocs

/WordPress

WP_Roles::remove_role( string $role )

Removes a role by name.

Parameters

$rolestringrequired
Role name.

Source

public function remove_role( $role ) {
	if ( ! isset( $this->role_objects[ $role ] ) ) {
		return;
	}

	unset( $this->role_objects[ $role ] );
	unset( $this->role_names[ $role ] );
	unset( $this->roles[ $role ] );

	if ( $this->use_db ) {
		update_option( $this->role_key, $this->roles );
	}

	if ( get_option( 'default_role' ) === $role ) {
		update_option( 'default_role', 'subscriber' );
	}
}

Changelog

Version Description
2.0.0 Introduced.

© 2003–2024 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_roles/remove_role