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

DirectoryIterator::getBasename

PHP function Edit on GitHub ✎

(PHP 5 >= 5.2.2, PHP 7, PHP 8)

Get base name of current DirectoryIterator item

Description

DirectoryIterator::getBasename(string $suffix = ""): string

Get the base name of the current DirectoryIterator item.

Parameters

suffix

If the base name ends in suffix, this will be cut.

Return Values

The base name of the current DirectoryIterator item.

Examples

A DirectoryIterator::getBasename example

This example will list the full base name and the base name with suffix .jpg removed for the files in the directory containing the script.

php
<?php
$dir = new DirectoryIterator(dirname(__FILE__));
foreach ($dir as $fileinfo) {
    if ($fileinfo->isFile()) {
        echo $fileinfo->getBasename() . "\n";
        echo $fileinfo->getBasename('.jpg') . "\n";
    }
}
?>

The above example will output something similar to:

output
apple.jpg
apple
banana.jpg
banana
index.php
index.php
pear.jpg
pear

See Also

  • DirectoryIterator::getFilename
  • DirectoryIterator::getPath
  • DirectoryIterator::getPathname
  • basename()
  • pathinfo()

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