Home/ Manual/ spl / directoryiterator/ DirectoryIterator::key

DirectoryIterator::key

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Return the key for the current DirectoryIterator item

Description

DirectoryIterator::key(): mixed

Get the key for the current DirectoryIterator item.

Parameters Parameters

Return Values

The key for the current DirectoryIterator item as an Integer.

Changelog

Version	Description
8.1.0	When the iterator is uninitialized, an `Error` is thrown now. Previously, the method returned false.

Examples

A DirectoryIterator::key example

php

<?php
$dir = new DirectoryIterator(dirname(__FILE__));
foreach ($dir as $fileinfo) {
    if (!$fileinfo->isDot()) {
        echo $fileinfo->key() . " => " . $fileinfo->getFilename() . "\n";
    }
}
?>

The above example will output something similar to:

output

0 => apple.jpg
1 => banana.jpg
2 => index.php
3 => pear.jpg