WordPress.org
Get WordPress
WordPress.org

WordPress Developer Resources

WP_Site_Query::parse_query()

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

In this article

Back to top

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

Description

See also

Parameters

$querystring|arrayoptional
Array or string of WP_Site_Query arguments. See WP_Site_Query::__construct().

Default:''

Source

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 $query The WP_Site_Query instance (passed by reference).
	 */
	do_action_ref_array( 'parse_site_query', array( &$this ) );
}

View all references View on Trac View on GitHub

Hooks

do_action_ref_array( ‘parse_site_query’, WP_Site_Query $query )

Fires after the site query vars have been parsed.

UsesDescription
do_action_ref_array()wp-includes/plugin.php

Calls the callback functions that have been added to an action hook, specifying arguments in an array.

wp_parse_args()wp-includes/functions.php

Merges user defined arguments into defaults array.

Used byDescription
WP_Site_Query::get_sites()wp-includes/class-wp-site-query.php

Retrieves a list of sites matching the query vars.

Changelog

VersionDescription
4.6.0Introduced.

User Contributed Notes

You must log in before being able to contribute a note or feedback.