<!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>Returns trailing name component of path</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.chgrp.html">chgrp</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.basename" class="refentry">
<div class="refnamediv">
<h1 class="refname">basename</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">basename</span> — <span class="dc-title">Returns trailing name component of path</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.basename-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>basename</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span>
[, <span class="methodparam"><span class="type">string</span> <code class="parameter">$suffix</code></span>
] )</div>
<p class="para rdfs-comment">
Given a string containing the path to a file or directory, this function
will return the trailing name component.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.basename-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">path</code></em></span>
<dd>
<p class="para">
A path.
</p>
<p class="para">
On Windows, both slash (<em>/</em>) and backslash
(<em>\</em>) are used as directory separator character. In
other environments, it is the forward slash (<em>/</em>).
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">suffix</code></em></span>
<dd>
<p class="para">
If the name component ends in <em><code class="parameter">suffix</code></em> this will also
be cut off.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.basename-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the base name of the given <em><code class="parameter">path</code></em>.
</p>
</div>
<div class="refsect1 changelog" id="refsect1-function.basename-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>4.1.0</td>
<td>
The <em><code class="parameter">suffix</code></em> parameter was added
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.basename-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2348">
<p><strong>Example #1 <span class="function"><strong>basename()</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: #DD0000">"1) "</span><span style="color: #007700">.</span><span style="color: #0000BB">basename</span><span style="color: #007700">(</span><span style="color: #DD0000">"/etc/sudoers.d"</span><span style="color: #007700">, </span><span style="color: #DD0000">".d"</span><span style="color: #007700">).</span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"2) "</span><span style="color: #007700">.</span><span style="color: #0000BB">basename</span><span style="color: #007700">(</span><span style="color: #DD0000">"/etc/passwd"</span><span style="color: #007700">).</span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"3) "</span><span style="color: #007700">.</span><span style="color: #0000BB">basename</span><span style="color: #007700">(</span><span style="color: #DD0000">"/etc/"</span><span style="color: #007700">).</span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"4) "</span><span style="color: #007700">.</span><span style="color: #0000BB">basename</span><span style="color: #007700">(</span><span style="color: #DD0000">"."</span><span style="color: #007700">).</span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">"5) "</span><span style="color: #007700">.</span><span style="color: #0000BB">basename</span><span style="color: #007700">(</span><span style="color: #DD0000">"/"</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>
1) sudoers
2) passwd
3) etc
4) .
5)
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.basename-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
<span class="function"><strong>basename()</strong></span> operates naively on the input string,
and is not aware of the actual filesystem, or path components such
as "<em>..</em>".
</p>
</p></blockquote>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
<span class="function"><strong>basename()</strong></span> is locale aware, so for it to see the
correct basename with multibyte character paths, the matching locale must
be set using the <span class="function"><a href="function.setlocale.html" class="function">setlocale()</a></span> function.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.basename-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.dirname.html" class="function" rel="rdfs-seeAlso">dirname()</a> - Returns parent directory's path</span></li>
<li class="member"> <span class="function"><a href="function.pathinfo.html" class="function" rel="rdfs-seeAlso">pathinfo()</a> - Returns information about a file path</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="ref.filesystem.html">Filesystem Functions</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.chgrp.html">chgrp</a></div>
<div class="up"><a href="ref.filesystem.html">Filesystem Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
