<!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>Tells whether the filename is writable</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.is-uploaded-file.html">is_uploaded_file</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.is-writeable.html">is_writeable</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.is-writable" class="refentry">
<div class="refnamediv">
<h1 class="refname">is_writable</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">is_writable</span> — <span class="dc-title">Tells whether the filename is writable</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.is-writable-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>is_writable</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$filename</code></span>
)</div>
<p class="para rdfs-comment">
Returns <strong><code>TRUE</code></strong> if the <em><code class="parameter">filename</code></em> exists and is
writable. The filename argument may be a directory name allowing you
to check if a directory is writable.
</p>
<p class="para">
Keep in mind that PHP may be accessing the file as the user id
that the web server runs as (often 'nobody'). Safe mode
limitations are not taken into account.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.is-writable-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">filename</code></em></span>
<dd>
<p class="para">
The filename being checked.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.is-writable-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns <strong><code>TRUE</code></strong> if the <em><code class="parameter">filename</code></em> exists and is
writable.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.is-writable-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-2405">
<p><strong>Example #1 <span class="function"><strong>is_writable()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$filename </span><span style="color: #007700">= </span><span style="color: #DD0000">'test.txt'</span><span style="color: #007700">;<br />if (</span><span style="color: #0000BB">is_writable</span><span style="color: #007700">(</span><span style="color: #0000BB">$filename</span><span style="color: #007700">)) {<br /> echo </span><span style="color: #DD0000">'The file is writable'</span><span style="color: #007700">;<br />} else {<br /> echo </span><span style="color: #DD0000">'The file is not writable'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
</div>
</p>
</div>
<div class="refsect1 errors" id="refsect1-function.is-writable-errors">
<h3 class="title">Errors/Exceptions</h3>
<p class="para">
Upon failure, an <strong><code>E_WARNING</code></strong> is emitted.
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.is-writable-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">The results of this
function are cached. See <span class="function"><a href="function.clearstatcache.html" class="function">clearstatcache()</a></span> for
more details.</span></p></blockquote>
<div class="tip"><strong class="tip">Tip</strong><p class="simpara">As of PHP 5.0.0, this function
can also be used with <em class="emphasis">some</em> URL wrappers. Refer to
<a href="wrappers.html" class="xref">Supported Protocols and Wrappers</a> to determine which wrappers support
<span class="function"><a href="function.stat.html" class="function">stat()</a></span> family of functionality.</p></div>
</div>
<div class="refsect1 seealso" id="refsect1-function.is-writable-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.is-readable.html" class="function" rel="rdfs-seeAlso">is_readable()</a> - Tells whether a file exists and is readable</span></li>
<li class="member"> <span class="function"><a href="function.file-exists.html" class="function" rel="rdfs-seeAlso">file_exists()</a> - Checks whether a file or directory exists</span></li>
<li class="member"> <span class="function"><a href="function.fwrite.html" class="function" rel="rdfs-seeAlso">fwrite()</a> - Binary-safe file write</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.is-uploaded-file.html">is_uploaded_file</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.is-writeable.html">is_writeable</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>
