WP_Site_Query::parse_query( string|array $query = '' )

Parses arguments passed to the site query with default query parameters.

Description

Parameters

$query

(string|array) (Optional) Array or string of WP_Site_Query arguments. See WP_Site_Query::__construct().

Default value: ''

Source

File: wp-includes/class-wp-site-query.php

	public function parse_query( $query = '' ) {
		if ( empty( $query ) ) {
			$query = $this->query_vars;
		}

		$this->query_vars = wp_parse_args( $query, $this->query_var_defaults );

		/**
		 * Fires after the site query vars have been parsed.
		 *
		 * @since WP-4.6.0
		 *
		 * @param WP_Site_Query $this The WP_Site_Query instance (passed by reference).
		 */
		do_action_ref_array( 'parse_site_query', array( &$this ) );
	}

Expand Source Code View on GitHub

Uses

Uses
Uses	Description
wp-includes/plugin.php: do_action_ref_array()	Execute functions hooked on a specific action hook, specifying arguments in an array.
wp-includes/class-wp-site-query.php: parse_site_query	Fires after the site query vars have been parsed.
wp-includes/functions.php: wp_parse_args()	Merge user defined arguments into defaults array.

Used By

Used By
Used By	Description
wp-includes/class-wp-site-query.php: WP_Site_Query::get_sites()	Retrieves a list of sites matching the query vars.

Changelog

Changelog
Version	Description
WP-4.6.0	Introduced.