http_build_queryとは何？わかりやすく解説 Weblio辞書

http_build_query

(PHP 5)
http_build_query — URL エンコードされたクエリ文字列を生成する

説明

string http_build_query ( array formdata [, string numeric_prefix [, string arg_separator]] )
与えられた連想配列 (もしくは添字配列) から URL エンコードされたクエリ文字列を生成します。

パラメータ

formdata: プロパティを含む配列もしくはオブジェクト。
配列の形式は、単純な一次元構造、もしくは配列の配列 (言い換えると、他の配列を含む配列) となります。
numeric_prefix: もし数値インデックスが基底となる配列に使用されたり numeric_prefix が指定された場合、基底となる配列の要素に対する数値インデックスの前にこれが追加されます。
これは、後で PHP や他の CGI アプリケーションによってデータがデコードされる際、正当な変数名になるよう考慮したものです。
arg_separator: arg_separator.output が区分のためのセパレータとして使用されます。ただし、このパラメータが指定されていた場合はそれが使用されます。

返り値

URL エンコードされた文字列を返します。

変更履歴

バージョン	説明
5.1.2	パラメータ `arg_separator` が追加されました。

例

例 2391. http_build_query() の簡単な使用法

 <?php
 $data = array('foo'=>'bar',
              'baz'=>'boom',
              'cow'=>'milk',
              'php'=>'hypertext processor');
 
 echo http_build_query($data); // foo=bar&baz=boom&cow=milk&php=hypertext+processor
 echo http_build_query($data, '', '&amp;'); // foo=bar&amp;baz=boom&amp;cow=milk&amp;php=hypertext+processor
 
 ?>

例 2392. 数値インデックス要素の場合での 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

例 2393. 複雑な配列の場合での 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[name]=Bob+Smith&user[age]=47&user[sex]=M&user[dob]=5%2F12%2F1956&
pastimes[0]=golf&pastimes[1]=opera&pastimes[2]=poker&pastimes[3]=rap&
children[bobby][age]=12&children[bobby][sex]=M&children[sally][age]=8&
children[sally][sex]=F&flags_0=CEO

注意: 基底の配列内の数値インデックス要素 "CEO" のみ、接頭辞を受け取ります。pastimes 以下にある他の数値インデックスは、正当な変数名にするための文字列の接頭辞を要求しません。

例 2394. オブジェクトの場合の http_build_query() の使用

 <?php
 class myClass {
    var $foo;
    var $baz;
 
    function myClass() {
        $this->foo = 'bar';
        $this->baz = 'boom';
    }
 }
 
 $data = new myClass();
 
 echo http_build_query($data); // foo=bar&baz=boom
 
 ?>