<!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>Escape a string for use in an LDAP filter or DN</title> </head> <body><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ldap-error.html">ldap_error</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ldap-exop-passwd.html">ldap_exop_passwd</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-escape" class="refentry"> <div class="refnamediv"> <h1 class="refname">ldap_escape</h1> <p class="verinfo">(PHP 5 >= 5.6.0, PHP 7)</p><p class="refpurpose"><span class="refname">ldap_escape</span> — <span class="dc-title">Escape a string for use in an LDAP filter or DN</span></p> </div> <div class="refsect1 description" id="refsect1-function.ldap-escape-description"> <h3 class="title">Description</h3> <div class="methodsynopsis dc-description"> <span class="type">string</span> <span class="methodname"><strong>ldap_escape</strong></span> ( <span class="methodparam"><span class="type">string</span> <code class="parameter">$value</code></span> [, <span class="methodparam"><span class="type">string</span> <code class="parameter">$ignore</code></span> [, <span class="methodparam"><span class="type">int</span> <code class="parameter">$flags</code></span> ]] )</div> <p class="para rdfs-comment"> Escapes <code class="parameter">value</code> for use in the context implied by <code class="parameter">flags</code>. </p> </div> <div class="refsect1 parameters" id="refsect1-function.ldap-escape-parameters"> <h3 class="title">Parameters</h3> <p class="para"> <dl> <dt> <code class="parameter">value</code></dt> <dd> <p class="para"> The value to escape. </p> </dd> <dt> <code class="parameter">ignore</code></dt> <dd> <p class="para"> Characters to ignore when escaping. </p> </dd> <dt> <code class="parameter">flags</code></dt> <dd> <p class="para"> The context the escaped string will be used in: <strong><code>LDAP_ESCAPE_FILTER</code></strong> for filters to be used with <span class="function"><a href="function.ldap-search.html" class="function">ldap_search()</a></span>, or <strong><code>LDAP_ESCAPE_DN</code></strong> for DNs. </p> </dd> </dl> </p> </div> <div class="refsect1 returnvalues" id="refsect1-function.ldap-escape-returnvalues"> <h3 class="title">Return Values</h3> <p class="para"> Returns the escaped string. </p> </div> </div><hr /><div class="manualnavbar" style="text-align: center;"> <div class="prev" style="text-align: left; float: left;"><a href="function.ldap-error.html">ldap_error</a></div> <div class="next" style="text-align: right; float: right;"><a href="function.ldap-exop-passwd.html">ldap_exop_passwd</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>