<!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>Creates a symbolic link</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.stat.html">stat</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.tempnam.html">tempnam</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.symlink" class="refentry"> <div class="refnamediv"> <h1 class="refname">symlink</h1> <p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">symlink</span> — <span class="dc-title">Creates a symbolic link</span></p> </div> <div class="refsect1 description" id="refsect1-function.symlink-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">bool</span> <span class="methodname"><strong>symlink</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$target</code></span> , <span class="methodparam"><span class="type">string</span> <code class="parameter">$link</code></span> )</div> <p class="para rdfs-comment"> <span class="function"><strong>symlink()</strong></span> creates a symbolic link to the existing <em><code class="parameter">target</code></em> with the specified name <em><code class="parameter">link</code></em>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.symlink-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <span class="term"><em><code class="parameter">target</code></em></span> <dd> <p class="para"> Target of the link. </p> </dd> </dt> <dt> <span class="term"><em><code class="parameter">link</code></em></span> <dd> <p class="para"> The link name. </p> </dd> </dt> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.symlink-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 changelog" id="refsect1-function.symlink-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>5.3.0</td> <td> This function is now available on Windows platforms (Vista, Server 2008 or greater). </td> </tr> </tbody> </table> </p> </div> <div class="refsect1 examples" id="refsect1-function.symlink-examples"> <h3 class="title">Examples</h3> <p class="para"> <div class="example" id="example-2433"> <p><strong>Example #1 Create a symbolic link</strong></p> <div class="example-contents"> <div class="phpcode"><code><span style="color: #000000"> <span style="color: #0000BB"><?php<br />$target </span><span style="color: #007700">= </span><span style="color: #DD0000">'uploads.php'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$link </span><span style="color: #007700">= </span><span style="color: #DD0000">'uploads'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">symlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$target</span><span style="color: #007700">, </span><span style="color: #0000BB">$link</span><span style="color: #007700">);<br /><br />echo </span><span style="color: #0000BB">readlink</span><span style="color: #007700">(</span><span style="color: #0000BB">$link</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.symlink-notes"> <h3 class="title">Notes</h3> <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara"> Windows users should note that this function will only work if the system you run PHP from is Windows Vista/Windows Server 2008 or newer. Windows versions prior to that does not support symbolic links. </span> </p></blockquote> </div> <div class="refsect1 seealso" id="refsect1-function.symlink-seealso"> <h3 class="title">See Also</h3> <p class="para"> <ul class="simplelist"> <li class="member"> <span class="function"><a href="function.link.html" class="function" rel="rdfs-seeAlso">link()</a> - Create a hard link</span></li> <li class="member"> <span class="function"><a href="function.readlink.html" class="function" rel="rdfs-seeAlso">readlink()</a> - Returns the target of a symbolic link</span></li> <li class="member"> <span class="function"><a href="function.linkinfo.html" class="function" rel="rdfs-seeAlso">linkinfo()</a> - Gets information about a link</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.stat.html">stat</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.tempnam.html">tempnam</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>