WP_Filesystem_Base::rmdir() WordPress Method

The WP_Filesystem_Base::rmdir() method is used to remove a directory from the filesystem. The method accepts two parameters: the path to the directory to be removed and the recursive flag. If the recursive flag is set to true, the directory will be removed along with all its contents.

WP_Filesystem_Base::rmdir( string $path, bool $recursive = false ) #

Deletes a directory.


Parameters

$path

(string)(Required)Path to directory.

$recursive

(bool)(Optional) Whether to recursively remove files/directories.

Default value: false


Top ↑

Return

(bool) True on success, false on failure.


Top ↑

Source

File: wp-admin/includes/class-wp-filesystem-base.php

	public function rmdir( $path, $recursive = false ) {
		return false;
	}

Top ↑

Changelog

Changelog
VersionDescription
2.5.0Introduced.

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by theĀ Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.