From cce3db21a11236d935dc93d601897302a8e7afe8 Mon Sep 17 00:00:00 2001
From: Nuno Lopes <nlopess@php.net>
Date: Sun, 11 Feb 2007 19:48:34 +0000
Subject: [PATCH] fix bug #40395: document which chars are escaped when running
 with '/e' modifier

git-svn-id: https://svn.php.net/repository/phpdoc/en/trunk@229572 c90b9560-bf6c-de11-be94-00142212c4b1
---
 reference/pcre/functions/preg-replace.xml | 13 ++++++++++++-
 1 file changed, 12 insertions(+), 1 deletion(-)

diff --git a/reference/pcre/functions/preg-replace.xml b/reference/pcre/functions/preg-replace.xml
index 47849dd742..0ef9f6a748 100644
--- a/reference/pcre/functions/preg-replace.xml
+++ b/reference/pcre/functions/preg-replace.xml
@@ -1,5 +1,5 @@
 <?xml version="1.0" encoding="iso-8859-1"?>
-<!-- $Revision: 1.22 $ -->
+<!-- $Revision: 1.23 $ -->
 <refentry id="function.preg-replace">
  <refnamediv>
   <refname>preg_replace</refname>
@@ -83,6 +83,17 @@
        <literal>$1</literal> backreference, leaving the <literal>1</literal>
        as a literal.
       </para>
+      <para>
+       When using the <literal>e</literal> modifier, this function escapes
+       some characters (namely <literal>'</literal>, <literal>"</literal>,
+       <literal>\</literal> and NULL) in the strings that replace the
+       backreferences. This is done to ensure that no syntax errors arrise
+       from backreference usage with either single or double quotes (e.g.
+       <literal>'strlen(\'$1\')+strlen("$2")'</literal>). Make sure you are
+       aware of PHP's <link linkend="language.types.string">string
+       syntax</link> to know exactly how the interpreted string will look
+       like.
+      </para>
      </listitem>
     </varlistentry>
     <varlistentry>