escapeshellarg

(PHP 4 >= 4.0.3, PHP 5, PHP 7)

escapeshellargEscape a string to be used as a shell argument

Description

escapeshellarg ( string $arg ) : string

escapeshellarg() adds single quotes around a string and quotes/escapes any existing single quotes allowing you to pass a string directly to a shell function and having it be treated as a single safe argument. This function should be used to escape individual arguments to shell functions coming from user input. The shell functions include exec(), system() and the backtick operator.

On Windows, escapeshellarg() instead replaces percent signs, exclamation marks (delayed variable substitution) and double quotes with spaces and adds double quotes around the string.

Parameters

arg

The argument that will be escaped.

Return Values

The escaped string.

Examples

Example #1 escapeshellarg() example

<?php
system
('ls '.escapeshellarg($dir));
?>

Changelog

Version Description
5.4.43, 5.5.27, 5.6.11 Exclamation marks are replaced by spaces.

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top