Manual:run.php

MediaWiki file: run.php
Location:	maintenance/
Source code:	master • 1.43.0 • 1.42.4 • 1.39.11
Classes:	Find code • Find documentation

Details

run.php file is the entry point introduced in task T99268 for running maintenance scripts. The executable maintenance/run will call it. Since MediaWiki 1.40, running a maintenance script without run.php is deprecated. It introduces the wfMaintenanceRunSetup callback.

Usage

./maintenance/run <script>

‎<script> - The name of the maintenance script to run. Can be given as a class name or file path. The .php suffix is optional. Paths starting with ./ or ../ are interpreted to be relative to the current working directory. Other relative paths are interpreted relative to the maintenance script directory. Dots (.) are supported as namespace separators in class names. An extension name may be provided as a prefix, followed by a colon, e.g. MyExtension:exampleScript, to indicate that the path or class name should be interpreted relative to the extension.

Advanced Usage

./maintenance/run [--conf|--globals|--memory-limit|--profiler|--server|--wiki] <script>

Generic maintenance parameters

Option/Parameter	Description
--conf	Location of "LocalSettings.php", if not default
--globals	Output globals at the end of processing for debugging
--memory-limit	Set a specific memory limit for the script, "max" for no limit or "default" to avoid changing it
--profiler	The output format of the profiler, usually "text".
--server	The protocol and server name to use in URLs, e.g. https://en.wikipedia.org. This is sometimes necessary because server name detection may fail in command line scripts.
--wiki	For specifying the wiki ID

See also

• Manual:Maintenance scripts