PHP - URL http_build_query() 函数



PHP URL http_build_query() 函数用于根据提供的关联(或索引)数组生成 URL 编码的查询字符串。当您需要创建带有查询参数的 URL 时,此函数非常有用。

语法

以下是 PHP URL http_build_query() 函数的语法:

string http_build_query( 
   mixed $query_data [, string $numeric_prefix [, string $arg_separator [, 
      int $enc_type = PHP_QUERY_RFC1738 ]]
   ] 
)

参数

以下是 http_build_query() 函数的参数:

  • $query_data − 要转换的数组或查询字符串。

  • $numeric_prefix − 要添加到查询字符串中数字键的前缀。

  • $arg_separator − 用于在查询字符串中参数之间使用的分隔符。默认值为 "&"

  • $enc_type − 编码类型。默认值为 PHP_QUERY_RFC1738。

返回值

http_build_query() 函数返回一个 URL 编码的字符串。

PHP 版本

http_build_query() 函数首次引入到核心 PHP 5 中,并在 PHP 7 和 PHP 8 中继续轻松运行。

示例 1

这是一个 PHP URL http_build_query() 函数的基本示例,用于根据给定数组生成 URL 编码的字符串。

<?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

示例 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

示例 3

此示例展示了如何使用嵌套数组(表示复杂数据结构)与 http_build_query() 函数一起使用。

<?php
   $data = array(
      "user" => array(
         "name" => "Amit Sharma",
         "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=Amit+Sharma&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

示例 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
php_function_reference.htm
广告