Last updated: Fri, 19 Jun 2009

preg_replace_callback

(PHP 4 >= 4.0.5, PHP 5)

preg_replace_callback — Sucht und ersetzt einen regulären Ausdruck unter Verwendung eines Callbacks

Beschreibung

mixed preg_replace_callback ( mixed $pattern , callback $callback , mixed $subject [, int $limit [, int &$count ]] )

Abgesehen von der Tatsache, dass statt des Parameters replacement ein callback angegeben werden soll, ist das Verhalten dieser Funktion identisch zu preg_replace().

Parameter-Liste

pattern

Der Ausdruck, nach dem gesucht werden soll. Es kann entweder eine Zeichenkette oder ein Array mit Zeichenketten sein.

callback

Ein Callback, dem ein Array von Übereinstimmungen mit subject übergeben wird. Der Callback sollte die Ersetzungs-Zeichenkette liefern.

Häufig werden Sie die callback -Funktion für preg_replace_callback() nur an einer Stelle benötigen. In diesem Fall können Sie create_function() verwenden, um innerhalb des Aufrufs von preg_replace_callback() eine anonyme Funktion als Callback zu deklarieren. Auf diese Weise haben Sie alle Informationen für den Aufruf an einer Stelle und stopfen den Namensraum für Funktionen nicht mit Namen für Callback-Funktionen voll, die sonst nirgends verwendet werden.

Beispiel #1 preg_replace_callback() und create_function()


<?php
// ein Kommandozeilen-Filter im Unix-Stil zum Umwandeln von Groß- in
// Kleinschreibung am Beginn eines Abschnitts
$fp = fopen("php://stdin", "r") or die("kann stdin nicht lesen");
while (!feof($fp)) {
  $zeile = fgets($fp);
  $zeile = preg_replace_callback(
    '|<p>\s*\w|',
    create_function(
      // hier sind entweder einfache Anführungszeichen nötig
      // oder alternativ die Maskierung aller $ als \$
      '$treffer',
      'return strtolower($treffer[0]);'
    ),
    $zeile
  );
  echo $zeile;
}
fclose($fp);
?>

subject

Die Zeichenkette oder ein Array mit Zeichenketten zum Suchen und Ersetzen.

limit

Die Höchstzahl der Ersetzungen für jedes Suchmuster in jeder subject . Standardmäßig -1 (unbegrenzt).

count

Falls angegeben, wird dieser Variable die Anzahl vorgenommener Ersetzungen zugewiesen.

Rückgabewerte

Falls subject ein Array ist, gibt preg_replace_callback() ein Array zurück und andernfalls eine Zeichenkette.

Falls Übereinstimmungen gefunden werden, wird die neue Zeichenkette zurückgegeben und andernfalls die unveränderte subject

Changelog

Version	Beschreibung
5.1.0	Den Parameter `count` hinzugefügt

Beispiele

Beispiel #2 preg_replace_callback() Beispiel


<?php
// dieser Text wurde 2002 verwendet
// wir wollen ihn für 2003 aktualisieren
$text = "Aprilscherze gibts am 01.04.2002\n";
$text.= "Das letzte Weihnachten war am 24.12.2001\n";
// die Callback-Funktion
function naechstes_jahr($treffer)
{
  // wie üblich: $treffer[0] ist die Übereinstimmung mit dem
  // kompletten Suchmuster, $treffer[1] die Übereinstimmung mit
  // dem ersten eingeklammerten Teilsuchmuster und so weiter
  return $treffer[1].($treffer[2]+1);
}
echo preg_replace_callback(
            "|(\d{2}\.\d{2}\.)(\d{4})|",
            "naechstes_jahr",
            $text);

?>

Das oben gezeigte Beispiel erzeugt folgende Ausgabe:

Aprilscherze gibts am 01.04.2003
Das letzte Weihnachten war am 24.12.2002

Beispiel #3 preg_replace_callback() unter Verwendung einer rekursiven Struktur um gekapselten BB-Code zu verarbeiten


<?php
$eingabe = "plain [indent] deep [indent] deeper [/indent] deep [/indent] plain";

