WP_Roles::remove_role() │ public │ WP 2.0.0

Removes a role by name.

Method of the class: WP_Roles{}

No Hooks.

Return

null. Nothing (null).

Usage

global $wp_roles;
$wp_roles->remove_role( $role );
$role(string) (required)
Role name.

Changelog

Since 2.0.0 Introduced.

WP_Roles::remove_role() code WP 6.5.2

wp-includes/class-wp-roles.php 
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' );
	}
}