Manual:eraseArchivedFile.php

MediaWiki version:

≥ 1.22

MediaWiki file: eraseArchivedFile.php
Location:	maintenance/
Source code:	master • 1.43.0 • 1.42.4 • 1.39.11
Classes:	EraseArchivedFile

Details

eraseArchivedFile.php file is a maintenance script to delete the archived file provided by --filekey from the filesystem.

When the script is run with --filekey or with --filename, it will purge the thumbnails of the according image - even, if --delete has not been specified. That way you can use the script to force a re-rendering of the thumbnails without having to re-upload the image. Information about deleted files is stored in the filearchive table.

Options/Arguments

Option	Description	Required?
--filekey	File storage key (with extension) for a specific version to be deleted or "*" for all versions (in that case, `--filename` is required). The file storage key is an entry from the `fa_storage_key` column of the `filearchive` table.	Required
--filename	File name (corresponds to the value of `fa_name` in the `filearchive` table).	Optional
--delete	Perform the deletion. Will delete the archived file and possible thumbnails, but will not delete its entry in the `filearchive` table (nor will it delete log messages of the upload/deletion of the now-deleted file).	Optional

Usage

php maintenance/run.php eraseArchivedFile --filekey fa_storage_key [ --filename| --delete ]

In MediaWiki version 1.39.10 and earlier, you must invoke maintenance scripts using php maintenance/scriptName.php instead of php maintenance/run.php scriptName.

Dry run to check deletion

Terminal

$ php maintenance/run.php eraseArchivedFile --filekey o50kk2gmida2gmaxbp19qzdhhfosovz.jpg

Use --delete to actually confirm this script
Purging all thumbnails for file '1631330937964.jpeg'...
done.
Would delete version 'o50kk2gmida2gmaxbp19qzdhhfosovz.jpg' (20211026113341) of file '1631330937964.jpeg'

Making deletion action