WP_Site_Query

Hooks fired · 7

Every hook that fires from inside WP_Site_Query, in the order it appears in the class, grouped by the method that fires it.

Properties · 10

$requeststringpublic

SQL for database query.

$sql_clausesarrayprotected

SQL query clauses.

$meta_queryWP_Meta_Querypublic

Metadata query container.

$meta_query_clausesarrayprotected

Metadata query clauses.

$date_queryWP_Date_Querypublic

Date query container.

$query_varsarraypublic

Query vars set by the user.

$query_var_defaultsarraypublic

Default values for query vars.

$sitesarraypublic

List of sites located by the query.

$found_sitesintpublic

The amount of found sites for the current query.

$max_num_pagesintpublic

The number of pages.

Methods · 9

• __construct()Sets up the site query, based on the query vars passed.
• parse_query()Parses arguments passed to the site query with default query parameters.
• query()Sets up the WordPress query for retrieving sites.
• get_sites()Retrieves a list of sites matching the query vars.
• get_site_ids()Used internally to get a list of site IDs matching the query vars.
• set_found_sites()Populates found_sites and max_num_pages properties for the current query if the limit clause was used.
• get_search_sql()Used internally to generate an SQL string for searching across multiple columns.
• parse_orderby()Parses and sanitizes 'orderby' keys passed to the site query.
• parse_order()Parses an 'order' query variable and cast it to 'ASC' or 'DESC' as necessary.

Source

View on Trac ↗View on GitHub ↗

17#[AllowDynamicProperties]18class WP_Site_Query {19 20	/**21	 * SQL for database query.22	 *23	 * @since 4.6.024	 * @var string25	 */26	public $request;27 28	/**29	 * SQL query clauses.30	 *31	 * @since 4.6.032	 * @var array33	 */34	protected $sql_clauses = array(35		'select'  => '',36		'from'    => '',37		'where'   => array(),38		'groupby' => '',39		'orderby' => '',40		'limits'  => '',41	);42 43	/**44	 * Metadata query container.45	 *46	 * @since 5.1.047	 * @var WP_Meta_Query48	 */49	public $meta_query = false;50 51	/**52	 * Metadata query clauses.53	 *54	 * @since 5.1.055	 * @var array56	 */57	protected $meta_query_clauses;58 59	/**60	 * Date query container.61	 *62	 * @since 4.6.063	 * @var WP_Date_Query A date query instance.64	 */65	public $date_query = false;66 67	/**68	 * Query vars set by the user.69	 *70	 * @since 4.6.071	 * @var array72	 */73	public $query_vars;74 75	/**76	 * Default values for query vars.77	 *78	 * @since 4.6.079	 * @var array80	 */81	public $query_var_defaults;82 83	/**84	 * List of sites located by the query.85	 *86	 * @since 4.6.087	 * @var array88	 */89	public $sites;90 91	/**92	 * The amount of found sites for the current query.93	 *94	 * @since 4.6.095	 * @var int96	 */

History

Introduced in 4.6.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.9.7 tag, from src/wp-includes/class-wp-site-query.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.