Changeset 48986

Timestamp:

09/17/2020 11:08:04 AM (6 years ago)

Author:

SergeyBiryukov

Message:

Docs: Reformat comments_pre_query, networks_pre_query, sites_pre_query DocBlocks for better readability.

See #50768.

Location:

trunk/src/wp-includes

Files:

• class-wp-comment-query.php (modified) (1 diff)
• class-wp-network-query.php (modified) (1 diff)
• class-wp-site-query.php (modified) (1 diff)

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

@@ -387 +387 @@
                  * Return a non-null value to bypass WordPress' default comment queries.
                  *
-                 * The expected return type from this filter depends on the value passed in the request query_vars.
-                 * When `$this->query_vars['count']` is set, the filter should return the comment count as an int.
-                 * When `'ids' === $this->query_vars['fields']`, the filter should return an array of comment IDs.
-                 * Otherwise the filter should return an array of WP_Comment objects.
+                 * The expected return type from this filter depends on the value passed
+                 * in the request query vars:
+                 * - When `$this->query_vars['count']` is set, the filter should return
+                 *   the comment count as an integer.
+                 * - When `'ids' === $this->query_vars['fields']`, the filter should return
+                 *   an array of comment IDs.
+                 * - Otherwise the filter should return an array of WP_Comment objects.
                  *
                  * @since 5.3.0

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

@@ -205 +205 @@
                  * Return a non-null value to bypass WordPress' default network queries.
                  *
-                 * The expected return type from this filter depends on the value passed in the request query_vars.
-                 * When `$this->query_vars['count']` is set, the filter should return the network count as an int.
-                 * When `'ids' === $this->query_vars['fields']`, the filter should return an array of network IDs.
-                 * Otherwise the filter should return an array of WP_Network objects.
+                 * The expected return type from this filter depends on the value passed
+                 * in the request query vars:
+                 * - When `$this->query_vars['count']` is set, the filter should return
+                 *   the network count as an integer.
+                 * - When `'ids' === $this->query_vars['fields']`, the filter should return
+                 *   an array of network IDs.
+                 * - Otherwise the filter should return an array of WP_Network objects.
                  *
                  * @since 5.2.0

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

@@ -296 +296 @@
                  * Return a non-null value to bypass WordPress' default site queries.
                  *
-                 * The expected return type from this filter depends on the value passed in the request query_vars:
-                 * When `$this->query_vars['count']` is set, the filter should return the site count as an int.
-                 * When `'ids' === $this->query_vars['fields']`, the filter should return an array of site IDs.
-                 * Otherwise the filter should return an array of WP_Site objects.
+                 * The expected return type from this filter depends on the value passed
+                 * in the request query vars:
+                 * - When `$this->query_vars['count']` is set, the filter should return
+                 *   the site count as an integer.
+                 * - When `'ids' === $this->query_vars['fields']`, the filter should return
+                 *   an array of site IDs.
+                 * - Otherwise the filter should return an array of WP_Site objects.
                  *
                  * @since 5.2.0