<!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 the value of a configuration option</title>
</head>
<body><div class="manualnavbar" style="text-align: center;">
<div class="prev" style="text-align: left; float: left;"><a href="function.ini-get-all.html">ini_get_all</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ini-restore.html">ini_restore</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.ini-get" class="refentry">
<div class="refnamediv">
<h1 class="refname">ini_get</h1>
<p class="verinfo">(PHP 4, PHP 5)</p><p class="refpurpose"><span class="refname">ini_get</span> — <span class="dc-title">Gets the value of a configuration option</span></p>
</div>
<div class="refsect1 description" id="refsect1-function.ini-get-description">
<h3 class="title">Description</h3>
<div class="methodsynopsis dc-description">
<span class="type">string</span> <span class="methodname"><strong>ini_get</strong></span>
( <span class="methodparam"><span class="type">string</span> <code class="parameter">$varname</code></span>
)</div>
<p class="para rdfs-comment">
Returns the value of the configuration option on success.
</p>
</div>
<div class="refsect1 parameters" id="refsect1-function.ini-get-parameters">
<h3 class="title">Parameters</h3>
<p class="para">
<dl>
<dt>
<span class="term"><em><code class="parameter">varname</code></em></span>
<dd>
<p class="para">
The configuration option name.
</p>
</dd>
</dt>
</dl>
</p>
</div>
<div class="refsect1 returnvalues" id="refsect1-function.ini-get-returnvalues">
<h3 class="title">Return Values</h3>
<p class="para">
Returns the value of the configuration option as a string on success, or an
empty string for <em>null</em> values. Returns <strong><code>FALSE</code></strong> if the
configuration option doesn't exist.
</p>
</div>
<div class="refsect1 examples" id="refsect1-function.ini-get-examples">
<h3 class="title">Examples</h3>
<p class="para">
<div class="example" id="example-501">
<p><strong>Example #1 A few <span class="function"><strong>ini_get()</strong></span> examples</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">/*<br />Our php.ini contains the following settings:<br /><br />display_errors = On<br />register_globals = Off<br />post_max_size = 8M<br />*/<br /><br /></span><span style="color: #007700">echo </span><span style="color: #DD0000">'display_errors = ' </span><span style="color: #007700">. </span><span style="color: #0000BB">ini_get</span><span style="color: #007700">(</span><span style="color: #DD0000">'display_errors'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'register_globals = ' </span><span style="color: #007700">. </span><span style="color: #0000BB">ini_get</span><span style="color: #007700">(</span><span style="color: #DD0000">'register_globals'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'post_max_size = ' </span><span style="color: #007700">. </span><span style="color: #0000BB">ini_get</span><span style="color: #007700">(</span><span style="color: #DD0000">'post_max_size'</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'post_max_size+1 = ' </span><span style="color: #007700">. (</span><span style="color: #0000BB">ini_get</span><span style="color: #007700">(</span><span style="color: #DD0000">'post_max_size'</span><span style="color: #007700">)+</span><span style="color: #0000BB">1</span><span style="color: #007700">) . </span><span style="color: #DD0000">"\n"</span><span style="color: #007700">;<br />echo </span><span style="color: #DD0000">'post_max_size in bytes = ' </span><span style="color: #007700">. </span><span style="color: #0000BB">return_bytes</span><span style="color: #007700">(</span><span style="color: #0000BB">ini_get</span><span style="color: #007700">(</span><span style="color: #DD0000">'post_max_size'</span><span style="color: #007700">));<br /><br />function </span><span style="color: #0000BB">return_bytes</span><span style="color: #007700">(</span><span style="color: #0000BB">$val</span><span style="color: #007700">) {<br /> </span><span style="color: #0000BB">$val </span><span style="color: #007700">= </span><span style="color: #0000BB">trim</span><span style="color: #007700">(</span><span style="color: #0000BB">$val</span><span style="color: #007700">);<br /> </span><span style="color: #0000BB">$last </span><span style="color: #007700">= </span><span style="color: #0000BB">strtolower</span><span style="color: #007700">(</span><span style="color: #0000BB">$val</span><span style="color: #007700">[</span><span style="color: #0000BB">strlen</span><span style="color: #007700">(</span><span style="color: #0000BB">$val</span><span style="color: #007700">)-</span><span style="color: #0000BB">1</span><span style="color: #007700">]);<br /> switch(</span><span style="color: #0000BB">$last</span><span style="color: #007700">) {<br /> </span><span style="color: #FF8000">// The 'G' modifier is available since PHP 5.1.0<br /> </span><span style="color: #007700">case </span><span style="color: #DD0000">'g'</span><span style="color: #007700">:<br /> </span><span style="color: #0000BB">$val </span><span style="color: #007700">*= </span><span style="color: #0000BB">1024</span><span style="color: #007700">;<br /> case </span><span style="color: #DD0000">'m'</span><span style="color: #007700">:<br /> </span><span style="color: #0000BB">$val </span><span style="color: #007700">*= </span><span style="color: #0000BB">1024</span><span style="color: #007700">;<br /> case </span><span style="color: #DD0000">'k'</span><span style="color: #007700">:<br /> </span><span style="color: #0000BB">$val </span><span style="color: #007700">*= </span><span style="color: #0000BB">1024</span><span style="color: #007700">;<br /> }<br /><br /> return </span><span style="color: #0000BB">$val</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #0000BB">?></span>
</span>
</code></div>
</div>
<div class="example-contents"><p>The above example will output
something similar to:</p></div>
<div class="example-contents screen">
<div class="cdata"><pre>
display_errors = 1
register_globals = 0
post_max_size = 8M
post_max_size+1 = 9
post_max_size in bytes = 8388608
</pre></div>
</div>
</div>
</p>
</div>
<div class="refsect1 notes" id="refsect1-function.ini-get-notes">
<h3 class="title">Notes</h3>
<blockquote class="note"><p><strong class="note">Note</strong>:
<strong>When querying boolean values</strong><br />
<p class="para">
A boolean ini value of <em>off</em> will be returned as an
empty string or "0" while a boolean ini value of <em>on</em> will
be returned as "1".
The function can also return the literal string of INI value.
</p>
</p></blockquote>
<blockquote class="note"><p><strong class="note">Note</strong>:
<strong>When querying memory size values</strong><br />
<p class="para">
Many ini memory size values, such as
<a href="ini.core.html#ini.upload-max-filesize" class="link">upload_max_filesize</a>, are
stored in the <var class="filename">php.ini</var> file in shorthand notation.
<span class="function"><strong>ini_get()</strong></span> will return the exact string stored in the
<var class="filename">php.ini</var> file and <em class="emphasis">NOT</em> its <span class="type"><a href="language.types.integer.html" class="type integer">integer</a></span>
equivalent. Attempting normal arithmetic functions on these values
will not have otherwise expected results. The example above shows one
way to convert shorthand notation into bytes, much like how the PHP
source does it.
</p>
</p></blockquote>
</div>
<div class="refsect1 changelog" id="refsect1-function.ini-get-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>5.3.0</td>
<td>Previously, the empty string was returned if the configuration
option didn't exist. now, <strong><code>FALSE</code></strong> is returned instead.
</td>
</tr>
</tbody>
</table>
</p>
</div>
<div class="refsect1 seealso" id="refsect1-function.ini-get-seealso">
<h3 class="title">See Also</h3>
<p class="para">
<ul class="simplelist">
<li class="member"> <span class="function"><a href="function.get-cfg-var.html" class="function" rel="rdfs-seeAlso">get_cfg_var()</a> - Gets the value of a PHP configuration option</span></li>
<li class="member"> <span class="function"><a href="function.ini-get-all.html" class="function" rel="rdfs-seeAlso">ini_get_all()</a> - Gets all configuration options</span></li>
<li class="member"> <span class="function"><a href="function.ini-restore.html" class="function" rel="rdfs-seeAlso">ini_restore()</a> - Restores the value of a configuration option</span></li>
<li class="member"> <span class="function"><a href="function.ini-set.html" class="function" rel="rdfs-seeAlso">ini_set()</a> - Sets the value of a configuration option</span></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.ini-get-all.html">ini_get_all</a></div>
<div class="next" style="text-align: right; float: right;"><a href="function.ini-restore.html">ini_restore</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>
