Edit Report a Bug

    preg_replace

    (PHP 4, PHP 5, PHP 7, PHP 8)

    preg_replace — Realiza uma pesquisa por uma expressão regular e substitui

    Descrição

    preg_replace(
        string|array $pattern,
        string|array $replacement,
        string|array $subject,
        int $limit = -1,
        int &$count = null
    ): string|array|null

    Pesquisa subject por correspondências a pattern e substitui-as por replacement.

    Para procurar correspondência por uma string exata, e não por um padrão, considere usar str_replace() ou str_ireplace() no lugar desta função.

    Parâmetros

    pattern

    O padrão a ser pesquisado. Pode ser uma string ou um array com strings.

    Diversos modificadores PCRE também estão disponíveis.

    replacement

    A string ou array com strings para substituir. Se este parâmetro é uma string e o parâmetro pattern é um array, todos patterns vão ser substituídos por esta string. Se ambos pattern e replacement parâmetros são arrays, cada pattern vai ser substituído pelo seureplacement correspondente. Se houver menos elementos no replacement array do que no pattern array, qualquer pattern extra será substituído por uma string vazia.

    replacement pode conter referências na forma \n ou $n, com a última forma sendo a preferível. Cada referência desse tipo será substituída pelo texto capturado pelo n-ésimo padrão entre parentêses. n pode ser de 0 to 99, e \0 ou $0 referem-se ao texto correspondente ao padrão inteiro. Parênteses de abertura são contados da esquerda para direita (iniciando em 1) para obter o número do sub-padrão de captura. Note que barra invertida em strings literais podem precisar ser escapados.

    Quando se trabalha com uma padrão de substituição, onde a referência passada é imediatamente seguida por outro número (isto é, inserido um número literal imediatamente após um padrão correspondente), não se pode usar a habitual notação \1 para a referência passada. \11, por exemplo, iria confundir a função preg_replace() pois ela não saberá se o desejado é a referência \1 seguida por um literal 1, ou a referência \11 seguida por nada. Neste caso, a solução é usar ${1}1. Isto cria uma referência $1 isolada, deixando o 1 como um literal.

    Ao usar o modificador e que está defasado, esta função escapa alguns caracteres (nomeadamente ', ", \ e NULL) nas strings que substituem as referências passadas. Isto é feito para garantir que nenhum erro de sintaxe surja de uso de referência passada com aspas simples ou duplas (por exemplo, 'strlen(\'$1\')+strlen("$2")'). Certifique-se de estar ciente da sintaxe string do PHP para ter uma visão exata de como será a string interpretada.

    subject

    String ou um array com strings para pesquisar e substituir.

    Se subject é um array, então a pesquisa e a substituição são executadas em cada entrada do subject, e o valor de retorno é um array também.

    Se o array subject for associativo, as chaves são preservadas no valor de retorno.

    limit

    O máximo possível de substituições para cada padrão em cada string de subject. O padrão é -1 (sem limite).

    count

    Se especificada, essa variável será preenchida com o número de substiuições realizadas.

    Valor Retornado

    preg_replace() retorna um array se o parâmetro subject é um array, caso contrário retorna uma string.

    Se correspondências forem encontradas, o novo subject será devolvido, caso contrário subject será devolvido inalterado ou null se um erro ocorreu.

    Erros/Exceções

    Usar o modificador "\e" é um erro; um erro de nível E_WARNING é emitido neste caso.

    Se o padrão de expressão regular passado não for compilado para uma expressão regular válida, um E_WARNING será emitido.

    Exemplos

    Exemplo #1 Usando referências passadas seguidas por literais numéricos

    <?php
    $string     = 'April 15, 2003';
    $pattern = '/(\w+) (\d+), (\d+)/i';
    $replacement = '${1}1,$3';
    echo     preg_replace($pattern, $replacement, $string);
    ?>

    O exemplo acima produzirá:

    April1,2003

    Exemplo #2 Usando array indexados com preg_replace()

    <?php
    $string     = 'The quick brown fox jumped over the lazy dog.';
    $patterns = array();
    $patterns[0] = '/quick/';
    $patterns[1] = '/brown/';
    $patterns[2] = '/fox/';
    $replacements = array();
    $replacements[2] = 'bear';
    $replacements[1] = 'black';
    $replacements[0] = 'slow';
    echo     preg_replace($patterns, $replacements, $string);
    ?>

    O exemplo acima produzirá:

    The bear black slow jumped over the lazy dog.

    Ao ordenar padrões e substituições com ksort, obtém-se o desejado.

    <?php
    ksort    ($patterns);
    ksort($replacements);
    echo     preg_replace($patterns, $replacements, $string);
    ?>

    O exemplo acima produzirá:

    The slow black bear jumped over the lazy dog.

    Exemplo #3 Substituindo vários valores

    <?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');
    ?>

    O exemplo acima produzirá:

    $startDate = 5/27/1999

    Exemplo #4 Removendo espaços

    Este exemplo retira o excesso de espaçoes em branco de uma string.

    <?php
    $str     = 'foo o';
    $str = preg_replace('/\s\s+/', ' ', $str);
    // This will be 'foo o' now
    echo $str;
    ?>

    Exemplo #5 Usando o parâmetro count

    <?php
    $count     = 0;

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

    O exemplo acima produzirá:

    xp***to
3

    Notas

    Nota:

    Ao usar arrays com pattern e replacement, as chaves são processadas na ordem que aparecem no array. Isto não é necessariamente o mesmo que a ordem de índice numérico. Se é feito o uso dos índices para indentificar qual pattern deve ser substituído por qual replacement, é necessário executar a função ksort() em cada array antes de chamar a função preg_replace().

    Nota:

    Quando ambos pattern e replacement forem arrays, as regras de correspondência irão operar sequancialmente. Isto é, o segundo par pattern/replacement irá operar na string que resulta do primeiro par pattern/replacement, e não da string original. Se for desejado simular substituições operando em paralelo, como inversão de dois valores, substitua um padrão por uma referência intermediária, e então em um par posterior substitua a referência intermediária pelo substituto desejado.

    <?php
    $p     = array('/a/', '/b/', '/c/');
    $r = array('b', 'c', 'd');
    print_r(preg_replace($p, $r, 'a'));
    // prints d
    ?>

    Veja Também

    add a note add a note

    User Contributed Notes 9 notes

    up
    766
    arkani at iol dot pt
    15 years ago
    Because i search a lot 4 this:

    The following should be escaped if you are trying to match that character

    \ ^ . $ | ( ) [ ]
    * + ? { } ,

    Special Character Definitions
    \ Quote the next metacharacter
    ^ Match the beginning of the line
    . Match any character (except newline)
    $ Match the end of the line (or before newline at the end)
    | Alternation
    () Grouping
    [] Character class
    * Match 0 or more times
    + Match 1 or more times
    ? Match 1 or 0 times
    {n} Match exactly n times
    {n,} Match at least n times
    {n,m} Match at least n but not more than m times
    More Special Character Stuff
    \t tab (HT, TAB)
    \n newline (LF, NL)
    \r return (CR)
    \f form feed (FF)
    \a alarm (bell) (BEL)
    \e escape (think troff) (ESC)
    \033 octal char (think of a PDP-11)
    \x1B hex char
    \c[ control char
    \l lowercase next char (think vi)
    \u uppercase next char (think vi)
    \L lowercase till \E (think vi)
    \U uppercase till \E (think vi)
    \E end case modification (think vi)
    \Q quote (disable) pattern metacharacters till \E
    Even More Special Characters
    \w Match a "word" character (alphanumeric plus "_")
    \W Match a non-word character
    \s Match a whitespace character
    \S Match a non-whitespace character
    \d Match a digit character
    \D Match a non-digit character
    \b Match a word boundary
    \B Match a non-(word boundary)
    \A Match only at beginning of string
    \Z Match only at end of string, or before newline at the end
    \z Match only at end of string
    \G Match only where previous m//g left off (works only with /g)
    up
    4
    nik at rolls dot cc
    11 years ago
    To split Pascal/CamelCase into Title Case (for example, converting descriptive class names for use in human-readable frontends), you can use the below function:

    <?php
    function expandCamelCase($source) {
      return     preg_replace('/(?<!^)([A-Z][a-z]|(?<=[a-z])[^a-z]|(?<=[A-Z])[0-9_])/', ' $1', $source);
    }
    ?>

    Before:
      ExpandCamelCaseAPIDescriptorPHP5_3_4Version3_21Beta
    After:
      Expand Camel Case API Descriptor PHP 5_3_4 Version 3_21 Beta
    up
    1
    bublifuk at mailinator dot com
    6 years ago
    A delimiter can be any ASCII non-alphanumeric, non-backslash, non-whitespace character:  !"#$%&'*+,./:;=?@^_`|~-  and  ({[<>]})
    up
    1
    ismith at nojunk dot motorola dot com
    17 years ago
    Be aware that when using the "/u" modifier, if your input text contains any bad UTF-8 code sequences, then preg_replace will return an empty string, regardless of whether there were any matches.

    This is due to the PCRE library returning an error code if the string contains bad UTF-8.
    up
    1
    php-comments-REMOVE dot ME at dotancohen dot com
    16 years ago
    Below is a function for converting Hebrew final characters to their
    normal equivelants should they appear in the middle of a word.
    The /b argument does not treat Hebrew letters as part of a word,
    so I had to work around that limitation.

    <?php

    $text    ="עברית מבולגנת";

    function     hebrewNotWordEndSwitch ($from, $to, $text) {
           $text=
            preg_replace('/'.$from.'([א-ת])/u','$2'.$to.'$1',$text);
       return     $text;
    }

    do {
           $text_before=$text;
           $text=hebrewNotWordEndSwitch("ך","כ",$text);
           $text=hebrewNotWordEndSwitch("ם","מ",$text);
           $text=hebrewNotWordEndSwitch("ן","נ",$text);
           $text=hebrewNotWordEndSwitch("ף","פ",$text);
           $text=hebrewNotWordEndSwitch("ץ","צ",$text);
    }   while (     $text_before!=$text );

    print     $text; // עברית מסודרת!

    ?>

    The do-while is necessary for multiple instances of letters, such
    as "אנני" which would start off as "אןןי". Note that there's still the
    problem of acronyms with gershiim but that's not a difficult one
    to solve. The code is in use at http://gibberish.co.il which you can
    use to translate wrongly-encoded Hebrew, transliterize, and some
    other Hebrew-related functions.

    To ensure that there will be no regular characters at the end of a
    word, just convert all regular characters to their final forms, then
    run this function. Enjoy!
    up
    0
    me at perochak dot com
    13 years ago
    If you would like to remove a tag along with the text inside it then use the following code.

    <?php
    preg_replace    ('/(<tag>.+?)+(<\/tag>)/i', '', $string);
    ?>

    example
    <?php $string='<span class="normalprice">55 PKR</span>'; ?>

    <?php
    $string     = preg_replace('/(<span class="normalprice">.+?)+(<\/span>)/i', '', $string);
    ?>

    This will results a null or empty string.

    <?php
    $string    ='My String <span class="normalprice">55 PKR</span>';

    $string = preg_replace('/(<span class="normalprice">.+?)+(<\/span>)/i', '', $string);
    ?>

    This will results a " My String"
    up
    -1
    sternkinder at gmail dot com
    17 years ago
    From what I can see, the problem is, that if you go straight and substitute all 'A's wit 'T's you can't tell for sure which 'T's to substitute with 'A's afterwards. This can be for instance solved by simply replacing all 'A's by another character (for instance '_' or whatever you like), then replacing all 'T's by 'A's, and then replacing all '_'s (or whatever character you chose) by 'A's:

    <?php
    $dna     = "AGTCTGCCCTAG";
    echo     str_replace(array("A","G","C","T","_","-"), array("_","-","G","A","T","C"), $dna); //output will be TCAGACGGGATC
    ?>

    Although I don't know how transliteration in perl works (though I remember that is kind of similar to the UNIX command "tr") I would suggest following function for "switching" single chars:

    <?php
    function switch_chars($subject,$switch_table,$unused_char="_") {
        foreach (     $switch_table as $_1 => $_2 ) {
                $subject = str_replace($_1,$unused_char,$subject);
                $subject = str_replace($_2,$_1,$subject);
                $subject = str_replace($unused_char,$_2,$subject);
        }
        return     $subject;
    }

    echo     switch_chars("AGTCTGCCCTAG", array("A"=>"T","G"=>"C")); //output will be TCAGACGGGATC
    ?>
    up
    -1
    mail at johanvandemerwe dot nl
    4 years ago
    Sample for replacing bracketed short-codes

    The used short-codes are purely used for educational purposes for they could be shorter as in 'italic' to 'i' or 'bold' to 'b'.

    Sample text
    ----
    This sample shows how to have [italic]italic[/italic], [bold]bold[/bold] and [underline]underlined[/underline] and [strikethrough]striked[/striketrhough] text.

    with this function:

    <?php
    function textDecoration($html)
    {
            $patterns = [
                '/\[(italic)\].*?\[\/\1\] ?/',
                '/\[(bold)\].*?\[\/\1\] ?/',
                '/\[(underline)\].*?\[\/\1\] ?/'
            ];

            $replacements = [
                '<i>$1</i>',
                '<strong>$1</strong>',
                '<u>$1</u>'
            ];

        return     preg_replace($patterns, $replacements, $html);
    }

    $html = textDecoration($html);

    echo     $html; // or return
    ?>

    results in:
    ----
    This sample shows how to have <i>italic</i>, <b>bold</b> and <u>underlined</u> and [strikethrough]striked[/striketrhough] text.

    Notice!
    There is no [strikethrough]striked[/striketrhough] fallback in the patterns and replacements array
    up
    -3
    razvan_bc at yahoo dot com
    2 years ago
    How to replace all comments inside code without remove crln  = \r\n or cr \r each line?

    <?php
    $txt_target    =<<<t1
    this;//    dsdsds
        nope
       
    /*
        ok
        */
    is;huge
    /*text bla*/
        /*bla*/

    t1;

    /*
    =======================================================================
    expected result:
    =======================================================================
    this;
        nope

    is;huge
    =======================================================================
    visualizing in a hex viewer .. to_check_with_a_hex_viewer.txt ...
    t  h  i  s  ; LF TAB n  o  p  e CR LF CR LF  i  s  ;  h  u  g  e CR LF
    74 68 69 73 3b 0a 09 6e 6f 70 65 0d 0a 0d 0a 69 73 3b 68 75 67 65 0d 0a
    I used F3 (viewer + options 3: hex) in mythical TOTAL COMMANDER!
    =======================================================================
    */

    echo '<hr><pre>';
    echo      $txt_target;
    echo     '</pre>';

    //  a single line '//' comments
    $txt_target = preg_replace('![ \t]*//.*[ \t]*!', '', $txt_target);

    //  /* comment */
    $txt_target = preg_replace('/\/\*([^\/]*)\*\/(\s+)/smi', '', $txt_target);
    echo     '<hr><pre>';
    echo      $txt_target;
    echo     '</pre><hr>';

    file_put_contents('to_check_with_a_hex_viewer.txt',$txt_target);

    ?>
    add a note add a note
    To Top