<!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>Modify the name of an entry</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ldap-read.html">ldap_read</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-sasl-bind.html">ldap_sasl_bind</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.ldap-rename" class="refentry">
<div class="refnamediv">
<h1 class="refname">ldap_rename</h1>
<p class="verinfo">(PHP 4 >= 4.0.5, PHP 5)</p><p class="refpurpose"><span class="refname">ldap_rename</span> — <span class="dc-title">Modify the name of an entry</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ldap-rename-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">bool</span> <span class="methodname"><strong>ldap_rename</strong></span>
( <span class="methodparam"><span class="type">resource</span> <code class="parameter">$link_identifier</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$dn</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$newrdn</code></span>
, <span class="methodparam"><span class="type">string</span> <code class="parameter">$newparent</code></span>
, <span class="methodparam"><span class="type">bool</span> <code class="parameter">$deleteoldrdn</code></span>
)</div>
<p class="para rdfs-comment">
The entry specified by <em><code class="parameter">dn</code></em> is renamed/moved.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ldap-rename-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">link_identifier</code></em></span>
<dd>
<p class="para">
An LDAP link identifier, returned by <span class="function"><a href="function.ldap-connect.html" class="function">ldap_connect()</a></span>.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">dn</code></em></span>
<dd>
<p class="para">
The distinguished name of an LDAP entity.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">newrdn</code></em></span>
<dd>
<p class="para">
The new RDN.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">newparent</code></em></span>
<dd>
<p class="para">
The new parent/superior entry.
</p>
</dd>
</dt>
<dt>
<span class="term"><em><code class="parameter">deleteoldrdn</code></em></span>
<dd>
<p class="para">
If <strong><code>TRUE</code></strong> the old RDN value(s) is removed, else the old RDN value(s)
is retained as non-distinguished values of the entry.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ldap-rename-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 notes" id="refsect1-function.ldap-rename-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
This function currently only works with LDAPv3. You may have to use
<span class="function"><a href="function.ldap-set-option.html" class="function">ldap_set_option()</a></span> prior to binding to use LDAPv3. This
function is only available when using OpenLDAP 2.x.x OR Netscape
Directory SDK x.x.
</p>
</p></blockquote>
</div>
<div class="refsect1 seealso" id="refsect1-function.ldap-rename-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.ldap-modify.html" class="function" rel="rdfs-seeAlso">ldap_modify()</a> - Modify an LDAP entry</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.ldap-read.html">ldap_read</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ldap-sasl-bind.html">ldap_sasl_bind</a></div>
<div class="up"><a href="ref.ldap.html">LDAP Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
