<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/ref.var.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'function.empty.php',
    1 => 'empty',
    2 => 'Determine whether a variable is empty',
  ),
  'up' => 
  array (
    0 => 'ref.var.php',
    1 => 'Variable handling Functions',
  ),
  'prev' => 
  array (
    0 => 'function.doubleval.php',
    1 => 'doubleval',
  ),
  'next' => 
  array (
    0 => 'function.floatval.php',
    1 => 'floatval',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'reference/var/functions/empty.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="function.empty" class="refentry">
 <div class="refnamediv">
  <h1 class="refname">empty</h1>
  <p class="verinfo">(PHP 4, PHP 5, PHP 7, PHP 8)</p><p class="refpurpose"><span class="refname">empty</span> &mdash; <span class="dc-title">Determine whether a variable is empty</span></p>

 </div>
 <div class="refsect1 description" id="refsect1-function.empty-description">
  <h3 class="title">Description</h3>
  <div class="methodsynopsis dc-description">
   <span class="methodname"><strong>empty</strong></span>(<span class="methodparam"><span class="type"><a href="language.types.mixed.php" class="type mixed">mixed</a></span> <code class="parameter">$var</code></span>): <span class="type"><a href="language.types.boolean.php" class="type bool">bool</a></span></div>

  <p class="para rdfs-comment">
   Determine whether a variable is considered to be empty. A variable is considered empty if it does not exist or if its value equals <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>. <span class="function"><strong>empty()</strong></span> does not generate a warning if the variable does not exist.
  </p>
 </div>

 <div class="refsect1 parameters" id="refsect1-function.empty-parameters">
  <h3 class="title">Parameters</h3>
  <p class="para">
   <dl>
    
     <dt><code class="parameter">var</code></dt>
     <dd>
      <p class="para">
       Variable to be checked
      </p>
      <p class="para">
       No warning is generated if the variable does not exist.
       That means <span class="function"><strong>empty()</strong></span> is essentially the
       concise equivalent to <strong class="command">!isset($var) || $var == false</strong>.
       This also applies to nested structures, such as a multidimensional array or chained properties.
      </p>
     </dd>
    
   </dl>
  </p>
 </div>

 <div class="refsect1 returnvalues" id="refsect1-function.empty-returnvalues">
  <h3 class="title">Return Values</h3>
  <p class="para">
   Returns <strong><code><a href="reserved.constants.php#constant.true">true</a></code></strong> if <code class="parameter">var</code> does not exist or has a value that is empty or equal to zero,
   aka falsey, see <a href="language.types.boolean.php#language.types.boolean.casting" class="link">conversion to boolean</a>.
   Otherwise returns <strong><code><a href="reserved.constants.php#constant.false">false</a></code></strong>.
  </p>
 </div>

 <div class="refsect1 examples" id="refsect1-function.empty-examples">
  <h3 class="title">Examples</h3>
  <p class="para">
   <div class="example" id="example-1">
    <p><strong>Example #1 
     A simple <span class="function"><strong>empty()</strong></span> / <span class="function"><a href="function.isset.php" class="function">isset()</a></span>
     comparison.
    </strong></p>  
    <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$var </span><span style="color: #007700">= </span><span style="color: #0000BB">0</span><span style="color: #007700">;<br /><br /></span><span style="color: #FF8000">// Evaluates to true because $var is empty<br /></span><span style="color: #007700">if (empty(</span><span style="color: #0000BB">$var</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">'$var is either 0, empty, or not set at all'</span><span style="color: #007700">;<br />}<br /><br /></span><span style="color: #FF8000">// Evaluates as true because $var is set<br /></span><span style="color: #007700">if (isset(</span><span style="color: #0000BB">$var</span><span style="color: #007700">)) {<br />    echo </span><span style="color: #DD0000">'$var is set even though it is empty'</span><span style="color: #007700">;<br />}<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
    </div>

   </div>
  </p>
  <div class="example" id="example-2">
   <p><strong>Example #2 <span class="function"><strong>empty()</strong></span> on String Offsets</strong></p>
   <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$expected_array_got_string </span><span style="color: #007700">= </span><span style="color: #DD0000">'somestring'</span><span style="color: #007700">;<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(empty(</span><span style="color: #0000BB">$expected_array_got_string</span><span style="color: #007700">[</span><span style="color: #DD0000">'some_key'</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(empty(</span><span style="color: #0000BB">$expected_array_got_string</span><span style="color: #007700">[</span><span style="color: #0000BB">0</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(empty(</span><span style="color: #0000BB">$expected_array_got_string</span><span style="color: #007700">[</span><span style="color: #DD0000">'0'</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(empty(</span><span style="color: #0000BB">$expected_array_got_string</span><span style="color: #007700">[</span><span style="color: #DD0000">'0.5'</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(empty(</span><span style="color: #0000BB">$expected_array_got_string</span><span style="color: #007700">[</span><span style="color: #DD0000">'0 Mostel'</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>The above example will output:</p></div>
   <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">bool(true)
bool(false)
bool(false)
bool(true)
bool(true)</pre>
</div>
   </div>
  </div>
  <div class="example" id="example-3">
   <p><strong>Example #3 <span class="function"><strong>empty()</strong></span> on multidimensional arrays</strong></p>
   <div class="example-contents">
<div class="annotation-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br />$multidimensional </span><span style="color: #007700">= [<br />    </span><span style="color: #DD0000">'some' </span><span style="color: #007700">=&gt; [<br />        </span><span style="color: #DD0000">'deep' </span><span style="color: #007700">=&gt; [<br />            </span><span style="color: #DD0000">'nested' </span><span style="color: #007700">=&gt; </span><span style="color: #DD0000">'value'<br />        </span><span style="color: #007700">]<br />    ]<br />];<br /><br />if (!empty(</span><span style="color: #0000BB">$multidimensional</span><span style="color: #007700">[</span><span style="color: #DD0000">'some'</span><span style="color: #007700">][</span><span style="color: #DD0000">'some'</span><span style="color: #007700">][</span><span style="color: #DD0000">'nested'</span><span style="color: #007700">])) {<br />    </span><span style="color: #0000BB">$someVariable </span><span style="color: #007700">= </span><span style="color: #0000BB">$multidimensional</span><span style="color: #007700">[</span><span style="color: #DD0000">'some'</span><span style="color: #007700">][</span><span style="color: #DD0000">'deep'</span><span style="color: #007700">][</span><span style="color: #DD0000">'nested'</span><span style="color: #007700">];<br />}<br /><br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(empty(</span><span style="color: #0000BB">$multidimensional</span><span style="color: #007700">[</span><span style="color: #DD0000">'some-undefined-key'</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(empty(</span><span style="color: #0000BB">$multidimensional</span><span style="color: #007700">[</span><span style="color: #DD0000">'some'</span><span style="color: #007700">][</span><span style="color: #DD0000">'deep'</span><span style="color: #007700">][</span><span style="color: #DD0000">'unknown'</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">var_dump</span><span style="color: #007700">(empty(</span><span style="color: #0000BB">$multidimensional</span><span style="color: #007700">[</span><span style="color: #DD0000">'some'</span><span style="color: #007700">][</span><span style="color: #DD0000">'deep'</span><span style="color: #007700">][</span><span style="color: #DD0000">'nested'</span><span style="color: #007700">]));<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

   <div class="example-contents"><p>The above example will output:</p></div>
   <div class="example-contents screen">
<div class="annotation-interactive examplescode"><pre class="examplescode">bool(true)
bool(true)
bool(false)</pre>
</div>
   </div>
  </div>
 </div>

 <div class="refsect1 notes" id="refsect1-function.empty-notes">
  <h3 class="title">Notes</h3>
  <blockquote class="note"><p><strong class="note">Note</strong>: <span class="simpara">Because this is a
language construct and not a function, it cannot be called using
<a href="functions.variable-functions.php" class="link">variable functions</a>,
or <a href="functions.arguments.php#functions.named-arguments" class="link">named arguments</a>.</span>
</p></blockquote>
  <blockquote class="note"><p><strong class="note">Note</strong>: 
   <p class="para">
    When using <span class="function"><strong>empty()</strong></span> on inaccessible object properties,
    the <a href="language.oop5.overloading.php#object.isset" class="link">__isset()</a>
    overloading method will be called, if declared.
   </p>
  </p></blockquote>
 </div>

 <div class="refsect1 seealso" id="refsect1-function.empty-seealso">
  <h3 class="title">See Also</h3>
  <p class="para">
   <ul class="simplelist">
    <li><span class="function"><a href="function.isset.php" class="function" rel="rdfs-seeAlso">isset()</a> - Determine if a variable is declared and is different than null</span></li>
    <li><a href="language.oop5.overloading.php#object.isset" class="link">__isset()</a></li>
    <li><span class="function"><a href="function.unset.php" class="function" rel="rdfs-seeAlso">unset()</a> - unset a given variable</span></li>
    <li><span class="function"><a href="function.array-key-exists.php" class="function" rel="rdfs-seeAlso">array_key_exists()</a> - Checks if the given key or index exists in the array</span></li>
    <li><span class="function"><a href="function.count.php" class="function" rel="rdfs-seeAlso">count()</a> - Counts all elements in an array or in a Countable object</span></li> 
    <li><span class="function"><a href="function.strlen.php" class="function" rel="rdfs-seeAlso">strlen()</a> - Get string length</span></li>
    <li><a href="types.comparisons.php" class="link">The type comparison tables</a></li>
   </ul>
  </p>
 </div>

</div><?php manual_footer($setup); ?>