Make WordPress Core


Ignore:
Timestamp:
09/17/2020 11:08:04 AM (4 years ago)
Author:
SergeyBiryukov
Message:

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

See #50768.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/class-wp-site-query.php

    r48985 r48986  
    296296         * Return a non-null value to bypass WordPress' default site queries.
    297297         *
    298          * The expected return type from this filter depends on the value passed in the request query_vars:
    299          * When `$this->query_vars['count']` is set, the filter should return the site count as an int.
    300          * When `'ids' === $this->query_vars['fields']`, the filter should return an array of site IDs.
    301          * Otherwise the filter should return an array of WP_Site objects.
     298         * The expected return type from this filter depends on the value passed
     299         * in the request query vars:
     300         * - When `$this->query_vars['count']` is set, the filter should return
     301         *   the site count as an integer.
     302         * - When `'ids' === $this->query_vars['fields']`, the filter should return
     303         *   an array of site IDs.
     304         * - Otherwise the filter should return an array of WP_Site objects.
    302305         *
    303306         * @since 5.2.0
Note: See TracChangeset for help on using the changeset viewer.