wppaste
WordPress

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

Since
2.5.0
Source
wp-admin/includes/class-wp-filesystem-direct.php:373
Deletes a file or directory.

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 · 5

Used by · 3

Source

	public function delete( $file, $recursive = false, $type = false ) {		if ( empty( $file ) ) {			// Some filesystems report this as /, which can cause non-expected recursive deletion of all files in the filesystem.			return false;		} 		$file = str_replace( '\\', '/', $file ); // For Win32, occasional problems deleting files otherwise. 		if ( 'f' === $type || $this->is_file( $file ) ) {			return @unlink( $file );		} 		if ( ! $recursive && $this->is_dir( $file ) ) {			return @rmdir( $file );		} 		// At this point it's a folder, and we're in recursive mode.		$file     = trailingslashit( $file );		$filelist = $this->dirlist( $file, true ); 		$retval = true; 		if ( is_array( $filelist ) ) {			foreach ( $filelist as $filename => $fileinfo ) {				if ( ! $this->delete( $file . $filename, $recursive, $fileinfo['type'] ) ) {					$retval = false;				}			}		} 		if ( file_exists( $file ) && ! @rmdir( $file ) ) {			$retval = false;		} 		return $retval;	}

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 6.8.8 tag, from src/wp-admin/includes/class-wp-filesystem-direct.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.