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

Parameters

$dataarrayrequired
URL-encode key/value pairs.

Return

string URL-encoded string.

Source

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

Changelog

VersionDescription
2.3.0Introduced.

User Contributed Notes

  1. Skip to note 2 content

    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

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