WP_Filesystem_ftpsockets::delete() – Method

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

Deletes a file or directory.

Parameters

$filestringrequired: Path to the file or directory.
$recursivebooloptional: If set to true, deletes files and folders recursively.

Default:false
$typestring|falseoptional: Type of resource. 'f' for file, 'd' for directory.

Default:false

Return

bool True on success, false on failure.

Source

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 );
}

View all references View on Trac View on GitHub

Uses	Description
WP_Filesystem_ftpsockets::is_file()`wp-admin/includes/class-wp-filesystem-ftpsockets.php`	Checks if resource is a file.

Used by	Description
WP_Filesystem_ftpsockets::rmdir()`wp-admin/includes/class-wp-filesystem-ftpsockets.php`	Deletes a directory.

Changelog

Version	Description
2.5.0	Introduced.

User Contributed Notes

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