関数・クラス解説

http_build_query

version:PHP 5, PHP 7 (公式)

URL エンコードされたクエリ文字列を生成する

公式リファレンス

書式

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

説明

与えられた連想配列 (もしくは添字配列) から URL エンコードされたクエリ文字列を生成します。

パラメータ

query_data
プロパティを含む配列もしくはオブジェクト。 query_data が配列の場合の形式は、 単純な一次元構造か あるいは配列の配列 (言い換えると、他の配列を含む配列) となります。 query_data がオブジェクトの場合、 public プロパティだけが結果に含められます。
numeric_prefix
情報源となる配列 (query_data で指定した配列) に数値インデックスが使われていて、しかも numeric_prefix が指定された場合、数値のインデックスを持つ要素に関してのみインデックスの前に 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 エンコードされた文字列を返します。

サンプル

例1 http_build_query() の簡単な使用法

$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()

$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()

$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

注意:

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

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

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

参考

  • parse_str() - 文字列を処理し、変数に代入する
  • parse_url() - URL を解釈し、その構成要素を返す
  • urlencode() - 文字列を URL エンコードする
  • array_walk() - 配列の全ての要素にユーザー定義の関数を適用する
  • ワード検索


    ※入力キーワードが、関数名・説明文・タグに含まれるものを検索

    関数名アルファベット別

    A B C D E F G H I J
    K L M N O P Q R S T
    U V W X Y Z _

    最終更新一覧

    stristr
     大文字小文字を区別せず文字列を検索し、ヒット箇所以降(あるいは以前)の文字列を返却

    stripslashes
     バックスラッシュでエスケープされた文字列から、バックスラッシュを取り除く

    stripos
     大文字小文字を区別せずに文字列が最初に現れる位置を取得する

    stripcslashes
     addcslashes() でクォートされた文字列をアンクォートする

    strip_tags
     文字列から HTML と PHP のタグを除去して返却

    strcspn
     指定した文字が最初に現れる位置を調べる

    strcoll
     ロケールに基づいて2つの文字列を比較し同じか(あるいは大小)を判定する

    strcmp
     2つの文字列を比較し同じか(あるいは大小)を判定する

    strchr
     strstr() のエイリアス

    strcasecmp
     2つの文字列を比較(大文字小文字を区別せず同じとみなす)

    カテゴリー一覧

    PHP の振る舞いの変更
    音声フォーマットの操作
    認証サービス
    コマンドライン関連
    圧縮およびアーカイブ
    暗号
    データベース関連
    日付および時刻関連
    ファイルシステム
    自然言語および文字エンコーディング
    画像処理および作成
    メール関連
    数学
    テキスト以外の MIME 型
    プロセス制御
    その他の基本モジュール
    その他のサービス
    検索エンジン用の拡張モジュール
    サーバー固有のモジュール
    セッション関連
    テキスト処理
    変数・データ型関連
    ウェブサービス
    Windows 用のモジュール
    XML 操作
    GUI用の拡張モジュール