rmdir()
rmdir() — Removes directory.
Built-in function of PHP 8.5. The manual lists it as available in PHP 4, PHP 5, PHP 7, PHP 8. This page is the reference card: signature, parameters and return value, plus the changelog and the example the manual provides.
What it does
Attempts to remove the directory named by directory. The directory must be empty, and the relevant permissions must permit this. A E_WARNING level error will be generated on failure.
Signature
rmdir(string $directory, ?resource $context = null): bool
Parameters
| Parameter | Type | What it takes |
|---|---|---|
| $directory | string | Path to the directory. |
| $context | ?resource | A context stream resource. |
Return value
Returns true on success or false on failure.
Example
A runnable snippet:
if (!is_dir('examples')) { mkdir('examples'); } rmdir('examples');
See also
All PHP 8.5 built-in functions
Reference card built from the PHP manual page rmdir() (PHP documentation, CC BY 3.0). The page is generated from the manual, so the wording of the parameter and return value text follows php.net.