WordPress.org

Make WordPress Core

Changeset 51184


Ignore:
Timestamp:
06/19/2021 08:55:52 PM (3 months ago)
Author:
SergeyBiryukov
Message:

Docs: Add a reference to WP_Site_Query::__construct() for information on accepted arguments in get_sites().

Synchronize the documentation between two places, use WP_Site_Query::__construct() as the canonical source.

Follow-up to [37616].

Props birgire, felipeelia, audrasjb.
Fixes #42156.

Location:
trunk/src/wp-includes
Files:
2 edited

Legend:

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

    r49946 r51184  
    153153     *     @type string[]     $lang__not_in           Array of language IDs to exclude affiliated sites for. Default empty.
    154154     *     @type string       $search                 Search term(s) to retrieve matching sites for. Default empty.
    155      *     @type array        $search_columns         Array of column names to be searched. Accepts 'domain' and 'path'.
     155     *     @type string[]     $search_columns         Array of column names to be searched. Accepts 'domain' and 'path'.
    156156     *                                                Default empty array.
    157157     *     @type bool         $update_site_cache      Whether to prime the cache for found sites. Default true.
  • trunk/src/wp-includes/ms-site.php

    r50641 r51184  
    411411 * @see WP_Site_Query::parse_query()
    412412 *
    413  * @param string|array $args {
    414  *     Optional. Array or query string of site query parameters. Default empty.
    415  *
    416  *     @type int[]        $site__in          Array of site IDs to include. Default empty.
    417  *     @type int[]        $site__not_in      Array of site IDs to exclude. Default empty.
    418  *     @type bool         $count             Whether to return a site count (true) or array of site objects.
    419  *                                           Default false.
    420  *     @type array        $date_query        Date query clauses to limit sites by. See WP_Date_Query.
    421  *                                           Default null.
    422  *     @type string       $fields            Site fields to return. Accepts 'ids' (returns an array of site IDs)
    423  *                                           or empty (returns an array of complete site objects). Default empty.
    424  *     @type int          $ID                A site ID to only return that site. Default empty.
    425  *     @type int          $number            Maximum number of sites to retrieve. Default 100.
    426  *     @type int          $offset            Number of sites to offset the query. Used to build LIMIT clause.
    427  *                                           Default 0.
    428  *     @type bool         $no_found_rows     Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true.
    429  *     @type string|array $orderby           Site status or array of statuses. Accepts 'id', 'domain', 'path',
    430  *                                           'network_id', 'last_updated', 'registered', 'domain_length',
    431  *                                           'path_length', 'site__in' and 'network__in'. Also accepts false,
    432  *                                           an empty array, or 'none' to disable `ORDER BY` clause.
    433  *                                           Default 'id'.
    434  *     @type string       $order             How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'.
    435  *     @type int          $network_id        Limit results to those affiliated with a given network ID. If 0,
    436  *                                           include all networks. Default 0.
    437  *     @type int[]        $network__in       Array of network IDs to include affiliated sites for. Default empty.
    438  *     @type int[]        $network__not_in   Array of network IDs to exclude affiliated sites for. Default empty.
    439  *     @type string       $domain            Limit results to those affiliated with a given domain. Default empty.
    440  *     @type string[]     $domain__in        Array of domains to include affiliated sites for. Default empty.
    441  *     @type string[]     $domain__not_in    Array of domains to exclude affiliated sites for. Default empty.
    442  *     @type string       $path              Limit results to those affiliated with a given path. Default empty.
    443  *     @type string[]     $path__in          Array of paths to include affiliated sites for. Default empty.
    444  *     @type string[]     $path__not_in      Array of paths to exclude affiliated sites for. Default empty.
    445  *     @type int          $public            Limit results to public sites. Accepts '1' or '0'. Default empty.
    446  *     @type int          $archived          Limit results to archived sites. Accepts '1' or '0'. Default empty.
    447  *     @type int          $mature            Limit results to mature sites. Accepts '1' or '0'. Default empty.
    448  *     @type int          $spam              Limit results to spam sites. Accepts '1' or '0'. Default empty.
    449  *     @type int          $deleted           Limit results to deleted sites. Accepts '1' or '0'. Default empty.
    450  *     @type int          $lang_id           Limit results to a language ID. Default empty.
    451  *     @type string[]     $lang__in          Array of language IDs to include affiliated sites for. Default empty.
    452  *     @type string[]     $lang__not_in      Array of language IDs to exclude affiliated sites for. Default empty.
    453  *     @type string       $search            Search term(s) to retrieve matching sites for. Default empty.
    454  *     @type string[]     $search_columns    Array of column names to be searched. Accepts 'domain' and 'path'.
    455  *                                           Default empty array.
    456  *     @type bool         $update_site_cache Whether to prime the cache for found sites. Default true.
    457  * }
     413 * @param string|array $args Optional. Array or string of arguments. See WP_Site_Query::__construct()
     414 *                           for information on accepted arguments. Default empty array.
    458415 * @return array|int List of WP_Site objects, a list of site IDs when 'fields' is set to 'ids',
    459416 *                   or the number of sites when 'count' is passed as a query var.
Note: See TracChangeset for help on using the changeset viewer.