Changeset 46087

Timestamp:

09/10/2019 07:03:04 PM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify the int return value in comments_pre_query filter DocBlock.

See #45800.

Location:

trunk/src/wp-includes

Files:

• class-wp-comment-query.php (modified) (2 diffs)
• 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's 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.
+         * 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.
@@ -395 +395 @@
          *
          * @param array|int|null   $comment_data Return an array of comment data to short-circuit WP's comment query,
+         *                                       the comment count as an integer if `$this->query_vars['count']` is set,
          *                                       or null to allow WP to run its normal queries.
          * @param WP_Comment_Query $this         The WP_Comment_Query instance, passed by reference.

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

@@ -205 +205 @@
          * Return a non-null value to bypass WordPress's default site queries.
          *
-         *
          * @since 5.2.0
          *

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

@@ -296 +296 @@
          * Return a non-null value to bypass WordPress's default site queries.
          *
-         *
          * @since 5.2.0
          *