(PHP >= 5.3.0, PECL phar >= 1.0.0)

Phar::offsetUnsetremove a file from a phar


bool Phar::offsetUnset ( string $offset )


This method requires the php.ini setting phar.readonly to be set to 0 in order to work for Phar objects. Otherwise, a PharException will be thrown.

This is an implementation of the ArrayAccess interface allowing direct manipulation of the contents of a Phar archive using array access brackets. offsetUnset is used for deleting an existing file, and is called by the unset() language construct.



The filename (relative path) to modify in a Phar.

Return Values

Returns TRUE on success or FALSE on failure.


if phar.readonly is 1, BadMethodCallException is thrown, as modifying a Phar is only allowed when phar.readonly is set to 0. Throws PharException if there are any problems flushing changes made to the Phar archive to disk.


Example #1 A Phar::offsetUnset() example

= new Phar('/path/to/my.phar'0'my.phar');
try {
// deletes file.txt from my.phar by calling offsetUnset
} catch (
Exception $e) {
'Could not delete file.txt: '$e;

See Also

add a note add a note

User Contributed Notes

There are no user contributed notes for this page.
To Top