<!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>Perform a regular expression search and replace using callbacks</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.preg-quote.html">preg_quote</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.preg-replace-callback.html">preg_replace_callback</a></div>
<div class="up"><a href="ref.pcre.html">PCRE Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.preg-replace-callback-array" class="refentry">
<div class="refnamediv">
<h1 class="refname">preg_replace_callback_array</h1>
<p class="verinfo">(PHP 7)</p><p class="refpurpose"><span class="refname">preg_replace_callback_array</span> — <span class="dc-title">Perform a regular expression search and replace using callbacks</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.preg-replace-callback-array-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <span class="methodname"><strong>preg_replace_callback_array</strong></span>
( <span class="methodparam"><span class="type">array</span> <code class="parameter">$patterns_and_callbacks</code></span>
, <span class="methodparam"><span class="type"><a href="language.pseudo-types.html#language.types.mixed" class="type mixed">mixed</a></span> <code class="parameter">$subject</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter">$limit</code><span class="initializer"> = -1</span></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$count</code></span>
]] )</div>
<p class="para rdfs-comment">
The behavior of this function is similar to
<span class="function"><a href="function.preg-replace-callback.html" class="function">preg_replace_callback()</a></span>, except that callbacks are
executed on a per-pattern basis.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.preg-replace-callback-array-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">patterns_and_callbacks</code></dt>
<dd>
<p class="para">
An associative array mapping patterns (keys) to callbacks (values).
</p>
</dd>
<dt>
<code class="parameter">subject</code></dt>
<dd>
<p class="para">
The string or an array with strings to search and replace.
</p>
</dd>
<dt>
<code class="parameter">limit</code></dt>
<dd>
<p class="para">
The maximum possible replacements for each pattern in each
<code class="parameter">subject</code> string. Defaults to
<em>-1</em> (no limit).
</p>
</dd>
<dt>
<code class="parameter">count</code></dt>
<dd>
<p class="para">
If specified, this variable will be filled with the number of
replacements done.
</p>
</dd>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.preg-replace-callback-array-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
<span class="function"><strong>preg_replace_callback_array()</strong></span> returns an array if the
<code class="parameter">subject</code> parameter is an array, or a string
otherwise. On errors the return value is <strong><code>NULL</code></strong>
</p>
<p class="para">
If matches are found, the new subject will be returned, otherwise
<code class="parameter">subject</code> will be returned unchanged.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.preg-replace-callback-array-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-5995">
<p><strong>Example #1 <span class="function"><strong>preg_replace_callback_array()</strong></span> example</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br />$subject </span><span style="color: #007700">= </span><span style="color: #DD0000">'Aaaaaa Bbb'</span><span style="color: #007700">;<br /><br /></span><span style="color: #0000BB">preg_replace_callback_array</span><span style="color: #007700">(<br /> [<br /> </span><span style="color: #DD0000">'~[a]+~i' </span><span style="color: #007700">=> function (</span><span style="color: #0000BB">$match</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$match</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]), </span><span style="color: #DD0000">' matches for "a" found'</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /> },<br /> </span><span style="color: #DD0000">'~[b]+~i' </span><span style="color: #007700">=> function (</span><span style="color: #0000BB">$match</span><span style="color: #007700">) {<br /> echo </span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$match</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]), </span><span style="color: #DD0000">' matches for "b" found'</span><span style="color: #007700">, </span><span style="color: #0000BB">PHP_EOL</span><span style="color: #007700">;<br /> }<br /> ],<br /> </span><span style="color: #0000BB">$subject<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
6 matches for "a" found
3 matches for "b" found
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.preg-replace-callback-array-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="pcre.pattern.html" class="link">PCRE Patterns</a></li>
<li class="member"><span class="function"><a href="function.preg-replace-callback.html" class="function" rel="rdfs-seeAlso">preg_replace_callback()</a> - Perform a regular expression search and replace using a callback</span></li>
<li class="member"><span class="function"><a href="function.preg-quote.html" class="function" rel="rdfs-seeAlso">preg_quote()</a> - Quote regular expression characters</span></li>
<li class="member"><span class="function"><a href="function.preg-replace.html" class="function" rel="rdfs-seeAlso">preg_replace()</a> - Perform a regular expression search and replace</span></li>
<li class="member"><span class="function"><a href="function.preg-last-error.html" class="function" rel="rdfs-seeAlso">preg_last_error()</a> - Returns the error code of the last PCRE regex execution</span></li>
<li class="member"><a href="functions.anonymous.html" class="link">Anonymous functions</a></li>
<li class="member">information about the <a href="language.pseudo-types.html#language.types.callback" class="link">callback</a> type</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.preg-quote.html">preg_quote</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.preg-replace-callback.html">preg_replace_callback</a></div>
<div class="up"><a href="ref.pcre.html">PCRE Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
