function ArchiverInterface::remove

Same name in other branches
  1. 9 core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface::remove()
  2. 8.9.x core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface::remove()
  3. 10 core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface::remove()
  4. 11.x core/lib/Drupal/Core/Archiver/ArchiverInterface.php \Drupal\Core\Archiver\ArchiverInterface::remove()

Removes the specified file from the archive.

Parameters

$path: The file name relative to the root of the archive to remove.

Return value

ArchiverInterface The called object.

2 methods override ArchiverInterface::remove()
ArchiverTar::remove in modules/system/system.archiver.inc
Removes the specified file from the archive.
ArchiverZip::remove in modules/system/system.archiver.inc
Removes the specified file from the archive.

File

includes/archiver.inc, line 44

Class

ArchiverInterface
Defines the common interface for all Archiver classes.

Code

public function remove($path);

Buggy or inaccurate documentation? Please file an issue. Need support? Need help programming? Connect with the Drupal community.