WordPress.org

Make WordPress Core

Ticket #42156: 42156.diff

File 42156.diff, 4.7 KB (added by felipeelia, 2 years ago)
  • src/wp-includes/ms-blogs.php

     
    596596 * @see WP_Site_Query::parse_query()
    597597 *
    598598 * @param string|array $args {
    599  *     Optional. Array or query string of site query parameters. Default empty.
    600  *
    601  *     @type array        $site__in          Array of site IDs to include. Default empty.
    602  *     @type array        $site__not_in      Array of site IDs to exclude. Default empty.
    603  *     @type bool         $count             Whether to return a site count (true) or array of site objects.
    604  *                                           Default false.
    605  *     @type array        $date_query        Date query clauses to limit sites by. See WP_Date_Query.
    606  *                                           Default null.
    607  *     @type string       $fields            Site fields to return. Accepts 'ids' (returns an array of site IDs)
    608  *                                           or empty (returns an array of complete site objects). Default empty.
    609  *     @type int          $ID                A site ID to only return that site. Default empty.
    610  *     @type int          $number            Maximum number of sites to retrieve. Default 100.
    611  *     @type int          $offset            Number of sites to offset the query. Used to build LIMIT clause.
    612  *                                           Default 0.
    613  *     @type bool         $no_found_rows     Whether to disable the `SQL_CALC_FOUND_ROWS` query. Default true.
    614  *     @type string|array $orderby           Site status or array of statuses. Accepts 'id', 'domain', 'path',
    615  *                                           'network_id', 'last_updated', 'registered', 'domain_length',
    616  *                                           'path_length', 'site__in' and 'network__in'. Also accepts false,
    617  *                                           an empty array, or 'none' to disable `ORDER BY` clause.
    618  *                                           Default 'id'.
    619  *     @type string       $order             How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'.
    620  *     @type int          $network_id        Limit results to those affiliated with a given network ID. If 0,
    621  *                                           include all networks. Default 0.
    622  *     @type array        $network__in       Array of network IDs to include affiliated sites for. Default empty.
    623  *     @type array        $network__not_in   Array of network IDs to exclude affiliated sites for. Default empty.
    624  *     @type string       $domain            Limit results to those affiliated with a given domain. Default empty.
    625  *     @type array        $domain__in        Array of domains to include affiliated sites for. Default empty.
    626  *     @type array        $domain__not_in    Array of domains to exclude affiliated sites for. Default empty.
    627  *     @type string       $path              Limit results to those affiliated with a given path. Default empty.
    628  *     @type array        $path__in          Array of paths to include affiliated sites for. Default empty.
    629  *     @type array        $path__not_in      Array of paths to exclude affiliated sites for. Default empty.
    630  *     @type int          $public            Limit results to public sites. Accepts '1' or '0'. Default empty.
    631  *     @type int          $archived          Limit results to archived sites. Accepts '1' or '0'. Default empty.
    632  *     @type int          $mature            Limit results to mature sites. Accepts '1' or '0'. Default empty.
    633  *     @type int          $spam              Limit results to spam sites. Accepts '1' or '0'. Default empty.
    634  *     @type int          $deleted           Limit results to deleted sites. Accepts '1' or '0'. Default empty.
    635  *     @type int          $lang_id           Limit results to a language ID. Default empty.
    636  *     @type array        $lang__in          Array of language IDs to include affiliated sites for. Default empty.
    637  *     @type array        $lang__not_in      Array of language IDs to exclude affiliated sites for. Default empty.
    638  *     @type string       $search            Search term(s) to retrieve matching sites for. Default empty.
    639  *     @type array        $search_columns    Array of column names to be searched. Accepts 'domain' and 'path'.
    640  *                                           Default empty array.
    641  *     @type bool         $update_site_cache Whether to prime the cache for found sites. Default true.
     599 *     Optional. Arguments to retrieve sites. See WP_Site_Query::__construct() for all
     600 *     available arguments.
    642601 * }
    643602 * @return array|int List of sites, or number of sites when 'count' is passed as a query var.
    644603 */