From e145c9aabae67451865aaa4fb9837e81e2e421f8 Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Thu, 17 Sep 2020 11:08:04 +0000 Subject: [PATCH] Docs: Reformat `comments_pre_query`, `networks_pre_query`, `sites_pre_query` DocBlocks for better readability. See #50768. git-svn-id: https://develop.svn.wordpress.org/trunk@48986 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/class-wp-comment-query.php | 11 +++++++---- src/wp-includes/class-wp-network-query.php | 11 +++++++---- src/wp-includes/class-wp-site-query.php | 11 +++++++---- 3 files changed, 21 insertions(+), 12 deletions(-) diff --git a/src/wp-includes/class-wp-comment-query.php b/src/wp-includes/class-wp-comment-query.php index 7868c8a58b..c04584b9d1 100644 --- a/src/wp-includes/class-wp-comment-query.php +++ b/src/wp-includes/class-wp-comment-query.php @@ -386,10 +386,13 @@ class WP_Comment_Query { * * 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 * diff --git a/src/wp-includes/class-wp-network-query.php b/src/wp-includes/class-wp-network-query.php index 67e574aaf1..bc5a2d6b3a 100644 --- a/src/wp-includes/class-wp-network-query.php +++ b/src/wp-includes/class-wp-network-query.php @@ -204,10 +204,13 @@ class WP_Network_Query { * * 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 * diff --git a/src/wp-includes/class-wp-site-query.php b/src/wp-includes/class-wp-site-query.php index 3461970985..39c82d2b67 100644 --- a/src/wp-includes/class-wp-site-query.php +++ b/src/wp-includes/class-wp-site-query.php @@ -295,10 +295,13 @@ class WP_Site_Query { * * 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 *