<!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 available space on filesystem or disk partition</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.dirname.html">dirname</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.disk-total-space.html">disk_total_space</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.disk-free-space" class="refentry"> <div class="refnamediv"> <h1 class="refname">disk_free_space</h1> <p class="verinfo">(PHP 4 >= 4.1.0, PHP 5)</p><p class="refpurpose"><span class="refname">disk_free_space</span> — <span class="dc-title">Returns available space on filesystem or disk partition</span></p> </div> <div class="refsect1 description" id="refsect1-function.disk-free-space-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">float</span> <span class="methodname"><strong>disk_free_space</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$directory</code></span> )</div> <p class="para rdfs-comment"> Given a string containing a directory, this function will return the number of bytes available on the corresponding filesystem or disk partition. </p> </div> <div class="refsect1 parameters" id="refsect1-function.disk-free-space-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">directory</code></em></span> <dd> <p class="para"> A directory of the filesystem or disk partition. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> Given a file name instead of a directory, the behaviour of the function is unspecified and may differ between operating systems and PHP versions. </p> </p></blockquote> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.disk-free-space-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the number of available bytes as a float or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 examples" id="refsect1-function.disk-free-space-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2354"> <p><strong>Example #1 <span class="function"><strong>disk_free_space()</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: #FF8000">// $df contains the number of bytes available on "/"<br /></span><span style="color: #0000BB">$df </span><span style="color: #007700">= </span><span style="color: #0000BB">disk_free_space</span><span style="color: #007700">(</span><span style="color: #DD0000">"/"</span><span style="color: #007700">);<br /><br /></span><span style="color: #FF8000">// On Windows:<br /></span><span style="color: #0000BB">$df_c </span><span style="color: #007700">= </span><span style="color: #0000BB">disk_free_space</span><span style="color: #007700">(</span><span style="color: #DD0000">"C:"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$df_d </span><span style="color: #007700">= </span><span style="color: #0000BB">disk_free_space</span><span style="color: #007700">(</span><span style="color: #DD0000">"D:"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span> </span> </code></div> </div> </div> </p> </div> <div class="refsect1 notes" id="refsect1-function.disk-free-space-notes"> <h3 class="title">Notes</h3> <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">This function will not work on <a href="features.remote-files.html" class="link">remote files</a> as the file to be examined must be accessible via the server's filesystem.</span></p></blockquote> </div> <div class="refsect1 seealso" id="refsect1-function.disk-free-space-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.disk-total-space.html" class="function" rel="rdfs-seeAlso">disk_total_space()</a> - Returns the total size of a filesystem or disk partition</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.dirname.html">dirname</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.disk-total-space.html">disk_total_space</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>