Changeset 54119

Timestamp:

09/11/2022 01:11:33 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Correct @global tags in WP_User_Query::prepare_query().

• $blog_id global was replaced with get_current_blog_id() and is no longer used directly.
• $wp_roles global usage was previously undocumented.

Follow-up to [32637], [38457], [51943].

Props shoaibkarimali.
Fixes #56543.

File:

• trunk/src/wp-includes/class-wp-user-query.php (modified) (3 diffs)

trunk/src/wp-includes/class-wp-user-query.php

@@ -141 +141 @@
          * @since 5.9.0 Added 'capability', 'capability__in', and 'capability__not_in' parameters.
          *
-         * @global wpdb $wpdb WordPress database abstraction object.
-         * @global int  $blog_id
+         * @global wpdb     $wpdb     WordPress database abstraction object.
+         * @global WP_Roles $wp_roles WordPress role management object.
          *
          * @param string|array $query {
@@ -257 +257 @@
          */
         public function prepare_query( $query = array() ) {
-                global $wpdb;
+                global $wpdb, $wp_roles;
 
                 if ( empty( $this->query_vars ) || ! empty( $query ) ) {
@@ -449 +449 @@
 
                 if ( ! empty( $qv['capability'] ) || ! empty( $qv['capability__in'] ) || ! empty( $qv['capability__not_in'] ) ) {
-                        global $wp_roles;
-
                         $wp_roles->for_site( $blog_id );
                         $available_roles = $wp_roles->roles;