function parseTagsRecursive($eingabe)
{
  $regex = '#\[indent]((?:[^[]|\[(?!/?indent])|(?R))+)\[/indent]#';

  if (is_array($eingabe)) {
    $eingabe = '<div style="margin-left: 10px">'.$eingabe[1].'</div>';
  }

  return preg_replace_callback($regex, 'parseTagsRecursive', $eingabe);
}

$ausgabe = parseTagsRecursive($eingabe);

echo $ausgabe;
?>

Siehe auch

preg_replace() - Sucht und ersetzt einen regulären Ausdruck
create_function() - Erzeugen einer anonymen / temporären (Lambda-Stil) Funktion
Informationen über den Callback-Typ

preg_replace

preg_quote

Last updated: Fri, 19 Jun 2009

add a note User Contributed Notes
preg_replace_callback

carlos dot ballesteros at softonic dot com
02-Jul-2009 05:02


A simple function to replace a list of complete words or terms in a string (for PHP 5.3 or above because of the closure):



<?php

function replace_words($list, $line, $callback) {

    return preg_replace_callback(

        '/(^|[^\\w\\-])(' . implode('|', array_map('preg_quote', $list)) . ')($|[^\\w\\-])/mi',

        function($v) use ($callback) { return $v[1] . $callback($v[2]) . $v[3]; },

        $line

    );

}

?>



Example of usage:

<?php

$list = array('php', 'apache web server');

$str = "php and the apache web server work fine together. php-gtk, for example, won't match. apache web servers shouldn't too.";



echo replace_words($list, $str, function($v) {

    return "<strong>{$v}</strong>";

});

?>

chris AT cmbuckley DOT co DOT uk
09-Jun-2009 04:44


This function does not support named subpatterns, so you can't do



<?php



preg_replace_callback('/(?<char>[a-z])/', 'callback', 'word');



function callback($matches) {

    var_dump($matches);

}



?>



and expect to get $matches['char'] in your function.

mariush
12-May-2009 10:17


If you're planning to use preg_replace_callback inside a class, you need to use the array() function:





<?php


class MyClass


{





  function preg_callback_url($matches)


  {


    //var_dump($matches);


    $url = $matches[1].$matches[2];


    $text = '';


    $pos = strpos($url,' ');


    if ($pos!==FALSE) {


      $text = trim(substr($url,$pos+1));


      $url = substr($url,0,$pos);


    }


    return '<a href="'.$url.'" rel="nofollow">'.(($text!='') ? $text : $url).'</a>';


  }





  function ParseText($text)


  {


    return preg_replace_callback('/\[(http|https|ftp)(.*?)\]/iS',array( &$this, 'preg_callback_url'), $text);


  }





}


?>

james dot records at gmail dot com
26-Apr-2009 09:22


This is what i use to read log files and do dns lookups on the ip's from the file.





<?php


function resolve_logs($arr) {


        return gethostbyaddr($arr[0]);


}





$logent=file('yourlogfile');





$ipaddr = '/\d{1,3}\.\d{1,3}\.\d{1,3}\.\d{1,3}/';


$logent = preg_replace_callback($ipaddr, resolve_logs, $logent);


?>

long2hu3 ATT yahoo DOTT com
02-Apr-2009 09:25


When you access variables from outside in a callback function, use the $global keyword:



<?php



// global # 1:

global $x;



$x = 0;

$str = '&Bla bla. &#x25ba;';



$find = '/(\&)([^#])/';



// global # 2:

