<!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 a URL</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.http-build-str.html">http_build_str</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.hw.html">Hyperwave</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-url" class="refentry">
<div class="refnamediv">
<h1 class="refname">http_build_url</h1>
<p class="verinfo">(PECL pecl_http >= 0.21.0)</p><p class="refpurpose"><span class="refname">http_build_url</span> — <span class="dc-title">Build a URL</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.http-build-url-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>http_build_url</strong></span>
([ <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$url</code></span>
[, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$parts</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code><span class="initializer"> = HTTP_URL_REPLACE</span></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter reference">&$new_url</code></span>
]]]] )</div>
<p class="para rdfs-comment">
Build a URL.
</p>
<p class="para">
The parts of the second URL will be merged into the first according to the flags argument.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.http-build-url-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">url</code></em></span>
<dd>
<p class="para">
(part(s) of) an URL in form of a string or associative array like <span class="function"><a href="function.parse-url.html" class="function">parse_url()</a></span> returns
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">parts</code></em></span>
<dd>
<p class="para">
same as the first argument
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">flags</code></em></span>
<dd>
<p class="para">
a bitmask of binary or'ed <a href="http.constants.html#http.constants.url" class="link">HTTP_URL constants</a>;
<strong><code>HTTP_URL_REPLACE</code></strong> is the default
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">new_url</code></em></span>
<dd>
<p class="para">
if set, it will be filled with the parts of the composed url like <span class="function"><a href="function.parse-url.html" class="function">parse_url()</a></span> would return
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.http-build-url-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the new URL as string on success or <strong><code>FALSE</code></strong> on failure.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.http-build-url-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-4376">
<p><strong>Example #1 A <span class="function"><strong>http_build_url()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #007700">echo </span><span style="color: #0000BB">http_build_url</span><span style="color: #007700">(</span><span style="color: #DD0000">"http://user@www.example.com/pub/index.php?a=b#files"</span><span style="color: #007700">,<br /> array(<br /> </span><span style="color: #DD0000">"scheme" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"ftp"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"host" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"ftp.example.com"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"path" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"files/current/"</span><span style="color: #007700">,<br /> </span><span style="color: #DD0000">"query" </span><span style="color: #007700">=> </span><span style="color: #DD0000">"a=c"<br /> </span><span style="color: #007700">),<br /> </span><span style="color: #0000BB">HTTP_URL_STRIP_AUTH </span><span style="color: #007700">| </span><span style="color: #0000BB">HTTP_URL_JOIN_PATH </span><span style="color: #007700">| </span><span style="color: #0000BB">HTTP_URL_JOIN_QUERY </span><span style="color: #007700">| </span><span style="color: #0000BB">HTTP_URL_STRIP_FRAGMENT<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
ftp://ftp.example.com/pub/files/current/?a=c
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.http-build-url-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.parse-url.html" class="function" rel="rdfs-seeAlso">parse_url()</a> - Parse a URL and return its components</span></li>
<li class="member"> <span class="function"><a href="function.http-build-str.html" class="function" rel="rdfs-seeAlso">http_build_str()</a> - Build query string</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-build-str.html">http_build_str</a></div>
<div class="next" style="text-align: right; float: right;"><a href="book.hw.html">Hyperwave</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>
