<?php
include_once $_SERVER['DOCUMENT_ROOT'] . '/include/shared-manual.inc';
$TOC = array();
$TOC_DEPRECATED = array();
$PARENTS = array();
include_once dirname(__FILE__) ."/toc/language.types.inc";
$setup = array (
  'home' => 
  array (
    0 => 'index.php',
    1 => 'PHP Manual',
  ),
  'head' => 
  array (
    0 => 'UTF-8',
    1 => 'en',
  ),
  'this' => 
  array (
    0 => 'language.types.void.php',
    1 => 'Void',
    2 => 'Void',
  ),
  'up' => 
  array (
    0 => 'language.types.php',
    1 => 'Types',
  ),
  'prev' => 
  array (
    0 => 'language.types.mixed.php',
    1 => 'Mixed',
  ),
  'next' => 
  array (
    0 => 'language.types.never.php',
    1 => 'Never',
  ),
  'alternatives' => 
  array (
  ),
  'source' => 
  array (
    'lang' => 'en',
    'path' => 'language/types/void.xml',
  ),
  'history' => 
  array (
  ),
);
$setup["toc"] = $TOC;
$setup["toc_deprecated"] = $TOC_DEPRECATED;
$setup["parents"] = $PARENTS;
manual_setup($setup);

contributors($setup);

?>
<div id="language.types.void" class="sect1">
 <h2 class="title">Void</h2>

 <p class="para">
  <span class="type"><span class="type"><a href="language.types.void.php" class="type void">void</a></span></span> is a return-only type declaration indicating the
  function does not return a value, but the function may still terminate.
  Therefore, it cannot be part of a
  <a href="language.types.type-system.php#language.types.type-system.composite.union" class="link">union type</a>
  declaration. Available as of PHP 7.1.0.
 </p>

 <blockquote class="note"><p><strong class="note">Note</strong>: 
  <span class="simpara">
   Even if a function has a return type of <span class="type"><span class="type"><a href="language.types.void.php" class="type void">void</a></span></span> it will
   still return a value, this value is always <strong><code><a href="reserved.constants.php#constant.null">null</a></code></strong>.
  </span>
 </p></blockquote>

 <div class="sect2" id="language.types.void.casting">
  <h3 class="title">Discarding a value with <code class="literal">(void)</code></h3>

  <p class="simpara">
   The <code class="literal">(void)</code> syntax may be used to explicitly discard the
   result of an expression. This is useful to indicate that ignoring a return
   value is intentional, especially when calling a function or method marked
   with the <span class="classname"><a href="class.nodiscard.php" class="classname">NoDiscard</a></span>
   attribute.
  </p>

  <p class="simpara">
   Unlike other casts, <code class="literal">(void)</code> does not convert the value to
   another type and does not produce a value. It is a statement and cannot be
   used as part of an expression.
  </p>

  <div class="example" id="example-1">
   <p><strong>Example #1 Discarding a return value</strong></p>
   <div class="example-contents">
    <div class="annotation-non-interactive phpcode"><code><span style="color: #000000"><span style="color: #0000BB">&lt;?php<br /></span><span style="color: #007700">#[</span><span style="color: #0000BB">\NoDiscard</span><span style="color: #007700">]<br />function </span><span style="color: #0000BB">process</span><span style="color: #007700">(): </span><span style="color: #0000BB">bool </span><span style="color: #007700">{<br />    return </span><span style="color: #0000BB">true</span><span style="color: #007700">;<br />}<br /><br />(</span><span style="color: #0000BB">void</span><span style="color: #007700">) </span><span style="color: #0000BB">process</span><span style="color: #007700">(); </span><span style="color: #FF8000">// Explicitly discard the return value<br /></span><span style="color: #0000BB">?&gt;</span></span></code></div>
   </div>

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