Note proper usage of escapeArgument()

trowski · trowski · commit 583959df17d0 · 2026-05-31T10:11:55.000-05:00
diff --git a/src/functions.php b/src/functions.php
@@ -8,7 +8,8 @@
 if (!\function_exists(__NAMESPACE__ . '\\escapeArgument')) {
     if (IS_WINDOWS) {
         /**
-         * Escapes the command argument for safe inclusion into a Windows command string.
+         * Escapes the command argument for safe inclusion into a Windows command string used with proc_open()
+         * and the option bypass_shell=true.
          */
         function escapeArgument(string $arg): string
         {
@@ -18,7 +19,7 @@ function escapeArgument(string $arg): string
         }
     } else {
         /**
-         * Escapes the command argument for safe inclusion into a Posix shell command string.
+         * Escapes the command argument for safe inclusion into a Posix shell command string used with proc_open().
          */
         function escapeArgument(string $arg): string
         {

Original file line number	Diff line number	Diff line change
`@@ -8,7 +8,8 @@`
`8`	`8`	`if (!\function_exists(__NAMESPACE__ . '\\escapeArgument')) {`
`9`	`9`	`if (IS_WINDOWS) {`
`10`	`10`	`/**`
`11`		`- * Escapes the command argument for safe inclusion into a Windows command string.`
	`11`	`+ * Escapes the command argument for safe inclusion into a Windows command string used with proc_open()`
	`12`	`+ * and the option bypass_shell=true.`
`12`	`13`	`*/`
`13`	`14`	`function escapeArgument(string $arg): string`
`14`	`15`	`{`
`@@ -18,7 +19,7 @@ function escapeArgument(string $arg): string`
`18`	`19`	`}`
`19`	`20`	`} else {`
`20`	`21`	`/**`
`21`		`- * Escapes the command argument for safe inclusion into a Posix shell command string.`
	`22`	`+ * Escapes the command argument for safe inclusion into a Posix shell command string used with proc_open().`
`22`	`23`	`*/`
`23`	`24`	`function escapeArgument(string $arg): string`
`24`	`25`	`{`