enmi-conf.org: comparison wp/wp-includes/class-wp-roles.php

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
 * The role option is simple, the structure is organized by role name that store
 * the name in value of the 'name' key. The capabilities are stored as an array
 * in the value of the 'capability' key.
 *
 *     array (
-*    		'rolename' => array (
+*          'rolename' => array (
-*    			'name' => 'rolename',
+*              'name' => 'rolename',
-*    			'capabilities' => array()
+*              'capabilities' => array()
-*    		)
+*          )
 *     )
 *
 * @since 2.0.0
 */
 class WP_Roles {
 	/**
 	 * List of roles and capabilities.
 	 *
 	 * @since 2.0.0
-	 * @var array
+	 * @var array[]
 	 */
 	public $roles;
 	/**
 	 * List of the role objects.
 	 *
 	 * @since 2.0.0
-	 * @var array
+	 * @var WP_Role[]
 	 */
 	public $role_objects = array();
 	/**
 	 * List of role names.
 	 *
 	 * @since 2.0.0
-	 * @var array
+	 * @var string[]
 	 */
 	public $role_names = array();
 	/**
 	 * Option name for storing role list.
 	/**
 	 * Constructor
 	 *
 	 * @since 2.0.0
-	 * @since 4.9.0 The $site_id argument was added.
+	 * @since 4.9.0 The `$site_id` argument was added.
 	 *
 	 * @global array $wp_user_roles Used to set the 'roles' property value.
 	 *
 	 * @param int $site_id Site ID to initialize roles for. Default is the current site.
 	 */
 	/**
 	 * Make private/protected methods readable for backward compatibility.
 	 *
 	 * @since 4.0.0
 	 *
-	 * @param callable $name      Method to call.
+	 * @param string   $name      Method to call.
 	 * @param array    $arguments Arguments to pass when calling.
 	 * @return mixed|false Return value of the callback, false otherwise.
 	 */
 	public function __call( $name, $arguments ) {
 		if ( '_init' === $name ) {
 	public function add_role( $role, $display_name, $capabilities = array() ) {
 		if ( empty( $role ) || isset( $this->roles[ $role ] ) ) {
 			return;
 		}
-		$this->roles[$role] = array(
+		$this->roles[ $role ] = array(
-			'name' => $display_name,
+			'name'         => $display_name,
-			'capabilities' => $capabilities
+			'capabilities' => $capabilities,
-			);
+		);
-		if ( $this->use_db )
+		if ( $this->use_db ) {
 			update_option( $this->role_key, $this->roles );
-		$this->role_objects[$role] = new WP_Role( $role, $capabilities );
+		}
-		$this->role_names[$role] = $display_name;
+		$this->role_objects[ $role ] = new WP_Role( $role, $capabilities );
-		return $this->role_objects[$role];
+		$this->role_names[ $role ]   = $display_name;
+		return $this->role_objects[ $role ];
 	}
 	/**
 	 * Remove role by name.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role Role name.
 	 */
 	public function remove_role( $role ) {
-		if ( ! isset( $this->role_objects[$role] ) )
+		if ( ! isset( $this->role_objects[ $role ] ) ) {
 			return;
+		}
-		unset( $this->role_objects[$role] );
-		unset( $this->role_names[$role] );
+		unset( $this->role_objects[ $role ] );
-		unset( $this->roles[$role] );
+		unset( $this->role_names[ $role ] );
+		unset( $this->roles[ $role ] );
-		if ( $this->use_db )
+		if ( $this->use_db ) {
 			update_option( $this->role_key, $this->roles );
+		}
-		if ( get_option( 'default_role' ) == $role )
+		if ( get_option( 'default_role' ) == $role ) {
 			update_option( 'default_role', 'subscriber' );
+		}
 	}
 	/**
 	 * Add capability to role.
 	 *
 	 * @param string $role Role name.
 	 * @param string $cap Capability name.
 	 * @param bool $grant Optional, default is true. Whether role is capable of performing capability.
 	 */
 	public function add_cap( $role, $cap, $grant = true ) {
-		if ( ! isset( $this->roles[$role] ) )
+		if ( ! isset( $this->roles[ $role ] ) ) {
 			return;
+		}
-		$this->roles[$role]['capabilities'][$cap] = $grant;
-		if ( $this->use_db )
+		$this->roles[ $role ]['capabilities'][ $cap ] = $grant;
+		if ( $this->use_db ) {
 			update_option( $this->role_key, $this->roles );
+		}
 	}
 	/**
 	 * Remove capability from role.
 	 *
 	 *
 	 * @param string $role Role name.
 	 * @param string $cap Capability name.
 	 */
 	public function remove_cap( $role, $cap ) {
-		if ( ! isset( $this->roles[$role] ) )
+		if ( ! isset( $this->roles[ $role ] ) ) {
 			return;
+		}
-		unset( $this->roles[$role]['capabilities'][$cap] );
-		if ( $this->use_db )
+		unset( $this->roles[ $role ]['capabilities'][ $cap ] );
+		if ( $this->use_db ) {
 			update_option( $this->role_key, $this->roles );
+		}
 	}
 	/**
 	 * Retrieve role object by name.
 	 *
 	 *
 	 * @param string $role Role name.
 	 * @return WP_Role|null WP_Role object if found, null if the role does not exist.
 	 */
 	public function get_role( $role ) {
-		if ( isset( $this->role_objects[$role] ) )
+		if ( isset( $this->role_objects[ $role ] ) ) {
-			return $this->role_objects[$role];
+			return $this->role_objects[ $role ];
-		else
+		} else {
 			return null;
+		}
 	}
 	/**
 	 * Retrieve list of role names.
 	 *
 	 * @since 2.0.0
 	 *
-	 * @return array List of role names.
+	 * @return string[] List of role names.
 	 */
 	public function get_names() {
 		return $this->role_names;
 	}
 	 *
 	 * @param string $role Role name to look up.
 	 * @return bool
 	 */
 	public function is_role( $role ) {
-		return isset( $this->role_names[$role] );
+		return isset( $this->role_names[ $role ] );
 	}
 	/**
 	 * Initializes all of the available roles.
 	 *
 		if ( empty( $this->roles ) ) {
 			return;
 		}
 		$this->role_objects = array();
-		$this->role_names =  array();
+		$this->role_names   = array();
 		foreach ( array_keys( $this->roles ) as $role ) {
 			$this->role_objects[ $role ] = new WP_Role( $role, $this->roles[ $role ]['capabilities'] );
-			$this->role_names[ $role ] = $this->roles[ $role ]['name'];
+			$this->role_names[ $role ]   = $this->roles[ $role ]['name'];
 		}
 		/**
 		 * After the roles have been initialized, allow plugins to add their own roles.
 		 *

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4