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

Parameters

$filestring

Path to the file or directory.

$recursivebooloptional

If set to true, deletes files and folders recursively. Default false.Default: false

$typestring|falseoptional

Type of resource. 'f' for file, 'd' for directory. Default false.Default: false

Return

bool

True on success, false on failure.

Uses · 1

• WP_Filesystem_ftpsockets::is_file()Checks if resource is a file.

Used by · 1

• WP_Filesystem_ftpsockets::rmdir()Deletes a directory.

Source

View on Trac ↗View on GitHub ↗

455	public function delete( $file, $recursive = false, $type = false ) {456		if ( empty( $file ) ) {457			return false;458		}459 460		if ( 'f' === $type || $this->is_file( $file ) ) {461			return (bool) $this->ftp->delete( $file );462		}463 464		if ( ! $recursive ) {465			return (bool) $this->ftp->rmdir( $file );466		}467 468		return (bool) $this->ftp->mdel( $file );469	}

History

Introduced in 2.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 7.1.0 tag, from src/wp-admin/includes/class-wp-filesystem-ftpsockets.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.