PHP Filesystem is_dir() Function
The PHP Filesystem is_dir() function is used to check if a path is a directory. It requires a path that you want to check to be given and passed. The method returns true if the path is a directory and returns false otherwise.
Syntax
Below is the syntax of the PHP Filesystem is_dir() function −
bool is_dir(string $path)
Parameters
Below are the required parameters of the is_dir() function −
| Sr.No | Parameter & Description |
|---|---|
| 1 |
$path(Required) It is the path that you want to check. |
Return Value
The function is_dir() returns true if the path is a directory, FALSE otherwise.
PHP Version
The is_dir() function was first introduced as part of core PHP 4 and work well with the PHP 5, PHP 7 and PHP 8.
Example
We have used the PHP Filesystem is_dir() function to check that the given path is a directory or not.
<?php
// Mention the directory path here
$path = '/Desktop/PhpProjects';
if (is_dir($path)) {
echo "The path is a directory.";
} else {
echo "The path is not a directory.";
}
?>
Output
Here is the outcome of the following code −
The path is a directory.
Example
This PHP example will perform the operation to check if a path is a directory or a file with the help of is_dir() function.
<?php
//mention your path here
$path = '/var/www/html/index.php';
// Check if the given path is directory or file
if (is_dir($path)) {
echo "The path is a directory.";
} else {
echo "The path is not a directory.";
}
?>
Output
This will produce the following result −
The path is not a directory.
Example
In this PHP code, we will use is_dir() function with a relative path. So if the mentioned path is a relative path so it will return true otherwise false.
<?php
// Mention the relative path here
$relativePath = './uploads';
if (is_dir($relativePath)) {
echo "The relative path is a directory.";
} else {
echo "The relative path is not a directory.";
}
?>
Output
This will generate the below result −
The relative path is a directory.
Example
In this PHP code, we will use is_dir() function to check multiple paths given in the array $paths. So it will check if the given paths are directory or not.
<?php
// Mention multiple paths here
$paths = ['/var/www/html', '/var/www/html/uploads', '/var/www/html/file.txt'];
foreach ($paths as $path) {
if (is_dir($path)) {
echo "The path '$path' is a directory.\n";
} else {
echo "The path '$path' is not a directory.\n";
}
}
?>
Output
This will produce the following output −
The path '/var/www/html' is a directory. The path '/var/www/html/uploads' is a directory. The path '/var/www/html/file.txt' is not a directory.
Note
- Verify to make sure the path is correct and easy to find.
- This function is useful when you need to make that a directory exists before performing specific file actions, such reading or writing files.
Summary
The is_dir() function is a powerful function for checking the given path is a directory in PHP. This method is useful to verify that directories exist before doing file operations.