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
This commit is contained in:
Sergey Biryukov 2020-09-17 11:08:04 +00:00
parent 8621e8d5c8
commit e145c9aaba
3 changed files with 21 additions and 12 deletions

View File

@ -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
*

View File

@ -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
*

View File

@ -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
*