Manual:cleanupEmptyCategories.php

From mediawiki.org
Other languages:
MediaWiki version:
1.28


Details[edit]

cleanupEmptyCategories.php is a maintenance script to clean up empty categories in the category table. This script will clean up the category table by removing entries for empty categories without a description page and adding entries for empty categories with a description page. It will print out progress indicators every batch. The script is perfectly safe to run on large, live wikis, and running it multiple times is harmless. You may want to use the throttling options if it's causing too much load; they will not affect correctness.

If the script is stopped and later resumed, you can use the --mode and --begin options with the last printed progress indicator to pick up where you left off.

Options/Arguments[edit]

Option Description Required?
--mode Use "add" option to empty categories with description pages, "remove" option to empty categories without description pages or "both" to actually do both. Default: both Optional
--begin Only do categories whose names are alphabetically after the provided name Optional
--throttle Wait this many milliseconds after each batch. Default: 0 Optional
--force If the script was already ever used once force it to cleanup again. Default: unused Optional

Usage[edit]

php maintenance/cleanupEmptyCategories.php [ --mode| --begin| --throttle| --force ]


Terminal
$ php maintenance/cleanupEmptyCategories.php

Adding empty categories with description pages...
Removing empty categories without description pages...
Category cleanup complete.


Whenever the script runs, it makes a note in the database and will not run again. If you want to run the script again, run the command with the --force option.

See bug T235019.

See also[edit]