quotemeta

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

quotemeta — Quote meta characters

Description

function quotemeta(string $string): string

Returns a version of str with a backslash character (\) before every character that is among these:

. \ + * ? [ ^ ] ( $ )

Parameters

string

The input string.

Return Values

Returns the string with meta characters quoted. If an empty string is given as string, an empty string is returned.

Changelog

Version Description
8.0.0 Returns an empty string, instead of false, when string is empty.

Examples

Example #1 quotemeta() example

<?php

var_dump(quotemeta('PHP is a popular scripting language. Fast, flexible, and pragmatic.'));
?>

The above example will output:

string(69) "PHP is a popular scripting language\. Fast, flexible, and pragmatic\."

Notes

Note:

This function is binary-safe.

See Also

+add a note

User Contributed Notes 3 notes

up
16
kumarkulandai at gmail dot com
16 years ago
<?php
$str = "Hello world. (can you hear me?)";
echo quotemeta($str);
?>

The output of the code above will be:
Hello world\. \(can you hear me\?\)
up
9
George Adams
20 years ago
Took me a while to realize this was NOT the command I wanted for escaping potentially harmful characters in a string that would be used as part of a system command.  Instead, I needed either escapeshellarg() (http://www.php.net/manual/en/function.escapeshellarg.php) or escapeshellcmd() (http://www.php.net/manual/en/function.escapeshellcmd.php)
up
6
Anonymous
25 years ago
This function escapes characters that have special meaning in regular expressions.  preg_quote() <http://php.net/manual/en/function.preg-quote.php> has similar functionality, but is more powerful since it escapes more characters (including one user-specified character).
To Top