preg_quote

(Auszug aus "Reguläre Ausdrücke" von Jeffrey E. F. Friedl)

preg_quote(input [, begrenzer ])

Parameter

input

Ein String, der in einem Pattern-Argument als literaler String behandelt werden soll (siehe Der »Pattern«-Parameter).

begrenzer

Ein optionaler, exakt ein Zeichen langer String, der im Pattern-Argument als Begrenzungszeichen verwendet werden soll.

Rückgabewert

preg_quote erzeugt eine Version von input, in der die Regex-Metazeichen maskiert sind. Wenn begrenzer angegeben wird, wird dieses Zeichen ebenfalls maskiert.

Erläuterungen

Wenn ein String vorhanden ist, der als literaler Text in einer Regex verwendet werden soll, sollte man diesen mit preg_quote behandeln, damit die Zeichen darin nicht als Regex-Metazeichen interpretiert werden. Man kann auch das Begrenzungszeichen angeben, das man verwenden wird, auch dieses wird dann maskiert.

Die Funktion preg_quote ist schon sehr spezialisiert, und man wird sie nicht allzu häufig verwenden, dennoch ein Beispiel:

Wenn $MailBetreff einen Text wie

**Sonderangebot** (Jetzt zugreifen!)

enthält, bekommt $pattern den Wert

der gefahrlos in einem Pattern-Argument einer preg-Funktion verwendet werden kann.

Wenn für begrenzer das Zeichen ›{‹ oder irgendein anderes klammerartiges Zeichen verwendet wird, dann wird nur dieses maskiert, nicht aber das Gegenstück (›}‹). Verwenden Sie für diesen Zweck also nur ungepaarte Begrenzungszeichen.

Außerdem wird weder Whitespace noch ›#‹ maskiert; das Resultat eignet sich also nicht für eine Mustersuche mit dem x-Modifikator.

Alles in allem ist preg_quote nur eine halbherzige Lösung zur Behandlung von beliebigen literalen Texten in einer PHP-Regex. Nur das Problem »Text-zu-Regex« wird gelöst, nicht aber der Teilschritt »Regex-zu-Pattern-Argument«, der für einen allgemeinen Einsatz mit den preg-Funktionen notwendig wäre. Eine Lösung zu diesem Problem wird unter »Fehlende« preg-Funktionen entwickelt.