Manuel PHP
Précédent |  | Suivant

# preg_replace

(PHP 3 >= 3.0.9, PHP 4, PHP 5)

preg_replace -- Rechercher et remplacer par expression rationnelle standard

## Description

mixed preg_replace ( mixed pattern, mixed replacement, mixed subject [, int limit [, int &count]] )

preg_replace() analyse `subject` pour trouver l'expression rationnelle `pattern` et remplace les résultats par `replacement`.

`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 masque de remplacement où une référence arrière est directement suivie 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`.

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

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

## Liste de paramètres

`pattern`

  Le masque à chercher. ll peut être soit une chaîne, soit un tableau de chaîne de caractères.

`replacement`

  La chaîne ou un tableau de chaînes pour le remplacement. Si ce paramètre est une chaîne et le paramètre `pattern` est un tableau, tous les masques seront remplacés par cette chaîne. Si les paramètres `pattern` et `replacement` sont des tableaux, chaque `pattern` sera remplacé son `replacement` associé. Si `replacement` à moins d'éléments que `pattern`, alors une chaîne vide est utilisée pour le reste des valeurs.

`subject`

  La chaîne ou le tableau de chaînes à chercher et à remplacer.

`limit`

  Le nombre maxmal de remplacement pour chaque masque dans chaque chaîne `subject`. Par défaut, vaut `-1` (aucune limite).

`count`

  Si spécifié, cete variable contiendra le nombre de remplacements effectués.

## Valeurs de retour

preg_replace() retourne un tableau si le paramètre `subject` est un tableau, ou une chaîne sinon.

Si des correspondances sont trouvées, le nouveau `subject` sera retourné, sinon `subject` sera retourné à l'identique.

## Historique

Version | Description
--- | ---
4.0.1pl2 | Ajout du paramètre `limit`
4.0.4 | Ajout de la forme '$n' pour le paramètre `replacement`
5.1.0 | Ajout du paramètre `count`

## Exemples

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

Exemple 2. Utilisation de tableaux indexé avec preg_replace()

`<?php $string = 'Le renard marron agile saute par dessus le chien paresseux.'; $patterns[0] = '/agile/'; $patterns[1] = '/marron/'; $patterns[2] = '/renard/'; $replacements[2] = 'grizzly'; $replacements[1] = 'brun'; $replacements[0] = 'lent'; echo preg_replace($patterns, $replacements, $string); ?>`

L'exemple ci-dessus va afficher :

    Le grizzly brun lent saute par dessus le chien paresseux.

En triant les masques 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 :

    Le lent grizzly brun saute par dessus le chien paresseux.

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. Suppression des espaces

Cet exemple supprime les espaces en trop dans une chaîne.

`<?php $str = 'foo o'; $str = preg_replace('/\s\s+/', ' ', $str); // Affichera 'foo o' echo $str; ?>`

Exemple 6. Utilisation du paramètre `count`

`<?php $count = 0; echo preg_replace(array('/\d/', '/\s/'), '*', 'xp 4 to', -1 , $count); echo $count; //3 ?>`

L'exemple ci-dessus va afficher :

    xp***to
    3

## Notes

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

## Voir aussi

preg_match()
preg_replace_callback()
preg_split()

Précédent | Sommaire | Suivant
preg_replace_callback | Niveau supérieur | preg_split