WP_Upgrader::delete_temp_backup()publicWP 6.3.0

Deletes a temporary backup.

Method of the class: WP_Upgrader{}

No Hooks.

Return

true|false|WP_Error. True on success, false on early exit, otherwise WP_Error.

Usage

$WP_Upgrader = new WP_Upgrader();
$WP_Upgrader->delete_temp_backup( $temp_backups );
$temp_backups(array[])

An array of temporary backups.

Default: array()

  • ...$0(array)
    Information about the backup.

    • dir(string)
      The temporary backup location in the upgrade-temp-backup directory.

    • slug(string)
      The item's slug.

    • src(string)
      The directory where the original is stored. For example, WP_PLUGIN_DIR.

Notes

  • Global. WP_Filesystem_Base. $wp_filesystem WordPress filesystem subclass.

Changelog

Since 6.3.0 Introduced.
Since 6.6.0 Added the $temp_backups parameter.

WP_Upgrader::delete_temp_backup() code WP 6.8

public function delete_temp_backup( array $temp_backups = array() ) {
	global $wp_filesystem;

	$errors = new WP_Error();

	if ( empty( $temp_backups ) ) {
		$temp_backups = $this->temp_backups;
	}

	foreach ( $temp_backups as $args ) {
		if ( empty( $args['slug'] ) || empty( $args['dir'] ) ) {
			return false;
		}

		if ( ! $wp_filesystem->wp_content_dir() ) {
			$errors->add( 'fs_no_content_dir', $this->strings['fs_no_content_dir'] );
			return $errors;
		}

		$temp_backup_dir = $wp_filesystem->wp_content_dir() . "upgrade-temp-backup/{$args['dir']}/{$args['slug']}";

		if ( ! $wp_filesystem->delete( $temp_backup_dir, true ) ) {
			$errors->add(
				'temp_backup_delete_failed',
				sprintf( $this->strings['temp_backup_delete_failed'], $args['slug'] )
			);
			continue;
		}
	}

	return $errors->has_errors() ? $errors : true;
}