XCVII. Regular Expression Functions (Perl-Compatible)

Introduction

The syntax for patterns used in these functions closely resembles Perl. The expression should be enclosed in the delimiters, a forward slash (/), for example. Any character can be used for delimiter as long as it's not alphanumeric or backslash (\). If the delimiter character has to be used in the expression itself, it needs to be escaped by backslash. Since PHP 4.0.4, you can also use Perl-style (), {}, [], and <> matching delimiters. See Pattern Syntax for detailed explanation.

The ending delimiter may be followed by various modifiers that affect the matching. See Pattern Modifiers.

PHP also supports regular expressions using a POSIX-extended syntax using the POSIX-extended regex functions.

Warning

You should be aware of some limitations of PCRE. Read http://www.pcre.org/pcre.txt for more info.

Requirements

Regular expression support is provided by the PCRE library package, which is open source software, written by Philip Hazel, and copyright by the University of Cambridge, England. It is available at ftp://ftp.csx.cam.ac.uk/pub/software/programming/pcre/.

Installation

Beginning with PHP 4.2.0 these functions are enabled by default. You can disable the pcre functions with --without-pcre-regex. Use --with-pcre-regex=DIR to specify DIR where PCRE's include and library files are located, if not using bundled library. For older versions you have to configure and compile PHP with --with-pcre-regex[=DIR] in order to use these functions.

The windows version of PHP has built in support for this extension. You do not need to load any additional extension in order to use these functions.

Runtime Configuration

This extension has no configuration directives defined in php.ini.

Resource Types

This extension has no resource types defined.

Predefined Constants

The constants below are defined by this extension, and will only be available when the extension has either been compiled into PHP or dynamically loaded at runtime.

Table 1. PREG constants

constant	description
PREG_PATTERN_ORDER	Orders results so that $matches[0] is an array of full pattern matches, $matches[1] is an array of strings matched by the first parenthesized subpattern, and so on. This flag is only used with preg_match_all().
PREG_SET_ORDER	Orders results so that $matches[0] is an array of first set of matches, $matches[1] is an array of second set of matches, and so on. This flag is only used with preg_match_all().
PREG_OFFSET_CAPTURE	See the description of `PREG_SPLIT_OFFSET_CAPTURE`. This flag is available since PHP 4.3.0.
PREG_SPLIT_NO_EMPTY	This flag tells preg_split() to return only non-empty pieces.
PREG_SPLIT_DELIM_CAPTURE	This flag tells preg_split() to capture parenthesized expression in the delimiter pattern as well. This flag is available since PHP 4.0.5.
PREG_SPLIT_OFFSET_CAPTURE	If this flag is set, for every occurring match the appendant string offset will also be returned. Note that this changes the return values in an array where every element is an array consisting of the matched string at offset 0 and its string offset within subject at offset 1. This flag is available since PHP 4.3.0 and is only used for preg_split().

Examples

Example 1. Examples of valid patterns
/<\/\w+>/
|(\d{3})-\d+|Sm
/^(?i)php[34]/
{^\s+(\s+)?$}

Example 2. Examples of invalid patterns
/href='(.*)' - missing ending delimiter
/\w+\s*\w+/J - unknown modifier 'J'
1-\d3-\d3-\d4| - missing starting delimiter

Table of Contents
Pattern Modifiers -- Describes possible modifiers in regex patterns
Pattern Syntax -- Describes PCRE regex syntax
preg_grep -- Return array entries that match the pattern
preg_match_all -- Perform a global regular expression match
preg_match -- Perform a regular expression match
preg_quote -- Quote regular expression characters
preg_replace_callback -- Perform a regular expression search and replace using a callback
preg_replace -- Perform a regular expression search and replace
preg_split -- Split string by a regular expression

User Contributed Notes
Regular Expression Functions (Perl-Compatible)

alexbodn at 012 dot n@t dot il
27-Apr-2005 09:52


Here is a small function to determine whether a string is a [valid] preg expression.



function preg_ispreg($str)

{

    $prefix = "";

    $sufix = "";

    if ($str[0] != '^')

        $prefix = '^';

    if ($str[strlen($str) - 1] != '$')

        $sufix = '$';

    $estr = preg_replace("'^/'", "\\/", preg_replace("'([^/])/'", "\\1\\/", $str));

    if (@preg_match("/".$prefix.$estr.$sufix."/", $str, $matches))

        return strcmp($str, $matches[0]) != 0;

    return false;

}

Ned Baldessin
23-Oct-2004 09:08


If you want to perform regular expressions on Unicode strings, the PCRE functions will NOT be of any help. You need to use the Multibyte extension : mb_ereg(), mb_eregi(), pb_ereg_replace() and so on. When doing so, be carefull to set the default text encoding to the same encoding used by the text you are searching and replacing in. You can do that with the mb_regex_encoding() function. You will probably also want to set the default encoding for the other mb_* string functions with mb_internal_encoding().



So when dealing with, say, french text, I start with these :

<?php

mb_internal_encoding('UTF-8');

mb_regex_encoding('UTF-8');

setlocale(LC_ALL, 'fr-fr');

?>

steve at stevedix dot de
20-Jul-2004 08:17


Something to bear in mind is that regex is actually a declarative programming language like prolog : your regex is a set of rules which the regex interpreter tries to match against a string.   During this matching, the interpreter will assume certain things, and continue assuming them until it comes up against a failure to match, which then causes it to backtrack.  Regex assumes "greedy matching" unless explicitly told not to, which can cause a lot of backtracking.  A general rule of thumb is that the more backtracking, the slower the matching process.



It is therefore vital, if you are trying to optimise your program to run quickly (and if you can't do without regex), to optimise your regexes to match quickly.



I recommend the use of a tool such as "The Regex Coach" to debug your regex strings.



http://weitz.de/files/regex-coach.exe (Windows installer) http://weitz.de/files/regex-coach.tgz (Linux tar archive)

ivan dot roth at free dot fr
12-May-2004 07:12


I think the adress for the simple PCRE tutorial is now http://207.218.249.247/tutorials/perl_faq.html#regular



And I approve, it is  good one! :)

Snobord787 at msn dot com
14-Jan-2004 09:51


http://gnosis.cx/publish/programming/regular_expressions.html

Best site I have ever seen uses images to help you

Biju
21-Sep-2003 12:00


Regular Expressions Tutorial from non PHP sites


   http://www.amk.ca/python/howto/regex/


   http://sitescooper.org/tao_regexps.html


   http://www.english.uga.edu/humcomp/perl/regex2a.html


   http://www.english.uga.edu/humcomp/perl/regexps.html


   http://www.english.uga.edu/humcomp/perl/regular_expressions.HTML


   http://www.english.uga.edu/humcomp/perl/


   http://java.sun.com/docs/books/tutorial/extra/regex/


   http://gnosis.cx/publish/programming/regular_expressions.html


   http://www.zvon.org/other/PerlTutorial/Books/Book1/


   http://it.metr.ou.edu/regex/


   http://www.regular-expressions.info/

hrz at geodata dot soton dot ac dot uk
06-Mar-2002 02:33


If you're venturing into new regular expression territory with a lack of useful examples then it would pay to get familiar with this page:



http://www.pcre.org/man.txt