php8.5
Home/ Manual/ stream / streamwrapper/ streamWrapper::rmdir

streamWrapper::rmdir

PHP function Edit on GitHub ✎

(PHP 5, PHP 7, PHP 8)

Removes a directory

Description

streamWrapper::rmdir(string $path, int $options): bool

This method is called in response to rmdir().

Note

In order for the appropriate error message to be returned this method should not be defined if the wrapper does not support removing directories.

Parameters

path

The directory URL which should be removed.

options

A bitwise mask of values, such as STREAM_MKDIR_RECURSIVE.

Return Values

Success

Errors/Exceptions Warning

Notes Context

See Also

  • rmdir()
  • streamwrapper::mkdir
  • streamwrapper::unlink

Source: reference/stream/streamwrapper/rmdir.xml · from the official PHP manual (php/doc-en)