WP_Filesystem_SSH2::delete

Advertisement

Summery Summery

Deletes a file or directory.

Syntax Syntax

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

Parameters Parameters

$file

(string) (Required) Path to the file or directory.

$recursive

(bool) (Optional) If set to true, deletes files and folders recursively.

Default value: false

$type

(string|false) (Optional) Type of resource. 'f' for file, 'd' for directory.

Default value: false

Return Return

(bool) True on success, false on failure.

Source Source

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

				// We need to remove the destination file before we can rename the source.
				$this->delete( $destination, false, 'f' );
			} else {
				// If we're not overwriting, the rename will fail, so return early.
				return false;
			}
		}

		return ssh2_sftp_rename( $this->sftp_link, $source, $destination );
	}

	/**
	 * Deletes a file or directory.
	 *
	 * @since 2.7.0

Advertisement

Changelog Changelog

Changelog
Version Description
2.7.0 Introduced.

Advertisement

Leave a Reply

This site uses Akismet to reduce spam. Learn how your comment data is processed.