WP_Filesystem_ftpsockets::delete( string $file, bool $recursive = false, string|false $type = false ): bool

Deletes a file or directory.


Parameters

$file string Required
Path to the file or directory.
$recursive bool Optional
If set to true, deletes files and folders recursively.

Default: false

$type string|false Optional
Type of resource. 'f' for file, 'd' for directory.

Default: false


Top ↑

Return

bool True on success, false on failure.


Top ↑

Source

File: wp-admin/includes/class-wp-filesystem-ftpsockets.php. View all references

public function delete( $file, $recursive = false, $type = false ) {
	if ( empty( $file ) ) {
		return false;
	}

	if ( 'f' === $type || $this->is_file( $file ) ) {
		return $this->ftp->delete( $file );
	}

	if ( ! $recursive ) {
		return $this->ftp->rmdir( $file );
	}

	return $this->ftp->mdel( $file );
}


Top ↑

Changelog

Changelog
Version Description
2.5.0 Introduced.

Top ↑

User Contributed Notes

You must log in before being able to contribute a note or feedback.