<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="content-type" content="text/html; charset=UTF-8">
<title>Gets options from the command line argument list</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.getmyuid.html">getmyuid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.getrusage.html">getrusage</a></div>
<div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div><hr /><div id="function.getopt" class="refentry">
<div class="refnamediv">
<h1 class="refname">getopt</h1>
<p class="verinfo">(PHP 4 >= 4.3.0, PHP 5, PHP 7)</p><p class="refpurpose"><span class="refname">getopt</span> — <span class="dc-title">Gets options from the command line argument list</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.getopt-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">array</span> <span class="methodname"><strong>getopt</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$options</code></span>
[, <span class="methodparam"><span class="type">array</span> <code class="parameter">$longopts</code></span>
[, <span class="methodparam"><span class="type">int</span> <code class="parameter reference">&$optind</code></span>
]] )</div>
<p class="para rdfs-comment">
Parses options passed to the script.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.getopt-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<code class="parameter">options</code></dt>
<dd>
<span class="simpara">
Each character in this string will be used as option characters and
matched against options passed to the script starting with a single
hyphen (<em>-</em>).
</span>
<span class="simpara">
For example, an option string <em>"x"</em> recognizes an
option <em>-x</em>.
</span>
<span class="simpara">
Only a-z, A-Z and 0-9 are allowed.
</span>
</dd>
<dt>
<code class="parameter">longopts</code></dt>
<dd>
<span class="simpara">
An array of options. Each element in this array will be used as option
strings and matched against options passed to the script starting with
two hyphens (<em>--</em>).
</span>
<span class="simpara">
For example, an longopts element <em>"opt"</em> recognizes an
option <em>--opt</em>.
</span>
</dd>
<dt>
<code class="parameter">optind</code></dt>
<dd>
<span class="simpara">
If the <code class="parameter">optind</code> parameter is present, then the
index where argument parsing stopped will be written to this variable.
</span>
</dd>
</dl>
</p>
<p class="para">
The <code class="parameter">options</code> parameter may contain the following
elements:
<ul class="simplelist">
<li class="member">Individual characters (do not accept values)</li>
<li class="member">Characters followed by a colon (parameter requires value)</li>
<li class="member">Characters followed by two colons (optional value)</li>
</ul>
Option values are the first argument after the string. If a value is required,
it does not matter whether the value has leading white space or not. See note.
<blockquote class="note"><p><strong class="note">Note</strong>:
<span class="simpara">
Optional values do not accept <em>" "</em> (space) as a separator.
</span>
</p></blockquote>
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
The format for the <code class="parameter">options</code> and
<code class="parameter">longopts</code> is almost the same, the only difference is
that <code class="parameter">longopts</code> takes an array of options (where each
element is the option) whereas <code class="parameter">options</code> takes a
string (where each character is the option).
</p>
</p></blockquote>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.getopt-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
This function will return an array of option / argument pairs, or <strong><code>FALSE</code></strong> on failure.
</p>
<blockquote class="note"><p><strong class="note">Note</strong>:
<p class="para">
The parsing of options will end at the first non-option found, anything
that follows is discarded.
</p>
</p></blockquote>
</div>
<div class="refsect1 changelog" id="refsect1-function.getopt-changelog">
<h3 class="title">Changelog</h3>
<p class="para">
<table class="doctable informaltable">
<thead>
<tr>
<th>Version</th>
<th>Description</th>
</tr>
</thead>
<tbody class="tbody">
<tr>
<td>7.1.0</td>
<td>
Added the <code class="parameter">optind</code> parameter.
</td>
</tr>
<tr>
<td>5.3.0</td>
<td>
Added support for "=" as argument/value separator.
</td>
</tr>
<tr>
<td>5.3.0</td>
<td>
Added support for optional values (specified with "::").
</td>
</tr>
<tr>
<td>5.3.0</td>
<td>
Parameter <code class="parameter">longopts</code> is available on all systems.
</td>
</tr>
<tr>
<td>5.3.0</td>
<td>
This function is no longer system dependent, and now works on Windows, too.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.getopt-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-541">
<p><strong>Example #1 <span class="function"><strong>getopt()</strong></span> example: The basics</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Script example.php<br /></span><span style="color: #0000BB">$options </span><span style="color: #007700">= </span><span style="color: #0000BB">getopt</span><span style="color: #007700">(</span><span style="color: #DD0000">"f:hp:"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents">
<div class="shellcode"><pre class="shellcode">shell> php example.php -fvalue -h</pre>
</div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
["f"]=>
string(5) "value"
["h"]=>
bool(false)
}
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-542">
<p><strong>Example #2 <span class="function"><strong>getopt()</strong></span> example: Introducing long options</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Script example.php<br /></span><span style="color: #0000BB">$shortopts </span><span style="color: #007700">= </span><span style="color: #DD0000">""</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$shortopts </span><span style="color: #007700">.= </span><span style="color: #DD0000">"f:"</span><span style="color: #007700">; </span><span style="color: #FF8000">// Required value<br /></span><span style="color: #0000BB">$shortopts </span><span style="color: #007700">.= </span><span style="color: #DD0000">"v::"</span><span style="color: #007700">; </span><span style="color: #FF8000">// Optional value<br /></span><span style="color: #0000BB">$shortopts </span><span style="color: #007700">.= </span><span style="color: #DD0000">"abc"</span><span style="color: #007700">; </span><span style="color: #FF8000">// These options do not accept values<br /><br /></span><span style="color: #0000BB">$longopts </span><span style="color: #007700">= array(<br /> </span><span style="color: #DD0000">"required:"</span><span style="color: #007700">, </span><span style="color: #FF8000">// Required value<br /> </span><span style="color: #DD0000">"optional::"</span><span style="color: #007700">, </span><span style="color: #FF8000">// Optional value<br /> </span><span style="color: #DD0000">"option"</span><span style="color: #007700">, </span><span style="color: #FF8000">// No value<br /> </span><span style="color: #DD0000">"opt"</span><span style="color: #007700">, </span><span style="color: #FF8000">// No value<br /></span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$options </span><span style="color: #007700">= </span><span style="color: #0000BB">getopt</span><span style="color: #007700">(</span><span style="color: #0000BB">$shortopts</span><span style="color: #007700">, </span><span style="color: #0000BB">$longopts</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents">
<div class="shellcode"><pre class="shellcode">shell> php example.php -f "value for f" -v -a --required value --optional="optional value" --option</pre>
</div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(6) {
["f"]=>
string(11) "value for f"
["v"]=>
bool(false)
["a"]=>
bool(false)
["required"]=>
string(5) "value"
["optional"]=>
string(14) "optional value"
["option"]=>
bool(false)
}
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-543">
<p><strong>Example #3 <span class="function"><strong>getopt()</strong></span> example: Passing multiple options as one</strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Script example.php<br /></span><span style="color: #0000BB">$options </span><span style="color: #007700">= </span><span style="color: #0000BB">getopt</span><span style="color: #007700">(</span><span style="color: #DD0000">"abc"</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$options</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents">
<div class="shellcode"><pre class="shellcode">shell> php example.php -aaac</pre>
</div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(2) {
["a"]=>
array(3) {
[0]=>
bool(false)
[1]=>
bool(false)
[2]=>
bool(false)
}
["c"]=>
bool(false)
}
</pre></div>
</div>
</div>
</p>
<p class="para">
<div class="example" id="example-544">
<p><strong>Example #4 <span class="function"><strong>getopt()</strong></span> example: Using <code class="parameter">optind</code></strong></p>
<div class="example-contents">
<div class="phpcode"><code><span style="color: #000000">
<span style="color: #0000BB"><?php<br /></span><span style="color: #FF8000">// Script example.php<br /></span><span style="color: #0000BB">$optind </span><span style="color: #007700">= </span><span style="color: #0000BB">null</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">$opts </span><span style="color: #007700">= </span><span style="color: #0000BB">getopt</span><span style="color: #007700">(</span><span style="color: #DD0000">'a:b:'</span><span style="color: #007700">, [], </span><span style="color: #0000BB">$optind</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">$pos_args </span><span style="color: #007700">= </span><span style="color: #0000BB">array_slice</span><span style="color: #007700">(</span><span style="color: #0000BB">$argv</span><span style="color: #007700">, </span><span style="color: #0000BB">$optind</span><span style="color: #007700">);<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(</span><span style="color: #0000BB">$pos_args</span><span style="color: #007700">);</span>
</span>
</code></div>
</div>
<div class="example-contents">
<div class="shellcode"><pre class="shellcode">shell> php example.php -a 1 -b 2 -- test</pre>
</div>
</div>
<div class="example-contents"><p>The above example will output:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
array(1) {
[0]=>
string(4) "test"
}
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.getopt-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"><a href="reserved.variables.argv.html" class="link"><var class="varname"><var class="varname"><a href="reserved.variables.argv.html" class="classname">$argv</a></var></var></a></li>
</ul>
</p>
</div>
</div><hr /><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.getmyuid.html">getmyuid</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.getrusage.html">getrusage</a></div>
<div class="up"><a href="ref.info.html">PHP Options/Info Functions</a></div>
<div class="home"><a href="index.html">PHP Manual</a></div>
</div></body></html>
