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

SergeyBiryukov · SergeyBiryukov · commit b3b64db5705f · 2019-09-10T19:03:04.000Z
See #45800. git-svn-id: https://develop.svn.wordpress.org/trunk@46087 602fd350-edb4-49c9-b593-d223f7449a82
diff --git a/src/wp-includes/class-wp-comment-query.php b/src/wp-includes/class-wp-comment-query.php
@@ -386,14 +386,15 @@ public function get_comments() {
 		 *
 		 * 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.
 		 *
 		 * @since 5.3.0
 		 *
 		 * @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.
 		 */
diff --git a/src/wp-includes/class-wp-network-query.php b/src/wp-includes/class-wp-network-query.php
@@ -204,7 +204,6 @@ public function get_networks() {
 		 *
 		 * Return a non-null value to bypass WordPress's default site queries.
 		 *
-		 *
 		 * @since 5.2.0
 		 *
 		 * @param array|null       $site_ids Return an array of site data to short-circuit WP's site query,
diff --git a/src/wp-includes/class-wp-site-query.php b/src/wp-includes/class-wp-site-query.php
@@ -295,7 +295,6 @@ public function get_sites() {
 		 *
 		 * Return a non-null value to bypass WordPress's default site queries.
 		 *
-		 *
 		 * @since 5.2.0
 		 *
 		 * @param array|null    $site_ids Return an array of site data to short-circuit WP's site query,

Original file line number	Diff line number	Diff line change
`@@ -386,14 +386,15 @@ public function get_comments() {`
`386`	`386`	`*`
`387`	`387`	`* Return a non-null value to bypass WordPress's default comment queries.`
`388`	`388`	`*`
`389`		`- * The expected return type from this filter depends on the value passed in the request query_vars:`
`390`		`- * When $this->query_vars['count'] is set, the filter should return the comment count as an int.`
	`389`	`+ * The expected return type from this filter depends on the value passed in the request query_vars.`
	`390`	+ * When `$this->query_vars['count']` is set, the filter should return the comment count as an int.
`391`	`391`	* When `'ids' == $this->query_vars['fields']`, the filter should return an array of comment ids.
`392`	`392`	`* Otherwise the filter should return an array of WP_Comment objects.`
`393`	`393`	`*`
`394`	`394`	`* @since 5.3.0`
`395`	`395`	`*`
`396`	`396`	`* @param array\|int\|null $comment_data Return an array of comment data to short-circuit WP's comment query,`
	`397`	+ * the comment count as an integer if `$this->query_vars['count']` is set,
`397`	`398`	`* or null to allow WP to run its normal queries.`
`398`	`399`	`* @param WP_Comment_Query $this The WP_Comment_Query instance, passed by reference.`
`399`	`400`	`*/`
Original file line number	Diff line number	Diff line change
`@@ -204,7 +204,6 @@ public function get_networks() {`
`204`	`204`	`*`
`205`	`205`	`* Return a non-null value to bypass WordPress's default site queries.`
`206`	`206`	`*`
`207`		`- *`
`208`	`207`	`* @since 5.2.0`
`209`	`208`	`*`
`210`	`209`	`* @param array\|null $site_ids Return an array of site data to short-circuit WP's site query,`
Original file line number	Diff line number	Diff line change
`@@ -295,7 +295,6 @@ public function get_sites() {`
`295`	`295`	`*`
`296`	`296`	`* Return a non-null value to bypass WordPress's default site queries.`
`297`	`297`	`*`
`298`		`- *`
`299`	`298`	`* @since 5.2.0`
`300`	`299`	`*`
`301`	`300`	`* @param array\|null $site_ids Return an array of site data to short-circuit WP's site query,`