preg_replace

Description

preg_replace() analyse subject pour trouver l'expression rationnelle pattern et remplace les résultats par replacement. Si limit est spécifié, alors uniquement limit résultats seront remplacés; si limit est omis ou vaut -1, alors tous les résultats seront remplacés.

replacement peut contenir des références de la forme \\n ou, (depuis PHP 4.0.4) $n. Cette dernière forme est recommandée. Ces références seront remplacées par le texte capturé par la n-ième parenthèse capturante du masque. n peut prendre des valeurs de 0 à 99, et \\0 ou $0, correspondent au texte de qui satisfait le masque complet. Les parenthèses ouvrantes sont comptées de gauche à droite (en commençant à 1) pour déterminer le numéro de parenthèse capturante.

Lorsque vous travaillez avec un pattern de remplacement où une référence arrière est directement suivi par un nombre (i.e.: placer un nombre littéral immédiatement après une référence arrière), vous ne pouvez pas utiliser la syntaxe classique \\1 pour la référence arrière. \\11, par exemple, sera confus pour la fonction preg_replace() dans le sens où elle ne saura pas si vous désirez la référence arrière \\1 suivi du nombre 1 ou si vous désirez la référence arrière \\11 suivi de "rien". Dans ce cas, la solution est d'utiliser la syntaxe \${1}1. Cela créera une référence arrière isolée $1, suivi du nombre litéral 1.

Exemple 1. Utilisation des références arrières avec des littéraux numériques <?php $string = "April 15, 2003"; $pattern = "/(\w+) (\d+), (\d+)/i"; $replacement = "\${1}1,\$3"; echo preg_replace($pattern, $replacement, $string); ?> L'exemple ci-dessus va afficher : April1,2003

Si la recherche n'aboutit à aucun résultat, subject sera inchangé.

Tous les paramètres de preg_replace(), excepté la paramètre limit, peuvent être des tableaux. Lorsque vous utilisez des tableaux avec les paramètres pattern et replacement, les clés sont traitées dans l'ordre dans lesquelles elles apparaissent dans le tableau. Ce n'est pas forcément la même chose que l'ordre des index numérique. Si vous utilisez des index pour identifier quel pattern doit être replacée par quel replacement, il est recommandé de faire un tri ksort() sur chaque tableau avant de faire appel à preg_replace().

Exemple 2. Utilisation de tableaux indexé avec preg_replace() <?php $string = "The quick brown fox jumped over the lazy dog."; $patterns[0] = "/quick/"; $patterns[1] = "/brown/"; $patterns[2] = "/fox/"; $replacements[2] = "bear"; $replacements[1] = "black"; $replacements[0] = "slow"; echo preg_replace($patterns, $replacements, $string); ?> L'exemple ci-dessus va afficher : The bear black slow jumped over the lazy dog. En triant les pattern et les remplacements, vous devriez obtenir le résultat escompté. <?php ksort($patterns); ksort($replacements); echo preg_replace($patterns, $replacements, $string); ?> L'exemple ci-dessus va afficher : The slow black bear jumped over the lazy dog.

Si subject est un tableau, alors l'opération sera appliquée à chacun des éléments du tableau, et le tableau sera retourné.

Si pattern et replacement sont des tableaux, alors preg_replace() prend une valeur de chaque tableau, et l'utilise pour faire la recherche et le remplacement. Si replacement à moins d'éléments que pattern, alors la chaîne vide est utilisé pour le reste des valeurs. Si pattern est un tableau, et que replacement est une chaîne, alors cette chaîne sera utilisée pour chaque valeur de pattern. Le contraire n'aurait pas de sens.

/e force preg_replace() à traiter replacement comme du code PHP une fois que les substitutions adéquates ont été faîtes. Conseil : assurez-vous que replacement est un code PHP valide, car sinon, PHP trouvera une erreur d'analyse dans cette ligne.

/F indique que le paramètre replacement doit être considéré comme un nom de fonction. Cette fonction sera appelée, avec un tableau contenant les éléments trouvés comme arguments. La fonction doit retourner la chaîne de remplacement. Cette option a été ajoutée en PHP 4.0.4.

Exemple 3. Remplacement de plusieurs valeurs simultanément <?php $patterns = array ("/(19|20)(\d{2})-(\d{1,2})-(\d{1,2})/",                    "/^\s*{(\w+)}\s*=/"); $replace = array ("\\3/\\4/\\1\\2", "$\\1 ="); echo preg_replace($patterns, $replace, "{startDate} = 1999-5-27"); ?> L'exemple ci-dessus va afficher : $startDate = 5/27/1999

Exemple 4. Utilisation de l'option /e <?php preg_replace("/(<\/?)(\w+)([^>]*>)/e",               "'\\1'.strtoupper('\\2').'\\3'",               $html_body); ?> Cela va mettre en majuscule toutes les balises HTML du texte.

Exemple 5. Conversion HTML en texte <?php // $document contient un document HTML // Ce script va effacer les balises HTML, les javascript // et les espaces. Il remplace aussi quelques entités HTML // courante en leur équivalent texte. $search = array ("'<script[^>]*?>.*?</script>'si",  // Supprime le javascript                  "'<[\/\!]*?[^<>]*?>'si",                           // Supprime les balises HTML                  "'([\r\n])[\s]+'",                                      // Supprime les espaces                  "'&(quot|#34);'i",                                    // Supprime les entites HTML                  "'&(amp|#38);'i",                  "'&(lt|#60);'i",                  "'&(gt|#62);'i",                  "'&(nbsp|#160);'i",                  "'&(iexcl|#161);'i",                  "'&(cent|#162);'i",                  "'&(pound|#163);'i",                  "'&(copy|#169);'i",                  "'&#(\d+);'e");                                        // Evaluation comme PHP $replace = array ("",                   "",                   "\\1",                   "\"",                   "&",                   "<",                   ">",                   " ",                   chr(161),                   chr(162),                   chr(163),                   chr(169),                   "chr(\\1)"); $text = preg_replace($search, $replace, $document); ?>

Voir aussi preg_match(), preg_match_all() et preg_split().