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

equal deleted inserted replaced

-:7b1b88e27a20
+:48c4eec2b7e6
 *          )
 *     )
 *
 * @since 2.0.0
 */
+#[AllowDynamicProperties]
 class WP_Roles {
 	/**
 	 * List of roles and capabilities.
 	 *
 	 * @since 2.0.0
 	 * @var int
 	 */
 	protected $site_id = 0;
 	/**
-	 * Constructor
+	 * Constructor.
 	 *
 	 * @since 2.0.0
 	 * @since 4.9.0 The `$site_id` argument was added.
 	 *
 	 * @global array $wp_user_roles Used to set the 'roles' property value.
 		$this->for_site( $site_id );
 	}
 	/**
-	 * Make private/protected methods readable for backward compatibility.
+	 * Makes private/protected methods readable for backward compatibility.
 	 *
 	 * @since 4.0.0
 	 *
 	 * @param string $name      Method to call.
 	 * @param array  $arguments Arguments to pass when calling.
 		}
 		return false;
 	}
 	/**
-	 * Set up the object properties.
+	 * Sets up the object properties.
 	 *
 	 * The role key is set to the current prefix for the $wpdb object with
 	 * 'user_roles' appended. If the $wp_user_roles global is set, then it will
 	 * be used and the role option will not be updated or used.
 	 *
 		$this->for_site();
 	}
 	/**
-	 * Reinitialize the object
+	 * Reinitializes the object.
 	 *
 	 * Recreates the role objects. This is typically called only by switch_to_blog()
 	 * after switching wpdb to a new site ID.
 	 *
 	 * @since 3.5.0
 		$this->for_site();
 	}
 	/**
-	 * Add role name with capabilities to list.
+	 * Adds a role name with capabilities to the list.
 	 *
 	 * Updates the list of roles, if the role doesn't already exist.
 	 *
-	 * The capabilities are defined in the following format `array( 'read' => true );`
+	 * The capabilities are defined in the following format: `array( 'read' => true )`.
-	 * To explicitly deny a role a capability you set the value for that capability to false.
+	 * To explicitly deny the role a capability, set the value for that capability to false.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role         Role name.
 	 * @param string $display_name Role display name.
-	 * @param bool[] $capabilities List of capabilities keyed by the capability name,
+	 * @param bool[] $capabilities Optional. List of capabilities keyed by the capability name,
-	 *                             e.g. array( 'edit_posts' => true, 'delete_posts' => false ).
+	 *                             e.g. `array( 'edit_posts' => true, 'delete_posts' => false )`.
-	 * @return WP_Role|void WP_Role object, if role is added.
+	 *                             Default empty array.
+	 * @return WP_Role|void WP_Role object, if the role is added.
 	 */
 	public function add_role( $role, $display_name, $capabilities = array() ) {
 		if ( empty( $role ) || isset( $this->roles[ $role ] ) ) {
 			return;
 		}
 		$this->role_names[ $role ]   = $display_name;
 		return $this->role_objects[ $role ];
 	}
 	/**
-	 * Remove role by name.
+	 * Removes a role by name.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role Role name.
 	 */
 		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.
+	 * Adds a capability to role.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role  Role name.
 	 * @param string $cap   Capability name.
 			update_option( $this->role_key, $this->roles );
 		}
 	}
 	/**
-	 * Remove capability from role.
+	 * Removes a capability from role.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role Role name.
 	 * @param string $cap  Capability name.
 			update_option( $this->role_key, $this->roles );
 		}
 	}
 	/**
-	 * Retrieve role object by name.
+	 * Retrieves a role object by name.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role Role name.
 	 * @return WP_Role|null WP_Role object if found, null if the role does not exist.
 			return null;
 		}
 	}
 	/**
-	 * Retrieve list of role names.
+	 * Retrieves a list of role names.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @return string[] List of role names.
 	 */
 	public function get_names() {
 		return $this->role_names;
 	}
 	/**
-	 * Whether role name is currently in the list of available roles.
+	 * Determines whether a role name is currently in the list of available roles.
 	 *
 	 * @since 2.0.0
 	 *
 	 * @param string $role Role name to look up.
 	 * @return bool
 			$this->role_objects[ $role ] = new WP_Role( $role, $this->roles[ $role ]['capabilities'] );
 			$this->role_names[ $role ]   = $this->roles[ $role ]['name'];
 		}
 		/**
-		 * After the roles have been initialized, allow plugins to add their own roles.
+		 * Fires after the roles have been initialized, allowing plugins to add their own roles.
 		 *
 		 * @since 4.7.0
 		 *
 		 * @param WP_Roles $wp_roles A reference to the WP_Roles object.
 		 */
 		if ( ! empty( $wp_user_roles ) ) {
 			return $wp_user_roles;
 		}
-		if ( is_multisite() && get_current_blog_id() != $this->site_id ) {
+		if ( is_multisite() && get_current_blog_id() !== $this->site_id ) {
 			remove_action( 'switch_blog', 'wp_switch_roles_and_user', 1 );
 			$roles = get_blog_option( $this->site_id, $this->role_key, array() );
 			add_action( 'switch_blog', 'wp_switch_roles_and_user', 1, 2 );

changeset 21	48c4eec2b7e6
parent 19	3d72ae0968f4
child 22	8c2e4d02f4ef