<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Build query string</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.http-throttle.html">http_throttle</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.http-build-url.html">http_build_url</a></div>
<div class="up"><a href="ref.http.html">HTTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.http-build-str" class="refentry">
<div class="refnamediv">
<h1 class="refname">http_build_str</h1>
<p class="verinfo">(PECL pecl_http >= 0.23.0)</p><p class="refpurpose"><span class="refname">http_build_str</span> — <span class="dc-title">Build query string</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.http-build-str-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>http_build_str</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$query</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$prefix</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$arg_separator</code><span class="initializer"> = ini_get("arg_separator.output")</span></span>
]] )</div>
<p class="para rdfs-comment">
Builds a query string from an array of query variables. In effect, this
function is the opposite of <span class="function"><a href="function.parse-str.html" class="function">parse_str()</a></span>.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.http-build-str-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">query</code></em></span>
<dd>
<p class="para">
associative array of query string parameters
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">prefix</code></em></span>
<dd>
<p class="para">
top level prefix
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">arg_separator</code></em></span>
<dd>
<p class="para">
argument separator to use (by default the INI setting arg_separator.output will be used, or "&" if neither is set
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.http-build-str-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the built query as string on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.http-build-str-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member">standard <span class="function"><a href="function.http-build-query.html" class="function" rel="rdfs-seeAlso">http_build_query()</a> - Generate URL-encoded query string</span></li>
<li class="member"> <span class="function"><a href="function.http-build-url.html" class="function" rel="rdfs-seeAlso">http_build_url()</a> - Build a URL</span></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.http-throttle.html">http_throttle</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.http-build-url.html">http_build_url</a></div>
<div class="up"><a href="ref.http.html">HTTP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
