©
This document uses PHP Chinese website manual Release
(PHP 5)
http_build_query — 生成 URL-encode 之后的请求字符串
$query_data
[, string $numeric_prefix
[, string $arg_separator
[, int $enc_type
= PHP_QUERY_RFC1738
]]] )使用给出的关联(或下标)数组生成一个经过 URL-encode 的请求字符串。
query_data
可以是数组或包含属性的对象。
一个
query_data
数组可以是简单的一维结构,也可以是由数组组成的数组(其依次可以包含其它数组)。
如果 query_data
是一个对象,只有 public 的属性会加入结果。
numeric_prefix
如果在基础数组中使用了数字下标同时给出了该参数,此参数值将会作为基础数组中的数字下标元素的前缀。
这是为了让 PHP 或其它 CGI 程序在稍后对数据进行解码时获取合法的变量名。
arg_separator
除非指定并使用了这个参数,否则会用 arg_separator.output 来分隔参数。
enc_type
默认使用 PHP_QUERY_RFC1738
。
如果 enc_type
是
PHP_QUERY_RFC1738
,则编码将会以 » RFC 1738 标准和 application/x-www-form-urlencoded 媒体类型进行编码,空格会被编码成加号(+)。
如果 enc_type
是
PHP_QUERY_RFC3986
,将根据 » RFC 3986 编码,空格会被百分号编码(%20)。
返回一个 URL 编码后的字符串。
版本 | 说明 |
---|---|
5.4.0 |
加入了 enc_type 参数。
|
5.1.3 | 方括号也会被转义。 |
5.1.2 |
加入了参数 arg_separator 。
|
Example #1 http_build_query() 使用示例
<?php
$data = array( 'foo' => 'bar' ,
'baz' => 'boom' ,
'cow' => 'milk' ,
'php' => 'hypertext processor' );
echo http_build_query ( $data ) . "\n" ;
echo http_build_query ( $data , '' , '&' );
?>
以上例程会输出:
foo=bar&baz=boom&cow=milk&php=hypertext+processor foo=bar&baz=boom&cow=milk&php=hypertext+processor
Example #2 http_build_query() 使用数字下标的元素
<?php
$data = array( 'foo' , 'bar' , 'baz' , 'boom' , 'cow' => 'milk' , 'php' => 'hypertext processor' );
echo http_build_query ( $data ) . "\n" ;
echo http_build_query ( $data , 'myvar_' );
?>
以上例程会输出:
0=foo&1=bar&2=baz&3=boom&cow=milk&php=hypertext+processor myvar_0=foo&myvar_1=bar&myvar_2=baz&myvar_3=boom&cow=milk&php=hypertext+processor
Example #3 http_build_query() 使用复杂的数组
<?php
$data = array( 'user' =>array( 'name' => 'Bob Smith' ,
'age' => 47 ,
'sex' => 'M' ,
'dob' => '5/12/1956' ),
'pastimes' =>array( 'golf' , 'opera' , 'poker' , 'rap' ),
'children' =>array( 'bobby' =>array( 'age' => 12 ,
'sex' => 'M' ),
'sally' =>array( 'age' => 8 ,
'sex' => 'F' )),
'CEO' );
echo http_build_query ( $data , 'flags_' );
?>
这会输出:(为了可读性,字已经换行了)
user%5Bname%5D=Bob+Smith&user%5Bage%5D=47&user%5Bsex%5D=M& user%5Bdob%5D=5%2F12%2F1956&pastimes%5B0%5D=golf&pastimes%5B1%5D=opera& pastimes%5B2%5D=poker&pastimes%5B3%5D=rap&children%5Bbobby%5D%5Bage%5D=12& children%5Bbobby%5D%5Bsex%5D=M&children%5Bsally%5D%5Bage%5D=8& children%5Bsally%5D%5Bsex%5D=F&flags_0=CEO
Note:
只有基础数组中的数字下标元素“CEO”才获取了前缀,其它数字下标元素(如 pastimes 下的元素)则不需要为了合法的变量名而加上前缀。
Example #4 http_build_query() 使用对象
<?php
class parentClass {
public $pub = 'publicParent' ;
protected $prot = 'protectedParent' ;
private $priv = 'privateParent' ;
public $pub_bar = Null ;
protected $prot_bar = Null ;
private $priv_bar = Null ;
public function __construct (){
$this -> pub_bar = new childClass ();
$this -> prot_bar = new childClass ();
$this -> priv_bar = new childClass ();
}
}
class childClass {
public $pub = 'publicChild' ;
protected $prot = 'protectedChild' ;
private $priv = 'privateChild' ;
}
$parent = new parentClass ();
echo http_build_query ( $parent );
?>
以上例程会输出:
pub=publicParent&pub_bar%5Bpub%5D=publicChild
[#1] itsadok at gmail dot com [2015-11-17 06:47:34]
Passing null to $arg_separator is the same as passing an empty string, which is probably not what you want.
If you need to change the enc_type, use this:
http_build_query($query, null, '&', PHP_QUERY_RFC3986);
Or possibly this:
http_build_query($query, null, ini_get('arg_separator.output'), PHP_QUERY_RFC3986);
But not this:
// BAD CODE!
http_build_query($query, null, null, PHP_QUERY_RFC3986);
[#2] james at dimensionengineering dot com [2015-07-15 23:04:17]
Be careful about Example 1 -- it is exactly how *not* to implement things.
& as a separator is the URL encoding.
& is HTML encoding.
You should HTML encode your URL if embedding it in a web page. This is more involved than just replacing & with &. Doing as this example suggests is a security hole waiting to happen.
[#3] joey dot qiang at innomative dot com [2015-06-12 04:35:48]
Not recommending to eliminate the numeric indices like:
'arg[0]' --> 'arg[]'
The reason is this function will not include null values in the result string:
$data = array(
'arg' => array(
null,
2,
3
)
);
echo http_build_query($data);
The output is something like "arg[1]=2&arg[2]=3";
[#4] Mark Simon [2015-03-01 10:41:16]
As noted, this function omits keys with null values. This could break some code which treats the key as boolean, and so has no value, or other code expecting the array to be populated regardless of value.
A workaround for this is to replace the null values with an empty string:
$data=array(
'a'=>'apple',
'b'=>2,
'c'=>null,
'd'=>'??',
);
// Compensate for fact that http_build_query omits null values
foreach($data as &$datum) if($datum===null) $datum='';
Losing the null-ness of the original is no real loss if it??s supposed to be a real query string. If the null is important, you could use a dummy value instead.
Mark
[#5] jakub dot lopuszanski at nasza-klasa dot pl [2013-12-10 10:41:44]
While this is not documented, this http_build_query can return FALSE on some inputs:
<?php
//gives bool(false)
var_dump(http_build_query('whatever'));
?>
[#6] Kirils Solovjovs [2013-07-16 20:51:30]
instead of some other suggestions that did not work for me, I found that the best way to build POST content (e.g. for stream_context_create) is urldecode(http_build_query($query))
[#7] Vitaly Dyatlov [2013-04-23 11:27:04]
Correct implementation of coding the array of params without indexes (valdikks fixed code - didnt work for inner arrays):
<code>
function cr_post($a,$b='',$c=0)
{
if (!is_array($a)) return false;
foreach ((array)$a as $k=>$v)
{
if ($c)
{
if( is_numeric($k) )
$k=$b."[]";
else
$k=$b."[$k]";
}
else
{ if (is_int($k))
$k=$b.$k;
}
if (is_array($v)||is_object($v))
{
$r[]=cr_post($v,$k,1);
continue;
}
$r[]=urlencode($k)."=".urlencode($v);
}
return implode("&",$r);
}
</code>
[#8] eric dot muyser at gmail dot com [2013-04-01 10:45:45]
This function makes like this
files[0]=1&files[1]=2&...
To do it like this:
files[]=1&files[]=2&...
Do this:
$query = http_build_query($query);
$query = preg_replace('/%5B[0-9]+%5D/simU', '%5B%5D', $query);
[#9] stocki dot r at gmail dot com [2013-03-01 15:38:11]
If you need only key+value pairs, you can use this:
<?php
$array = array(
"type" => "welcome",
"message" => "Hello World!"
);
echo urldecode(http_build_query($array, '', ';'));
?>
Result: type=welcome;message=Hello World!
[#10] anonymous [2012-07-19 15:57:12]
Is it worth noting that if query_data is an associative array and a value is itself an empty array, or an array of nothing but empty array (or arrays containing only empty arrays etc.), the corresponding key will not appear in the resulting query string?
E.g.
$post_data = array('name'=>'miller', 'address'=>array('address_lines'=>array()), 'age'=>23);
echo http_build_query($post_data);
will print
name=miller&age=23
[#11] Anonymous [2011-02-08 12:11:49]
As noted before, with php5.3 the separator is & on some servers it seems. Normally if posting to another php5.3 machine this will not be a problem.
But if you post to a tomcat java server or something else the & might not be handled properly.
To overcome this specify:
http_build_query($array, '', '&');
and NOT
http_build_query($array); //gives & to some servers
[#12] v0idnull[try_to_spam_me_now] at gee-mail dot co [2010-03-11 11:51:26]
on my install of PHP 5.3, http_build_query() seems to use & as the default separator. Kind of interesting when combined with stream_context_create() for a POST request, and getting $_POST['amp;fieldName'] on the receiving end.
[#13] irish [-@-] ytdj [-dot-] ca [2010-01-21 13:31:17]
When using the http_build_query function to create a URL query from an array for use in something like curl_setopt($ch, CURLOPT_POSTFIELDS, $post_url), be careful about the url encoding.
In my case, I simply wanted to pass on the received $_POST data to a CURL's POST data, which requires it to be in the URL format. If something like a space [ ] goes into the http_build_query, it comes out as a +. If you're then sending this off for POST again, you won't get the expected result. This is good for GET but not POST.
Instead you can make your own simple function if you simply want to pass along the data:
<?php
$post_url = '';
foreach ($_POST AS $key=>$value)
$post_url .= $key.'='.$value.'&';
$post_url = rtrim($post_url, '&');
?>
You can then use this to pass along POST data in CURL.
<?php
$ch = curl_init($some_url);
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, $post_url);
curl_exec($ch);
?>
Note that at the final page that processes the POST data, you should be properly filtering/escaping it.
[#14] netrox at aol dot com [2009-08-26 19:24:00]
I noticed that even with the magic quotes disabled, http_build_query() automagically adds slashes to strings.
So, I had to add "stripslashes" to every string variable.
[#15] valdikss at gmail dot com [2007-08-27 01:15:13]
This function is wrong for http!
arrays in http is like this:
files[]=1&files[]=2&...
but function makes like this
files[0]=1&files[1]=2&...
Here is normal function:
<?php
function cr_post($a,$b=\'\',$c=0){
if (!is_array($a)) return false;
foreach ((array)$a as $k=>$v){
if ($c) $k=$b.\"[]\"; elseif (is_int($k)) $k=$b.$k;
if (is_array($v)||is_object($v)) {$r[]=cr_post($v,$k,1);continue;}
$r[]=urlencode($k).\"=\".urlencode($v);}return implode(\"&\",$r);}
?>
[#16] Ilya Rudenko [2006-01-09 23:57:07]
Params with null value do not present in result string.
<?php
$arr = array('test' => null, 'test2' => 1);
echo http_build_query($arr);
?>
will produce:
test2=1