php8.5
Home/ Manual/ spl / directoryiterator/ DirectoryIterator::valid

DirectoryIterator::valid

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Check whether current DirectoryIterator position is a valid file

Description

DirectoryIterator::valid(): bool

Check whether current DirectoryIterator position is a valid file.

Parameters Parameters

Return Values

Returns true if the position is valid, otherwise false

Examples

A DirectoryIterator::valid example

php
<?php
$iterator = new DirectoryIterator(dirname(__FILE__));

// Loop to end of iterator
while($iterator->valid()) {
    $iterator->next();
}

$iterator->valid(); // FALSE
$iterator->rewind(); 
$iterator->valid(); // TRUE

?>

See Also

  • DirectoryIterator::current
  • DirectoryIterator::key
  • DirectoryIterator::next
  • DirectoryIterator::rewind
  • Iterator::valid

Source: reference/spl/directoryiterator/valid.xml · from the official PHP manual (php/doc-en)