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

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

Description

See also

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 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 ) );
	}

Changelog

Version Description
4.6.0 Introduced.

© 2003–2021 WordPress Foundation
Licensed under the GNU GPLv2+ License.
https://developer.wordpress.org/reference/classes/wp_site_query/parse_query