_http_build_query( array|object $data, string $prefix = null, string $sep = null, string $key = '', bool $urlencode = true ): string
- Since
- 3.2.0
- Source
wp-includes/functions.php:1063
Compatibility
- WordPress
- since 3.2.0
- PHP
- 7.4–8.6-dev
- 6.7.7
- 6.8.8
- 6.9.7
- 7.0.4
- 7.1.0
Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.
Parameters
$dataarray|object- An array or object of data. Converted to array.
$prefixstringoptional- Numeric index. If set, start parameter numbering with it.
Default null.Default:null $sepstringoptional- Argument separator; defaults to 'arg_separator.output'.
Default null.Default:null $keystringoptional- Used to prefix key name. Default empty string.Default:
'' $urlencodebooloptional- Whether to use urlencode() in the result. Default true.Default:
true
Return value
string- The query string.
Performance profile
How much work a call to _http_build_query() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.
- Cost class
- Light
- Scaling
- Scales with input
- Instructions
- 13–18
- Plugin surface
- None
- Called by
- 2
Touches nothing outside its own arguments.
The body loops, so the work grows with what you pass in.
Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 75.
Nothing here hands control to plugin code.
2 places in core call this, so the cost is paid more often than your own code shows.
What one call costs · 2 distinct outcomes
One number would be a lie: the work depends on which branch runs. These are every distinct cost _http_build_query() can have, taken from its control-flow graph on PHP 8.5.
| When | Instructions | Calls it makes |
|---|---|---|
$sep !== null | 13–14 | none |
$sep === null | 17–18 | ini_get() |
Across PHP versions
| PHP | Compiled | Executed | Branches | Notes |
|---|---|---|---|---|
| 8.6-dev | 75 | 13–18 | 12 | |
| 8.5 | 75 | 13–18 | 12 | |
| 8.4 | 75 | 13–18 | 12 | 3 fewer instructions than PHP 8.3 |
| 8.3 | 78 | 16–21 | 12 | |
| 8.2 | 78 | 16–21 | 12 | |
| 8.1 | 78 | 16–21 | 12 | |
| 7.4 | 78 | 16–21 | 12 |
An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.
Uses · 1
- _http_build_query()From php.net (modified by Mark Jaquith to behave like the native PHP5 function).
Used by · 2
- _http_build_query()From php.net (modified by Mark Jaquith to behave like the native PHP5 function).
- build_query()Builds URL query based on an associative and, or indexed array.
Source code
function _http_build_query( $data, $prefix = null, $sep = null, $key = '', $urlencode = true ) { $ret = array(); foreach ( (array) $data as $k => $v ) { if ( $urlencode ) { $k = urlencode( $k ); } if ( is_int( $k ) && null !== $prefix ) { $k = $prefix . $k; } if ( ! empty( $key ) ) { $k = $key . '%5B' . $k . '%5D'; } if ( null === $v ) { continue; } elseif ( false === $v ) { $v = '0'; } if ( is_array( $v ) || is_object( $v ) ) { array_push( $ret, _http_build_query( $v, '', $sep, $k, $urlencode ) ); } elseif ( $urlencode ) { array_push( $ret, $k . '=' . urlencode( $v ) ); } else { array_push( $ret, $k . '=' . $v ); } } if ( null === $sep ) { $sep = ini_get( 'arg_separator.output' ); } return implode( $sep, $ret );}Changelog
Introduced in 3.2.0. Unchanged from 6.7.7 through 7.1.0.
Signature, return type and hooks compared across 5 parsed releases.
About this page
- Parsed data
- Generated from the wordpress-develop 6.8.8 tag, from
src/wp-includes/functions.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it. - Corrections
- Something wrong on this page? Report it and it gets fixed in the next regeneration.