Last updated: Fri, 13 Nov 2009

preg_replace_callback

(PHP 4 >= 4.0.5, PHP 5)

preg_replace_callback — 正規表現検索を行い、コールバック関数を使用して置換を行う

説明

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

この関数の動作は、ほぼ preg_replace() と同じですが、 replacement の代わりに callback を指定するところが異なります。

パラメータ

pattern

検索するパターン。文字列あるいは文字列の配列のいずれかとなります。

callback

このコールバック関数は、検索対象文字列でマッチした要素の配列が指定されてコールされます。このコールバック関数は、置換後の文字列を返す必要があります。

preg_replace_callback() 用の callback 関数が、ひとつの場所だけで必要となることがあります。そんな場合は、無名関数機能 (PHP 5.3.0 以降) あるいは create_function() を使って宣言した無名関数を preg_replace_callback() のコール時に使用します。このようにすることにより、コールに関するすべての情報を 1 ヶ所に集め、他の場所で使用されないコールバック関数名で関数の名前空間を汚染しないようにすることができます。

例1 preg_replace_callback() と create_function()


<?php
/* Unix 方式のコマンドラインフィルタです。
 * 段落の冒頭の大文字を、小文字に変換します。*/
$fp = fopen("php://stdin", "r") or die("標準入力から読み込めません");
while (!feof($fp)) {
    $line = fgets($fp);
    $line = preg_replace_callback(
        '|<p>\s*\w|',
        create_function(
            // ここでは単一引用符の使用が不可欠です。
            // そうでない場合は、$ をすべて \$ とエスケープします。
            '$matches',
            'return strtolower($matches[0]);'
        ),
        $line
    );
    echo $line;
}
fclose($fp);
?>

subject

文字列あるいは文字列の配列で、検索および置換の対象となる文字列を指定します。

limit

subject 文字列における各パターンの最大置換回数。デフォルトは -1 (無制限) です。

count

指定した場合は、置換を行った回数がここに格納されます。

返り値

preg_replace_callback() は、 subject が配列の場合には配列を、それ以外の場合は文字列を返します。エラー時の返り値は NULL となります。

マッチするものが見つかった場合は新しい subject を返し、それ以外の場合はもとの subject をそのまま返します。

変更履歴

バージョン	説明
5.1.0	パラメータ `count` が追加されました。

例

例2 preg_replace_callback() の例


<?php
// このテキストは 2002 に使われていたものなのですが、
// これを 2003 年対応の日付に変更したいのです
$text = "エイプリルフールの日付は 04/01/2002 です\n";  
$text.= "この前のクリスマスの日付は 12/24/2001 でした\n";  
// コールバック関数
function next_year($matches)
{
  // 通常は、$matches[0] がマッチした全体を表します。
  // $matches[1] は、マッチした中で、パターン内の最初の '(...)'
  // にあてはまる部分を表します。それ以降も同様です。
  return $matches[1].($matches[2]+1);
}
echo preg_replace_callback(
            "|(\d{2}/\d{2}/)(\d{4})|",
            "next_year",
            $text);

?>

上の例の出力は以下となります。

エイプリルフールの日付は 04/01/2003 です
この前のクリスマスの日付は 12/24/2002 でした

例3 カプセル化された BB code を処理するための、 preg_replace_callback() での再帰構造の使用


<?php
$input = "通常の位置 [indent] 字下げ [indent] もっと字下げ [/indent] 字下げ [/indent] 通常の位置"; 

function parseTagsRecursive($input)
{

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

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

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

$output = parseTagsRecursive($input);

echo $output;
?>

参考

preg_replace() - 正規表現検索および置換を行う
create_function() - 匿名関数 (ラムダ形式) を作成する
callback 型に関する情報

preg_replace

preg_quote

Last updated: Fri, 13 Nov 2009

add a note User Contributed Notes
preg_replace_callback

Matt
14-Sep-2009 04:24


If you're looking to show only the first digit and last four digits of a credit card number (4xxxxxxxxxxxx2331) use something like this:

preg_replace_callback('/((.)(.*))?(.{4})/', create_function('$x', 'return $x[2].str_repeat("x", strlen($x[3])).$x[4];'), '$CCNUMBER')

ixiter at gmail dot com
29-Jul-2009 02:06


When you use preg_replace_callback in a class and have the callback function as a private method of that class, you need to set the callback function name like className::CallBack.


self::CallBack does not work and returns an error:


"Cannot call method self::CallBack() or method does not exist"!





<?php


class myClass{


    public function parsetext($text){


        // parses text and sets literals A - C to lower case


        // this works 


        return preg_replace_callback('|([a-c])|i', 'myClass::preg_tolower', $text);


    }


    public function parsefail($text){


        // parses text and sets literals A - C to lower case


        // this fails


        return preg_replace_callback('|([a-c])|i', 'self::preg_tolower', $text);


    }


    


    private static function preg_tolower($matches){


        return strtolower($matches[1]);


    }


}





$parser = new myClass;


echo $parser->parsetext('ABCDEFGH');


// echoes abcDEFGH





echo $parser->parsefail('ABCDEFGH');


// throws the error


?>

carlos dot ballesteros at softonic dot com
02-Jul-2009 03: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 02: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 08: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 07: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 07: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 10: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 04: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 02: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 07: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 10: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 11: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 09: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, 13 Nov 2009