Changeset 59009 for trunk/src/wp-includes/class-wp-site-query.php

Timestamp:

09/11/2024 12:06:15 PM (2 years ago)

Author:

johnbillion

Message:

Docs: Various docblock improvements and corrections.

See #61608

File:

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

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

@@ -264 +264 @@
          *
          * @param string|array $query Array or URL query string of parameters.
-         * @return array|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids',
-         *                   or the number of sites when 'count' is passed as a query var.
+         * @return WP_Site[]|int[]|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids',
+         *                             or the number of sites when 'count' is passed as a query var.
          */
         public function query( $query ) {
@@ -280 +280 @@
          * @global wpdb $wpdb WordPress database abstraction object.
          *
-         * @return array|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids',
-         *                   or the number of sites when 'count' is passed as a query var.
+         * @return WP_Site[]|int[]|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids',
+         *                             or the number of sites when 'count' is passed as a query var.
          */
         public function get_sites() {
@@ -334 +334 @@
                  *              of the current WP_Site_Query instance.
                  *
-                 * @param array|int|null $site_data Return an array of site data to short-circuit WP's site query,
-                 *                                  the site count as an integer if `$this->query_vars['count']` is set,
-                 *                                  or null to run the normal queries.
-                 * @param WP_Site_Query  $query     The WP_Site_Query instance, passed by reference.
+                 * @param WP_Site[]|int[]|int|null $site_data Return an array of site data to short-circuit WP's site query,
+                 *                                            the site count as an integer if `$this->query_vars['count']` is set,
+                 *                                            or null to run the normal queries.
+                 * @param WP_Site_Query            $query     The WP_Site_Query instance, passed by reference.
                  */
                 $site_data = apply_filters_ref_array( 'sites_pre_query', array( $site_data, &$this ) );