<!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>Delete a file</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="streamwrapper.stream-write.html">streamWrapper::stream_write</a></div> <div class="next" style="text-align: right; float: right;"><a href="streamwrapper.url-stat.html">streamWrapper::url_stat</a></div> <div class="up"><a href="class.streamwrapper.html">streamWrapper</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div><hr /><div id="streamwrapper.unlink" class="refentry"> <div class="refnamediv"> <h1 class="refname">streamWrapper::unlink</h1> <p class="verinfo">(PHP 5)</p><p class="refpurpose"><span class="refname">streamWrapper::unlink</span> — <span class="dc-title">Delete a file</span></p> </div> <div class="refsect1 description" id="refsect1-streamwrapper.unlink-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="modifier">public</span> <span class="type">bool</span> <span class="methodname"><strong>streamWrapper::unlink</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$path</code></span> )</div> <p class="para rdfs-comment"> This method is called in response to <span class="function"><a href="function.unlink.html" class="function">unlink()</a></span>. </p> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para"> In order for the appropriate error message to be returned this method should <em class="emphasis">not</em> be defined if the wrapper does not support removing files. </p> </p></blockquote> </div> <div class="refsect1 parameters" id="refsect1-streamwrapper.unlink-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"> The file URL which should be deleted. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-streamwrapper.unlink-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns <strong><code>TRUE</code></strong> on success or <strong><code>FALSE</code></strong> on failure. </p> </div> <div class="refsect1 errors" id="refsect1-streamwrapper.unlink-errors"> <h3 class="title">Errors/Exceptions</h3> <p class="para">Emits <strong><code>E_WARNING</code></strong> if call to this method fails (i.e. not implemented).</p> </div> <div class="refsect1 notes" id="refsect1-streamwrapper.unlink-notes"> <h3 class="title">Notes</h3> <blockquote class="note"><p><strong class="note">Note</strong>: <p class="para">The <var class="varname"><var class="varname">streamWrapper::$context</var></var> property is updated if a valid context is passed to the caller function.</p></p></blockquote> </div> <div class="refsect1 seealso" id="refsect1-streamwrapper.unlink-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.unlink.html" class="function" rel="rdfs-seeAlso">unlink()</a> - Deletes a file</span></li> <li class="member"> <span class="methodname"><a href="streamwrapper.rmdir.html" class="methodname" rel="rdfs-seeAlso">streamWrapper::rmdir()</a> - Removes a directory</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="streamwrapper.stream-write.html">streamWrapper::stream_write</a></div> <div class="next" style="text-align: right; float: right;"><a href="streamwrapper.url-stat.html">streamWrapper::url_stat</a></div> <div class="up"><a href="class.streamwrapper.html">streamWrapper</a></div> <div class="home"><a href="index.html">PHP Manual</a></div> </div></body></html>