WordPress.org

Make WordPress Core

Changeset 38596


Ignore:
Timestamp:
09/13/16 13:19:57 (8 months ago)
Author:
SergeyBiryukov
Message:

Docs: Synchronize docblocks for WP_Site_Query::__construct() and get_sites() after the changes in [37735], [38008], [38103], and [38336].

Props MaximeCulea.
Fixes #38039.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/ms-blogs.php

    r38595 r38596  
    567567 *     @type array        $date_query        Date query clauses to limit sites by. See WP_Date_Query. 
    568568 *                                           Default null. 
    569  *     @type string       $fields            Site fields to return. Accepts 'ids' for site IDs only or empty 
    570  *                                           for all fields. Default empty. 
     569 *     @type string       $fields            Site fields to return. Accepts 'ids' (returns an array of site IDs) 
     570 *                                           or empty (returns an array of complete site objects). Default empty. 
    571571 *     @type int          $ID                A site ID to only return that site. Default empty. 
    572  *     @type int          $number            Maximum number of sites to retrieve. Default null (no limit). 
     572 *     @type int          $number            Maximum number of sites to retrieve. Default 100. 
    573573 *     @type int          $offset            Number of sites to offset the query. Used to build LIMIT clause. 
    574574 *                                           Default 0. 
     
    580580 *                                           Default 'id'. 
    581581 *     @type string       $order             How to order retrieved sites. Accepts 'ASC', 'DESC'. Default 'ASC'. 
    582  *     @type int          $network_id        Limit results to those affiliated with a given network ID. 
    583  *                                           Default current network ID. 
     582 *     @type int          $network_id        Limit results to those affiliated with a given network ID. If 0, 
     583 *                                           include all networks. Default 0. 
    584584 *     @type array        $network__in       Array of network IDs to include affiliated sites for. Default empty. 
    585585 *     @type array        $network__not_in   Array of network IDs to exclude affiliated sites for. Default empty. 
     
    596596 *     @type int          $deleted           Limit results to deleted sites. Accepts '1' or '0'. Default empty. 
    597597 *     @type string       $search            Search term(s) to retrieve matching sites for. Default empty. 
     598 *     @type array        $search_columns    Array of column names to be searched. Accepts 'domain' and 'path'. 
     599 *                                           Default empty array. 
    598600 *     @type bool         $update_site_cache Whether to prime the cache for found sites. Default false. 
    599601 * } 
Note: See TracChangeset for help on using the changeset viewer.