WordPress Developer Resources

build_query( array $data ): string

Builds URL query based on an associative and, or indexed array.

Description

This is a convenient function for easily building url queries. It sets the separator to ‘&’ and uses _http_build_query() function.

See also

_http_build_query(): Used to build the query

Parameters

$dataarrayrequired: URL-encode key/value pairs.

Return

string URL-encoded string.

Source

function build_query( $data ) {
	return _http_build_query( $data, null, '&', '', false );
}

View all references View on Trac View on GitHub

Uses	Description
_http_build_query()`wp-includes/functions.php`	From php.net (modified by Mark Jaquith to behave like the native PHP5 function).

Used by	Description
WP_REST_Pattern_Directory_Controller::get_items()`wp-includes/rest-api/endpoints/class-wp-rest-pattern-directory-controller.php`	Search and retrieve block patterns metadata
add_query_arg()`wp-includes/functions.php`	Retrieves a modified URL query string.
create_initial_post_types()`wp-includes/post.php`	Creates the initial post types when ‘init’ action is fired.

Changelog

Version	Description
2.3.0	Introduced.

User Contributed Notes

Skip to note 2 content

Andy Schmidt 5 years ago

You must log in to vote on the helpfulness of this noteVote results for this note: 4You must log in to vote on the helpfulness of this note
It’s not clearly spelled out that this function will call _http_build_query() with urlencode = FALSE. So it is assumed that you had previously urlencoded each individual key and value of your input array!

Crucially:
```
$myarray = array( 'p%s/n#q?a*e!s p+' =>  'percent%slash/number#question?asterisk*exclamate!space plus+end' );
build_query( $myarray );
```
will output:
p%s/n#q?a*e!s p+=percent%slash/number#question?asterisk*exclamate!space plus+end

If you have an array with ‘raw’ data, you should use the native PHP function instead:
```
$myarray = array( 'p%s/n#q?a*e!s p+' =>  'percent%slash/number#question?asterisk*exclamate!space plus+end' );
http_build_query( $myarray );
```
will output the proper/usable:
p%25s%2Fn%23q%3Fa%2Ae%21s+p%2B=percent%25slash%2Fnumber%23question%3Fasterisk%2Aexclamate%21space+plus%2Bend
Log in to add feedback

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