$replace = create_function('$f',

    'global $x; $x ++; return $f[2];';



$str2 = preg_replace_callback($find, $replace, $str);



// $x == 1

// $str2 == 'Bla bla. &#x25ba;'

// without global, $x would be 0



?>

tijn at q-go dot com
06-Jan-2009 11:01


To access a local variable within a callback, use currying (delayed argument binding). For example

<?php

function curry($func, $arity) {

    return create_function('', "

        \$args = func_get_args();

        if(count(\$args) >= $arity)

            return call_user_func_array('$func', \$args);

        \$args = var_export(\$args, 1);

        return create_function('','

            \$a = func_get_args();

            \$z = ' . \$args . ';

            \$a = array_merge(\$z,\$a);

            return call_user_func_array(\'$func\', \$a);

        ');

    ");

}



function on_match($transformation, $matches)

{

    return $transformation[strtolower($matches[1])];

}



$transform = array('a' => 'Well,', 'd'=>'whatever', 'b'=>' ');



$callback = curry(on_match, 2);

echo preg_replace_callback('/([a-z])/i', $callback($transform), 'Abcd');



echo "\n";

?>



outputs:



"Well, whatever"



The magic lies in this curry function I found here: http://www.sitepoint.com/forums/showthread.php?threadid=336758

tijn at q-go dot com
05-Jan-2009 05:48


To access a local variable within a callback, use currying (delayed argument binding). For example

<?php

function curry($func, $arity) {

    return create_function('', "

        \$args = func_get_args();

        if(count(\$args) >= $arity)

            return call_user_func_array('$func', \$args);

        \$args = var_export(\$args, 1);

        return create_function('','

            \$a = func_get_args();

            \$z = ' . \$args . ';

            \$a = array_merge(\$z,\$a);

            return call_user_func_array(\'$func\', \$a);

        ');

    ");

}



function on_match($transformation, $matches)

{

    return $transformation[strtolower($matches[1])];

}



$transform = array('a' => 'Well,', 'd'=>'whatever', 'b'=>' ');



$callback = curry(on_match, 2);

echo preg_replace_callback('/([a-z])/i', $callback($transform), 'Abcd');



echo "\n";

?>



outputs:



"Well, whatever"



The magic lies in this curry function I found here: http://www.sitepoint.com/forums/showthread.php?threadid=336758

nicolaspar at gmail dot com
20-Dec-2008 03:33


To spend more than one parameter can do the following (note the "e" parameter in preg_replace function)

<?

$array = array(

1=>'ONE',

2=>'TWO',

3=>'Three'

);



function search(&$array, $str, $foo, $bar){

    return ( empty($array[$str]) ? '['.$foo.'-'.$bar.']' : $array[$str] );

}



function keys(&$array, $str,$foo,$bar){

    return preg_replace('/\[(.*?)\]/e',"search(\$array,$1,\$foo,\$bar)",$str);

}



$str = "One [1] Two [2] Three [3], Other parameter [22]";



echo keys($array, $str,'Foo','Bar');

?>

Nice

harrrrpo at gmail dot com
19-Sep-2008 09:59


The last example -nested BBCode- has a problem and won't work

it should be

<?php

  $regex = '#\[indent]((?:[^\[]|\[(?!/?indent])|(?R))+)\[/indent]#';

?>

([ should be escaped to be \[)



--

a nicer regex i used in a BBCode parser  (BBEngine http://www.phpclasses.org/browse/package/4829.html)

This one Captures Tag Arguments ,Empty tags and 

also uses ?> for performance , wrapped in a simple function for templating (ofcourse it's one line but note's line size is limited :) )

<?php

     /**

     * A Template for the recursive tags matcher RE

     * it generates it for a given tag ,open bracket and closing one

     * $O & $C must be pre-escaped from #'s

     * @param String $tag Tag to be parsed recursively

     * @param String $O   Opeening brackets of tag

     * @param String $C   Closing brackets of tag

     */

    public function Recursive_RE_Generator($tag,$O,$C)

    {

       $re="#{$O}({$tag}.*?){$C}((?>{$O}(?!/?{$tag}[^{$O}]*?{$C})|

[^{$O}]|(?R))*){$O}/{$tag}{$C}#is";

        return $re;

    }

?>

nene at triin dot net
20-May-2008 12:14


The first example is bad, because it creates function for every line it processes. When the file has many lines, you could easily run out of memory. The code should be changed so, that create_function() is used outside of loop.

Sjon at hortensius dot net
24-Jun-2007 01:56


preg_replace_callback returns NULL when pcre.backtrack_limit is reached; this sometimes occurs faster then you might expect. No error is raised either; so don't forget to check for NULL yourself

matt at mattsoft dot net
26-Apr-2006 11:16


it is much better on preformance and better practice to use the preg_replace_callback function instead of preg_replace with the e modifier.



function a($text){return($text);}



// 2.76 seconds to run 50000 times

preg_replace("/\{(.*?)\}/e","a('\\1','\\2','\\3',\$b)",$a);



// 0.97 seconds to run 50000 times

preg_replace_callback("/\{(.*?)\}/s","a",$a);

add a note

preg_replace

preg_quote

Last updated: Fri, 19 Jun 2009