Changeset 32541

Timestamp:

05/22/2015 04:46:36 AM (10 years ago)

Author:

wonderboymusic

Message:

Create a function, wp_roles(), to DRY the inline instantiation of the $wp_roles global.

Add missing doc blocks for capabilities.php.

See #32444.

Location:

trunk/src/wp-includes

Files:

• capabilities.php (modified) (19 diffs)
• user.php (modified) (2 diffs)

trunk/src/wp-includes/capabilities.php

@@ -139 +139 @@
      * @since 3.5.0
      * @access public
+     *
+     * @global wpdb $wpdb
      */
     public function reinit() {
@@ -340 +342 @@
      * Assign role a capability.
      *
-     * @see WP_Roles::add_cap() Method uses implementation for role.
      * @since 2.0.0
      * @access public
@@ -348 +349 @@
      */
     public function add_cap( $cap, $grant = true ) {
-        global $wp_roles;
-
-        if ( ! isset( $wp_roles ) )
-            $wp_roles = new WP_Roles();
-
         $this->capabilities[$cap] = $grant;
-        $wp_roles->add_cap( $this->name, $cap, $grant );
+        wp_roles()->add_cap( $this->name, $cap, $grant );
     }
 
@@ -371 +367 @@
      */
     public function remove_cap( $cap ) {
-        global $wp_roles;
-
-        if ( ! isset( $wp_roles ) )
-            $wp_roles = new WP_Roles();
-
         unset( $this->capabilities[$cap] );
-        $wp_roles->remove_cap( $this->name, $cap );
+        wp_roles()->remove_cap( $this->name, $cap );
     }
 
@@ -509 +500 @@
      * @access public
      *
+     * @global wpdb $wpdb
+     *
      * @param int|string|stdClass|WP_User $id User's ID, a WP_User object, or a user object from the DB.
      * @param string $name Optional. User's username
@@ -569 +562 @@
      *
      * @since 3.3.0
+     *
+     * @global wpdb $wpdb
      *
      * @param string $field The field to query against: 'id', 'slug', 'email' or 'login'
@@ -756 +751 @@
      * @since 2.1.0
      *
+     * @global wpdb $wpdb
+     *
      * @param string $cap_key Optional capability key
      */
@@ -783 +780 @@
      *
      * @since 2.0.0
-     * @uses $wp_roles
      * @access public
      *
@@ -789 +785 @@
      */
     public function get_role_caps() {
-        global $wp_roles;
-
-        if ( ! isset( $wp_roles ) )
-            $wp_roles = new WP_Roles();
+        $wp_roles = wp_roles();
 
         //Filter out caps that are not role names and assign to $this->roles
@@ -923 +916 @@
      * @since 2.0.0
      * @access public
+     *
+     * @global wpdb $wpdb
      */
     public function update_user_level_from_caps() {
@@ -969 +964 @@
      * @since 2.1.0
      * @access public
+     *
+     * @global wpdb $wpdb
      */
     public function remove_all_caps() {
@@ -1049 +1046 @@
      *
      * @since 3.0.0
+     *
+     * @global wpdb $wpdb
      *
      * @param int $blog_id Optional Blog ID, defaults to current blog.
@@ -1476 +1475 @@
 
 /**
+ * Retrieve the global WP_Roles instance, instantiate if necessary
+ *
+ * @global WP_Roles $wp_roles
+ * @return WP_Roles global instance
+ */
+function wp_roles() {
+    global $wp_roles;
+
+    if ( ! isset( $wp_roles ) ) {
+        $wp_roles = new WP_Roles();
+    }
+    return $wp_roles;
+}
+
+/**
  * Retrieve role object.
  *
- * @see WP_Roles::get_role() Uses method to retrieve role object.
  * @since 2.0.0
  *
@@ -1485 +1498 @@
  */
 function get_role( $role ) {
-    global $wp_roles;
-
-    if ( ! isset( $wp_roles ) )
-        $wp_roles = new WP_Roles();
-
-    return $wp_roles->get_role( $role );
+    return wp_roles()->get_role( $role );
 }
 
@@ -1496 +1504 @@
  * Add role, if it does not exist.
  *
- * @see WP_Roles::add_role() Uses method to add role.
  * @since 2.0.0
  *
@@ -1505 +1512 @@
  */
 function add_role( $role, $display_name, $capabilities = array() ) {
-    global $wp_roles;
-
-    if ( ! isset( $wp_roles ) )
-        $wp_roles = new WP_Roles();
-
-    return $wp_roles->add_role( $role, $display_name, $capabilities );
+    return wp_roles()->add_role( $role, $display_name, $capabilities );
 }
 
@@ -1516 +1518 @@
  * Remove role, if it exists.
  *
- * @see WP_Roles::remove_role() Uses method to remove role.
  * @since 2.0.0
  *
@@ -1522 +1523 @@
  */
 function remove_role( $role ) {
-    global $wp_roles;
-
-    if ( ! isset( $wp_roles ) )
-        $wp_roles = new WP_Roles();
-
-    $wp_roles->remove_role( $role );
+    wp_roles()->remove_role( $role );
 }
 
@@ -1535 +1531 @@
  * @since 3.0.0
  *
- * @uses $super_admins Super admins global variable, if set.
+ * @global array $super_admins
  *
  * @return array List of super admin logins

trunk/src/wp-includes/user.php

@@ -1335 +1335 @@
  */
 function count_users($strategy = 'time') {
-    global $wpdb, $wp_roles;
+    global $wpdb;
 
     // Initialize
@@ -1343 +1343 @@
 
     if ( 'time' == $strategy ) {
-        global $wp_roles;
-
-        if ( ! isset( $wp_roles ) )
-            $wp_roles = new WP_Roles();
-
-        $avail_roles = $wp_roles->get_names();
+        $avail_roles = wp_roles()->get_names();
 
         // Build a CPU-intensive query that will return concise information.