MediaWiki  master
DefaultSettings.php File Reference

Default values for MediaWiki configuration settings. More...

Go to the source code of this file.

Variables

 $wgActionPaths = []
 To set 'pretty' URL paths for actions other than plain page views, add to this array. More...
 
 $wgAppleTouchIcon = false
 The URL path of the icon for iPhone and iPod Touch web app bookmarks. More...
 
 $wgArticlePath = false
 The URL path for primary article page views. More...
 
 $wgCapitalLinkOverrides = []
 
 $wgCapitalLinks = true
 Set this to false to avoid forcing the first letter of links to capitals. More...
 
 $wgConf = new SiteConfiguration
 $wgConf hold the site configuration. More...
 
 $wgConfigRegistry
 Registry of factory functions to create config objects: The 'main' key must be set, and the value should be a valid callable. More...
 
 $wgContentNamespaces = [ NS_MAIN ]
 Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are concerned. More...
 
 $wgExtensionAssetsPath = false
 The URL path of the extensions directory. More...
 
 $wgExtensionDirectory = "{$IP}/extensions"
 Filesystem extensions directory. More...
 
 $wgExtraSignatureNamespaces = []
 Array of namespaces, in addition to the talk namespaces, where signatures (~~~~) are likely to be used. More...
 
 $wgFavicon = '/favicon.ico'
 The URL path of the shortcut icon. More...
 
 $wgFileCacheDirectory = false
 Directory where the cached page will be saved. More...
 
 $wgImgAuthPath = false
 The base path for img_auth.php. More...
 
 $wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ]
 Array of invalid page redirect targets. More...
 
 $wgLoadScript = false
 The URL path to load.php. More...
 
 $wgLocalStylePath = false
 The URL path of the skins directory. More...
 
 $wgLogo = false
 The URL path of the wiki logo. More...
 
array false $wgLogoHD = false
 Array with URL paths to HD versions of the wiki logo. More...
 
array false $wgLogos = false
 The URL path to various wiki logos. More...
 
 $wgMaxRedirects = 1
 Max number of redirects to follow when resolving redirects. More...
 
 $wgNamespacesWithSubpages
 Which namespaces should support subpages? See Language.php for a list of namespaces. More...
 
 $wgRedirectSources = false
 If local interwikis are set up which allow redirects, set this regexp to restrict URLs which will be displayed as 'redirected from' links. More...
 
array string bool $wgReferrerPolicy = false
 Value for the referrer policy meta tag. More...
 
 $wgRestPath = false
 The URL path to the REST API Defaults to "{$wgScriptPath}/rest.php". More...
 
 $wgScript = false
 The URL path to index.php. More...
 
 $wgShortPagesNamespaceBlacklist = []
 Optional array of namespaces which should be blacklisted from Special:ShortPages Only pages inside $wgContentNamespaces but not $wgShortPagesNamespaceBlacklist will be shown on that page. More...
 
 $wgSitename = 'MediaWiki'
 Name of the site. More...
 
 $wgStyleDirectory = "{$IP}/skins"
 Filesystem stylesheets directory. More...
 
 $wgStylePath = false
 The URL path of the skins directory. More...
 
 $wgStyleSheetPath = &$wgStylePath
 
 $wgTmpDirectory = false
 The local filesystem path to a temporary directory. More...
 
 $wgTrackingCategories = []
 Array holding default tracking category names. More...
 
 $wgUploadBaseUrl = ''
 If set, this URL is added to the start of $wgUploadPath to form a complete upload URL. More...
 
 $wgUploadDirectory = false
 The filesystem path of the images directory. More...
 
 $wgUploadPath = false
 The URL path for the images directory. More...
 
 $wgUploadStashScalerBaseUrl = false
 To enable remote on-demand scaling, set this to the thumbnail base URL. More...
 
 $wgVersion = MW_VERSION
 MediaWiki version number. More...
 
Server URLs and file paths

In this section, a "path" is usually a host-relative URL, i.e.

a URL without the host part, that starts with a slash. In most cases a full URL is also acceptable. A "directory" is a local file path.

In both paths and directories, trailing slashes should not be included.

bool $wgAssumeProxiesUseDefaultProtocolPorts = true
 When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes the wiki on the standard ports (443 for https and 80 for http). More...
 
 $wgCanonicalServer = false
 Canonical URL of the server, to use in IRC feeds and notification e-mails. More...
 
bool $wgForceHTTPS = false
 If this is true, when an insecure HTTP request is received, always redirect to HTTPS. More...
 
 $wgHttpsPort = 443
 For installations where the canonical server is HTTP but HTTPS is optionally supported, you can specify a non-standard HTTPS port here. More...
 
 $wgScriptPath = '/wiki'
 The path we should point to. More...
 
 $wgServer = false
 URL of the server. More...
 
 $wgServerName = false
 Server name. More...
 
 $wgUsePathInfo
 Whether to support URLs like index.php/Page_title These often break when PHP is set up in CGI mode. More...
 
Files and file uploads
 $wgAllowCopyUploads = false
 Allow for upload to be copied from an URL. More...
 
 $wgAllowImageMoving = true
 Allows to move images and other media files. More...
 
 $wgAllowJavaUploads = false
 Allow Java archive uploads. More...
 
 $wgAntivirus = null
 Internal name of virus scanner. More...
 
 $wgAntivirusRequired = true
 Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected. More...
 
 $wgAntivirusSetup
 Configuration for different virus scanners. More...
 
 $wgAttemptFailureEpoch = 1
 Certain operations are avoided if there were too many recent failures, for example, thumbnail generation. More...
 
bool $wgCacheSharedUploads = true
 Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos. More...
 
 $wgCheckFileExtensions = true
 This is a flag to determine whether or not to check file extensions on upload. More...
 
 $wgContentHandlers
 Plugins for page content model handling. More...
 
 $wgCopyUploadProxy = false
 Proxy to use for copy upload requests. More...
 
 $wgCopyUploadsDomains = []
 A list of domains copy uploads can come from. More...
 
 $wgCopyUploadsFromSpecialUpload = false
 Enable copy uploads from Special:Upload. More...
 
int bool $wgCopyUploadTimeout = false
 Different timeout for upload by url This could be useful since when fetching large files, you may want a timeout longer than the default $wgHTTPTimeout. More...
 
 $wgCustomConvertCommand = false
 Use another resizing converter, e.g. More...
 
 $wgDeletedDirectory = false
 What directory to place deleted uploads in. More...
 
 $wgDirectoryMode = 0777
 Default value for chmoding of new directories. More...
 
 $wgDisableUploadScriptChecks = false
 Setting this to true will disable the upload system's checks for HTML/JavaScript. More...
 
 $wgEnableAsyncUploads = false
 Enable deferred upload tasks that use the job queue. More...
 
 $wgEnableAutoRotation = null
 If set to true, images that contain certain the exif orientation tag will be rotated accordingly. More...
 
 $wgEnableUploads = false
 Allow users to upload files. More...
 
 $wgExiftool = '/usr/bin/exiftool'
 Path to exiftool binary. More...
 
 $wgExiv2Command = '/usr/bin/exiv2'
 Some tests and extensions use exiv2 to manipulate the Exif metadata in some image formats. More...
 
bool $wgFetchCommonsDescriptions = false
 Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos. More...
 
 $wgFileBackends = []
 File backend structure configuration. More...
 
 $wgFileBlacklist
 Files with these extensions will never be allowed as uploads. More...
 
 $wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ]
 This is the list of preferred extensions for uploading files. More...
 
 $wgForeignFileRepos = []
 Enable the use of files from one or more other wikis. More...
 
 $wgForeignUploadTargets = [ 'local' ]
 Array of foreign file repo names (set in $wgForeignFileRepos above) that are allowable upload targets. More...
 
 $wgGalleryOptions = []
 Parameters for the "<gallery>" tag. More...
 
bool $wgGenerateThumbnailOnParse = true
 Render thumbnails while parsing wikitext. More...
 
bool $wgHashedSharedUploadDirectory = true
 Shortcut for the 'hashLevels' setting of $wgForeignFileRepos. More...
 
bool $wgHashedUploadDirectory = true
 Shortcut for setting hashLevels=2 in $wgLocalFileRepo. More...
 
 $wgIgnoreImageErrors = false
 If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an error message. More...
 
 $wgIllegalFileChars = ":\\/\\\\"
 Additional characters that are not allowed in filenames. More...
 
 $wgImageLimits
 Limit images on image description pages to a user-selectable limit. More...
 
 $wgImageMagickConvertCommand = '/usr/bin/convert'
 The convert command shipped with ImageMagick. More...
 
 $wgImageMagickTempDir = false
 Temporary directory used for ImageMagick. More...
 
 $wgImagePreconnect = false
 On pages containing images, tell the user agent to pre-connect to hosts from $wgForeignFileRepos. More...
 
 $wgImgAuthDetails = false
 Set this to true if you use img_auth and want the user to see details on why access failed. More...
 
 $wgImgAuthUrlPathMap = []
 Map of relative URL directories to match to internal mwstore:// base storage paths. More...
 
 $wgJpegPixelFormat = 'yuv420'
 At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma subsampling to reduce file size, at the cost of possible color fringing at sharp edges. More...
 
 $wgJpegQuality = 80
 When scaling a JPEG thumbnail, this is the quality we request from the backend. More...
 
 $wgJpegTran = '/usr/bin/jpegtran'
 used for lossless jpeg rotation More...
 
 $wgLocalFileRepo = false
 File repository structures. More...
 
 $wgLockManagers = []
 Array of configuration arrays for each lock manager. More...
 
 $wgMaxAnimatedGifArea = 1.25e7
 Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnail. More...
 
 $wgMaxImageArea = 1.25e7
 The maximum number of pixels a source image can have if it is to be scaled down by a scaler that requires the full source image to be decompressed and stored in decompressed form, before the thumbnail is generated. More...
 
 $wgMaxInterlacingAreas = []
 Array of max pixel areas for interlacing per MIME type. More...
 
 $wgMaxUploadSize = 1024 * 1024 * 100
 Max size for uploads, in bytes. More...
 
 $wgMediaHandlers = []
 Plugins for media file type handling. More...
 
 $wgMediaInTargetLanguage = true
 Whether thumbnails should be generated in target language (usually, same as page language), if available. More...
 
 $wgMimeDetectorCommand = null
 Sets an external MIME detector program. More...
 
 $wgMimeInfoFile = 'internal'
 Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php. More...
 
 $wgMimeTypeBlacklist
 Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled. More...
 
 $wgMimeTypeFile = 'internal'
 Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php. More...
 
 $wgMinUploadChunkSize = 1024
 Minimum upload chunk size, in bytes. More...
 
 $wgParserTestMediaHandlers
 Media handler overrides for parser tests (they don't need to generate actual thumbnails, so a mock will do) More...
 
 $wgRepositoryBaseUrl = 'https://commons.wikimedia.org/wiki/File:'
 Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos. More...
 
 $wgResponsiveImages = true
 Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities. More...
 
string $wgSharedThumbnailScriptPath = false
 Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos. More...
 
bool string $wgSharedUploadDBname = false
 Shortcut for the ForeignDBRepo 'dbName' setting in $wgForeignFileRepos. More...
 
string $wgSharedUploadDBprefix = ''
 Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos. More...
 
string $wgSharedUploadDirectory = null
 Shortcut for the 'directory' setting of $wgForeignFileRepos. More...
 
string $wgSharedUploadPath = null
 Shortcut for the 'url' setting of $wgForeignFileRepos. More...
 
 $wgSharpenParameter = '0x0.4'
 Sharpening parameter to ImageMagick. More...
 
 $wgSharpenReductionThreshold = 0.85
 Reduction in linear dimensions below which sharpening will be enabled. More...
 
 $wgShowArchiveThumbnails = true
 Show thumbnails for old images on the image description page. More...
 
 $wgShowEXIF = function_exists( 'exif_read_data' )
 Show Exif data, on by default if available. More...
 
 $wgStrictFileExtensions = true
 If this is turned off, users may override the warning for files not covered by $wgFileExtensions. More...
 
 $wgSVGConverter = 'ImageMagick'
 Pick a converter defined in $wgSVGConverters. More...
 
 $wgSVGConverterPath = ''
 If not in the executable PATH, specify the SVG converter path. More...
 
 $wgSVGConverters
 Scalable Vector Graphics (SVG) may be uploaded as images. More...
 
 $wgSVGMaxSize = 5120
 Don't scale a SVG larger than this. More...
 
 $wgSVGMetadataCutoff = 262144
 Don't read SVG metadata beyond this point. More...
 
 $wgThumbLimits
 Adjust thumbnails on image pages according to a user setting. More...
 
 $wgThumbnailBuckets = null
 When defined, is an array of image widths used as buckets for thumbnail generation. More...
 
 $wgThumbnailEpoch = '20030516000000'
 If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if the file didn't already exist. More...
 
 $wgThumbnailMinimumBucketDistance = 50
 When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size. More...
 
 $wgThumbnailScriptPath = false
 Give a path here to use thumb.php for thumbnail generation on client request, instead of generating them on render and outputting a static URL. More...
 
 $wgThumbUpright = 0.75
 Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright images without the need to fix the width by hardcoded px in wiki sourcecode. More...
 
 $wgTiffThumbnailType = []
 Browsers don't support TIFF inline generally... More...
 
 $wgTrivialMimeDetection = false
 Switch for trivial MIME detection. More...
 
 $wgTrustedMediaFormats
 list of trusted media-types and MIME types. More...
 
 $wgUpdateCompatibleMetadata = false
 If to automatically update the img_metadata field if the metadata field is outdated but compatible with the current version. More...
 
 $wgUploadDialog
 Configuration for file uploads using the embeddable upload dialog (https://www.mediawiki.org/wiki/Upload_dialog). More...
 
 $wgUploadMissingFileUrl = false
 Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl. More...
 
 $wgUploadNavigationUrl = false
 Point the upload navigation link to an external URL Useful if you want to use a shared repository by default without disabling local uploads (use $wgEnableUploads = false for that). More...
 
 $wgUploadSizeWarning = false
 Warn if uploaded files are larger than this (in bytes), or false to disable. More...
 
 $wgUploadStashMaxAge = 6 * 3600
 The maximum age of temporary (incomplete) uploaded files. More...
 
 $wgUploadThumbnailRenderHttpCustomDomain = false
 When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to. More...
 
 $wgUploadThumbnailRenderHttpCustomHost = false
 When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header. More...
 
 $wgUploadThumbnailRenderMap = []
 When defined, is an array of thumbnail widths to be rendered at upload time. More...
 
 $wgUploadThumbnailRenderMethod = 'jobqueue'
 The method through which the thumbnails will be prerendered for the entries in $wgUploadThumbnailRenderMap. More...
 
 $wgUseImageMagick = false
 Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party converter, e.g. More...
 
 $wgUseImageResize = true
 Whether to enable server-side image thumbnailing. More...
 
 $wgUseInstantCommons = false
 Use Wikimedia Commons as a foreign file repository. More...
 
bool $wgUseSharedUploads = false
 Shortcut for adding an entry to $wgForeignFileRepos. More...
 
 $wgUseTinyRGBForJPGThumbnails = false
 When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight (and free) TinyRGB profile when generating thumbnails. More...
 
 $wgVerifyMimeType = true
 Determines if the MIME type of uploaded files should be checked. More...
 
 $wgVerifyMimeTypeIE = true
 Determines whether extra checks for IE type detection should be applied. More...
 
 $wgXMLMimeTypes
 Additional XML types we can allow via MIME-detection. More...
 
DJVU settings
 $wgDjvuDump = null
 Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';. More...
 
 $wgDjvuOutputExtension = 'jpg'
 File extension for the DJVU post processor output. More...
 
 $wgDjvuPostProcessor = 'pnmtojpeg'
 Shell command for the DJVU post processor Default: pnmtojpeg, since ddjvu generates ppm output Set this to false to output the ppm file directly. More...
 
 $wgDjvuRenderer = null
 Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';. More...
 
 $wgDjvuToXML = null
 Path of the djvutoxml executable This works like djvudump except much, much slower as of version 3.5. More...
 
 $wgDjvuTxt = null
 Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';. More...
 
Email settings
 $wgAdditionalMailParams = null
 Additional email parameters, will be passed as the last argument to mail() call. More...
 
 $wgAllowHTMLEmail = false
 For parts of the system that have been updated to provide HTML email content, send both text and HTML parts as the body of the email. More...
 
 $wgEmailAuthentication = true
 Require email authentication before sending mail to an email address. More...
 
 $wgEmergencyContact = false
 Site admin email address. More...
 
 $wgEnableEmail = true
 Set to true to enable the e-mail basic features: Password reminders, etc. More...
 
 $wgEnableSpecialMute = false
 Set to true to enable the Special Mute page. More...
 
 $wgEnableUserEmail = true
 Set to true to enable user-to-user e-mail. More...
 
 $wgEnableUserEmailBlacklist = false
 Set to true to enable user-to-user e-mail blacklist. More...
 
bool $wgEnotifFromEditor = false
 Allow sending of e-mail notifications with the editor's address as sender. More...
 
 $wgEnotifImpersonal = false
 Send a generic mail instead of a personalised mail for each user. More...
 
 $wgEnotifMaxRecips = 500
 Maximum number of users to mail at once when using impersonal mail. More...
 
 $wgEnotifMinorEdits = true
 Potentially send notification mails on minor edits to pages. More...
 
bool $wgEnotifRevealEditorAddress = false
 Allow sending of e-mail notifications with the editor's address in "Reply-To". More...
 
 $wgEnotifUseRealName = false
 Use real name instead of username in e-mail "from" field. More...
 
 $wgEnotifUserTalk = false
 Allow users to enable email notification ("enotif") when someone edits their user talk page. More...
 
 $wgEnotifWatchlist = false
 Allow users to enable email notification ("enotif") on watchlist changes. More...
 
 $wgNewPasswordExpiry = 3600 * 24 * 7
 The time, in seconds, when an emailed temporary password expires. More...
 
 $wgNoReplyAddress = false
 Reply-To address for e-mail notifications. More...
 
 $wgPasswordExpirationDays = false
 The number of days that a user's password is good for. More...
 
 $wgPasswordExpireGrace = 3600 * 24 * 7
 If a user's password is expired, the number of seconds when they can still login, and cancel their password change, but are sent to the password change form on each login. More...
 
 $wgPasswordReminderResendTime = 24
 Minimum time, in hours, which must elapse between password reminder emails for a given account. More...
 
 $wgPasswordSender = false
 Sender email address for e-mail notifications. More...
 
 $wgSMTP = false
 SMTP Mode. More...
 
 $wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60
 The time, in seconds, when an email confirmation email expires. More...
 
 $wgUserEmailUseReplyTo = true
 If true put the sending user's email in a Reply-To header instead of From (false). More...
 
 $wgUsersNotifiedOnAllChanges = []
 Array of usernames who will be sent a notification email for every change which occurs on a wiki. More...
 
Database settings
 $wgDataCenterUpdateStickTTL = 10
 After a state-changing request is done by a client, this determines how many seconds that client should keep using the master datacenter. More...
 
 $wgDBadminpassword = null
 Separate password for maintenance tasks. More...
 
 $wgDBadminuser = null
 Separate username for maintenance tasks. More...
 
 $wgDBcompress = false
 Whether to use compression in DB connection. More...
 
 $wgDBDefaultGroup = null
 Default group to use when getting database connections. More...
 
 $wgDBerrorLog = false
 File to log database errors to. More...
 
 $wgDBerrorLogTZ = false
 Timezone to use in the error log. More...
 
 $wgDBmwschema = null
 Current wiki database schema name. More...
 
 $wgDBname = 'my_wiki'
 Current wiki database name. More...
 
 $wgDBpassword = ''
 Database user's password. More...
 
 $wgDBport = 5432
 Database port number (for PostgreSQL and Microsoft SQL Server). More...
 
 $wgDBprefix = ''
 Current wiki database table name prefix. More...
 
 $wgDBserver = 'localhost'
 Database host name or IP address. More...
 
 $wgDBservers = false
 Database load balancer This is a two-dimensional array, an array of server info structures Fields are: More...
 
 $wgDBssl = false
 Whether to use SSL in DB connection. More...
 
 $wgDBTableOptions = 'ENGINE=InnoDB, DEFAULT CHARSET=binary'
 MySQL table options to use during installation or update. More...
 
 $wgDBtype = 'mysql'
 Database type. More...
 
 $wgDBuser = 'wikiuser'
 Database username. More...
 
 $wgLBFactoryConf = [ 'class' => \Wikimedia\Rdbms\LBFactorySimple::class ]
 Load balancer factory configuration To set up a multi-master wiki farm, set the class here to something that can return a LoadBalancer with an appropriate master on a call to getMainLB(). More...
 
string[] $wgLocalDatabases = []
 Other wikis on this site, can be administered from a single developer account. More...
 
 $wgSearchType = null
 Search type. More...
 
 $wgSearchTypeAlternatives = null
 Alternative search types. More...
 
 $wgSharedDB = null
 Shared database for multiple wikis. More...
 
 $wgSharedPrefix = false
 
 $wgSharedSchema = false
 
 $wgSharedTables = [ 'user', 'user_properties' ]
 
 $wgSlaveLagCritical = 30
 
 $wgSlaveLagWarning = 10
 If lag is higher than $wgSlaveLagWarning, show a warning in some special pages (like watchlist). More...
 
 $wgSQLiteDataDir = ''
 To override default SQLite data directory ($docroot/../data) More...
 
 $wgSQLMode = ''
 SQL Mode - default is turning off all modes, including strict, if set. More...
 
Text storage
 $wgCompressRevisions = false
 We can also compress text stored in the 'text' table. More...
 
array $wgDefaultExternalStore = false
 The place to put new revisions, false to put them in the local text table. More...
 
 $wgExternalServers = []
 An array of external MySQL servers. More...
 
 $wgExternalStores = []
 External stores allow including content from non database sources following URL links. More...
 
 $wgRevisionCacheExpiry = 86400 * 7
 Revision text may be cached in $wgMemc to reduce load on external storage servers and object extraction overhead for frequently-loaded revisions. More...
 
Performance hacks and limits
 $wgAllowSchemaUpdates = true
 Allow schema updates. More...
 
 $wgAllowSlowParserFunctions = false
 Enable slow parser functions. More...
 
 $wgDisableQueryPages = false
 Disable all query pages if miser mode is on, not just some. More...
 
 $wgMaxArticleSize = 2048
 Maximum article size in kilobytes. More...
 
 $wgMemoryLimit = "50M"
 The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount. More...
 
 $wgMiserMode = false
 Disable database-intensive features. More...
 
 $wgQueryCacheLimit = 1000
 Number of rows to cache in 'querycache' table when miser mode is on. More...
 
 $wgTransactionalTimeLimit = 120
 The minimum amount of time that MediaWiki needs for "slow" write request, particularly ones with multiple non-atomic writes that should be as transactional as possible; MediaWiki will call set_time_limit() if needed. More...
 
 $wgWantedPagesThreshold = 1
 Number of links to a page required before it is deemed "wanted". More...
 
Cache settings
 $wgAdaptiveMessageCache = false
 Instead of caching everything, only cache those messages which have been customised in the site content language. More...
 
 $wgCacheDirectory = false
 Directory for caching data in the local filesystem. More...
 
 $wgCacheEpoch = '20030516000000'
 Set this to current time to invalidate all prior cached pages. More...
 
 $wgCachePages = true
 Allow client-side caching of pages. More...
 
 $wgEnableSidebarCache = false
 If on, the sidebar navigation links are cached for users with the current language set. More...
 
bool $wgEnableWANCacheReaper = false
 Verify and enforce WAN cache purges using reliable DB sources as streams. More...
 
int bool $wgExtensionInfoMTime = false
 When loading extensions through the extension registration system, this can be used to invalidate the cache. More...
 
 $wgFileCacheDepth = 2
 Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory. More...
 
 $wgFooterLinkCacheExpiry = 0
 Expiry time for the footer link cache, in seconds, or 0 if disabled. More...
 
 $wgGitInfoCacheDirectory = false
 Directory where GitInfo will look for pre-computed cache files. More...
 
 $wgInvalidateCacheOnLocalSettingsChange = true
 Invalidate various caches when LocalSettings.php changes. More...
 
 $wgLanguageConverterCacheType = CACHE_ANYTHING
 The cache type for storing language conversion tables, which are used when parsing certain text and interface messages. More...
 
 $wgLocalisationCacheConf
 Localisation cache configuration. More...
 
 $wgMainCacheType = CACHE_NONE
 Main cache type. More...
 
 $wgMainStash = 'db-replicated'
 The object store type of the main stash. More...
 
 $wgMainWANCache = false
 Main Wide-Area-Network cache type. More...
 
 $wgMemCachedPersistent = false
 Use persistent connections to MemCached, which are shared across multiple requests. More...
 
 $wgMemCachedServers = [ '127.0.0.1:11211' ]
 The list of MemCached servers and port numbers. More...
 
 $wgMemCachedTimeout = 500000
 Read/write timeout for MemCached server communication, in microseconds. More...
 
 $wgMessageCacheType = CACHE_ANYTHING
 The cache type for storing the contents of the MediaWiki namespace. More...
 
 $wgObjectCaches
 Advanced object cache configuration. More...
 
 $wgObjectCacheSessionExpiry = 3600
 The expiry time to use for session storage, in seconds. More...
 
 $wgParserCacheExpireTime = 86400
 The expiry time for the parser cache, in seconds. More...
 
 $wgParserCacheType = CACHE_ANYTHING
 The cache type for storing article HTML. More...
 
string $wgPHPSessionHandling = 'enable'
 Whether to use PHP session handling ($_SESSION and session_*() functions) More...
 
 $wgRenderHashAppend = ''
 Append a configured value to the parser cache and the sitenotice key so that they can be kept separate for some class of activity. More...
 
 $wgSessionCacheType = CACHE_ANYTHING
 The cache type for storing session data. More...
 
 $wgSessionPbkdf2Iterations = 10001
 Number of internal PBKDF2 iterations to use when deriving session secrets. More...
 
 $wgSidebarCacheExpiry = 86400
 Expiry time for the sidebar cache, in seconds. More...
 
 $wgUseFileCache = false
 This will cache static pages for non-logged-in users to reduce database traffic on public sites. More...
 
 $wgUseGzip = false
 When using the file cache, we can store the cached HTML gzipped to save disk space. More...
 
 $wgUseLocalMessageCache = false
 Set this to true to maintain a copy of the message cache on the local server. More...
 
 $wgWANObjectCaches
 Advanced WAN object cache configuration. More...
 
HTTP proxy (CDN) settings

Many of these settings apply to any HTTP proxy used in front of MediaWiki, although they are sometimes still referred to as Squid settings for historical reasons.

Achieving a high hit ratio with an HTTP proxy requires special configuration. See https://www.mediawiki.org/wiki/Manual:Performance_tuning#Page_view_caching for more details.

 $wgCdnMaxAge = 18000
 Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI). More...
 
 $wgCdnMaxageLagged = 30
 Cache timeout for the CDN when DB replica DB lag is high. More...
 
 $wgCdnMaxageStale = 10
 Cache timeout when delivering a stale ParserCache response due to PoolCounter contention. More...
 
 $wgCdnMaxageSubstitute = 60
 Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load) More...
 
 $wgCdnReboundPurgeDelay = 0
 If set, any SquidPurge call on a URL or URLs will send a second purge no less than this many seconds later via the job queue. More...
 
 $wgCdnServers = []
 List of proxy servers to purge on changes; default port is 80. More...
 
 $wgCdnServersNoPurge = []
 As with $wgCdnServers, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc. More...
 
 $wgForcedRawSMaxage = 300
 Default maximum age for raw CSS/JS accesses. More...
 
 $wgHTCPMulticastTTL = 1
 HTCP multicast TTL. More...
 
 $wgHTCPRouting = []
 Routing configuration for HTCP multicast purging. More...
 
 $wgInternalServer = false
 Internal server name as known to CDN, if different. More...
 
 $wgLoggedOutMaxAge = 0
 Cache TTL for the user agent sent as max-age, for logged out users. More...
 
 $wgSquidPurgeUseHostHeader = true
 Whether to use a Host header in purge requests sent to the proxy servers configured in $wgCdnServers. More...
 
 $wgUseCdn = false
 Enable/disable CDN. More...
 
 $wgUsePrivateIPs = false
 Should forwarded Private IPs be accepted? More...
 
 $wgVaryOnXFP = false
 Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds. More...
 
Language, regional and character encoding settings
 $wgAllUnicodeFixes = false
 Set this to always convert certain Unicode sequences to modern ones regardless of the content language. More...
 
 $wgAmericanDates = false
 Enable dates like 'May 12' instead of '12 May', if the default date format is 'dmy or mdy'. More...
 
 $wgDefaultLanguageVariant = false
 Default variant code, if false, the default will be the language code. More...
 
 $wgDisabledVariants = []
 Disabled variants array of language variant conversion. More...
 
 $wgDisableLangConversion = false
 Whether to enable language variant conversion. More...
 
 $wgDisableTitleConversion = false
 Whether to enable language variant conversion for links. More...
 
 $wgDummyLanguageCodes = []
 Functionally the same as $wgExtraLanguageCodes, but deprecated. More...
 
 $wgExtraInterlanguageLinkPrefixes = []
 List of additional interwiki prefixes that should be treated as interlanguage links (i.e. More...
 
 $wgExtraLanguageCodes
 List of mappings from one language code to another. More...
 
 $wgExtraLanguageNames = []
 List of language names or overrides for default names in Names.php. More...
 
 $wgForceUIMsgAsContentMsg = []
 When translating messages with wfMessage(), it is not always clear what should be considered UI messages and what should be content messages. More...
 
 $wgGrammarForms = []
 Some languages need different word forms, usually for different cases. More...
 
 $wgHideInterlanguageLinks = false
 Hide interlanguage links from the sidebar. More...
 
 $wgInterlanguageLinkCodeMap = []
 Map of interlanguage link codes to language codes. More...
 
 $wgInterwikiMagic = true
 Treat language links as magic connectors, not inline links. More...
 
 $wgLangObjCacheSize = 10
 Language cache size, or really how many languages can we handle simultaneously without degrading to crawl speed. More...
 
 $wgLanguageCode = 'en'
 Site language code. More...
 
 $wgLegacyEncoding = false
 Set this to eg 'ISO-8859-1' to perform character set conversion when loading old revisions not marked with "utf-8" flag. More...
 
 $wgLegacySchemaConversion = false
 If set to true, the MediaWiki 1.4 to 1.5 schema conversion will create stub reference rows in the text table instead of copying the full text of all current entries from 'cur' to 'text'. More...
 
 $wgLocaltimezone = null
 Fake out the timezone that the server thinks it's in. More...
 
 $wgLocalTZoffset = null
 Set an offset from UTC in minutes to use for the default timezone setting for anonymous users and new user accounts. More...
 
 $wgLoginLanguageSelector = false
 Show a bar of language selection links in the user login and user registration forms; edit the "loginlanguagelinks" message to customise these. More...
 
 $wgMaxMsgCacheEntrySize = 10000
 Maximum entry size in the message cache, in bytes. More...
 
array $wgOverrideUcfirstCharacters = []
 List of Unicode characters for which capitalization is overridden in Language::ucfirst. More...
 
 $wgTranslateNumerals = true
 For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface. More...
 
 $wgUseDatabaseMessages = true
 Translation using MediaWiki: namespace. More...
 
 $wgUsePigLatinVariant = false
 Whether to enable the pig Latin variant of English (en-x-piglatin), used to ease variant development work. More...
 
 $wgVariantArticlePath = false
 Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which parts of the URL contain the language variant. More...
 
Output format and skin settings
 $wgAllowUserCss = false
 Allow user Cascading Style Sheets (CSS)? This enables a lot of neat customizations, but may increase security risk to users and server load. More...
 
 $wgAllowUserCssPrefs = true
 Allow style-related user-preferences? More...
 
 $wgAllowUserJs = false
 Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load. More...
 
 $wgApiFrameOptions = 'DENY'
 Disallow framing of API pages directly, by setting the X-Frame-Options header. More...
 
 $wgBreakFrames = false
 Break out of framesets. More...
 
 $wgDefaultSkin = 'vector'
 Default skin, for new users and anonymous visitors. More...
 
 $wgDisableOutputCompression = false
 Disable output compression (enabled by default if zlib is available) More...
 
 $wgEdititis = false
 Display user edit counts in various prominent places. More...
 
 $wgEditPageFrameOptions = 'DENY'
 The X-Frame-Options header to send on pages sensitive to clickjacking attacks, such as edit pages. More...
 
 $wgEditSubmitButtonLabelPublish = false
 Whether to label the store-to-database-and-show-to-others button in the editor as "Save page"/"Save changes" if false (the default) or, if true, instead as "Publish page"/"Publish changes". More...
 
 $wgEnableCanonicalServerLink = false
 Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e. More...
 
 $wgExternalInterwikiFragmentMode = 'legacy'
 Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragmentMode above for details of each mode. More...
 
 $wgFallbackSkin = 'fallback'
 Fallback skin used when the skin defined by $wgDefaultSkin can't be found. More...
 
 $wgFooterIcons
 Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can add new icons to the built in copyright or poweredby, or you can create a new block. More...
 
 $wgFragmentMode = [ 'legacy', 'html5' ]
 How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of: More...
 
 $wgHtml5Version = null
 Defines the value of the version attribute in the <html> tag, if any. More...
 
 $wgHTMLFormAllowTableFormat = true
 Temporary variable that allows HTMLForms to be rendered as tables. More...
 
 $wgMangleFlashPolicy = true
 When OutputHandler is used, mangle any output that contains <cross-domain-policy>. More...
 
 $wgMimeType = 'text/html'
 The default Content-Type header. More...
 
 $wgSend404Code = true
 Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output. More...
 
 $wgShowRollbackEditCount = 10
 The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back. More...
 
 $wgSiteNotice = ''
 Site notice shown at the top of each page. More...
 
 $wgSkipSkins = []
 Specify the names of skins that should not be presented in the list of available skins in user preferences. More...
 
 $wgUseCombinedLoginLink = false
 Login / create account link behavior when it's possible for anonymous users to create an account. More...
 
 $wgUseMediaWikiUIEverywhere = false
 Temporary variable that applies MediaWiki UI wherever it can be supported. More...
 
 $wgUseSiteCss = true
 Use the site's Cascading Style Sheets (CSS)? More...
 
 $wgUseSiteJs = true
 Use the site's Javascript page? More...
 
 $wgXhtmlNamespaces = []
 Permit other namespaces in addition to the w3.org default. More...
 
ResourceLoader settings
 $wgAllowSiteCSSOnRestrictedPages = false
 Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on restricted pages like Special:UserLogin or Special:Preferences where JavaScript is disabled for security reasons. More...
 
 $wgIncludeLegacyJavaScript = false
 Whether to ensure the mediawiki.legacy library is loaded before other modules. More...
 
 $wgLegacyJavaScriptGlobals = true
 Whether or not to assign configuration variables to the global window object. More...
 
 $wgResourceBasePath = null
 The default 'remoteBasePath' value for instances of ResourceLoaderFileModule. More...
 
 $wgResourceLoaderDebug = false
 The default debug mode (on/off) for of ResourceLoader requests. More...
 
 $wgResourceLoaderEnableJSProfiler = false
 When enabled, execution of JavaScript modules is profiled client-side. More...
 
 $wgResourceLoaderMaxage
 Maximum time in seconds to cache resources served by ResourceLoader. More...
 
int $wgResourceLoaderMaxQueryLength = false
 ResourceLoader will not generate URLs whose query string is more than this many characters long, and will instead use multiple requests with shorter query strings. More...
 
 $wgResourceLoaderSources = []
 Extensions should register foreign module sources here. More...
 
 $wgResourceLoaderStorageEnabled = true
 Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API. More...
 
 $wgResourceLoaderStorageVersion = 1
 Cache version for client-side ResourceLoader module storage. More...
 
 $wgResourceLoaderUseObjectCacheForDeps = false
 Use the main stash instead of the module_deps table for indirect dependency tracking. More...
 
 $wgResourceLoaderValidateJS = true
 If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it. More...
 
 $wgResourceModules = []
 Define extra client-side modules to be registered with ResourceLoader. More...
 
 $wgResourceModuleSkinStyles = []
 Add extra skin-specific styles to a resource module. More...
 
 $wgVueDevelopmentMode = false
 Whether to use the development version of Vue.js. More...
 
Page title and interwiki link settings
 $wgExtraGenderNamespaces = []
 Same as above, but for namespaces with gender distinction. More...
 
 $wgExtraNamespaces = []
 Additional namespaces. More...
 
 $wgInterwikiExpiry = 10800
 Expiry time for cache of interwiki table. More...
 
 $wgLegalTitleChars = " %!\"$&'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+"
 Allowed title characters – regex character class Don't change this unless you know what you're doing. More...
 
 $wgLocalInterwikis = []
 Array for local interwiki values, for each of the interwiki prefixes that point to the current wiki. More...
 
 $wgMetaNamespace = false
 Name of the project namespace. More...
 
 $wgMetaNamespaceTalk = false
 Name of the project talk namespace. More...
 
 $wgNamespaceAliases = []
 Define extra namespace aliases. More...
 
Interwiki caching settings.
bool array string $wgInterwikiCache = false
 Interwiki cache, either as an associative array or a path to a constant database (.cdb) file. More...
 
 $wgInterwikiFallbackSite = 'wiki'
 Fallback site, if unable to resolve from cache. More...
 
 $wgInterwikiScopes = 3
 Specify number of domains to check for messages. More...
 
Parser settings

These settings configure the transformation from wikitext to HTML.

 $wgAllowDisplayTitle = true
 Allow DISPLAYTITLE to change title display. More...
 
 $wgAllowExternalImages = false
 Whether to allow inline image pointing to other websites. More...
 
 $wgAllowExternalImagesFrom = ''
 If the above is false, you can specify an exception here. More...
 
 $wgAllowImageTag = false
 A different approach to the above: simply allow the "<img>" tag to be used. More...
 
 $wgCleanSignatures = true
 If true, removes (by substituting) templates in signatures. More...
 
 $wgEnableImageWhitelist = false
 If $wgAllowExternalImages is false, you can allow an on-wiki allow list of regular expression fragments to match the image URL against. More...
 
 $wgEnableMagicLinks
 Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links. More...
 
 $wgEnableScaryTranscluding = false
 Enable interwiki transcluding. More...
 
 $wgExpensiveParserFunctionLimit = 100
 Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY. More...
 
 $wgExternalLinkTarget = false
 Set a default target for external links, e.g. More...
 
 $wgMaxPPExpandDepth = 40
 
 $wgMaxPPNodeCount = 1000000
 A complexity limit on template expansion: the maximum number of nodes visited by PPFrame::expand() More...
 
 $wgMaxTemplateDepth = 40
 Maximum recursion depth for templates within templates. More...
 
 $wgMaxTocLevel = 999
 Maximum indent level of toc. More...
 
 $wgNoFollowDomainExceptions = [ 'mediawiki.org' ]
 If this is set to an array of domains, external links to these domain names (or any subdomains) will not be set to rel="nofollow" regardless of the value of $wgNoFollowLinks. More...
 
 $wgNoFollowLinks = true
 If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to search engines that they should not be followed for ranking purposes as they are user-supplied and thus subject to spamming. More...
 
 $wgNoFollowNsExceptions = []
 Namespaces in which $wgNoFollowLinks doesn't apply. More...
 
 $wgParserConf
 Parser configuration. More...
 
 $wgPreprocessorCacheThreshold = 1000
 Preprocessor caching threshold Setting it to 'false' will disable the preprocessor cache. More...
 
 $wgRawHtml = false
 Allow raw, unchecked HTML in "<html>...</html>" sections. More...
 
 $wgRestrictDisplayTitle = true
 For consistency, restrict DISPLAYTITLE to text that normalizes to the same canonical DB key. More...
 
 $wgTidyConfig = [ 'driver' => 'RemexHtml' ]
 Configuration for HTML postprocessing tool. More...
 
 $wgTranscludeCacheExpiry = 3600
 Expiry time for transcluded templates cached in object cache. More...
 
 $wgUrlProtocols
 URL schemes that should be recognized as valid by wfParseUrl(). More...
 
Statistics
 $wgActiveUserDays = 30
 How many days user must be idle before he is considered inactive. More...
 
 $wgArticleCountMethod = 'link'
 Method used to determine if a page in a content namespace should be counted as a valid article. More...
 
User accounts, authentication
 $wgAllowRequiringEmailForResets = false
 Temporary feature flag that controls whether users will see a checkbox allowing them to require providing email during password resets. More...
 
bool[] $wgAllowSecuritySensitiveOperationIfCannotReauthenticate
 Whether to allow security-sensitive operations when re-authentication is not possible. More...
 
string null $wgAuthenticationTokenVersion = null
 Versioning for authentication tokens. More...
 
 $wgAuthManagerAutoConfig
 
 $wgAuthManagerConfig = null
 Configure AuthManager. More...
 
string $wgCentralIdLookupProvider = 'local'
 Central ID lookup provider to use by default. More...
 
 $wgCentralIdLookupProviders
 Central ID lookup providers Key is the provider ID, value is a specification for ObjectFactory. More...
 
string[] $wgChangeCredentialsBlacklist
 List of AuthenticationRequest class names which are not changeable through Special:ChangeCredentials and the changeauthenticationdata API. More...
 
 $wgDefaultUserOptions
 Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts. More...
 
 $wgHiddenPrefs = []
 An array of preferences to not show for the user. More...
 
 $wgInvalidPasswordReset = true
 Specifies if users should be sent to a password-reset form on login, if their password doesn't meet the requirements of User::isValidPassword(). More...
 
 $wgInvalidUsernameCharacters = '@:'
 Characters to prevent during new account creations. More...
 
 $wgMaximalPasswordLength = false
 Specifies the maximal length of a user password (T64685). More...
 
 $wgMaxNameChars = 255
 Maximum number of bytes in username. More...
 
 $wgMaxSigChars = 255
 Maximum number of Unicode characters in signature. More...
 
 $wgMinimalPasswordLength = false
 Specifies the minimal length of a user password. More...
 
 $wgPasswordConfig
 Configuration for built-in password types. More...
 
 $wgPasswordDefault = 'pbkdf2'
 Default password type to use when hashing user passwords. More...
 
 $wgPasswordPolicy
 Password policy for the wiki. More...
 
 $wgPasswordResetRoutes
 Whether to allow password resets ("enter some identifying data, and we'll send an email with a temporary password you can use to get back into the account") identified by various bits of data. More...
 
int[] $wgReauthenticateTime
 Time frame for re-authentication. More...
 
string[] $wgRemoveCredentialsBlacklist
 List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata API. More...
 
 $wgReservedUsernames
 Array of usernames which may not be registered or logged in from Maintenance scripts can still use these. More...
 
 $wgSecureLogin = false
 This is to let user authenticate using https when they come from http. More...
 
 $wgSessionProviders
 MediaWiki\Session\SessionProvider configuration. More...
 
 $wgSignatureAllowedLintErrors = [ 'obsolete-tag' ]
 List of lint error codes which don't cause signature validation to fail. More...
 
 $wgSignatureValidation = 'warning'
 Behavior of signature validation. More...
 
 $wgUserrightsInterwikiDelimiter = '@'
 Character used as a delimiter when testing for interwiki userrights (In Special:UserRights, it is possible to modify users on different databases if the delimiter is used, e.g. More...
 
User rights, access control and monitoring
 $wgAccountCreationThrottle
 Number of accounts each IP address may create per specified period(s). More...
 
 $wgAddGroups = []
 $wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups at Special:Userrights. More...
 
 $wgApplyIpBlocksToXff = false
 Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them. More...
 
 $wgAutoblockExpiry = 86400
 Number of seconds before autoblock entries expire. More...
 
 $wgAutoConfirmAge = 0
 Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group membership. More...
 
 $wgAutoConfirmCount = 0
 Number of edits an account requires before it is autoconfirmed. More...
 
 $wgAutopromote
 Array containing the conditions of automatic promotion of a user to specific groups. More...
 
 $wgAutopromoteOnce
 Automatically add a usergroup to any user who matches certain conditions. More...
 
 $wgAutopromoteOnceLogInRC = true
 Put user rights log entries for autopromotion in recent changes? More...
 
 $wgAvailableRights = []
 A list of available rights, in addition to the ones defined by the core. More...
 
 $wgBlockAllowsUTEdit = true
 Set this to true to allow blocked users to edit their own user talk page. More...
 
 $wgBlockCIDRLimit
 Limits on the possible sizes of range blocks. More...
 
 $wgBlockDisablesLogin = false
 If true, blocked users will not be allowed to login. More...
 
string bool $wgBotPasswordsCluster = false
 Cluster for the bot_passwords table If false, the normal cluster will be used. More...
 
string bool $wgBotPasswordsDatabase = false
 Database name for the bot_passwords table. More...
 
 $wgCascadingRestrictionLevels = [ 'sysop' ]
 Restriction levels that can be used with cascading protection. More...
 
 $wgDeleteRevisionsBatchSize = 1000
 Page deletions with > this number of revisions will use the job queue. More...
 
 $wgDeleteRevisionsLimit = 0
 Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission. More...
 
 $wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ]
 List of DNS blacklists to use, if $wgEnableDnsBlacklist is true. More...
 
 $wgEmailConfirmToEdit = false
 Should editors be required to have a validated e-mail address before being allowed to edit? More...
 
bool $wgEnableBotPasswords = true
 Whether to enable bot passwords. More...
 
 $wgEnableDnsBlacklist = false
 Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies. More...
 
array $wgGrantPermissionGroups
 Map of grants to their UI grouping. More...
 
array $wgGrantPermissions = []
 Map of (grant => right => boolean) Users authorize consumers (like Apps) to act on their behalf but only with a subset of the user's normal account rights (signed off on by the user). More...
 
 $wgGrantPermissions ['basic']['autoconfirmed'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['autocreateaccount'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['autopatrol'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['editsemiprotected'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['ipblock-exempt'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['nominornewtalk'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['patrolmarks'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['purge'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['read'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['basic']['writeapi'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['blockusers']['block'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['blockusers']['blockemail'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createaccount']['createaccount'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createeditmovepage'] = $wgGrantPermissions['editpage']
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createeditmovepage']['createpage'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createeditmovepage']['createtalk'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createeditmovepage']['move'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createeditmovepage']['move-categorypages'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createeditmovepage']['move-rootuserpages'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createeditmovepage']['move-subpages'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['createeditmovepage']['suppressredirect'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['delete']
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['delete']['bigdelete'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['delete']['delete'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['delete']['deletelogentry'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['delete']['deleterevision'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['delete']['undelete'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editinterface'] = $wgGrantPermissions['editpage']
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editinterface']['editinterface'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editinterface']['editsitejson'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editinterface']['edituserjson'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editmycssjs'] = $wgGrantPermissions['editpage']
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editmycssjs']['editmyusercss'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editmycssjs']['editmyuserjs'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editmycssjs']['editmyuserjson'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editmyoptions']['editmyoptions'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editmyoptions']['editmyuserjson'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editmywatchlist']['editmywatchlist'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editpage']['applychangetags'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editpage']['changetags'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editpage']['edit'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editpage']['minoredit'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editprotected'] = $wgGrantPermissions['editpage']
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editprotected']['editprotected'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editsiteconfig'] = $wgGrantPermissions['editinterface']
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editsiteconfig']['editsitecss'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editsiteconfig']['editsitejs'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editsiteconfig']['editusercss'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editsiteconfig']['edituserjs'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['highvolume']['apihighlimits'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['highvolume']['bot'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['highvolume']['markbotedits'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['highvolume']['noratelimit'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['oversight']['suppressrevision'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['patrol']['patrol'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['privateinfo']['viewmyprivateinfo'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['protect'] = $wgGrantPermissions['editprotected']
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['protect']['protect'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['rollback']['rollback'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['sendemail']['sendemail'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['uploadeditmovefile'] = $wgGrantPermissions['uploadfile']
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['uploadeditmovefile']['movefile'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['uploadeditmovefile']['reupload'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['uploadeditmovefile']['reupload-shared'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['uploadeditmovefile']['suppressredirect'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['uploadeditmovefile']['upload_by_url'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['uploadfile']['reupload-own'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['uploadfile']['upload'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['viewdeleted']['browsearchive'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['viewdeleted']['deletedhistory'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['viewdeleted']['deletedtext'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['viewmywatchlist']['viewmywatchlist'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['viewrestrictedlogs']['suppressionlog'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGroupPermissions = []
 Permission keys given to users in each group. More...
 
 $wgGroupsAddToSelf = []
 A map of group names that the user is in, to group names that those users are allowed to add or revoke. More...
 
 $wgGroupsRemoveFromSelf = []
 
 $wgHideIdentifiableRedirects = true
 Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public. More...
 
 $wgHideUserContribLimit = 1000
 The maximum number of edits a user can have and can still be hidden by users with the hideuser permission. More...
 
 $wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ]
 Implicit groups, aren't shown on Special:Listusers or somewhere else. More...
 
 $wgNamespaceProtection = []
 Set the minimum permissions required to edit pages in each namespace. More...
 
 $wgNonincludableNamespaces = []
 Pages in namespaces in this array can not be used as templates. More...
 
 $wgPasswordAttemptThrottle
 Limit password attempts to X attempts per Y seconds per IP per account. More...
 
 $wgProxyWhitelist = []
 Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say. More...
 
 $wgPutIPinRC = true
 Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g. More...
 
 $wgQueryPageDefaultLimit = 50
 Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere. More...
 
 $wgRateLimits
 Simple rate limiter options to brake edit floods. More...
 
 $wgRateLimitsExcludedIPs = []
 Array of IPs / CIDR ranges which should be excluded from rate limits. More...
 
 $wgRemoveGroups = []
 
 $wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ]
 Rights which can be required for each protection level (via action=protect) More...
 
 $wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ]
 Set of available actions that can be restricted via action=protect You probably shouldn't change this. More...
 
 $wgRevokePermissions = []
 Permission keys revoked from users in each group. More...
 
 $wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ]
 Restriction levels that should be considered "semiprotected". More...
 
string[] $wgSoftBlockRanges = []
 IP ranges that should be considered soft-blocked (anon-only, account creation allowed). More...
 
 $wgSpamRegex = []
 Edits matching these regular expressions in body text will be recognised as spam and rejected automatically. More...
 
 $wgSummarySpamRegex = []
 Same as the above except for edit summaries. More...
 
 $wgWhitelistRead = false
 Pages anonymous user may see, set as an array of pages titles. More...
 
 $wgWhitelistReadRegexp = false
 Pages anonymous user may see, set as an array of regular expressions. More...
 
Proxy scanner settings
 $wgProxyList = []
 Big list of banned IP addresses. More...
 
 $wgSecretKey = false
 This should always be customised in LocalSettings.php. More...
 
Cookie settings
 $wgCacheVaryCookies = []
 A list of cookies that vary the cache (for use by extensions) More...
 
 $wgCookieDomain = ''
 Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net". More...
 
 $wgCookieExpiration = 30 * 86400
 Default cookie lifetime, in seconds. More...
 
 $wgCookieHttpOnly = true
 Set authentication cookies to HttpOnly to prevent access by JavaScript, in browsers that support this feature. More...
 
 $wgCookiePath = '/'
 Set this variable if you want to restrict cookies to a certain path within the domain specified by $wgCookieDomain. More...
 
 $wgCookiePrefix = false
 Cookies generated by MediaWiki have names starting with this prefix. More...
 
 $wgCookieSecure = 'detect'
 Whether the "secure" flag should be set on the cookie. More...
 
 $wgCookieSetOnAutoblock = true
 Whether to set a cookie when a user is autoblocked. More...
 
 $wgCookieSetOnIpBlock = true
 Whether to set a cookie when a logged-out user is blocked. More...
 
 $wgDisableCookieCheck = false
 By default, MediaWiki checks if the client supports cookies during the login process, so that it can display an informative error message if cookies are disabled. More...
 
 $wgExtendedLoginCookieExpiration = 180 * 86400
 Default login cookie lifetime, in seconds. More...
 
 $wgSessionName = false
 Override to customise the session name. More...
 
LaTeX (mathematical formulas)
 $wgUseTeX = false
 To use inline TeX, you need to compile 'texvc' (in the 'math' subdirectory of the MediaWiki package and have latex, dvips, gs (ghostscript), andconvert (ImageMagick) installed and available in the PATH. More...
 
Profiling, testing and debugging

See $wgProfiler for how to enable profiling.

 $wgCachePrefix = false
 Overwrite the caching key prefix with custom value. More...
 
 $wgDebugComments = false
 Send debug data to an HTML comment in the output. More...
 
 $wgDebugDumpSql = false
 Write SQL queries to the debug log. More...
 
 $wgDebugLogFile = ''
 Filename for debug logging. More...
 
 $wgDebugLogGroups = []
 Map of string log group names to log destinations. More...
 
 $wgDebugLogPrefix = ''
 Prefix for debug log lines. More...
 
 $wgDebugRawPage = false
 If true, log debugging data from action=raw and load.php. More...
 
 $wgDebugRedirects = false
 If true, instead of redirecting, show a page with a link to the redirect destination. More...
 
 $wgDebugToolbar = false
 Display the new debugging toolbar. More...
 
 $wgDeprecationReleaseLimit = false
 Release limitation to wfDeprecated warnings, if set to a release number development warnings will not be generated for deprecations added in releases after the limit. More...
 
 $wgDevelopmentWarnings = false
 If set to true MediaWiki will throw notices for some possible error conditions and for deprecated functions. More...
 
 $wgEnableJavaScriptTest = false
 Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit). More...
 
 $wgLogExceptionBacktrace = true
 If true, send the exception backtrace to the error log. More...
 
 $wgMWLoggerDefaultSpi
 Default service provider for creating Psr\Log\LoggerInterface instances. More...
 
 $wgOverrideHostname = false
 Override server hostname detection with a hardcoded value. More...
 
 $wgPageInfoTransclusionLimit = 50
 InfoAction retrieves a list of transclusion links (both to and from). More...
 
 $wgParserTestFiles = []
 Parser test suite files to be run by parserTests.php when no specific filename is passed to it. More...
 
 $wgProfiler = []
 Profiler configuration. More...
 
 $wgPropagateErrors = true
 If true, the MediaWiki error handler passes errors/warnings to the default error handler after logging them. More...
 
 $wgShowDBErrorBacktrace = false
 If true, show a backtrace for database errors. More...
 
 $wgShowDebug = false
 Display debug data at the bottom of the main content area. More...
 
 $wgShowExceptionDetails = false
 If set to true, uncaught exceptions will print the exception message and a complete stack trace to output. More...
 
 $wgShowHostnames = false
 Expose backend server host names through the API and various HTML comments. More...
 
 $wgShowSQLErrors = false
 Whether to show "we're sorry, but there has been a database error" pages. More...
 
 $wgSpecialVersionShowHooks = false
 Show the contents of $wgHooks in Special:Version. More...
 
 $wgStatsdMetricPrefix = 'MediaWiki'
 Prefix for metric names sent to $wgStatsdServer. More...
 
 $wgStatsdSamplingRates
 Sampling rate for statsd metrics as an associative array of patterns and rates. More...
 
 $wgStatsdServer = false
 Destination of statsd metrics. More...
 
 $wgTrxProfilerLimits
 Performance expectations for DB usage. More...
 
Search
 $wgAdvancedSearchHighlighting = false
 Set to true to have nicer highlighted text in search results, by default off due to execution overhead. More...
 
 $wgDisableInternalSearch = false
 Disable the internal MySQL-based search, to allow it to be implemented by an extension instead. More...
 
 $wgDisableSearchUpdate = false
 If you've disabled search semi-permanently, this also disables updates to the table. More...
 
 $wgDisableTextSearch = false
 Set this to true to disable the full text search feature. More...
 
 $wgEnableOpenSearchSuggest = true
 This was previously a used to force empty responses from ApiOpenSearch with the 'suggest' parameter set. More...
 
 $wgEnableSearchContributorsByIP = true
 If true, searches for IP addresses will be redirected to that IP's contributions page. More...
 
 $wgNamespacesToBeSearchedDefault
 List of namespaces which are searched by default. More...
 
 $wgOpenSearchDefaultLimit = 10
 Integer defining default number of entries to show on OpenSearch call. More...
 
 $wgOpenSearchDescriptionLength = 100
 Minimum length of extract in . More...
 
 $wgOpenSearchTemplate = false
 Template for OpenSearch suggestions, defaults to API action=opensearch. More...
 
 $wgOpenSearchTemplates
 Templates for OpenSearch suggestions, defaults to API action=opensearch. More...
 
 $wgSearchForwardUrl = null
 Set this to a URL to forward search requests to some external location. More...
 
 $wgSearchHighlightBoundaries = '[\p{Z}\p{P}\p{C}]'
 Regexp to match word boundaries, defaults for non-CJK languages should be empty for CJK since the words are not separate. More...
 
 $wgSearchSuggestCacheExpiry = 1200
 Expiry time for search suggestion responses. More...
 
 $wgSitemapNamespaces = false
 Array of namespaces to generate a Google sitemap for when the maintenance/generateSitemap.php script is run, or false if one is to be generated for all namespaces. More...
 
 $wgSitemapNamespacesPriorities = false
 Custom namespace priorities for sitemaps. More...
 
 $wgUseTwoButtonsSearchForm = true
 Search form behavior. More...
 
Edit user interface
 $wgDiff = '/usr/bin/diff'
 Path to the GNU diff utility. More...
 
 $wgDiff3 = '/usr/bin/diff3'
 Path to the GNU diff3 utility. More...
 
 $wgPreviewOnOpenNamespaces
 Which namespaces have special treatment where they should be preview-on-open Internally only Category: pages apply, but using this extensions (e.g. More...
 
 $wgUniversalEditButton = true
 Enable the UniversalEditButton for browsers that support it (currently only Firefox with an extension) See http://universaleditbutton.org for more background information. More...
 
 $wgUseAutomaticEditSummaries = true
 If user doesn't specify any edit summary when making a an edit, MediaWiki will try to automatically create one. More...
 
Maintenance

See also $wgSiteNotice

 $wgCommandLineDarkBg = false
 For colorized maintenance script output, is your terminal background dark ? More...
 
 $wgGitBin = '/usr/bin/git'
 Fully specified path to git binary. More...
 
 $wgGitRepositoryViewers
 Map GIT repository URLs to viewer URLs to provide links in Special:Version. More...
 
 $wgReadOnly = null
 Set this to a string to put the wiki into read-only mode. More...
 
 $wgReadOnlyFile = false
 If this lock file exists (size > 0), the wiki will be forced into read-only mode. More...
 
bool $wgReadOnlyWatchedItemStore = false
 Set this to true to put the wiki watchlists into read-only mode. More...
 
 $wgUpgradeKey = false
 When you run the web-based upgrade utility, it will tell you what to set this to in order to authorize the upgrade process. More...
 
Recent changes, new pages, watchlist and history
 $wgAdvertisedFeedTypes = [ 'atom' ]
 Which feed types should we provide by default? This can include 'rss', 'atom', neither, or both. More...
 
 $wgDisableAnonTalk = false
 Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history, Special:Recentchanges, etc. More...
 
 $wgFeed = true
 Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages. More...
 
 $wgFeedCacheTimeout = 60
 Minimum timeout for cached Recentchanges feed, in seconds. More...
 
 $wgFeedClasses
 Available feeds objects. More...
 
 $wgFeedDiffCutoff = 32768
 When generating Recentchanges RSS/Atom feed, diffs will not be generated for pages larger than this size. More...
 
 $wgFeedLimit = 50
 Set maximum number of results to return in syndication feeds (RSS, Atom) for eg Recentchanges, Newpages. More...
 
 $wgOverrideSiteFeed = []
 Override the site's default RSS/ATOM feed for recentchanges that appears on every page. More...
 
 $wgRCChangedSizeThreshold = 500
 If the difference between the character counts of the text before and after the edit is below that value, the value will be highlighted on the RC page. More...
 
 $wgRCEngines
 Used by RecentChange::getEngine to find the correct engine for a given URI scheme. More...
 
 $wgRCFeeds = []
 Configuration for feeds to which notifications about recent changes will be sent. More...
 
 $wgRCFilterByAge = false
 Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers higher than what will be stored. More...
 
 $wgRCLinkDays = [ 1, 3, 7, 14, 30 ]
 List of Days options to list in the Special:Recentchanges and Special:Recentchangeslinked pages. More...
 
 $wgRCLinkLimits = [ 50, 100, 250, 500 ]
 List of Limits options to list in the Special:Recentchanges and Special:Recentchangeslinked pages. More...
 
 $wgRCMaxAge = 90 * 24 * 3600
 Recentchanges items are periodically purged; entries older than this many seconds will go. More...
 
 $wgRCShowChangedSize = true
 Show the amount of changed characters in recent changes. More...
 
 $wgRCShowWatchingUsers = false
 Show watching users in recent changes, watchlist and page history views. More...
 
 $wgRCWatchCategoryMembership = false
 Treat category membership changes as a RecentChange. More...
 
 $wgRecentChangesFlags
 Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits. More...
 
 $wgShowUpdatedMarker = true
 Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes. More...
 
array $wgSoftwareTags
 List of core tags to enable. More...
 
 $wgStructuredChangeFiltersLiveUpdatePollingRate = 3
 Polling rate, in seconds, used by the 'live update' and 'view newest' features of the RCFilters app on SpecialRecentChanges and Special:Watchlist. More...
 
 $wgUnwatchedPageSecret = 1
 If active watchers (per above) are this number or less, do not disclose it. More...
 
 $wgUnwatchedPageThreshold = false
 If set to an integer, pages that are watched by this many users or more will not require the unwatchedpages permission to view the number of watchers. More...
 
 $wgUseFilePatrol = true
 Use file patrolling to check new files on Special:Newfiles. More...
 
 $wgUseNPPatrol = true
 Use new page patrolling to check new pages on Special:Newpages. More...
 
 $wgUseRCPatrol = true
 Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files are included. More...
 
 $wgUseTagFilter = true
 Allow filtering by change tag in recentchanges, history, etc Has no effect if no tags are defined in valid_tag. More...
 
 $wgWatchersMaxAge = 180 * 24 * 3600
 Page watchers inactive for more than this many seconds are considered inactive. More...
 
Copyright and credits settings
 $wgMaxCredits = 0
 Set this to the number of authors that you want to be credited below an article text. More...
 
 $wgRightsIcon = null
 Override for copyright metadata. More...
 
 $wgRightsPage = null
 Override for copyright metadata. More...
 
 $wgRightsText = null
 If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link. More...
 
 $wgRightsUrl = null
 Set this to specify an external URL containing details about the content license used on your wiki. More...
 
 $wgShowCreditsIfMax = true
 If there are more than $wgMaxCredits authors, show $wgMaxCredits of them. More...
 
 $wgUseCopyrightUpload = false
 Set this to true if you want detailed copyright information forms on Upload. More...
 
Import / Export
 $wgExportAllowAll = false
 Whether to allow exporting the entire wiki into a single file. More...
 
 $wgExportAllowHistory = true
 If set to false, disables the full-history option on Special:Export. More...
 
 $wgExportAllowListContributors = false
 Return distinct author list (when not returning full history) More...
 
 $wgExportFromNamespaces = false
 Whether to allow the "export all pages in namespace" option. More...
 
 $wgExportMaxHistory = 0
 If set nonzero, Special:Export requests for history of pages with more revisions than this will be rejected. More...
 
 $wgExportMaxLinkDepth = 0
 If non-zero, Special:Export accepts a "pagelink-depth" parameter up to this specified level, which will cause it to include all pages linked to from the pages you specify. More...
 
 $wgExportPagelistLimit = 5000
 Maximum number of pages returned by the GetPagesFromCategory and GetPagesFromNamespace functions. More...
 
 $wgImportSources = []
 List of interwiki prefixes for wikis we'll accept as sources for Special:Import and API action=import. More...
 
 $wgImportTargetNamespace = null
 Optional default target namespace for interwiki imports. More...
 
Extensions
 $wgAutoloadAttemptLowercase = false
 Switch controlling legacy case-insensitive classloading. More...
 
 $wgAutoloadClasses = $wgAutoloadClasses ?? []
 Array mapping class names to filenames, for autoloading. More...
 
 $wgEnableParserLimitReporting = true
 Whether to include the NewPP limit report as a HTML comment. More...
 
 $wgExtensionCredits = []
 Add information about an installed extension, keyed by its type. More...
 
 $wgExtensionEntryPointListFiles = []
 Array of files with list(s) of extension entry points to be used in maintenance/mergeMessageFileList.php. More...
 
 $wgExtensionFunctions = []
 A list of callback functions which are called once MediaWiki is fully initialised. More...
 
 $wgExtensionMessagesFiles = []
 Extension messages files. More...
 
 $wgHooks = []
 Global list of hooks. More...
 
float[] $wgJobBackoffThrottling = []
 Map of job types to how many job "work items" should be run per second on each job runner process. More...
 
 $wgJobClasses
 Maps jobs to their handlers; extensions can add to this to provide custom jobs. More...
 
 $wgJobQueueIncludeInMaxLagFactor = false
 Whether to include the number of jobs that are queued for the API's maxlag parameter. More...
 
float bool $wgJobSerialCommitThreshold = false
 Make job runners commit changes for replica DB-lag prone jobs one job at a time. More...
 
 $wgJobTypeConf
 Map of job types to configuration arrays. More...
 
 $wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ]
 Jobs that must be explicitly requested, i.e. More...
 
 $wgMessagesDirs = []
 Extension messages directories. More...
 
 $wgPagePropLinkInvalidations
 Page property link table invalidation lists. More...
 
 $wgParserOutputHooks = []
 Parser output hooks. More...
 
 $wgServiceWiringFiles
 List of service wiring files to be loaded by the default instance of MediaWikiServices. More...
 
 $wgSpecialPageCacheUpdates
 Additional functions to be performed with updateSpecialPages. More...
 
 $wgSpecialPages = []
 Special page list. More...
 
 $wgValidSkinNames = []
 List of valid skin names. More...
 
Categories
 $wgCategoryCollation = 'uppercase'
 Specify how category names should be sorted, when listed on a category page. More...
 
 $wgCategoryMagicGallery = true
 On category pages, show thumbnail gallery for images belonging to that category instead of listing them as articles. More...
 
 $wgCategoryPagingLimit = 200
 Paging limit for categories. More...
 
 $wgUseCategoryBrowser = false
 Use experimental, DMOZ-like category browser. More...
 
Logging
 $wgActionFilteredLogs
 List of log types that can be filtered by action types. More...
 
 $wgFilterLogTypes
 Show/hide links on Special:Log will be shown for these log types. More...
 
 $wgLogActions = []
 Lists the message key string for formatting individual events of each type and action when listed in the logs. More...
 
 $wgLogActionsHandlers
 The same as above, but here values are names of classes, not messages. More...
 
 $wgLogHeaders
 Lists the message key string for descriptive text to be shown at the top of each log type. More...
 
 $wgLogNames
 Lists the message key string for each log type. More...
 
 $wgLogRestrictions
 This restricts log access to those who have a certain right Users without this will not see it in the option menu and can not view it Restricted logs are not added to recent changes Logs should remain non-transcludable Format: logtype => permissiontype. More...
 
 $wgLogTypes
 The logging system has two levels: an event type, which describes the general category and can be viewed as a named subset of all logs; and an action, which is a specific kind of event that can exist in that log type. More...
 
 $wgNewUserLog = true
 Maintain a log of newusers at Special:Log/newusers? More...
 
 $wgPageCreationLog = true
 Maintain a log of page creations at Special:Log/create? More...
 
Special pages (general and miscellaneous)
 $wgAllowSpecialInclusion = true
 Allow special page inclusions such as {{Special:Allpages}}. More...
 
 $wgCountCategorizedImagesAsUsed = false
 On Special:Unusedimages, consider images "used", if they are put into a category. More...
 
 $wgDisableQueryPageUpdate = false
 Set this to an array of special page names to prevent maintenance/updateSpecialPages.php from updating those pages. More...
 
 $wgMaxRedirectLinksRetrieved = 500
 Maximum number of links to a redirect page listed on Special:Whatlinkshere/RedirectDestination. More...
 
Actions
 $wgActions
 Array of allowed values for the "title=foo&action=<action>" parameter. More...
 
Robot (search engine crawler) policy

See also $wgNoFollowLinks.

 $wgArticleRobotPolicies = []
 Robot policies per article. More...
 
 $wgDefaultRobotPolicy = 'index,follow'
 Default robot policy. More...
 
 $wgExemptFromUserRobotsControl = null
 An array of namespace keys in which the INDEX/__NOINDEX__ magic words will not function, so users can't decide whether pages in that namespace are indexed by search engines. More...
 
 $wgNamespaceRobotPolicies = []
 Robot policies per namespaces. More...
 
AJAX, Action API and REST API

Note: The AJAX entry point which this section refers to is gradually being replaced by the Action API entry point, api.php.

They are essentially equivalent. Both of them are used for dynamic client-side features, via XHR.

 $wgAjaxEditStash = true
 Have clients send edits to be prepared when filling in edit summaries. More...
 
 $wgAjaxExportList = []
 List of Ajax-callable functions. More...
 
 $wgAjaxLicensePreview = true
 Enable previewing licences via AJAX. More...
 
 $wgAjaxUploadDestCheck = true
 Enable AJAX check for file overwrite, pre-upload. More...
 
 $wgAllowedCorsHeaders
 List of allowed headers for cross-origin API requests. More...
 
 $wgAPICacheHelpTimeout = 60 * 60
 Set the timeout for the API help text cache. More...
 
 $wgAPIFormatModules = []
 API format module extensions. More...
 
 $wgAPIListModules = []
 API Query list module extensions. More...
 
 $wgAPIMaxDBRows = 5000
 Maximum amount of rows to scan in a DB query in the API The default value is generally fine. More...
 
 $wgAPIMaxLagThreshold = 7
 Maximum amount of DB lag on a majority of DB replica DBs to tolerate before forcing bots to retry any write requests via API errors. More...
 
 $wgAPIMaxResultSize = 8388608
 The maximum size (in bytes) of an API result. More...
 
 $wgAPIMaxUncachedDiffs = 1
 The maximum number of uncached diffs that can be retrieved in one API request. More...
 
 $wgAPIMetaModules = []
 API Query meta module extensions. More...
 
 $wgAPIModules = []
 API module extensions. More...
 
 $wgAPIPropModules = []
 API Query prop module extensions. More...
 
 $wgAPIRequestLog = false
 Log file or URL (TCP or UDP) to log API requests to, or false to disable API request logging. More...
 
 $wgAPIUselessQueryPages
 The ApiQueryQueryPages module should skip pages that are redundant to true API queries. More...
 
 $wgCrossSiteAJAXdomainExceptions = []
 Domains that should not be allowed to make AJAX requests, even if they match one of the domains allowed by $wgCrossSiteAJAXdomains Uses the same syntax as $wgCrossSiteAJAXdomains. More...
 
 $wgCrossSiteAJAXdomains = []
 Settings for incoming cross-site AJAX requests: Newer browsers support cross-site AJAX when the target resource allows requests from the origin domain by the Access-Control-Allow-Origin header. More...
 
 $wgDebugAPI = false
 
 $wgEnableRestAPI = false
 Enable the experimental REST API. More...
 
 $wgRestAPIAdditionalRouteFiles = []
 Additional REST API Route files. More...
 
 $wgUseAjax = true
 Enable AJAX framework. More...
 
Shell and process control
 $wgMaxShellFileSize = 102400
 Maximum file size created by shell processes under linux, in KB ImageMagick convert for example can be fairly hungry for scratch space. More...
 
 $wgMaxShellMemory = 307200
 Maximum amount of virtual memory available to shell processes under linux, in KB. More...
 
 $wgMaxShellTime = 180
 Maximum CPU time in seconds for shell processes under Linux. More...
 
 $wgMaxShellWallClockTime = 180
 Maximum wall clock time (i.e. More...
 
 $wgPhpCli = '/usr/bin/php'
 Executable path of the PHP cli binary. More...
 
 $wgShellCgroup = false
 Under Linux: a cgroup directory used to constrain memory usage of shell commands. More...
 
 $wgShellLocale = 'C.UTF-8'
 Locale for LC_ALL, to provide a known environment for locale-sensitive operations. More...
 
string bool $wgShellRestrictionMethod = false
 Method to use to restrict shell commands. More...
 
HTTP client
 $wgAllowExternalReqID = false
 Whether to respect/honour the request ID provided by the incoming request via the X-Request-Id header. More...
 
 $wgAsyncHTTPTimeout = 25
 Timeout for Asynchronous (background) HTTP requests, in seconds. More...
 
float int $wgHTTPConnectTimeout = 5.0
 Timeout for connections done internally (in seconds). More...
 
 $wgHTTPImportTimeout = 25
 Timeout for HTTP requests done internally for transwiki imports, in seconds. More...
 
float int $wgHTTPMaxConnectTimeout = INF
 The maximum HTTP connect timeout in seconds. More...
 
float int $wgHTTPMaxTimeout = INF
 The maximum HTTP request timeout in seconds. More...
 
 $wgHTTPProxy = ''
 Proxy to use for CURL requests. More...
 
float int $wgHTTPTimeout = 25
 Timeout for HTTP requests done internally, in seconds. More...
 
 $wgLocalVirtualHosts = []
 Local virtual hosts. More...
 
Job queue
 $wgJobRunRate = 1
 Number of jobs to perform per request. More...
 
 $wgRunJobsAsync = false
 When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process to handle the job execution, instead of blocking the request until the job execution finishes. More...
 
 $wgUpdateRowsPerJob = 300
 Number of rows to update per job. More...
 
 $wgUpdateRowsPerQuery = 100
 Number of rows to update per query. More...
 
Miscellaneous
 $wgContentHandlerTextFallback = 'ignore'
 How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText(): More...
 
 $wgCSPFalsePositiveUrls
 List of urls which appear often to be triggering CSP reports but do not appear to be caused by actual content, but by client software inserting scripts (i.e. More...
 
bool array $wgCSPHeader = false
 Controls Content-Security-Policy header [Experimental]. More...
 
bool array $wgCSPReportOnlyHeader = false
 Controls Content-Security-Policy-Report-Only header. More...
 
string null $wgDiffEngine = null
 Specify the difference engine to use. More...
 
 $wgDisableHardRedirects = false
 Disable redirects to special pages and interwiki redirects, which use a 302 and have no "redirected from" link. More...
 
bool $wgElementTiming = false
 Enable Element Timing. More...
 
 $wgEventRelayerConfig
 Mapping of event channels (or channel categories) to EventRelayer configuration. More...
 
 $wgExperiencedUserEdits = 500
 Specify the difference engine to use. More...
 
 $wgExperiencedUserMemberSince = 30
 Specify the difference engine to use. More...
 
string false $wgExternalDiffEngine = false
 Name of the external diff engine to use. More...
 
array $wgFeaturePolicyReportOnly = []
 List of Feature Policy Reporting types to enable. More...
 
 $wgFixDoubleRedirects = false
 Fix double redirects after a page move. More...
 
 $wgHKDFAlgorithm = 'sha256'
 Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers). More...
 
 $wgHKDFSecret = false
 Secret for hmac-based key derivation function (fast, cryptographically secure random numbers). More...
 
 $wgInterwikiPrefixDisplayTypes = []
 Mapping of interwiki index prefixes to descriptors that can be used to change the display of interwiki search results. More...
 
 $wgLearnerEdits = 10
 The following variables define 3 user experience levels: More...
 
 $wgLearnerMemberSince = 4
 Specify the difference engine to use. More...
 
 $wgLinkHolderBatchSize = 1000
 LinkHolderArray batch size For debugging. More...
 
bool $wgMainPageIsDomainRoot = false
 Option to whether serve the main page as the domain root. More...
 
 $wgMaximumMovedPages = 100
 Maximum number of pages to move at once when moving subpages with a page. More...
 
 $wgMaxJobDBWriteDuration = false
 Specify the difference engine to use. More...
 
 $wgMaxUserDBWriteDuration = false
 Specify the difference engine to use. More...
 
int $wgMultiContentRevisionSchemaMigrationStage = SCHEMA_COMPAT_NEW
 RevisionStore table schema migration stage (content, slots, content_models & slot_roles tables). More...
 
 $wgNamespaceContentModels = []
 Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by default (use the CONTENT_MODEL_XXX constants). More...
 
array $wgNativeImageLazyLoading = false
 Toggles native image lazy loading, via the "loading" attribute. More...
 
array $wgOriginTrials = []
 Origin Trials tokens. More...
 
bool $wgPageLanguageUseDB = false
 Enable page language feature Allows setting page language in database. More...
 
 $wgPagePropsHaveSortkey = true
 Whether the page_props table has a pp_sortkey column. More...
 
bool $wgPingback = false
 Share data about this installation with MediaWiki developers. More...
 
 $wgPoolCounterConf = null
 Configuration for processing pool control, for use in high-traffic wikis. More...
 
bool $wgPriorityHints = false
 Enable client-side Priority Hints. More...
 
float $wgPriorityHintsRatio = 1.0
 Ratio of requests that should get Priority Hints when the feature is enabled. More...
 
array $wgRangeContributionsCIDRLimit
 Shortest CIDR limits that can be checked in any individual range check at Special:Contributions. More...
 
string[] $wgRawHtmlMessages
 List of messages which might contain raw HTML. More...
 
 $wgRedirectOnLogin = null
 Allow redirection to another page when a user logs in. More...
 
 $wgRegisterInternalExternals = false
 By default MediaWiki does not register links pointing to same server in externallinks dataset, use this value to override: More...
 
array $wgReportToEndpoints = []
 List of endpoints for the Reporting API. More...
 
int $wgReportToExpiry = 86400
 Expiry of the endpoint definition for the Reporting API. More...
 
bool $wgSearchMatchRedirectPreference = false
 Set true to allow logged-in users to set a preference whether or not matches in search results should force redirection to that page. More...
 
bool $wgSearchRunSuggestedQuery = true
 Controls whether zero-result search queries with suggestions should display results for these suggestions. More...
 
 $wgSessionInsecureSecrets = false
 If for some reason you can't install the PHP OpenSSL extension, you can set this to true to make MediaWiki work again at the cost of storing sensitive session data insecurely. More...
 
 $wgSessionSecret = false
 Secret for session storage. More...
 
 $wgSiteTypes
 Register handlers for specific types of sites. More...
 
array $wgSpecialSearchFormOptions = []
 Options for Special:Search completion widget form created by SearchFormWidget class. More...
 
 $wgTextModelsToParse
 Determines which types of text are parsed as wikitext. More...
 
 $wgUploadMaintenance = false
 To disable file delete/restore temporarily. More...
 
array $wgVirtualRestConfig
 Global configuration variable for Virtual REST Services. More...
 
bool $wgWatchlistExpiry = false
 Whether to enable the watchlist expiry feature. More...
 
string null $wgWatchlistExpiryMaxDuration = '6 months'
 Relative maximum duration for watchlist expiries, as accepted by strtotime(). More...
 
float $wgWatchlistPurgeRate = 0.1
 Chance of expired watchlist items being purged on any page edit. More...
 
 $wgXmlDumpSchemaVersion = XML_DUMP_SCHEMA_VERSION_11
 The schema to use per default when generating XML dumps. More...
 

Detailed Description

Default values for MediaWiki configuration settings.

            NEVER EDIT THIS FILE

To customize your installation, edit "LocalSettings.php". If you make changes here, they will be lost on next upgrade of MediaWiki!

In this file, variables whose default values depend on other variables are set to false. The actual default value of these variables will only be set in Setup.php, taking into account any custom settings performed in LocalSettings.php.

Documentation is in the source and on: https://www.mediawiki.org/wiki/Manual:Configuration_settings

Warning
Note: this (and other things) will break if the autoloader is not enabled. Please include includes/AutoLoader.php before including this file.

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program; if not, write to the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA. http://www.gnu.org/copyleft/gpl.html

Definition in file DefaultSettings.php.

Variable Documentation

◆ $wgAccountCreationThrottle

$wgAccountCreationThrottle
Initial value:
= [ [
'count' => 0,
'seconds' => 86400,
] ]

Number of accounts each IP address may create per specified period(s).

Example:
// no more than 100 per month
[
'count' => 100,
'seconds' => 30*86400,
],
// no more than 10 per day
[
'count' => 10,
'seconds' => 86400,
],
];
Warning
Requires $wgMainCacheType to be enabled

Definition at line 5990 of file DefaultSettings.php.

◆ $wgActionFilteredLogs

$wgActionFilteredLogs

List of log types that can be filtered by action types.

To each action is associated the list of log_action subtypes to search for, usually one, but not necessarily so Extensions may append to this array

Since
1.27

Definition at line 8278 of file DefaultSettings.php.

◆ $wgActionPaths

$wgActionPaths = []

To set 'pretty' URL paths for actions other than plain page views, add to this array.

Example:
Set pretty URL for the edit action:
'edit' => "$wgScriptPath/edit/$1"

There must be an appropriate script or rewrite rule in place to handle these URLs.

Since
1.5

Definition at line 446 of file DefaultSettings.php.

Referenced by Title\getLocalURL(), and WebRequest\getPathInfo().

◆ $wgActions

$wgActions
Initial value:
= [
'credits' => true,
'delete' => true,
'edit' => true,
'editchangetags' => SpecialPageAction::class,
'history' => true,
'info' => true,
'markpatrolled' => true,
'mcrundo' => McrUndoAction::class,
'mcrrestore' => McrRestoreAction::class,
'protect' => true,
'purge' => true,
'raw' => true,
'render' => true,
'revert' => true,
'revisiondelete' => SpecialPageAction::class,
'rollback' => true,
'submit' => true,
'unprotect' => true,
'unwatch' => true,
'view' => true,
'watch' => true,
]

Array of allowed values for the "title=foo&action=<action>" parameter.

Syntax is: 'foo' => 'ClassName' Load the specified class which subclasses Action 'foo' => true Load the class FooAction which subclasses Action If something is specified in the getActionOverrides() of the relevant Page object it will be used instead of the default class. 'foo' => false The action is disabled; show an error message Unsetting core actions will probably cause things to complain loudly.

Definition at line 8398 of file DefaultSettings.php.

Referenced by Action\getActionName(), and Action\getClass().

◆ $wgActiveUserDays

$wgActiveUserDays = 30

How many days user must be idle before he is considered inactive.

Will affect the number shown on Special:Statistics, Special:ActiveUsers, and the {{NUMBEROFACTIVEUSERS}} magic word in wikitext. You might want to leave this as the default value, to provide comparable numbers between different wikis.

Definition at line 4779 of file DefaultSettings.php.

Referenced by RecentChangesUpdateJob\updateActiveUsers().

◆ $wgAdaptiveMessageCache

$wgAdaptiveMessageCache = false

Instead of caching everything, only cache those messages which have been customised in the site content language.

This means that MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist. This option is probably only useful for translatewiki.net.

Definition at line 2717 of file DefaultSettings.php.

Referenced by MessageCache\loadFromDB().

◆ $wgAddGroups

$wgAddGroups = []

$wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups at Special:Userrights.

Example:
Bureaucrats can add any group:
$wgAddGroups['bureaucrat'] = true;
Bureaucrats can only remove bots and sysops:
$wgRemoveGroups['bureaucrat'] = [ 'bot', 'sysop' ];
Sysops can make bots:
$wgAddGroups['sysop'] = [ 'bot' ];
Sysops can disable other sysops in an emergency, and disable bots:
$wgRemoveGroups['sysop'] = [ 'sysop', 'bot' ];

Definition at line 5935 of file DefaultSettings.php.

Referenced by User\changeableByGroup().

◆ $wgAdditionalMailParams

$wgAdditionalMailParams = null

Additional email parameters, will be passed as the last argument to mail() call.

Definition at line 1876 of file DefaultSettings.php.

Referenced by UserMailer\sendInternal().

◆ $wgAdvancedSearchHighlighting

$wgAdvancedSearchHighlighting = false

Set to true to have nicer highlighted text in search results, by default off due to execution overhead.

Definition at line 6920 of file DefaultSettings.php.

Referenced by SqlSearchResult\getTextSnippet().

◆ $wgAdvertisedFeedTypes

$wgAdvertisedFeedTypes = [ 'atom' ]

Which feed types should we provide by default? This can include 'rss', 'atom', neither, or both.

Definition at line 7413 of file DefaultSettings.php.

◆ $wgAjaxEditStash

$wgAjaxEditStash = true

Have clients send edits to be prepared when filling in edit summaries.

This gives the server a head start on the expensive parsing operation.

Definition at line 8666 of file DefaultSettings.php.

Referenced by WikiPage\newPageUpdater().

◆ $wgAjaxExportList

$wgAjaxExportList = []

List of Ajax-callable functions.

Extensions acting as Ajax callbacks must register here

Deprecated:
(officially) since 1.27; use the API instead

Definition at line 8650 of file DefaultSettings.php.

◆ $wgAjaxLicensePreview

$wgAjaxLicensePreview = true

Enable previewing licences via AJAX.

Definition at line 8660 of file DefaultSettings.php.

◆ $wgAjaxUploadDestCheck

$wgAjaxUploadDestCheck = true

Enable AJAX check for file overwrite, pre-upload.

Definition at line 8655 of file DefaultSettings.php.

◆ $wgAllowCopyUploads

$wgAllowCopyUploads = false

Allow for upload to be copied from an URL.

The timeout for copy uploads is set by $wgCopyUploadTimeout. You have to assign the user right 'upload_by_url' to a user group, to use this.

Definition at line 898 of file DefaultSettings.php.

Referenced by UploadFromUrl\isEnabled().

◆ $wgAllowDisplayTitle

$wgAllowDisplayTitle = true

Allow DISPLAYTITLE to change title display.

Definition at line 4703 of file DefaultSettings.php.

Referenced by CoreParserFunctions\register().

◆ $wgAllowedCorsHeaders

$wgAllowedCorsHeaders
Initial value:
= [
'Accept',
'Accept-Language',
'Content-Language',
'Content-Type',
'Accept-Encoding',
'DNT',
'Origin',
'User-Agent',
'Api-User-Agent',
]

List of allowed headers for cross-origin API requests.

Definition at line 8700 of file DefaultSettings.php.

◆ $wgAllowExternalImages

$wgAllowExternalImages = false

Whether to allow inline image pointing to other websites.

Definition at line 4592 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgAllowExternalImagesFrom

$wgAllowExternalImagesFrom = ''

If the above is false, you can specify an exception here.

Image URLs that start with this string are then rendered, while all others are not. You can use this to set up a trusted, simple repository of images. You may also specify an array of strings to allow multiple sites

Examples:
$wgAllowExternalImagesFrom = 'http://127.0.0.1/';
$wgAllowExternalImagesFrom = [ 'http://127.0.0.1/', 'http://example.com' ];

Definition at line 4606 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgAllowExternalReqID

$wgAllowExternalReqID = false

Whether to respect/honour the request ID provided by the incoming request via the X-Request-Id header.

Set to true if the entity sitting in front of Mediawiki sanitises external requests. Default: false.

Definition at line 8919 of file DefaultSettings.php.

Referenced by WebRequest\getRequestId().

◆ $wgAllowHTMLEmail

$wgAllowHTMLEmail = false

For parts of the system that have been updated to provide HTML email content, send both text and HTML parts as the body of the email.

Definition at line 1882 of file DefaultSettings.php.

Referenced by UserMailer\send().

◆ $wgAllowImageMoving

$wgAllowImageMoving = true

Allows to move images and other media files.

Deprecated:
since 1.35, use group permission settings instead. (eg $wgGroupPermissions['sysop']['movefile'] = false; to revoke the ability from sysops)

Definition at line 478 of file DefaultSettings.php.

◆ $wgAllowImageTag

$wgAllowImageTag = false

A different approach to the above: simply allow the "<img>" tag to be used.

This allows you to specify alt text and other attributes, copy-paste HTML to your wiki more easily, etc. However, allowing external images in any manner will allow anyone with editing rights to snoop on your visitors' IP addresses and so forth, if they wanted to, by inserting links to images on sites they control.

Deprecated:
since 1.35; register an extension tag named

instead.

Definition at line 4630 of file DefaultSettings.php.

Referenced by Sanitizer\getRecognizedTagData().

◆ $wgAllowJavaUploads

$wgAllowJavaUploads = false

Allow Java archive uploads.

This is not recommended for public wikis since a maliciously-constructed applet running on the same domain as the wiki can steal the user's cookies.

Definition at line 1066 of file DefaultSettings.php.

Referenced by UploadBase\verifyPartialFile().

◆ $wgAllowRequiringEmailForResets

$wgAllowRequiringEmailForResets = false

Temporary feature flag that controls whether users will see a checkbox allowing them to require providing email during password resets.

Deprecated:
This feature is under development, don't assume this flag's existence or function outside of MediaWiki.

Definition at line 5397 of file DefaultSettings.php.

◆ $wgAllowSchemaUpdates

$wgAllowSchemaUpdates = true

Allow schema updates.

Definition at line 2398 of file DefaultSettings.php.

Referenced by UpdateMediaWiki\execute().

◆ $wgAllowSecuritySensitiveOperationIfCannotReauthenticate

bool [] $wgAllowSecuritySensitiveOperationIfCannotReauthenticate
Initial value:
= [
'default' => true,
]

Whether to allow security-sensitive operations when re-authentication is not possible.

If AuthManager::canAuthenticateNow() is false (e.g. the current SessionProvider is not able to change users, such as when OAuth is in use), AuthManager::securitySensitiveOperationStatus() cannot sensibly return SEC_REAUTH. Setting an operation true here will have it return SEC_OK in that case, while setting it false will have it return SEC_FAIL.

The key 'default' is used if a requested operation isn't defined in the array.

Since
1.27
See also
$wgReauthenticateTime operation => boolean. A 'default' key must always be provided.

Definition at line 5055 of file DefaultSettings.php.

◆ $wgAllowSiteCSSOnRestrictedPages

$wgAllowSiteCSSOnRestrictedPages = false

Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on restricted pages like Special:UserLogin or Special:Preferences where JavaScript is disabled for security reasons.

As it is possible to execute JavaScript through CSS, setting this to true opens up a potential security hole. Some sites may "skin" their wiki by using site-wide CSS, causing restricted pages to look unstyled and different from the rest of the site.

Since
1.25

Definition at line 4221 of file DefaultSettings.php.

◆ $wgAllowSlowParserFunctions

$wgAllowSlowParserFunctions = false

Enable slow parser functions.

Definition at line 2393 of file DefaultSettings.php.

Referenced by CoreParserFunctions\register().

◆ $wgAllowSpecialInclusion

$wgAllowSpecialInclusion = true

Allow special page inclusions such as {{Special:Allpages}}.

Definition at line 8360 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgAllowUserCss

$wgAllowUserCss = false

Allow user Cascading Style Sheets (CSS)? This enables a lot of neat customizations, but may increase security risk to users and server load.

Definition at line 3482 of file DefaultSettings.php.

◆ $wgAllowUserCssPrefs

$wgAllowUserCssPrefs = true

Allow style-related user-preferences?

This controls whether the editfont and underline preferences are available to users.

Definition at line 3490 of file DefaultSettings.php.

◆ $wgAllowUserJs

$wgAllowUserJs = false

Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load.

Definition at line 3475 of file DefaultSettings.php.

◆ $wgAllUnicodeFixes

$wgAllUnicodeFixes = false

Set this to always convert certain Unicode sequences to modern ones regardless of the content language.

This has a small performance impact.

Since
1.17

Definition at line 3193 of file DefaultSettings.php.

Referenced by Language\normalize().

◆ $wgAmericanDates

$wgAmericanDates = false

Enable dates like 'May 12' instead of '12 May', if the default date format is 'dmy or mdy'.

Definition at line 3225 of file DefaultSettings.php.

◆ $wgAntivirus

$wgAntivirus = null

Internal name of virus scanner.

This serves as a key to the $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not null, every file uploaded will be scanned for viruses.

Definition at line 1427 of file DefaultSettings.php.

Referenced by UploadBase\detectVirus().

◆ $wgAntivirusRequired

$wgAntivirusRequired = true

Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.

Definition at line 1481 of file DefaultSettings.php.

Referenced by UploadBase\detectVirus().

◆ $wgAntivirusSetup

$wgAntivirusSetup
Initial value:
= [
# setup for clamav
'clamav' => [
'command' => 'clamscan --no-summary ',
'codemap' => [
"0" => AV_NO_VIRUS, # no virus
"1" => AV_VIRUS_FOUND, # virus found
"52" => AV_SCAN_ABORTED, # unsupported file format (probably immune)
"*" => AV_SCAN_FAILED, # else scan failed
],
'messagepattern' => '/.*?:(.*)/sim',
],
]

Configuration for different virus scanners.

This an associative array of associative arrays. It contains one setup array per known scanner type. The entry is selected by $wgAntivirus, i.e. valid values for $wgAntivirus are the keys defined in this array.

The configuration array for each scanner contains the following keys: "command", "codemap", "messagepattern":

"command" is the full command to call the virus scanner - f will be replaced with the name of the file to scan. If not present, the filename will be appended to the command. Note that this must be overwritten if the scanner is not in the system path; in that case, please set $wgAntivirusSetup[$wgAntivirus]['command'] to the desired command with full path.

"codemap" is a mapping of exit code to return codes of the detectVirus function in SpecialUpload.

  • An exit code mapped to AV_SCAN_FAILED causes the function to consider the scan to be failed. This will pass the file if $wgAntivirusRequired is not set.
  • An exit code mapped to AV_SCAN_ABORTED causes the function to consider the file to have an unsupported format, which is probably immune to viruses. This causes the file to pass.
  • An exit code mapped to AV_NO_VIRUS will cause the file to pass, meaning no virus was found.
  • All other codes (like AV_VIRUS_FOUND) will cause the function to report a virus.
  • You may use "*" as a key in the array to catch all exit codes not mapped otherwise.

"messagepattern" is a perl regular expression to extract the meaningful part of the scanners output. The relevant part should be matched as group one (\1). If not defined or the pattern does not match, the full message is shown to the user.

Definition at line 1463 of file DefaultSettings.php.

Referenced by UploadBase\detectVirus().

◆ $wgAPICacheHelpTimeout

$wgAPICacheHelpTimeout = 60 * 60

Set the timeout for the API help text cache.

If set to 0, caching disabled

Definition at line 8626 of file DefaultSettings.php.

◆ $wgAPIFormatModules

$wgAPIFormatModules = []

API format module extensions.

Associative array mapping format module name to module specs (see $wgAPIModules). Extension modules may override the core modules.

See ApiMain::$Formats for a list of the core format modules.

Definition at line 8563 of file DefaultSettings.php.

◆ $wgApiFrameOptions

$wgApiFrameOptions = 'DENY'

Disallow framing of API pages directly, by setting the X-Frame-Options header.

Since the API returns CSRF tokens, allowing the results to be framed can compromise your user's account security. Options are:

  • 'DENY': Do not allow framing. This is recommended for most wikis.
  • 'SAMEORIGIN': Allow framing by pages on the same domain.
  • false: Allow all framing. Note: $wgBreakFrames will override this for human formatted API output.

Definition at line 3539 of file DefaultSettings.php.

◆ $wgAPIListModules

$wgAPIListModules = []

API Query list module extensions.

Associative array mapping list module name to module specs (see $wgAPIModules). Extension modules may override the core modules.

See ApiQuery::$QueryListModules for a list of the core list modules.

Definition at line 8590 of file DefaultSettings.php.

◆ $wgAPIMaxDBRows

$wgAPIMaxDBRows = 5000

Maximum amount of rows to scan in a DB query in the API The default value is generally fine.

Definition at line 8596 of file DefaultSettings.php.

◆ $wgAPIMaxLagThreshold

$wgAPIMaxLagThreshold = 7

Maximum amount of DB lag on a majority of DB replica DBs to tolerate before forcing bots to retry any write requests via API errors.

This should be lower than the 'max lag' value in $wgLBFactoryConf.

Definition at line 8615 of file DefaultSettings.php.

◆ $wgAPIMaxResultSize

$wgAPIMaxResultSize = 8388608

The maximum size (in bytes) of an API result.

Warning
Do not set this lower than $wgMaxArticleSize*1024

Definition at line 8602 of file DefaultSettings.php.

◆ $wgAPIMaxUncachedDiffs

$wgAPIMaxUncachedDiffs = 1

The maximum number of uncached diffs that can be retrieved in one API request.

Set this to 0 to disable API diffs altogether

Definition at line 8608 of file DefaultSettings.php.

◆ $wgAPIMetaModules

$wgAPIMetaModules = []

API Query meta module extensions.

Associative array mapping meta module name to module specs (see $wgAPIModules). Extension modules may override the core modules.

See ApiQuery::$QueryMetaModules for a list of the core meta modules.

Definition at line 8572 of file DefaultSettings.php.

◆ $wgAPIModules

$wgAPIModules = []

API module extensions.

Associative array mapping module name to modules specs; Each module spec is an associative array containing at least the 'class' key for the module's class, and optionally a 'factory' key for the factory function to use for the module.

That factory function will be called with two parameters, the parent module (an instance of ApiBase, usually ApiMain) and the name the module was registered under. The return value must be an instance of the class given in the 'class' field.

For backward compatibility, the module spec may also be a simple string containing the module's class name. In that case, the class' constructor will be called with the parent module and module name as parameters, as described above.

Examples for registering API modules:

$wgAPIModules['foo'] = 'ApiFoo';
$wgAPIModules['bar'] = [
'class' => ApiBar::class,
'factory' => function( $main, $name ) { ... }
];
$wgAPIModules['xyzzy'] = [
'class' => ApiXyzzy::class,
'factory' => [ XyzzyFactory::class, 'newApiModule' ]
];

Extension modules may override the core modules. See ApiMain::$Modules for a list of the core modules.

Definition at line 8554 of file DefaultSettings.php.

◆ $wgAPIPropModules

$wgAPIPropModules = []

API Query prop module extensions.

Associative array mapping prop module name to module specs (see $wgAPIModules). Extension modules may override the core modules.

See ApiQuery::$QueryPropModules for a list of the core prop modules.

Definition at line 8581 of file DefaultSettings.php.

◆ $wgAPIRequestLog

$wgAPIRequestLog = false

Log file or URL (TCP or UDP) to log API requests to, or false to disable API request logging.

Definition at line 8621 of file DefaultSettings.php.

Referenced by wfApiMain().

◆ $wgAPIUselessQueryPages

$wgAPIUselessQueryPages
Initial value:
= [
'MIMEsearch',
'LinkSearch',
'FileDuplicateSearch',
]

The ApiQueryQueryPages module should skip pages that are redundant to true API queries.

Definition at line 8632 of file DefaultSettings.php.

◆ $wgAppleTouchIcon

$wgAppleTouchIcon = false

The URL path of the icon for iPhone and iPod Touch web app bookmarks.

Defaults to no icon.

Since
1.12

Definition at line 371 of file DefaultSettings.php.

◆ $wgApplyIpBlocksToXff

$wgApplyIpBlocksToXff = false

Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them.

This allows for IP blocks to work with correctly-configured (transparent) proxies without needing to block the proxies themselves.

Definition at line 6065 of file DefaultSettings.php.

◆ $wgArticleCountMethod

$wgArticleCountMethod = 'link'

Method used to determine if a page in a content namespace should be counted as a valid article.

Redirect pages will never be counted as valid articles.

This variable can have the following values:

  • 'any': all pages as considered as valid articles
  • 'link': the page must contain a [[wiki link]] to be considered valid

See also See https://www.mediawiki.org/wiki/Manual:Article_count

Retroactively changing this variable will not affect the existing count, to update it, you will need to run the maintenance/updateArticleCount.php script.

Definition at line 4770 of file DefaultSettings.php.

Referenced by TextContent\isCountable(), WikitextContent\isCountable(), WikiPage\isCountable(), and WikiPage\newDerivedDataUpdater().

◆ $wgArticlePath

$wgArticlePath = false

The URL path for primary article page views.

This path should contain $1, which is replaced by the article title.

Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1", depending on $wgUsePathInfo.

Definition at line 267 of file DefaultSettings.php.

Referenced by Title\getLocalURL(), WebRequest\getPathInfo(), and BenchmarkPurge\randomUrl().

◆ $wgArticleRobotPolicies

$wgArticleRobotPolicies = []

Robot policies per article.

These override the per-namespace robot policies. Must be in the form of an array where the key part is a properly canonicalised text form title and the value is a robot policy.

Example:
'Main Page' => 'noindex,follow',
'User:Bob' => 'index,follow',
];
Example that DOES NOT WORK because the names are not canonical text
forms:
# Underscore, not space!
'Main_Page' => 'noindex,follow',
# "Project", not the actual project name!
'Project:X' => 'index,follow',
# Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
'abc' => 'noindex,nofollow'
];

Definition at line 8479 of file DefaultSettings.php.

Referenced by Article\getRobotPolicy().

◆ $wgAssumeProxiesUseDefaultProtocolPorts

bool $wgAssumeProxiesUseDefaultProtocolPorts = true

When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes the wiki on the standard ports (443 for https and 80 for http).

Since
1.26

Definition at line 133 of file DefaultSettings.php.

Referenced by WebRequest\detectServer().

◆ $wgAsyncHTTPTimeout

$wgAsyncHTTPTimeout = 25

Timeout for Asynchronous (background) HTTP requests, in seconds.

Definition at line 8892 of file DefaultSettings.php.

◆ $wgAttemptFailureEpoch

$wgAttemptFailureEpoch = 1

Certain operations are avoided if there were too many recent failures, for example, thumbnail generation.

Bump this value to invalidate all memory of failed operations and thus allow further attempts to resume. This is useful when a cause for the failures has been found and fixed.

Definition at line 1373 of file DefaultSettings.php.

Referenced by wfGenerateThumbnail().

◆ $wgAuthenticationTokenVersion

string null $wgAuthenticationTokenVersion = null

Versioning for authentication tokens.

If non-null, this is combined with the user's secret (the user_token field in the DB) to generate the token cookie. Changing this will invalidate all active sessions (i.e. it will log everyone out).

Since
1.27

Definition at line 5364 of file DefaultSettings.php.

Referenced by User\getToken().

◆ $wgAuthManagerAutoConfig

$wgAuthManagerAutoConfig
See also
$wgAuthManagerConfig
Since
1.27

Definition at line 4942 of file DefaultSettings.php.

◆ $wgAuthManagerConfig

$wgAuthManagerConfig = null

Configure AuthManager.

All providers are constructed using ObjectFactory, see that for the general structure. The array may also contain a key "sort" used to order providers: providers are stably sorted by this value, which should be an integer (default is 0).

Elements are:

  • preauth: Array (keys ignored) of specifications for PreAuthenticationProviders
  • primaryauth: Array (keys ignored) of specifications for PrimaryAuthenticationProviders
  • secondaryauth: Array (keys ignored) of specifications for SecondaryAuthenticationProviders
Since
1.27
Note
If this is null or empty, the value from $wgAuthManagerAutoConfig is used instead. Local customization should generally set this variable from scratch to the desired configuration. Extensions that want to auto-configure themselves should use $wgAuthManagerAutoConfig instead.

Definition at line 4936 of file DefaultSettings.php.

◆ $wgAutoblockExpiry

$wgAutoblockExpiry = 86400

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5409 of file DefaultSettings.php.

Referenced by MediaWiki\Block\DatabaseBlock\getAutoblockExpiry().

◆ $wgAutoConfirmAge

$wgAutoConfirmAge = 0

Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group membership.

This can be used to limit privileges of new accounts.

Accounts created by earlier versions of the software may not have a recorded creation date, and will always be considered to pass the age test.

When left at 0, all registered accounts will pass.

Example:
Set automatic confirmation to 10 minutes (which is 600 seconds):
$wgAutoConfirmAge = 600; // ten minutes
Set age to one day:
$wgAutoConfirmAge = 3600*24; // one day

Definition at line 5808 of file DefaultSettings.php.

◆ $wgAutoConfirmCount

$wgAutoConfirmCount = 0

Number of edits an account requires before it is autoconfirmed.

Passing both this AND the time requirement is needed. Example:

Example:

Definition at line 5819 of file DefaultSettings.php.

◆ $wgAutoloadAttemptLowercase

$wgAutoloadAttemptLowercase = false

Switch controlling legacy case-insensitive classloading.

Do not disable if your wiki must support data created by PHP4, or by MediaWiki 1.4 or earlier.

Deprecated:
since 1.35

Definition at line 7825 of file DefaultSettings.php.

Referenced by AutoLoader\autoload().

◆ $wgAutoloadClasses

$wgAutoloadClasses = $wgAutoloadClasses ?? []

◆ $wgAutopromote

$wgAutopromote
Initial value:
= [
'autoconfirmed' => [ '&',
],
]

Array containing the conditions of automatic promotion of a user to specific groups.

The basic syntax for $wgAutopromote is:

$wgAutopromote = [
    'groupname' => cond,
    'group2' => cond2,
];

A cond may be:

  • a single condition without arguments: Note that Autopromote wraps a single non-array value into an array e.g. APCOND_EMAILCONFIRMED OR [ APCOND_EMAILCONFIRMED ]
  • a single condition with arguments: e.g. [ APCOND_EDITCOUNT, 100 ]
  • a set of conditions: e.g. ‘[ 'operand’, cond1, cond2, ... ]`

When constructing a set of conditions, the following conditions are available:

  • & (AND): promote if user matches ALL conditions
  • | (OR): promote if user matches ANY condition
  • ^ (XOR): promote if user matches ONLY ONE OF THE CONDITIONS
  • ! (NOT): promote if user matces NO condition
  • [ APCOND_EMAILCONFIRMED ]: true if user has a confirmed e-mail
  • [ APCOND_EDITCOUNT, number of edits ]: true if user has the at least the number of edits as the passed parameter
  • [ APCOND_AGE, seconds since registration ]: true if the length of time since the user created his/her account is at least the same length of time as the passed parameter
  • [ APCOND_AGE_FROM_EDIT, seconds since first edit ]: true if the length of time since the user made his/her first edit is at least the same length of time as the passed parameter
  • [ APCOND_INGROUPS, group1, group2, ... ]: true if the user is a member of each of the passed groups
  • [ APCOND_ISIP, ip ]: true if the user has the passed IP address
  • [ APCOND_IPINRANGE, range ]: true if the user has an IP address in the range of the passed parameter
  • [ APCOND_BLOCKED ]: true if the user is sitewide blocked
  • [ APCOND_ISBOT ]: true if the user is a bot
  • similar constructs can be defined by extensions

The sets of conditions are evaluated recursively, so you can use nested sets of conditions linked by operands.

Note that if $wgEmailAuthentication is disabled, APCOND_EMAILCONFIRMED will be true for any user who has provided an e-mail address.

Definition at line 5878 of file DefaultSettings.php.

◆ $wgAutopromoteOnce

$wgAutopromoteOnce
Initial value:
= [
'onEdit' => [],
]

Automatically add a usergroup to any user who matches certain conditions.

Does not add the user to the group again if it has been removed. Also, does not remove the group if the user no longer meets the criteria.

The format is:

[ event => criteria, ... ]

Where event is either:

  • 'onEdit' (when user edits)

Criteria has the same format as $wgAutopromote

See also
$wgAutopromote
Since
1.18

Definition at line 5903 of file DefaultSettings.php.

◆ $wgAutopromoteOnceLogInRC

$wgAutopromoteOnceLogInRC = true

Put user rights log entries for autopromotion in recent changes?

Since
1.18

Definition at line 5911 of file DefaultSettings.php.

◆ $wgAvailableRights

$wgAvailableRights = []

A list of available rights, in addition to the ones defined by the core.

For extensions only.

Definition at line 5946 of file DefaultSettings.php.

◆ $wgBlockAllowsUTEdit

$wgBlockAllowsUTEdit = true

Set this to true to allow blocked users to edit their own user talk page.

This only applies to sitewide blocks. Partial blocks always allow users to edit their own user talk page unless otherwise specified in the block restrictions.

Definition at line 5418 of file DefaultSettings.php.

◆ $wgBlockCIDRLimit

$wgBlockCIDRLimit
Initial value:
= [
'IPv4' => 16, # Blocks larger than a /16 (64k addresses) will not be allowed
'IPv6' => 19,
]

Limits on the possible sizes of range blocks.

CIDR notation is hard to understand, it's easy to mistakenly assume that a /1 is a small range and a /31 is a large range. For IPv4, setting a limit of half the number of bits avoids such errors, and allows entire ISPs to be blocked using a small number of range blocks.

For IPv6, RFC 3177 recommends that a /48 be allocated to every residential customer, so range blocks larger than /64 (half the number of bits) will plainly be required. RFC 4692 implies that a very large ISP may be allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that as our limit. As of 2012, blocking the whole world would require a /4 range.

Definition at line 5434 of file DefaultSettings.php.

Referenced by MediaWiki\Block\DatabaseBlock\getIpFragment(), and SpecialBlock\validateTarget().

◆ $wgBlockDisablesLogin

$wgBlockDisablesLogin = false

If true, blocked users will not be allowed to login.

When using this with a public wiki, the effect of logging out blocked users may actually be avers: unless the user's address is also blocked (e.g. auto-block), logging the user out will again allow reading and editing, just as for anonymous visitors.

Definition at line 5446 of file DefaultSettings.php.

Referenced by EmailNotification\actuallyNotifyOnPageChange(), EmailNotification\canSendUserTalkEmail(), and MediaWiki\Block\DatabaseBlock\insert().

◆ $wgBotPasswordsCluster

string bool $wgBotPasswordsCluster = false

Cluster for the bot_passwords table If false, the normal cluster will be used.

Since
1.27

Definition at line 6385 of file DefaultSettings.php.

Referenced by BotPassword\getDB().

◆ $wgBotPasswordsDatabase

string bool $wgBotPasswordsDatabase = false

Database name for the bot_passwords table.

To use a database with a table prefix, set this variable to "{$database}-{$prefix}". If false, the normal database will be used

Since
1.27

Definition at line 6395 of file DefaultSettings.php.

Referenced by BotPassword\getDB().

◆ $wgBreakFrames

$wgBreakFrames = false

Break out of framesets.

This can be used to prevent clickjacking attacks, or to prevent external sites from framing your site with ads.

Definition at line 3506 of file DefaultSettings.php.

◆ $wgCacheDirectory

$wgCacheDirectory = false

Directory for caching data in the local filesystem.

Should not be accessible from the web.

Note: if multiple wikis share the same localisation cache directory, they must all have the same set of extensions. You can set a directory just for the localisation cache using $wgLocalisationCacheConf['storeDirectory'].

Definition at line 2434 of file DefaultSettings.php.

Referenced by RebuildLocalisationCache\execute().

◆ $wgCacheEpoch

$wgCacheEpoch = '20030516000000'

Set this to current time to invalidate all prior cached pages.

Affects both client-side and server-side caching. You can get the current date on your server by using the command:

*   date +%Y%m%d%H%M%S
* 

Definition at line 2773 of file DefaultSettings.php.

Referenced by CacheTime\expired(), and FileCacheBase\isCacheGood().

◆ $wgCachePages

$wgCachePages = true

Allow client-side caching of pages.

Definition at line 2763 of file DefaultSettings.php.

◆ $wgCachePrefix

$wgCachePrefix = false

Overwrite the caching key prefix with custom value.

Since
1.19

Definition at line 6893 of file DefaultSettings.php.

Referenced by ObjectCache\getDefaultKeyspace().

◆ $wgCacheSharedUploads

bool $wgCacheSharedUploads = true

Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.5

Definition at line 747 of file DefaultSettings.php.

◆ $wgCacheVaryCookies

$wgCacheVaryCookies = []

A list of cookies that vary the cache (for use by extensions)

Definition at line 6488 of file DefaultSettings.php.

◆ $wgCanonicalServer

$wgCanonicalServer = false

Canonical URL of the server, to use in IRC feeds and notification e-mails.

Must be fully qualified, even if $wgServer is protocol-relative.

Defaults to $wgServer, expanded to a fully qualified http:// URL if needed.

Since
1.18

Definition at line 118 of file DefaultSettings.php.

Referenced by WikiMap\getCanonicalServerInfoForAllWikis(), IRCColourfulRCFeedFormatter\getLine(), MachineReadableRCFeedFormatter\getLine(), WikiMap\getWikiFromUrl(), and wfExpandUrl().

◆ $wgCapitalLinkOverrides

$wgCapitalLinkOverrides = []
Since
1.16 - This can now be set per-namespace. Some special namespaces (such as Special, see NamespaceInfo::$alwaysCapitalizedNamespaces for the full list) must be true by default (and setting them has no effect), due to various things that require them to be so. Also, since Talk namespaces need to directly mirror their associated content namespaces, the values for those are ignored in favor of the subject namespace's setting. Setting for NS_MEDIA is taken automatically from NS_FILE.
Example:

Definition at line 4433 of file DefaultSettings.php.

◆ $wgCapitalLinks

$wgCapitalLinks = true

Set this to false to avoid forcing the first letter of links to capitals.

Warning
may break links! This makes links COMPLETELY case-sensitive. Links appearing with a capital at the beginning of a sentence will not go to the same place as links in the middle of a sentence using a lowercase initial.

Definition at line 4418 of file DefaultSettings.php.

Referenced by XmlDumpWriter\caseSetting().

◆ $wgCascadingRestrictionLevels

$wgCascadingRestrictionLevels = [ 'sysop' ]

Restriction levels that can be used with cascading protection.

A page can only be protected with cascading protection if the requested restriction level is included in this array.

'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility. 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.

Definition at line 5752 of file DefaultSettings.php.

Referenced by WikiPage\doUpdateRestrictions().

◆ $wgCategoryCollation

$wgCategoryCollation = 'uppercase'

Specify how category names should be sorted, when listed on a category page.

A sorting scheme is also known as a collation.

Available values are:

  • uppercase: Converts the category name to upper case, and sorts by that.
  • identity: Does no conversion. Sorts by binary value of the string.
  • uca-default: Provides access to the Unicode Collation Algorithm with the default element table. This is a compromise collation which sorts all languages in a mediocre way. However, it is better than "uppercase".

To use the uca-default collation, you must have PHP's intl extension installed. See https://www.php.net/manual/en/intl.setup.php . The details of the resulting collation will depend on the version of ICU installed on the server.

After you change this, you must run maintenance/updateCollation.php to fix the sort keys in the database.

Extensions can define there own collations by subclassing Collation and using the Collation::factory hook.

Definition at line 8100 of file DefaultSettings.php.

Referenced by UpdateCollation\__construct(), DatabaseUpdater\doCollationUpdate(), LinksUpdate\getCategoryInsertions(), and Collation\singleton().

◆ $wgCategoryMagicGallery

$wgCategoryMagicGallery = true

On category pages, show thumbnail gallery for images belonging to that category instead of listing them as articles.

Definition at line 8068 of file DefaultSettings.php.

◆ $wgCategoryPagingLimit

$wgCategoryPagingLimit = 200

Paging limit for categories.

Definition at line 8073 of file DefaultSettings.php.

◆ $wgCdnMaxAge

$wgCdnMaxAge = 18000

Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI).

Without ESI, you should strip out s-maxage in the CDN config.

18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.

Since
1.34 Renamed from $wgSquidMaxage

Definition at line 2915 of file DefaultSettings.php.

◆ $wgCdnMaxageLagged

$wgCdnMaxageLagged = 30

Cache timeout for the CDN when DB replica DB lag is high.

See also
$wgCdnMaxAge
Since
1.27

Definition at line 2923 of file DefaultSettings.php.

◆ $wgCdnMaxageStale

$wgCdnMaxageStale = 10

Cache timeout when delivering a stale ParserCache response due to PoolCounter contention.

Since
1.35

Definition at line 2931 of file DefaultSettings.php.

Referenced by Article\view().

◆ $wgCdnMaxageSubstitute

$wgCdnMaxageSubstitute = 60

Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)

See also
$wgCdnMaxAge
Since
1.27

Definition at line 2963 of file DefaultSettings.php.

◆ $wgCdnReboundPurgeDelay

$wgCdnReboundPurgeDelay = 0

If set, any SquidPurge call on a URL or URLs will send a second purge no less than this many seconds later via the job queue.

This requires delayed job support. This should be safely higher than the 'max lag' value in $wgLBFactoryConf, so that replica DB lag does not cause page to be stuck in stales states in CDN.

This also fixes race conditions in two-tiered CDN setups (e.g. cdn2 => cdn1 => MediaWiki). If a purge for a URL reaches cdn2 before cdn1 and a request reaches cdn2 for that URL, it will populate the response from the stale cdn1 value. When cdn1 gets the purge, cdn2 will still be stale. If the rebound purge delay is safely higher than the time to relay a purge to all nodes, then the rebound purge will clear cdn2 after cdn1 was cleared.

Since
1.27

Definition at line 2956 of file DefaultSettings.php.

◆ $wgCdnServers

$wgCdnServers = []

List of proxy servers to purge on changes; default port is 80.

Use IP addresses.

When MediaWiki is running behind a proxy, it will trust X-Forwarded-For headers sent/modified from these proxies when obtaining the remote IP address

For a list of trusted servers which aren't purged, see $wgSquidServersNoPurge.

Since
1.34 Renamed from $wgSquidServers.

Definition at line 2982 of file DefaultSettings.php.

Referenced by BenchmarkPurge\execute(), CdnCacheUpdate\naivePurge(), and CdnCacheUpdate\purge().

◆ $wgCdnServersNoPurge

$wgCdnServersNoPurge = []

As with $wgCdnServers, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc.

Supports both individual IP addresses and CIDR blocks.

Since
1.23 Supports CIDR ranges
1.34 Renamed from $wgSquidServersNoPurge

Definition at line 2992 of file DefaultSettings.php.

◆ $wgCentralIdLookupProvider

string $wgCentralIdLookupProvider = 'local'

Central ID lookup provider to use by default.

Definition at line 4801 of file DefaultSettings.php.

Referenced by CentralIdLookup\factory().

◆ $wgCentralIdLookupProviders

$wgCentralIdLookupProviders
Initial value:
= [
'local' => [ 'class' => LocalIdLookup::class ],
]

Central ID lookup providers Key is the provider ID, value is a specification for ObjectFactory.

Since
1.27

Definition at line 4793 of file DefaultSettings.php.

Referenced by CentralIdLookup\factory().

◆ $wgChangeCredentialsBlacklist

string [] $wgChangeCredentialsBlacklist
Initial value:
= [
\MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::class
]

List of AuthenticationRequest class names which are not changeable through Special:ChangeCredentials and the changeauthenticationdata API.

This is only enforced on the client level; AuthManager itself (e.g. AuthManager::allowsAuthenticationDataChange calls) is not affected. Class names are checked for exact match (not for subclasses).

Since
1.27

Definition at line 5068 of file DefaultSettings.php.

◆ $wgCheckFileExtensions

$wgCheckFileExtensions = true

This is a flag to determine whether or not to check file extensions on upload.

Warning
Setting this to false is insecure for public wikis.

Definition at line 1073 of file DefaultSettings.php.

Referenced by UploadBase\checkUnwantedFileExtensions(), StreamFile\contentTypeFromPath(), and UploadBase\getTitle().

◆ $wgCleanSignatures

$wgCleanSignatures = true

If true, removes (by substituting) templates in signatures.

Definition at line 4587 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgCommandLineDarkBg

$wgCommandLineDarkBg = false

For colorized maintenance script output, is your terminal background dark ?

Definition at line 7120 of file DefaultSettings.php.

Referenced by AnsiTermColorer\color().

◆ $wgCompressRevisions

$wgCompressRevisions = false

We can also compress text stored in the 'text' table.

If this is set on, new revisions will be compressed on page save if zlib support is available. Any compressed revisions will be decompressed on load regardless of this setting, but will not be readable at all* if zlib support is not available.

Definition at line 2308 of file DefaultSettings.php.

◆ $wgConf

$wgConf = new SiteConfiguration

$wgConf hold the site configuration.

Not used for much in a default install.

Since
1.5

Definition at line 58 of file DefaultSettings.php.

Referenced by JobQueueGroup\getCachedConfigVar(), and WikiMap\getWikiReferenceFromWgConf().

◆ $wgConfigRegistry

$wgConfigRegistry
Initial value:
= [
'main' => 'GlobalVarConfig::newInstance'
]

Registry of factory functions to create config objects: The 'main' key must be set, and the value should be a valid callable.

Since
1.23

Definition at line 66 of file DefaultSettings.php.

◆ $wgContentHandlers

$wgContentHandlers
Initial value:
= [
CONTENT_MODEL_WIKITEXT => WikitextContentHandler::class,
CONTENT_MODEL_JAVASCRIPT => JavaScriptContentHandler::class,
CONTENT_MODEL_JSON => JsonContentHandler::class,
CONTENT_MODEL_CSS => CssContentHandler::class,
CONTENT_MODEL_TEXT => TextContentHandler::class,
]

Plugins for page content model handling.

Each entry in the array maps a model id to a class name or callback that creates an instance of the appropriate ContentHandler subclass.

Since
1.21

Definition at line 1148 of file DefaultSettings.php.

◆ $wgContentHandlerTextFallback

$wgContentHandlerTextFallback = 'ignore'

How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText():

  • 'ignore': return null
  • 'fail': throw an MWException
  • 'serialize': serialize to default format
Since
1.21

Definition at line 9084 of file DefaultSettings.php.

Referenced by ContentHandler\getContentText().

◆ $wgContentNamespaces

$wgContentNamespaces = [ NS_MAIN ]

Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are concerned.

Useful if additional namespaces also contain "content" which should be considered when generating a count of the number of articles in the wiki.

Definition at line 4478 of file DefaultSettings.php.

◆ $wgCookieDomain

$wgCookieDomain = ''

Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net".

Definition at line 6443 of file DefaultSettings.php.

Referenced by FauxResponse\setCookie(), and WebResponse\setCookie().

◆ $wgCookieExpiration

$wgCookieExpiration = 30 * 86400

Default cookie lifetime, in seconds.

Setting to 0 makes all cookies session-only.

Definition at line 6429 of file DefaultSettings.php.

Referenced by FauxResponse\setCookie(), and WebResponse\setCookie().

◆ $wgCookieHttpOnly

$wgCookieHttpOnly = true

Set authentication cookies to HttpOnly to prevent access by JavaScript, in browsers that support this feature.

This can mitigates some classes of XSS attack.

Definition at line 6483 of file DefaultSettings.php.

Referenced by FauxResponse\setCookie(), and WebResponse\setCookie().

◆ $wgCookiePath

$wgCookiePath = '/'

Set this variable if you want to restrict cookies to a certain path within the domain specified by $wgCookieDomain.

Definition at line 6449 of file DefaultSettings.php.

Referenced by FauxResponse\setCookie(), and WebResponse\setCookie().

◆ $wgCookiePrefix

$wgCookiePrefix = false

Cookies generated by MediaWiki have names starting with this prefix.

Set it to a string to use a custom prefix. Setting it to false causes the database name to be used as a prefix.

Definition at line 6476 of file DefaultSettings.php.

Referenced by FauxRequest\getCookie(), WebRequest\getCookie(), FauxResponse\setCookie(), WebResponse\setCookie(), and FauxRequest\setCookies().

◆ $wgCookieSecure

$wgCookieSecure = 'detect'

Whether the "secure" flag should be set on the cookie.

This can be:

  • true: Set secure flag
  • false: Don't set secure flag
  • "detect": Set the secure flag if $wgServer is set to an HTTPS URL, or if $wgForceHTTPS is true.

If $wgForceHTTPS is true, session cookies will be secure regardless of this setting. However, other cookies will still be affected.

Definition at line 6461 of file DefaultSettings.php.

Referenced by FauxResponse\setCookie(), and WebResponse\setCookie().

◆ $wgCookieSetOnAutoblock

$wgCookieSetOnAutoblock = true

Whether to set a cookie when a user is autoblocked.

Doing so means that a blocked user, even after logging out and moving to a new IP address, will still be blocked. This cookie will contain an authentication code if $wgSecretKey is set, or otherwise will just be the block ID (in which case there is a possibility of an attacker discovering the names of revdeleted users, so it is best to use this in conjunction with $wgSecretKey being set).

Definition at line 6502 of file DefaultSettings.php.

◆ $wgCookieSetOnIpBlock

$wgCookieSetOnIpBlock = true

Whether to set a cookie when a logged-out user is blocked.

Doing so means that a blocked user, even after moving to a new IP address, will still be blocked. This cookie will contain an authentication code if $wgSecretKey is set, or otherwise will just be the block ID (in which case there is a possibility of an attacker discovering the names of revdeleted users, so it is best to use this in conjunction with $wgSecretKey being set).

Definition at line 6511 of file DefaultSettings.php.

◆ $wgCopyUploadProxy

$wgCopyUploadProxy = false

Proxy to use for copy upload requests.

Since
1.20

Definition at line 918 of file DefaultSettings.php.

Referenced by UploadFromUrl\reallyFetchFile().

◆ $wgCopyUploadsDomains

$wgCopyUploadsDomains = []

A list of domains copy uploads can come from.

Since
1.20

Definition at line 905 of file DefaultSettings.php.

Referenced by UploadFromUrl\isAllowedHost().

◆ $wgCopyUploadsFromSpecialUpload

$wgCopyUploadsFromSpecialUpload = false

Enable copy uploads from Special:Upload.

$wgAllowCopyUploads must also be true. If $wgAllowCopyUploads is true, but this is false, you will only be able to perform copy uploads from the API or extensions (e.g. UploadWizard).

Definition at line 912 of file DefaultSettings.php.

◆ $wgCopyUploadTimeout

int bool $wgCopyUploadTimeout = false

Different timeout for upload by url This could be useful since when fetching large files, you may want a timeout longer than the default $wgHTTPTimeout.

False means fallback to default.

Since
1.22

Definition at line 930 of file DefaultSettings.php.

Referenced by UploadFromUrl\reallyFetchFile().

◆ $wgCountCategorizedImagesAsUsed

$wgCountCategorizedImagesAsUsed = false

On Special:Unusedimages, consider images "used", if they are put into a category.

Default (false) is not to count those as used.

Definition at line 8373 of file DefaultSettings.php.

◆ $wgCrossSiteAJAXdomainExceptions

$wgCrossSiteAJAXdomainExceptions = []

Domains that should not be allowed to make AJAX requests, even if they match one of the domains allowed by $wgCrossSiteAJAXdomains Uses the same syntax as $wgCrossSiteAJAXdomains.

Definition at line 8695 of file DefaultSettings.php.

◆ $wgCrossSiteAJAXdomains

$wgCrossSiteAJAXdomains = []

Settings for incoming cross-site AJAX requests: Newer browsers support cross-site AJAX when the target resource allows requests from the origin domain by the Access-Control-Allow-Origin header.

This is currently only used by the API (requests to api.php) $wgCrossSiteAJAXdomains can be set using a wildcard syntax:

  • '*' matches any number of characters
  • '?' matches any 1 character
Example:
'www.mediawiki.org',
'*.wikipedia.org',
'*.wikimedia.org',
'*.wiktionary.org',
];

Definition at line 8688 of file DefaultSettings.php.

◆ $wgCSPFalsePositiveUrls

$wgCSPFalsePositiveUrls
Initial value:
= [
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'chrome-extension' => true,
]

List of urls which appear often to be triggering CSP reports but do not appear to be caused by actual content, but by client software inserting scripts (i.e.

Ad-Ware). List based on results from Wikimedia logs.

Since
1.28

Definition at line 9336 of file DefaultSettings.php.

◆ $wgCSPHeader

bool array $wgCSPHeader = false

Controls Content-Security-Policy header [Experimental].

See also
https://www.w3.org/TR/CSP2/
Since
1.32 true to send default version, false to not send. If an array, can have parameters: 'default-src' If true or array (of additional urls) will set a default-src directive, which limits what places things can load from. If false or not set, will send a default-src directive allowing all sources. 'includeCORS' If true or not set, will include urls from $wgCrossSiteAJAXdomains as an allowed load sources. 'unsafeFallback' Add unsafe-inline as a script source, as a fallback for browsers that do not understand nonce-sources [default on]. 'useNonces' Require nonces on all inline scripts. If disabled and 'unsafeFallback' is on, then all inline scripts will be allowed [default true]. 'script-src' Array of additional places that are allowed to have JS be loaded from. 'object-src' Array or string of where to load objects from. unset/true means 'none'. False means omit. (Since 1.35) 'report-uri' true to use MW api [default], false to disable, string for alternate uri
Warning
May cause slowness on windows due to slow random number generator.

Definition at line 9259 of file DefaultSettings.php.

◆ $wgCSPReportOnlyHeader

bool array $wgCSPReportOnlyHeader = false

Controls Content-Security-Policy-Report-Only header.

Since
1.32 Same as $wgCSPHeader

Definition at line 9267 of file DefaultSettings.php.

◆ $wgCustomConvertCommand

$wgCustomConvertCommand = false

Use another resizing converter, e.g.

GraphicMagick s will be replaced with the source path, d with the destination w and h will be replaced with the width and height.

Example for GraphicMagick:
$wgCustomConvertCommand = "gm convert %s -resize %wx%h %d"

Leave as false to skip this.

Definition at line 1217 of file DefaultSettings.php.

Referenced by BitmapHandler\getScalerType(), and BitmapHandler\transformCustom().

◆ $wgDataCenterUpdateStickTTL

$wgDataCenterUpdateStickTTL = 10

After a state-changing request is done by a client, this determines how many seconds that client should keep using the master datacenter.

This avoids unexpected stale or 404 responses due to replication lag.

Since
1.27

Definition at line 2241 of file DefaultSettings.php.

◆ $wgDBadminpassword

$wgDBadminpassword = null

Separate password for maintenance tasks.

Leave as null to use the default.

Definition at line 2071 of file DefaultSettings.php.

Referenced by Maintenance\finalSetup().

◆ $wgDBadminuser

$wgDBadminuser = null

Separate username for maintenance tasks.

Leave as null to use the default.

Definition at line 2066 of file DefaultSettings.php.

Referenced by Maintenance\finalSetup().

◆ $wgDBcompress

$wgDBcompress = false

Whether to use compression in DB connection.

This setting is only used $wgLBFactoryConf['class'] is set to '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise the DBO_COMPRESS flag must be set in the 'flags' option of the database connection to achieve the same functionality.

Definition at line 2061 of file DefaultSettings.php.

◆ $wgDBDefaultGroup

$wgDBDefaultGroup = null

Default group to use when getting database connections.

Will be used as default query group in ILoadBalancer::getConnection.

Since
1.32

Definition at line 2118 of file DefaultSettings.php.

Referenced by Maintenance\finalSetup().

◆ $wgDBerrorLog

◆ $wgDBerrorLogTZ

$wgDBerrorLogTZ = false

Timezone to use in the error log.

Defaults to the wiki timezone ($wgLocaltimezone).

A list of usable timezones can found at: https://www.php.net/manual/en/timezones.php

Examples:
$wgDBerrorLogTZ = 'PST8PDT';
$wgDBerrorLogTZ = 'Europe/Sweden';
Since
1.20

Definition at line 2266 of file DefaultSettings.php.

Referenced by MediaWiki\Logger\LegacyLogger\formatAsWfLogDBError().

◆ $wgDBmwschema

$wgDBmwschema = null

Current wiki database schema name.

Should be alphanumeric, without spaces nor hyphens. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).

This should still be set even if $wgLBFactoryConf is configured.

Definition at line 2006 of file DefaultSettings.php.

Referenced by WikiMap\getCurrentWikiDbDomain().

◆ $wgDBname

$wgDBname = 'my_wiki'

Current wiki database name.

Should be alphanumeric, without spaces nor hyphens. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).

This should still be set even if $wgLBFactoryConf is configured.

Definition at line 1996 of file DefaultSettings.php.

Referenced by CloneDatabase\changePrefix(), XmlDumpWriter\dbname(), RenameDbPrefix\execute(), CompressOld\execute(), WikiMap\getCurrentWikiDbDomain(), CheckStorage\restoreText(), and wfWikiID().

◆ $wgDBpassword

$wgDBpassword = ''

Database user's password.

Definition at line 2036 of file DefaultSettings.php.

Referenced by Maintenance\finalSetup(), MysqlInstaller\preUpgrade(), and PostgresInstaller\preUpgrade().

◆ $wgDBport

$wgDBport = 5432

Database port number (for PostgreSQL and Microsoft SQL Server).

Definition at line 2026 of file DefaultSettings.php.

◆ $wgDBprefix

$wgDBprefix = ''

Current wiki database table name prefix.

Should be alphanumeric, without spaces nor hyphens, preferably ending in an underscore. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).

This should still be set even if $wgLBFactoryConf is configured.

Definition at line 2016 of file DefaultSettings.php.

Referenced by CloneDatabase\changePrefix(), WikiMap\getCurrentWikiDbDomain(), and wfWikiID().

◆ $wgDBserver

$wgDBserver = 'localhost'

Database host name or IP address.

Definition at line 2021 of file DefaultSettings.php.

Referenced by BackupDumper\backupServer().

◆ $wgDBservers

$wgDBservers = false

Database load balancer This is a two-dimensional array, an array of server info structures Fields are:

  • host: Host name
  • dbname: Default database name
  • user: DB user
  • password: DB password
  • type: DB type
  • driver: DB driver (when there are multiple drivers)
  • load: Ratio of DB_REPLICA load, must be >=0, the sum of all loads must be >0. If this is zero for any given server, no normal query traffic will be sent to it. It will be excluded from lag checks in maintenance scripts. The only way it can receive traffic is if groupLoads is used.
  • groupLoads: (optional) Array of load ratios, the key is the query group name. A query may belong to several groups, the most specific group defined here is used.
  • flags: (optional) Bit field of properties:
    • DBO_DEFAULT: Transactionalize web requests and use autocommit otherwise
    • DBO_DEBUG: Equivalent of $wgDebugDumpSql
    • DBO_SSL: Use TLS connection encryption if available
    • DBO_COMPRESS: Use protocol compression with database connections
    • DBO_PERSISTENT: Enables persistent database connections
  • max lag: (optional) Maximum replication lag before a replica DB goes out of rotation
  • is static: (optional) Set to true if the dataset is static and no replication is used.
  • cliMode: (optional) Connection handles will not assume that requests are short-lived nor that INSERT..SELECT can be rewritten into a buffered SELECT and INSERT. This is what DBO_DEFAULT uses to determine when a web request is present. [Default: uses value of $wgCommandLineMode]

These and any other user-defined properties will be assigned to the mLBInfo member variable of the Database object.

Leave at false to use the single-server variables above. If you set this variable, the single-server variables will generally be ignored (except perhaps in some command-line scripts).

The first server listed in this array (with key 0) will be the master. The rest of the servers will be replica DBs. To prevent writes to your replica DBs due to accidental misconfiguration or MediaWiki bugs, set read_only=1 on all your replica DBs in my.cnf. You can set read_only mode at runtime using:

SET @@read_only=1;

Since the effect of writing to a replica DB is so damaging and difficult to clean up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even our masters, and then set read_only=0 on masters at runtime.

Definition at line 2221 of file DefaultSettings.php.

Referenced by Maintenance\finalSetup().

◆ $wgDBssl

$wgDBssl = false

Whether to use SSL in DB connection.

This setting is only used if $wgLBFactoryConf['class'] is set to '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise the DBO_SSL flag must be set in the 'flags' option of the database connection to achieve the same functionality.

Definition at line 2051 of file DefaultSettings.php.

◆ $wgDBTableOptions

$wgDBTableOptions = 'ENGINE=InnoDB, DEFAULT CHARSET=binary'

MySQL table options to use during installation or update.

Definition at line 2103 of file DefaultSettings.php.

Referenced by UpdateLogging\execute(), and MysqlUpdater\getSchemaVars().

◆ $wgDBtype

$wgDBtype = 'mysql'

Database type.

Definition at line 2041 of file DefaultSettings.php.

◆ $wgDBuser

$wgDBuser = 'wikiuser'

Database username.

Definition at line 2031 of file DefaultSettings.php.

Referenced by Maintenance\finalSetup(), MysqlInstaller\preUpgrade(), and PostgresInstaller\preUpgrade().

◆ $wgDebugAPI

$wgDebugAPI = false
WARNING: SECURITY THREAT - debug use only

Disables many security checks in the API for debugging purposes. This flag should never be used on the production servers, as it introduces a number of potential security holes. Even when enabled, the validation will still be performed, but instead of failing, API will return a warning. Also, there will always be a warning notifying that this flag is set. At this point, the flag allows GET requests to go through for modules requiring POST.

Since
1.21

Definition at line 8516 of file DefaultSettings.php.

◆ $wgDebugComments

$wgDebugComments = false

Send debug data to an HTML comment in the output.

This may occasionally be useful when supporting a non-technical end-user. It's more secure than exposing the debug log file to the web, since the output only contains private data for the current user. But it's not ideal for development use since data is lost on fatal errors and redirects.

Definition at line 6572 of file DefaultSettings.php.

Referenced by MWDebug\debugMsg(), and MWDebug\getDebugHTML().

◆ $wgDebugDumpSql

$wgDebugDumpSql = false

Write SQL queries to the debug log.

This setting is only used $wgLBFactoryConf['class'] is set to '\Wikimedia\Rdbms\LBFactorySimple'; otherwise the DBO_DEBUG flag must be set in the 'flags' option of the database connection to achieve the same functionality.

Definition at line 6581 of file DefaultSettings.php.

◆ $wgDebugLogFile

$wgDebugLogFile = ''

Filename for debug logging.

See https://www.mediawiki.org/wiki/How_to_debug The debug log file should be not be publicly accessible if it is used, as it may contain private data.

Definition at line 6543 of file DefaultSettings.php.

Referenced by MediaWiki\Logger\LegacyLogger\__construct(), MediaWiki\Logger\LegacyLogger\destination(), and MediaWiki\Logger\LegacyLogger\shouldEmit().

◆ $wgDebugLogGroups

$wgDebugLogGroups = []

Map of string log group names to log destinations.

If set, wfDebugLog() output for that group will go to that file instead of the regular $wgDebugLogFile. Useful for enabling selective logging in production.

Log destinations may be one of the following:

  • false to completely remove from the output, including from $wgDebugLogFile.
  • string values specifying a filename or URI.
  • associative array with keys:
    • 'destination' desired filename or URI.
    • 'sample' an integer value, specifying a sampling factor (optional)
    • 'level' A \Psr\Log\LogLevel constant, indicating the minimum level to log (optional, since 1.25)
Example:
$wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
Advanced example:
$wgDebugLogGroups['memcached'] = [
'destination' => '/var/log/mediawiki/memcached.log',
'sample' => 1000, // log 1 message out of every 1,000.
'level' => \\Psr\\Log\\LogLevel::WARNING
];

Definition at line 6671 of file DefaultSettings.php.

Referenced by MediaWiki\Logger\LegacyLogger\__construct(), MediaWiki\Logger\LegacyLogger\destination(), MediaWiki\Logger\LegacyLogger\format(), and MediaWiki\Logger\LegacyLogger\shouldEmit().

◆ $wgDebugLogPrefix

$wgDebugLogPrefix = ''

Prefix for debug log lines.

Definition at line 6548 of file DefaultSettings.php.

Referenced by wfDebug().

◆ $wgDebugRawPage

$wgDebugRawPage = false

If true, log debugging data from action=raw and load.php.

This is normally false to avoid overlapping debug entries due to gen=css and gen=js requests.

Definition at line 6562 of file DefaultSettings.php.

Referenced by wfDebug().

◆ $wgDebugRedirects

$wgDebugRedirects = false

If true, instead of redirecting, show a page with a link to the redirect destination.

This allows for the inspection of PHP error messages, and easy resubmission of form data. For developer use only.

Definition at line 6555 of file DefaultSettings.php.

◆ $wgDebugToolbar

$wgDebugToolbar = false

Display the new debugging toolbar.

This also enables profiling on database queries and other useful output. Will be ignored if $wgUseFileCache or $wgUseCdn is enabled.

Since
1.19

Definition at line 6902 of file DefaultSettings.php.

Referenced by MediaWiki\Logger\LegacyLogger\__construct(), and MWDebug\setup().

◆ $wgDefaultExternalStore

array $wgDefaultExternalStore = false

The place to put new revisions, false to put them in the local text table.

Part of a URL, e.g. DB://cluster1

Can be an array instead of a single string, to enable data distribution. Keys must be consecutive integers, starting at zero.

Example:
$wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];

Definition at line 2353 of file DefaultSettings.php.

◆ $wgDefaultLanguageVariant

$wgDefaultLanguageVariant = false

Default variant code, if false, the default will be the language code.

Definition at line 3257 of file DefaultSettings.php.

Referenced by LanguageConverter\getDefaultVariant(), and LanguageConverter\getPreferredVariant().

◆ $wgDefaultRobotPolicy

$wgDefaultRobotPolicy = 'index,follow'

Default robot policy.

The default policy is to encourage indexing and fol- lowing of links. It may be overridden on a per-namespace and/or per-page basis.

Definition at line 8435 of file DefaultSettings.php.

Referenced by Article\getRobotPolicy().

◆ $wgDefaultSkin

$wgDefaultSkin = 'vector'

Default skin, for new users and anonymous visitors.

Registered users may change this to any one of the other available skins in their preferences.

Definition at line 3449 of file DefaultSettings.php.

Referenced by Skin\normalizeKey(), and ResourceFileCache\useFileCache().

◆ $wgDefaultUserOptions

$wgDefaultUserOptions

Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts.

For instance, to disable editing on double clicks: $wgDefaultUserOptions ['editondblclick'] = 0;

Definition at line 5259 of file DefaultSettings.php.

Referenced by MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions().

◆ $wgDeletedDirectory

$wgDeletedDirectory = false

What directory to place deleted uploads in.

Defaults to "{$wgUploadDirectory}/deleted".

Definition at line 503 of file DefaultSettings.php.

◆ $wgDeleteRevisionsBatchSize

$wgDeleteRevisionsBatchSize = 1000

Page deletions with > this number of revisions will use the job queue.

Revisions will be archived in batches of (at most) this size, one batch per job.

Definition at line 5958 of file DefaultSettings.php.

Referenced by WikiPage\archiveRevisions(), and WikiPage\isBatchedDelete().

◆ $wgDeleteRevisionsLimit

$wgDeleteRevisionsLimit = 0

Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission.

(Default given to sysops.)

Definition at line 5952 of file DefaultSettings.php.

Referenced by MediaWiki\Permissions\PermissionManager\checkActionPermissions(), Article\delete(), and Title\isBigDeletion().

◆ $wgDeprecationReleaseLimit

$wgDeprecationReleaseLimit = false

Release limitation to wfDeprecated warnings, if set to a release number development warnings will not be generated for deprecations added in releases after the limit.

Definition at line 6774 of file DefaultSettings.php.

Referenced by MWDebug\deprecatedMsg().

◆ $wgDevelopmentWarnings

$wgDevelopmentWarnings = false

If set to true MediaWiki will throw notices for some possible error conditions and for deprecated functions.

Definition at line 6767 of file DefaultSettings.php.

Referenced by ExtensionRegistry\saveToCache(), MWDebug\sendRawDeprecated(), and MWDebug\warning().

◆ $wgDiff

$wgDiff = '/usr/bin/diff'

Path to the GNU diff utility.

Definition at line 7075 of file DefaultSettings.php.

Referenced by CompareParsers\checkOptions(), and wfDiff().

◆ $wgDiff3

$wgDiff3 = '/usr/bin/diff3'

Path to the GNU diff3 utility.

If the file doesn't exist, edit conflicts will fall back to the old behavior (no merging).

Definition at line 7070 of file DefaultSettings.php.

Referenced by wfMerge().

◆ $wgDiffEngine

string null $wgDiffEngine = null

Specify the difference engine to use.

Supported values:

  • 'external': Use an external diff engine, which must be specified via $wgExternalDiffEngine
  • 'wikidiff2': Use the wikidiff2 PHP extension
  • 'php': PHP implementations included in MediaWiki

The default (null) is to use the first engine that's available.

Since
1.35

Definition at line 8975 of file DefaultSettings.php.

◆ $wgDirectoryMode

$wgDirectoryMode = 0777

Default value for chmoding of new directories.

Definition at line 1679 of file DefaultSettings.php.

Referenced by wfMkdirParents().

◆ $wgDisableAnonTalk

$wgDisableAnonTalk = false

Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history, Special:Recentchanges, etc.

Definition at line 7442 of file DefaultSettings.php.

Referenced by WikiPage\commitRollback(), EditPage\getContentObject(), and Linker\userToolLinks().

◆ $wgDisableCookieCheck

$wgDisableCookieCheck = false

By default, MediaWiki checks if the client supports cookies during the login process, so that it can display an informative error message if cookies are disabled.

Set this to true if you want to disable this cookie check.

Definition at line 6469 of file DefaultSettings.php.

Referenced by LoginSignupSpecialPage\hasSessionCookie().

◆ $wgDisabledVariants

$wgDisabledVariants = []

Disabled variants array of language variant conversion.

Example:
$wgDisabledVariants[] = 'zh-mo';
$wgDisabledVariants[] = 'zh-my';

Definition at line 3274 of file DefaultSettings.php.

Referenced by LanguageConverter\__construct().

◆ $wgDisableHardRedirects

$wgDisableHardRedirects = false

Disable redirects to special pages and interwiki redirects, which use a 302 and have no "redirected from" link.

Note
This is only for articles with #REDIRECT in them. URL's containing a local interwiki prefix (or a non-canonical special page name) are still hard redirected regardless of this setting.

Definition at line 8991 of file DefaultSettings.php.

◆ $wgDisableInternalSearch

$wgDisableInternalSearch = false

Disable the internal MySQL-based search, to allow it to be implemented by an extension instead.

Definition at line 7000 of file DefaultSettings.php.

◆ $wgDisableLangConversion

$wgDisableLangConversion = false

Whether to enable language variant conversion.

Definition at line 3247 of file DefaultSettings.php.

Referenced by LanguageConverter\convertTo(), LanguageConverter\findVariantLink(), ParserOptions\getDefaults(), and Preprocessor_Hash\preprocessToObj().

◆ $wgDisableOutputCompression

$wgDisableOutputCompression = false

Disable output compression (enabled by default if zlib is available)

Definition at line 3544 of file DefaultSettings.php.

Referenced by MediaWiki\OutputHandler\handle(), and wfResetOutputBuffers().

◆ $wgDisableQueryPages

$wgDisableQueryPages = false

Disable all query pages if miser mode is on, not just some.

Definition at line 2378 of file DefaultSettings.php.

◆ $wgDisableQueryPageUpdate

$wgDisableQueryPageUpdate = false

Set this to an array of special page names to prevent maintenance/updateSpecialPages.php from updating those pages.

Mapping each special page name to an run mode like 'periodical' if a cronjob is set up.

Definition at line 8367 of file DefaultSettings.php.

◆ $wgDisableSearchUpdate

$wgDisableSearchUpdate = false

If you've disabled search semi-permanently, this also disables updates to the table.

If you ever re-enable, be sure to rebuild the search table.

Definition at line 6981 of file DefaultSettings.php.

Referenced by UpdateSearchIndex\doUpdateSearchIndex().

◆ $wgDisableTextSearch

$wgDisableTextSearch = false

Set this to true to disable the full text search feature.

Definition at line 6914 of file DefaultSettings.php.

◆ $wgDisableTitleConversion

$wgDisableTitleConversion = false

Whether to enable language variant conversion for links.

Definition at line 3252 of file DefaultSettings.php.

Referenced by LanguageConverter\findVariantLink(), and ParserOptions\getDefaults().

◆ $wgDisableUploadScriptChecks

$wgDisableUploadScriptChecks = false

Setting this to true will disable the upload system's checks for HTML/JavaScript.

Warning
THIS IS VERY DANGEROUS on a publicly editable site, so USE $wgGroupPermissions TO RESTRICT UPLOADING to only those that you trust

Definition at line 1089 of file DefaultSettings.php.

Referenced by UploadBase\verifyFile(), and UploadBase\verifyPartialFile().

◆ $wgDjvuDump

$wgDjvuDump = null

Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';.

Definition at line 1708 of file DefaultSettings.php.

Referenced by DjVuHandler\isEnabled(), and DjVuImage\retrieveMetaData().

◆ $wgDjvuOutputExtension

$wgDjvuOutputExtension = 'jpg'

File extension for the DJVU post processor output.

Definition at line 1750 of file DefaultSettings.php.

Referenced by DjVuHandler\getThumbType().

◆ $wgDjvuPostProcessor

$wgDjvuPostProcessor = 'pnmtojpeg'

Shell command for the DJVU post processor Default: pnmtojpeg, since ddjvu generates ppm output Set this to false to output the ppm file directly.

Definition at line 1745 of file DefaultSettings.php.

Referenced by DjVuHandler\doTransform().

◆ $wgDjvuRenderer

$wgDjvuRenderer = null

Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';.

Definition at line 1715 of file DefaultSettings.php.

Referenced by DjVuHandler\doTransform(), and DjVuHandler\isEnabled().

◆ $wgDjvuToXML

$wgDjvuToXML = null

Path of the djvutoxml executable This works like djvudump except much, much slower as of version 3.5.

For now we recommend you use djvudump instead. The djvuxml output is probably more stable, so we'll switch back to it as soon as they fix the efficiency problem. https://sourceforge.net/tracker/index.php?func=detail&aid=1704049&group_id=32953&atid=406583

Example:
$wgDjvuToXML = 'djvutoxml';

Definition at line 1738 of file DefaultSettings.php.

Referenced by DjVuHandler\isEnabled(), and DjVuImage\retrieveMetaData().

◆ $wgDjvuTxt

$wgDjvuTxt = null

Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';.

Definition at line 1722 of file DefaultSettings.php.

Referenced by DjVuImage\retrieveMetaData().

◆ $wgDnsBlacklistUrls

$wgDnsBlacklistUrls = [ 'http.dnsbl.sorbs.net.' ]

List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.

This is an array of either a URL or an array with the URL and a key (should the blacklist require a key).

Example:
// String containing URL
'http.dnsbl.sorbs.net.',
// Array with URL and key, for services that require a key
[ 'dnsbl.httpbl.net.', 'mykey' ],
// Array with just the URL. While this works, it is recommended that you
// just use a string as shown above
[ 'opm.tornevall.org.' ]
];
Note
You should end the domain name with a . to avoid searching your eventual domain search suffixes.
Since
1.16

Definition at line 6043 of file DefaultSettings.php.

◆ $wgDummyLanguageCodes

$wgDummyLanguageCodes = []

Functionally the same as $wgExtraLanguageCodes, but deprecated.

Instead of appending values to this array, append them to $wgExtraLanguageCodes.

Deprecated:
since 1.29

Definition at line 3184 of file DefaultSettings.php.

Referenced by WikiStatsOutput\heading().

◆ $wgEdititis

$wgEdititis = false

Display user edit counts in various prominent places.

Definition at line 3643 of file DefaultSettings.php.

◆ $wgEditPageFrameOptions

$wgEditPageFrameOptions = 'DENY'

The X-Frame-Options header to send on pages sensitive to clickjacking attacks, such as edit pages.

This prevents those pages from being displayed in a frame or iframe. The options are:

  • 'DENY': Do not allow framing. This is recommended for most wikis.
  • 'SAMEORIGIN': Allow framing by pages on the same domain. This can be used to allow framing within a trusted domain. This is insecure if there is a page on the same domain which allows framing of arbitrary URLs.
  • false: Allow all framing. This opens up the wiki to XSS attacks and thus full compromise of local user accounts. Private wikis behind a corporate firewall are especially vulnerable. This is not recommended.

For extra safety, set $wgBreakFrames = true, to prevent framing on all pages, not just edit pages.

Definition at line 3527 of file DefaultSettings.php.

◆ $wgEditSubmitButtonLabelPublish

$wgEditSubmitButtonLabelPublish = false

Whether to label the store-to-database-and-show-to-others button in the editor as "Save page"/"Save changes" if false (the default) or, if true, instead as "Publish page"/"Publish changes".

Since
1.28

Definition at line 3418 of file DefaultSettings.php.

◆ $wgElementTiming

bool $wgElementTiming = false

Enable Element Timing.

Warning
EXPERIMENTAL!
Since
1.33

Definition at line 9467 of file DefaultSettings.php.

Referenced by ThumbnailImage\toHtml().

◆ $wgEmailAuthentication

$wgEmailAuthentication = true

Require email authentication before sending mail to an email address.

This is highly recommended. It prevents MediaWiki from being used as an open spam relay.

Definition at line 1908 of file DefaultSettings.php.

Referenced by User\isEmailConfirmationPending(), User\isEmailConfirmed(), and User\setEmailWithConfirmation().

◆ $wgEmailConfirmToEdit

$wgEmailConfirmToEdit = false

Should editors be required to have a validated e-mail address before being allowed to edit?

Definition at line 5502 of file DefaultSettings.php.

Referenced by LoginSignupSpecialPage\getFieldDefinitions().

◆ $wgEmergencyContact

$wgEmergencyContact = false

Site admin email address.

Defaults to "wikiadmin@$wgServerName" (in Setup.php).

Definition at line 1766 of file DefaultSettings.php.

◆ $wgEnableAsyncUploads

$wgEnableAsyncUploads = false

Enable deferred upload tasks that use the job queue.

Only enable this if job runners are set up for both the 'AssembleUploadChunks' and 'PublishStashedFile' job types.

Note
If you use suhosin, this setting is incompatible with suhosin.session.encrypt.

Definition at line 488 of file DefaultSettings.php.

◆ $wgEnableAutoRotation

$wgEnableAutoRotation = null

If set to true, images that contain certain the exif orientation tag will be rotated accordingly.

If set to null, try to auto-detect whether a scaler is available that can rotate.

Definition at line 1420 of file DefaultSettings.php.

Referenced by BitmapHandler\autoRotateEnabled().

◆ $wgEnableBotPasswords

bool $wgEnableBotPasswords = true

◆ $wgEnableCanonicalServerLink

$wgEnableCanonicalServerLink = false

Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e.

$wgServer or $wgCanonicalServer. Since detection of the current server is unreliable, the link is sent unconditionally.

Definition at line 3675 of file DefaultSettings.php.

◆ $wgEnableDnsBlacklist

$wgEnableDnsBlacklist = false

Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies.

Since
1.16

Definition at line 6018 of file DefaultSettings.php.

◆ $wgEnableEmail

$wgEnableEmail = true

Set to true to enable the e-mail basic features: Password reminders, etc.

If sending e-mail on your server doesn't work, you might want to disable this.

Definition at line 1790 of file DefaultSettings.php.

Referenced by User\canSendEmail(), and User\setEmailWithConfirmation().

◆ $wgEnableImageWhitelist

$wgEnableImageWhitelist = false

If $wgAllowExternalImages is false, you can allow an on-wiki allow list of regular expression fragments to match the image URL against.

If the image matches one of the regular expression fragments, the image will be displayed.

Set this to true to enable the on-wiki allow list (MediaWiki:External image whitelist) Or false to disable it

Since
1.14

Definition at line 4619 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgEnableJavaScriptTest

$wgEnableJavaScriptTest = false

Allow running of javascript test suites via [[Special:JavaScriptTest]] (such as QUnit).

Definition at line 6887 of file DefaultSettings.php.

◆ $wgEnableMagicLinks

$wgEnableMagicLinks
Initial value:
= [
'ISBN' => false,
'PMID' => false,
'RFC' => false
]

Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.

Since
1.28

Definition at line 4741 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults(), and wfEscapeWikiText().

◆ $wgEnableOpenSearchSuggest

$wgEnableOpenSearchSuggest = true

This was previously a used to force empty responses from ApiOpenSearch with the 'suggest' parameter set.

Deprecated:
since 1.35 No longer used

Definition at line 6959 of file DefaultSettings.php.

◆ $wgEnableParserLimitReporting

$wgEnableParserLimitReporting = true

Whether to include the NewPP limit report as a HTML comment.

Definition at line 7777 of file DefaultSettings.php.

Referenced by ParserOptions\getCanonicalOverrides().

◆ $wgEnableRestAPI

$wgEnableRestAPI = false

Enable the experimental REST API.

This will be removed once the REST API is stable and used by clients.

Definition at line 8720 of file DefaultSettings.php.

◆ $wgEnableScaryTranscluding

$wgEnableScaryTranscluding = false

Enable interwiki transcluding.

Only when iw_trans=1 in the interwiki table.

Definition at line 4727 of file DefaultSettings.php.

Referenced by WikiPage\purgeInterwikiCheckKey().

◆ $wgEnableSearchContributorsByIP

$wgEnableSearchContributorsByIP = true

If true, searches for IP addresses will be redirected to that IP's contributions page.

E.g. searching for "1.2.3.4" will redirect to [[Special:Contributions/1.2.3.4]]

Definition at line 7057 of file DefaultSettings.php.

◆ $wgEnableSidebarCache

$wgEnableSidebarCache = false

If on, the sidebar navigation links are cached for users with the current language set.

This can save a touch of load on a busy site by shaving off extra message lookups.

However it is also fragile: changing the site configuration, or having a variable $wgArticlePath, can produce broken links that don't update as expected.

Definition at line 2811 of file DefaultSettings.php.

◆ $wgEnableSpecialMute

$wgEnableSpecialMute = false

Set to true to enable the Special Mute page.

This allows users to mute unwanted communications from other users, and is linked to from emails originating from Special:Email.

Since
1.34
Deprecated:
1.34

Definition at line 1806 of file DefaultSettings.php.

◆ $wgEnableUploads

$wgEnableUploads = false

Allow users to upload files.

Use $wgLocalFileRepo to control how and where uploads are stored. Disabled by default as for security reasons. See https://www.mediawiki.org/wiki/Manual:Configuring_file_uploads.

Since
1.5

Definition at line 464 of file DefaultSettings.php.

Referenced by UploadBase\isEnabled(), Linker\makeBrokenImageLinkObj(), and ImagePage\openShowImage().

◆ $wgEnableUserEmail

$wgEnableUserEmail = true

Set to true to enable user-to-user e-mail.

This can potentially be abused, as it's hard to track.

Definition at line 1796 of file DefaultSettings.php.

Referenced by SpecialBlock\canBlockEmail(), and User\canSendEmail().

◆ $wgEnableUserEmailBlacklist

$wgEnableUserEmailBlacklist = false

Set to true to enable user-to-user e-mail blacklist.

Since
1.30

Definition at line 1813 of file DefaultSettings.php.

◆ $wgEnableWANCacheReaper

bool $wgEnableWANCacheReaper = false

Verify and enforce WAN cache purges using reliable DB sources as streams.

These secondary cache purges are de-duplicated via simple cache mutexes. This improves consistency when cache purges are lost, which becomes more likely as more cache servers are added or if there are multiple datacenters. Only keys related to important mutable content will be checked.

Since
1.29

Definition at line 2607 of file DefaultSettings.php.

◆ $wgEnotifFromEditor

bool $wgEnotifFromEditor = false

Allow sending of e-mail notifications with the editor's address as sender.

This setting depends on $wgEnotifRevealEditorAddress also being enabled. If both are enabled, notifications for actions from users that have opted-in, will be sent to other users with their address as "From" instead of "Reply-To".

If disabled, or not opted-in, notifications come from $wgPasswordSender.

Definition at line 1895 of file DefaultSettings.php.

Referenced by EmailNotification\composeCommonMailtext().

◆ $wgEnotifImpersonal

$wgEnotifImpersonal = false

Send a generic mail instead of a personalised mail for each user.

This always uses UTC as the time zone, and doesn't include the username.

For pages with many users watching, this can significantly reduce mail load. Has no effect when using sendmail rather than SMTP.

Definition at line 1962 of file DefaultSettings.php.

Referenced by EmailNotification\compose(), EmailNotification\composeCommonMailtext(), and EmailNotification\sendMails().

◆ $wgEnotifMaxRecips

$wgEnotifMaxRecips = 500

Maximum number of users to mail at once when using impersonal mail.

Should match the limit on your mail server.

Definition at line 1968 of file DefaultSettings.php.

Referenced by UserMailer\sendInternal().

◆ $wgEnotifMinorEdits

$wgEnotifMinorEdits = true

Potentially send notification mails on minor edits to pages.

This is enabled by default. If this is false, users will never be notified on minor edits.

If it is true, editors with the 'nominornewtalk' right (typically bots) will still not trigger notifications for minor edits they make (to any page, not just user talk).

Finally, if the watcher/recipient has the 'enotifminoredits' user preference set to false, they will not receive notifications for minor edits.

User talk notifications are also affected by $wgEnotifMinorEdits, the above settings, $wgEnotifUserTalk, and the preference described there.

Definition at line 1953 of file DefaultSettings.php.

Referenced by EmailNotification\actuallyNotifyOnPageChange(), and EmailNotification\notifyOnPageChange().

◆ $wgEnotifRevealEditorAddress

bool $wgEnotifRevealEditorAddress = false

Allow sending of e-mail notifications with the editor's address in "Reply-To".

Note, enabling this only actually uses it in notification e-mails if the user opted-in to this feature. This feature flag also controls visibility of the 'enotifrevealaddr' preference, which, if users opt into, will make e-mail notifications about their actions use their address as "Reply-To".

To set the address as "From" instead of "Reply-To", also enable $wgEnotifFromEditor.

If disabled, or not opted-in, notifications come from $wgPasswordSender.

Definition at line 1938 of file DefaultSettings.php.

Referenced by EmailNotification\composeCommonMailtext().

◆ $wgEnotifUseRealName

$wgEnotifUseRealName = false

Use real name instead of username in e-mail "from" field.

Definition at line 1973 of file DefaultSettings.php.

Referenced by EmailNotification\composeCommonMailtext(), EmailNotification\sendPersonalised(), and MailAddress\toString().

◆ $wgEnotifUserTalk

$wgEnotifUserTalk = false

Allow users to enable email notification ("enotif") when someone edits their user talk page.

The owner of the user talk page must also have the 'enotifusertalkpages' user preference set to true.

Definition at line 1922 of file DefaultSettings.php.

Referenced by EmailNotification\actuallyNotifyOnPageChange(), EmailNotification\canSendUserTalkEmail(), and EmailNotification\notifyOnPageChange().

◆ $wgEnotifWatchlist

$wgEnotifWatchlist = false

Allow users to enable email notification ("enotif") on watchlist changes.

Definition at line 1913 of file DefaultSettings.php.

Referenced by EmailNotification\actuallyNotifyOnPageChange().

◆ $wgEventRelayerConfig

$wgEventRelayerConfig
Initial value:
= [
'default' => [
'class' => EventRelayerNull::class,
]
]

Mapping of event channels (or channel categories) to EventRelayer configuration.

By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN cache purging and CDN cache purging will emit events to this system. Appropriate listers can subscribe to the channel and take actions based on the events. For example, a local daemon can run on each CDN cache node and perform local purges based on the URL purge channel events.

Some extensions may want to use "channel categories" so that different channels can also share the same custom relayer instance (e.g. when it's likely to be overriden). They can use EventRelayerGroup::getRelayer() based on the category but call notify() on various different actual channels. One reason for this would be that some system have very different performance vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.

The 'default' key is for all channels (or channel categories) without an explicit entry here.

Since
1.27

Definition at line 9307 of file DefaultSettings.php.

◆ $wgExemptFromUserRobotsControl

$wgExemptFromUserRobotsControl = null

An array of namespace keys in which the INDEX/__NOINDEX__ magic words will not function, so users can't decide whether pages in that namespace are indexed by search engines.

If set to null, default to $wgContentNamespaces.

Example:

Definition at line 8491 of file DefaultSettings.php.

Referenced by Title\canUseNoindex().

◆ $wgExiftool

$wgExiftool = '/usr/bin/exiftool'

Path to exiftool binary.

Used for lossless ICC profile swapping.

Since
1.26

Definition at line 1267 of file DefaultSettings.php.

Referenced by JpegHandler\swapICCProfile().

◆ $wgExiv2Command

$wgExiv2Command = '/usr/bin/exiv2'

Some tests and extensions use exiv2 to manipulate the Exif metadata in some image formats.

Definition at line 1260 of file DefaultSettings.php.

◆ $wgExpensiveParserFunctionLimit

$wgExpensiveParserFunctionLimit = 100

Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY.

Definition at line 4716 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgExperiencedUserEdits

$wgExperiencedUserEdits = 500

Specify the difference engine to use.

Supported values:

  • 'external': Use an external diff engine, which must be specified via $wgExternalDiffEngine
  • 'wikidiff2': Use the wikidiff2 PHP extension
  • 'php': PHP implementations included in MediaWiki

The default (null) is to use the first engine that's available.

Since
1.35

Definition at line 9380 of file DefaultSettings.php.

Referenced by ChangesListSpecialPage\filterOnUserExperienceLevel(), and User\getExperienceLevel().

◆ $wgExperiencedUserMemberSince

$wgExperiencedUserMemberSince = 30

Specify the difference engine to use.

Supported values:

  • 'external': Use an external diff engine, which must be specified via $wgExternalDiffEngine
  • 'wikidiff2': Use the wikidiff2 PHP extension
  • 'php': PHP implementations included in MediaWiki

The default (null) is to use the first engine that's available.

Since
1.35

Definition at line 9381 of file DefaultSettings.php.

Referenced by ChangesListSpecialPage\filterOnUserExperienceLevel(), and User\getExperienceLevel().

◆ $wgExportAllowAll

$wgExportAllowAll = false

Whether to allow exporting the entire wiki into a single file.

Definition at line 7673 of file DefaultSettings.php.

◆ $wgExportAllowHistory

$wgExportAllowHistory = true

If set to false, disables the full-history option on Special:Export.

This is currently poorly optimized for long edit histories, so is disabled on Wikimedia's sites.

Definition at line 7638 of file DefaultSettings.php.

◆ $wgExportAllowListContributors

$wgExportAllowListContributors = false

Return distinct author list (when not returning full history)

Definition at line 7650 of file DefaultSettings.php.

◆ $wgExportFromNamespaces

$wgExportFromNamespaces = false

Whether to allow the "export all pages in namespace" option.

Definition at line 7668 of file DefaultSettings.php.

◆ $wgExportMaxHistory

$wgExportMaxHistory = 0

If set nonzero, Special:Export requests for history of pages with more revisions than this will be rejected.

On some big sites things could get bogged down by very very long pages.

Definition at line 7645 of file DefaultSettings.php.

◆ $wgExportMaxLinkDepth

$wgExportMaxLinkDepth = 0

If non-zero, Special:Export accepts a "pagelink-depth" parameter up to this specified level, which will cause it to include all pages linked to from the pages you specify.

Since this number can become insanely large and could easily break your wiki, it's disabled by default for now.

Warning
There's a HARD CODED limit of 5 levels of recursion to prevent a crazy-big export from being done by someone setting the depth number too high. In other words, last resort safety net.

Definition at line 7663 of file DefaultSettings.php.

◆ $wgExportPagelistLimit

$wgExportPagelistLimit = 5000

Maximum number of pages returned by the GetPagesFromCategory and GetPagesFromNamespace functions.

Since
1.27

Definition at line 7681 of file DefaultSettings.php.

◆ $wgExtendedLoginCookieExpiration

$wgExtendedLoginCookieExpiration = 180 * 86400

Default login cookie lifetime, in seconds.

Setting $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make login cookies session-only.

Definition at line 6437 of file DefaultSettings.php.

◆ $wgExtensionAssetsPath

$wgExtensionAssetsPath = false

The URL path of the extensions directory.

Defaults to "{$wgResourceBasePath}/extensions".

Since
1.16

Definition at line 244 of file DefaultSettings.php.

Referenced by ResourceLoaderFileModule\extractBasePaths().

◆ $wgExtensionCredits

$wgExtensionCredits = []

Add information about an installed extension, keyed by its type.

This is for use from LocalSettings.php and legacy PHP-entrypoint extensions. In general, extensions should (only) declare this information in their extension.json file.

The 'name', 'path' and 'author' keys are required.

$wgExtensionCredits['other'][] = [
'path' => __FILE__,
'name' => 'Example extension',
'namemsg' => 'exampleextension-name',
'author' => [
'Foo Barstein',
],
'version' => '0.0.1',
'url' => 'https://example.org/example-extension/',
'descriptionmsg' => 'exampleextension-desc',
'license-name' => 'GPL-2.0-or-later',
];

The extensions are listed on Special:Version. This page also looks for a file named COPYING or LICENSE (optional .txt extension) and provides a link to view said file. When the 'license-name' key is specified, this file is interpreted as wikitext.

  • $type: One of 'specialpage', 'parserhook', 'variable', 'media', 'antispam', 'skin', 'api', or 'other', or any additional types as specified through the ExtensionTypes hook as used in SpecialVersion::getExtensionTypes().
  • name: Name of extension as an inline string instead of localizable message. Do not omit this even if 'namemsg' is provided, as it is used to override the path Special:Version uses to find extension's license info, and is required for backwards-compatibility with MediaWiki 1.23 and older.
  • namemsg (since MW 1.24): A message key for a message containing the extension's name, if the name is localizable. (For example, skin names usually are.)
  • author: A string or an array of strings. Authors can be linked using the regular wikitext link syntax. To have an internationalized version of "and others" show, add an element "...". This element can also be linked, for instance "[https://example ...]".
  • descriptionmsg: A message key or an an array with message key and parameters: ‘'descriptionmsg’ => 'exampleextension-desc',`
  • description: Description of extension as an inline string instead of localizable message (omit in favour of 'descriptionmsg').
  • license-name: Short name of the license (used as label for the link), such as "GPL-2.0-or-later" or "MIT" (https://spdx.org/licenses/ for a list of identifiers).
See also
SpecialVersion::getCredits

Definition at line 7885 of file DefaultSettings.php.

◆ $wgExtensionDirectory

$wgExtensionDirectory = "{$IP}/extensions"

Filesystem extensions directory.

Defaults to "{$IP}/extensions".

Since
1.25

Definition at line 251 of file DefaultSettings.php.

Referenced by Installer\getExistingLocalSettings(), MediaWiki\Installer\Services\InstallerDBSupport\getInstance(), wfLoadExtension(), and wfLoadExtensions().

◆ $wgExtensionEntryPointListFiles

$wgExtensionEntryPointListFiles = []

Array of files with list(s) of extension entry points to be used in maintenance/mergeMessageFileList.php.

Since
1.22

Definition at line 7756 of file DefaultSettings.php.

Referenced by MergeMessageFileList\execute().

◆ $wgExtensionFunctions

$wgExtensionFunctions = []

A list of callback functions which are called once MediaWiki is fully initialised.

Definition at line 7694 of file DefaultSettings.php.

◆ $wgExtensionInfoMTime

int bool $wgExtensionInfoMTime = false

When loading extensions through the extension registration system, this can be used to invalidate the cache.

A good idea would be to set this to one file, you can just touch that one to invalidate the cache

Example:
$wgExtensionInfoMtime = filemtime( "$IP/LocalSettings.php" );

If set to false, the mtime for each individual JSON file will be checked, which can be slow if a large number of extensions are being loaded.

Definition at line 2859 of file DefaultSettings.php.

Referenced by ExtensionRegistry\queue().

◆ $wgExtensionMessagesFiles

$wgExtensionMessagesFiles = []

Extension messages files.

Associative array mapping extension name to the filename where messages can be found. The file should contain variable assignments. Any of the variables present in languages/messages/MessagesEn.php may be defined, but $messages is the most common.

Variables defined in extensions will override conflicting variables defined in the core.

Since MediaWiki 1.23, use of this variable to define messages is discouraged; instead, store messages in JSON format and use $wgMessagesDirs. For setting other variables than $messages, $wgExtensionMessagesFiles should still be used. Use a DIFFERENT key because any entry having a key that also exists in $wgMessagesDirs will be ignored.

Extensions using the JSON message format can preserve backward compatibility with earlier versions of MediaWiki by using a compatibility shim, such as one generated by the generateJsonI18n.php maintenance script, listing it under the SAME key as for the $wgMessagesDirs entry.

Example:
$wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';

Definition at line 7722 of file DefaultSettings.php.

◆ $wgExternalDiffEngine

string false $wgExternalDiffEngine = false

Name of the external diff engine to use.

Path to an external diff executable

Definition at line 8981 of file DefaultSettings.php.

◆ $wgExternalInterwikiFragmentMode

$wgExternalInterwikiFragmentMode = 'legacy'

Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragmentMode above for details of each mode.

Because you can't control external sites, this setting should probably always be 'legacy', unless every wiki you link to has converted to 'html5'.

Since
1.30

Definition at line 3584 of file DefaultSettings.php.

Referenced by Sanitizer\escapeIdForExternalInterwiki().

◆ $wgExternalLinkTarget

$wgExternalLinkTarget = false

Set a default target for external links, e.g.

_blank to pop up a new window.

This will also set the "noreferrer" and "noopener" link rel to prevent the attack described at https://mathiasbynens.github.io/rel-noopener/ . Some older browsers may not support these link attributes, hence setting $wgExternalLinkTarget to _blank may represent a security risk to some of your users.

Definition at line 4669 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults(), and Installer\restoreLinkPopups().

◆ $wgExternalServers

$wgExternalServers = []

An array of external MySQL servers.

Example:
Create a cluster named 'cluster1' containing three servers:
'cluster1' => <array in the same format as $wgDBservers>
];

Used by \Wikimedia\Rdbms\LBFactorySimple, may be ignored if $wgLBFactoryConf is set to another class.

Definition at line 2337 of file DefaultSettings.php.

◆ $wgExternalStores

$wgExternalStores = []

External stores allow including content from non database sources following URL links.

Short names of ExternalStore classes may be specified in an array here:

$wgExternalStores = [ "http","file","custom" ]...

CAUTION: Access to database might lead to code execution

Definition at line 2321 of file DefaultSettings.php.

◆ $wgExtraGenderNamespaces

$wgExtraGenderNamespaces = []

Same as above, but for namespaces with gender distinction.

Note: the default form for the namespace should also be set using $wgExtraNamespaces for the same index.

Since
1.18

Definition at line 4290 of file DefaultSettings.php.

Referenced by Language\getGenderNsText(), Language\getNamespaceAliases(), and Language\needsGenderDistinction().

◆ $wgExtraInterlanguageLinkPrefixes

$wgExtraInterlanguageLinkPrefixes = []

List of additional interwiki prefixes that should be treated as interlanguage links (i.e.

placed in the sidebar). Notes:

  • This will not do anything unless the prefixes are defined in the interwiki map.
  • The display text for these custom interlanguage links will be fetched from the system message "interlanguage-link-xyz" where xyz is the prefix in this array.
  • A friendly name for each site, used for tooltip text, may optionally be placed in the system message "interlanguage-link-sitename-xyz" where xyz is the prefix in this array.

Definition at line 3140 of file DefaultSettings.php.

◆ $wgExtraLanguageCodes

$wgExtraLanguageCodes
Initial value:
= [
'bh' => 'bho',
'no' => 'nb',
'simple' => 'en',
]

List of mappings from one language code to another.

This array makes the codes not appear as a selectable language on the installer.

In Setup.php, the variable $wgDummyLanguageCodes is created by combining these codes with a list of "deprecated" codes, which are mostly leftovers from renames or other legacy things, and the internal codes 'qqq' and 'qqx'. If a mapping in $wgExtraLanguageCodes collide with a built-in mapping, the value in $wgExtraLanguageCodes will be used.

Since
1.29

Definition at line 3169 of file DefaultSettings.php.

◆ $wgExtraLanguageNames

$wgExtraLanguageNames = []

List of language names or overrides for default names in Names.php.

Definition at line 3154 of file DefaultSettings.php.

◆ $wgExtraNamespaces

$wgExtraNamespaces = []

Additional namespaces.

If the namespaces defined in Language.php and Namespace.php are insufficient, you can create new ones here, for example, to import Help files in other languages. You can also override the namespace names of existing namespaces. Extensions should use the CanonicalNamespaces hook or extension.json.

Warning
Once you delete a namespace, the pages in that namespace will no longer be accessible. If you rename it, then you can access them through the new namespace name.

Custom namespaces should start at 100 to avoid conflicting with standard namespaces, and should always follow the even/odd main/talk pattern.

Example:
100 => "Hilfe",
101 => "Hilfe_Diskussion",
102 => "Aide",
103 => "Discussion_Aide"
];
Todo:
Add a note about maintenance/namespaceDupes.php

Definition at line 4282 of file DefaultSettings.php.

Referenced by Language\getNamespaces(), and Language\needsGenderDistinction().

◆ $wgExtraSignatureNamespaces

$wgExtraSignatureNamespaces = []

Array of namespaces, in addition to the talk namespaces, where signatures (~~~~) are likely to be used.

This determines whether to display the Signature button on the edit toolbar, and may also be used by extensions. For example, "traditional" style wikis, where content and discussion are intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.

Definition at line 4495 of file DefaultSettings.php.

◆ $wgFallbackSkin

$wgFallbackSkin = 'fallback'

Fallback skin used when the skin defined by $wgDefaultSkin can't be found.

Since
1.24

Definition at line 3456 of file DefaultSettings.php.

Referenced by Skin\normalizeKey().

◆ $wgFavicon

$wgFavicon = '/favicon.ico'

The URL path of the shortcut icon.

Since
1.6

Definition at line 364 of file DefaultSettings.php.

Referenced by LocalRepo\getInfo(), and wfOpenSearchDescMain().

◆ $wgFeaturePolicyReportOnly

array $wgFeaturePolicyReportOnly = []

List of Feature Policy Reporting types to enable.

Each entry is turned into a Feature-Policy-Report-Only header.

Warning
EXPERIMENTAL!
Since
1.34

Definition at line 9498 of file DefaultSettings.php.

◆ $wgFeed

$wgFeed = true

Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages.

Definition at line 7361 of file DefaultSettings.php.

Referenced by FeedUtils\checkFeedOutput().

◆ $wgFeedCacheTimeout

$wgFeedCacheTimeout = 60

Minimum timeout for cached Recentchanges feed, in seconds.

A cached version will continue to be served out even if changes are made, until this many seconds runs out since the last render.

If set to 0, feed caching is disabled. Use this for debugging only; feed generation can be pretty slow with diffs.

Definition at line 7377 of file DefaultSettings.php.

◆ $wgFeedClasses

$wgFeedClasses
Initial value:
= [
'rss' => RSSFeed::class,
'atom' => AtomFeed::class,
]

Available feeds objects.

Should probably only be defined when a page is syndicated ie when $wgOut->isSyndicated() is true.

Definition at line 7404 of file DefaultSettings.php.

Referenced by FeedUtils\checkFeedOutput(), ChangesFeed\getFeedObject(), and RebuildRecentchanges\purgeFeeds().

◆ $wgFeedDiffCutoff

$wgFeedDiffCutoff = 32768

When generating Recentchanges RSS/Atom feed, diffs will not be generated for pages larger than this size.

Definition at line 7383 of file DefaultSettings.php.

Referenced by FeedUtils\formatDiffRow().

◆ $wgFeedLimit

$wgFeedLimit = 50

Set maximum number of results to return in syndication feeds (RSS, Atom) for eg Recentchanges, Newpages.

Definition at line 7367 of file DefaultSettings.php.

◆ $wgFetchCommonsDescriptions

bool $wgFetchCommonsDescriptions = false

Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.5

Definition at line 719 of file DefaultSettings.php.

◆ $wgFileBackends

$wgFileBackends = []

File backend structure configuration.

This is an array of file backend configuration arrays. Each backend configuration has the following parameters:

  • name : A unique name for the backend
  • class : The file backend class to use
  • wikiId : A unique string that identifies the wiki (container prefix)
  • lockManager : The name of a lock manager (see $wgLockManagers) [optional]
  • fileJournal : File journal configuration for FileJournal::__construct() [optional]

See FileBackend::__construct() for more details. Additional parameters are specific to the file backend class used. These settings should be global to all wikis when possible.

FileBackendMultiWrite::__construct() is augmented with a 'template' option that can be used in any of the values of the 'backends' array. Its value is the name of another backend in $wgFileBackends. When set, it pre-fills the array with all of the configuration of the named backend. Explicitly set values in the array take precedence.

There are two particularly important aspects about each backend:

  • a) Whether it is fully qualified or wiki-relative. By default, the paths of files are relative to the current wiki, which works via prefixing them with the current wiki ID when accessed. Setting 'domainId' forces the backend to be fully qualified by prefixing all paths with the specified value instead. This can be useful if multiple wikis need to share the same data. Note that 'name' is not part of any prefix and thus should not be relied upon for namespacing.
  • b) Whether it is only defined for some wikis or is defined on all wikis in the wiki farm. Defining a backend globally is useful if multiple wikis need to share the same data. One should be aware of these aspects when configuring a backend for use with any basic feature or plugin. For example, suppose an extension stores data for different wikis in different directories and sometimes needs to access data from a foreign wiki's directory in order to render a page on given wiki. The extension would need a fully qualified backend that is defined on all wikis in the wiki farm.

Definition at line 859 of file DefaultSettings.php.

◆ $wgFileBlacklist

$wgFileBlacklist
Initial value:
= [
# HTML may contain cookie-stealing JavaScript and web bugs
'html', 'htm', 'js', 'jsb', 'mhtml', 'mht', 'xhtml', 'xht',
# PHP scripts may execute arbitrary code on the server
'php', 'phtml', 'php3', 'php4', 'php5', 'phps', 'phar',
# Other types that may be interpreted by some servers
'shtml', 'jhtml', 'pl', 'py', 'cgi',
# May contain harmful executables for Windows victims
'exe', 'scr', 'dll', 'msi', 'vbs', 'bat', 'com', 'pif', 'cmd', 'vxd', 'cpl' ]

Files with these extensions will never be allowed as uploads.

An array of file extensions to blacklist. You should append to this array if you want to blacklist additional files.

Definition at line 1034 of file DefaultSettings.php.

Referenced by StreamFile\contentTypeFromPath(), UploadStash\getExtensionForPath(), and UploadBase\getTitle().

◆ $wgFileCacheDepth

$wgFileCacheDepth = 2

Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory.

The subdirectories will be named based on the MD5 hash of the title. A value of 0 means all cache files will be put directly into the main file cache directory.

Definition at line 2794 of file DefaultSettings.php.

Referenced by FileCacheBase\hashSubdirectory().

◆ $wgFileCacheDirectory

$wgFileCacheDirectory = false

Directory where the cached page will be saved.

Defaults to "{$wgUploadDirectory}/cache".

Definition at line 298 of file DefaultSettings.php.

Referenced by FileCacheBase\baseCacheDirectory(), and PruneFileCache\execute().

◆ $wgFileExtensions

$wgFileExtensions = [ 'png', 'gif', 'jpg', 'jpeg', 'webp' ]

This is the list of preferred extensions for uploading files.

Uploading files with extensions not in this list will trigger a warning.

Warning
If you add any OpenOffice or Microsoft Office file formats here, such as odt or doc, and untrusted users are allowed to upload files, then your wiki will be vulnerable to cross-site request forgery (CSRF).

Definition at line 1027 of file DefaultSettings.php.

Referenced by UploadBase\checkUnwantedFileExtensions(), StreamFile\contentTypeFromPath(), ImportImages\execute(), and UploadBase\getTitle().

◆ $wgFilterLogTypes

$wgFilterLogTypes
Initial value:
= [
'patrol' => true,
'tag' => true,
'newusers' => false,
]

Show/hide links on Special:Log will be shown for these log types.

This is associative array of log type => boolean "hide by default"

See $wgLogTypes for a list of available log types.

Example:
$wgFilterLogTypes = [ 'move' => true, 'import' => false ];

Will display show/hide links for the move and import logs. Move logs will be hidden by default unless the link is clicked. Import logs will be shown by default, and hidden when the link is clicked.

A message of the form logeventslist-[type]-log should be added, and will be used for the link text.

Definition at line 8165 of file DefaultSettings.php.

Referenced by RebuildRecentchanges\rebuildRecentChangesTablePass3().

◆ $wgFixDoubleRedirects

$wgFixDoubleRedirects = false

Fix double redirects after a page move.

Tends to conflict with page move vandalism, use only on a private wiki.

Definition at line 9014 of file DefaultSettings.php.

◆ $wgFooterIcons

$wgFooterIcons
Initial value:
= [
"copyright" => [
"copyright" => [],
],
"poweredby" => [
"mediawiki" => [
"src" => null,
"url" => "https://www.mediawiki.org/",
"alt" => "Powered by MediaWiki",
]
],
]

Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can add new icons to the built in copyright or poweredby, or you can create a new block.

Though note that you may need to add some custom css to get good styling of new blocks in monobook. vector and modern should work without any special css.

$wgFooterIcons itself is a key/value array. The key is the name of a block that the icons will be wrapped in. The final id varies by skin; Monobook and Vector will turn poweredby into f-poweredbyico while Modern turns it into mw_poweredby. The value is either key/value array of icons or a string. In the key/value array the key may or may not be used by the skin but it can be used to find the icon and unset it or change the icon if needed. This is useful for disabling icons that are set by extensions. The value should be either a string or an array. If it is a string it will be output directly as html, however some skins may choose to ignore it. An array is the preferred format for the icon, the following keys are used:

  • src: An absolute url to the image to use for the icon, this is recommended but not required, however some skins will ignore icons without an image
  • srcset: optional additional-resolution images; see HTML5 specs
  • url: The url to use in the a element around the text or icon, if not set an a element will not be outputted
  • alt: This is the text form of the icon, it will be displayed without an image in skins like Modern or if src is not set, and will otherwise be used as the alt="" for the image. This key is required.
  • width and height: If the icon specified by src is not of the standard size you can specify the size of image to use with these keys. Otherwise they will default to the standard 88x31.
    Todo:
    Reformat documentation.

Definition at line 3616 of file DefaultSettings.php.

◆ $wgFooterLinkCacheExpiry

$wgFooterLinkCacheExpiry = 0

Expiry time for the footer link cache, in seconds, or 0 if disabled.

Since
1.35

Definition at line 2823 of file DefaultSettings.php.

◆ $wgForcedRawSMaxage

$wgForcedRawSMaxage = 300

Default maximum age for raw CSS/JS accesses.

300 seconds = 5 minutes.

Definition at line 2970 of file DefaultSettings.php.

◆ $wgForceHTTPS

bool $wgForceHTTPS = false

If this is true, when an insecure HTTP request is received, always redirect to HTTPS.

This overrides and disables the preferhttps user preference, and it overrides $wgSecureLogin and the CanIPUseHTTPS hook.

$wgServer may be either https or protocol-relative. If $wgServer starts with "http://", an exception will be thrown.

If a reverse proxy or CDN is used to forward requests from HTTPS to HTTP, the request header "X-Forwarded-Proto: https" should be sent to suppress the redirect.

In addition to setting this to true, for optimal security, the web server should also be configured to send Strict-Transport-Security response headers.

Since
1.35

Definition at line 166 of file DefaultSettings.php.

Referenced by User\requiresHTTPS().

◆ $wgForceUIMsgAsContentMsg

$wgForceUIMsgAsContentMsg = []

When translating messages with wfMessage(), it is not always clear what should be considered UI messages and what should be content messages.

For example, for the English Wikipedia, there should be only one 'mainpage', so when getting the link for 'mainpage', we should treat it as site content and call ->inContentLanguage()->text(), but for rendering the text of the link, we call ->text(). The code behaves this way by default. However, sites like the Wikimedia Commons do offer different versions of 'mainpage' and the like for different languages. This array provides a way to override the default behavior.

Example:
To allow language-specific main page and community portal:
$wgForceUIMsgAsContentMsg = [ 'mainpage', 'portal-url' ];

Definition at line 3321 of file DefaultSettings.php.

Referenced by Message\getTitle(), and Message\inContentLanguage().

◆ $wgForeignFileRepos

$wgForeignFileRepos = []

Enable the use of files from one or more other wikis.

If you operate multiple wikis, you can declare a shared upload path here. Uploads to the local wiki will NOT be stored here - See $wgLocalFileRepo and $wgUploadDirectory for that.

The wiki will only consider the foreign repository if no file of the given name is found in the local repository (e.g. via [[File:..]] syntax).

Since
1.11
See also
$wgLocalFileRepo

Definition at line 634 of file DefaultSettings.php.

◆ $wgForeignUploadTargets

$wgForeignUploadTargets = [ 'local' ]

Array of foreign file repo names (set in $wgForeignFileRepos above) that are allowable upload targets.

These wikis must have some method of authentication (i.e. CentralAuth), and be CORS-enabled for this wiki. The string 'local' signifies the default local file repository.

Example: $wgForeignUploadTargets = [ 'shared' ];

Definition at line 758 of file DefaultSettings.php.

◆ $wgFragmentMode

$wgFragmentMode = [ 'legacy', 'html5' ]

How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of:

  • 'html5' is modern HTML5 style encoding with minimal escaping. Displays Unicode characters in most browsers' address bars.
  • 'legacy' is old MediaWiki-style encoding, e.g. 啤酒 turns into .E5.95.A4.E9.85.92

The first element of this array specifies the primary mode of escaping IDs. This is what users will see when they e.g. follow an [[#internal link]] to a section of a page.

The optional second element defines a fallback mode, useful for migrations. If present, it will direct MediaWiki to add empty s to every section with its id attribute set to fallback encoded title so that links using the previous encoding would still work.

Example: you want to migrate your wiki from 'legacy' to 'html5'

On the first step, set this variable to [ 'legacy', 'html5' ]. After a while, when all caches (parser, HTTP, etc.) contain only pages generated with this setting, flip the value to [ 'html5', 'legacy' ]. This will result in all internal links being generated in the new encoding while old links (both external and cached internal) will still work. After a long time, you might want to ditch backwards compatibility and set it to [ 'html5' ]. After all, pages get edited, breaking incoming links no matter which fragment mode is used.

Since
1.30

Definition at line 3574 of file DefaultSettings.php.

Referenced by Sanitizer\escapeIdForAttribute(), and Sanitizer\escapeIdForLink().

◆ $wgGalleryOptions

$wgGalleryOptions = []

Parameters for the "<gallery>" tag.

Fields are:

  • imagesPerRow: Default number of images per-row in the gallery. 0 -> Adapt to screensize
  • imageWidth: Width of the cells containing images in galleries (in "px")
  • imageHeight: Height of the cells containing images in galleries (in "px")
  • captionLength: Length to truncate filename to in caption when using "showfilename". A value of 'true' will truncate the filename to one line using CSS and will be the behaviour after deprecation.
    Deprecated:
    since 1.28

Definition at line 1667 of file DefaultSettings.php.

◆ $wgGenerateThumbnailOnParse

bool $wgGenerateThumbnailOnParse = true

Render thumbnails while parsing wikitext.

If set to false, then the Parser will output valid thumbnail URLs without generating or storing the thumbnail files. This can significantly speed up processing on the web server. The site admin needs to configure a 404 handler in order for the URLs in question to regenerate the thumbnails in question on-demand. This can enable concurrency and also save computing resources as not every resolution of every image on every page is accessed between re-parses of the article. For example, re-parses triggered by bot edits, or cascading updates from template edits.

If you use $wgLocalFileRepo, then you will also need to set the following:

$wgLocalFileRepo['transformVia404'] = true;
Since
1.7.0

Definition at line 1408 of file DefaultSettings.php.

◆ $wgGitBin

$wgGitBin = '/usr/bin/git'

Fully specified path to git binary.

Definition at line 7162 of file DefaultSettings.php.

Referenced by GitInfo\getHeadCommitDate().

◆ $wgGitInfoCacheDirectory

$wgGitInfoCacheDirectory = false

Directory where GitInfo will look for pre-computed cache files.

If false, $wgCacheDirectory/gitinfo will be used.

Definition at line 2779 of file DefaultSettings.php.

Referenced by GitInfo\getCacheFilePath().

◆ $wgGitRepositoryViewers

$wgGitRepositoryViewers
Initial value:
= [
'https:
'https:
'ssh:
'https:
]

Map GIT repository URLs to viewer URLs to provide links in Special:Version.

Key is a pattern passed to preg_match() and preg_replace(), without the delimiters (which are #) and must match the whole URL. The value is the replacement for the key (it can contain $1, etc.) h will be replaced by the short SHA-1 (7 first chars) and H by the full SHA-1 of the HEAD revision. r will be replaced with a URL-encoded version of $1. R will be replaced with $1 and no URL-encoding

Since
1.20

Definition at line 7177 of file DefaultSettings.php.

Referenced by GitInfo\getViewers().

◆ $wgGrammarForms

◆ $wgGrantPermissionGroups

array $wgGrantPermissionGroups

Map of grants to their UI grouping.

Since
1.27

Definition at line 6338 of file DefaultSettings.php.

Referenced by MWGrants\getGrantGroups(), and MWGrants\getHiddenGrants().

◆ $wgGrantPermissions [1/74]

array $wgGrantPermissions = []

Map of (grant => right => boolean) Users authorize consumers (like Apps) to act on their behalf but only with a subset of the user's normal account rights (signed off on by the user).

The possible rights to grant to a consumer are bundled into groups called "grants". Each grant defines some rights it lets consumers inherit from the account they may act on behalf of. Note that a user granting a right does nothing if that user does not actually have that right to begin with.

Since
1.27

Definition at line 6230 of file DefaultSettings.php.

Referenced by MWGrants\getGrantGroups(), MWGrants\getGrantRights(), MWGrants\getRightsByGrant(), and MWGrants\getValidGrants().

◆ $wgGrantPermissions [2/74]

$wgGrantPermissions[ 'basic'][ 'autoconfirmed'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6236 of file DefaultSettings.php.

◆ $wgGrantPermissions [3/74]

$wgGrantPermissions[ 'basic'][ 'autocreateaccount'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6235 of file DefaultSettings.php.

◆ $wgGrantPermissions [4/74]

$wgGrantPermissions[ 'basic'][ 'autopatrol'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6237 of file DefaultSettings.php.

◆ $wgGrantPermissions [5/74]

$wgGrantPermissions[ 'basic'][ 'editsemiprotected'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6238 of file DefaultSettings.php.

◆ $wgGrantPermissions [6/74]

$wgGrantPermissions[ 'basic'][ 'ipblock-exempt'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6239 of file DefaultSettings.php.

◆ $wgGrantPermissions [7/74]

$wgGrantPermissions[ 'basic'][ 'nominornewtalk'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6240 of file DefaultSettings.php.

◆ $wgGrantPermissions [8/74]

$wgGrantPermissions[ 'basic'][ 'patrolmarks'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6241 of file DefaultSettings.php.

◆ $wgGrantPermissions [9/74]

$wgGrantPermissions[ 'basic'][ 'purge'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6242 of file DefaultSettings.php.

◆ $wgGrantPermissions [10/74]

$wgGrantPermissions[ 'basic'][ 'read'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6243 of file DefaultSettings.php.

◆ $wgGrantPermissions [11/74]

$wgGrantPermissions[ 'basic'][ 'writeapi'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6244 of file DefaultSettings.php.

◆ $wgGrantPermissions [12/74]

$wgGrantPermissions[ 'blockusers'][ 'block'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6302 of file DefaultSettings.php.

◆ $wgGrantPermissions [13/74]

$wgGrantPermissions[ 'blockusers'][ 'blockemail'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6303 of file DefaultSettings.php.

◆ $wgGrantPermissions [14/74]

$wgGrantPermissions[ 'createaccount'][ 'createaccount'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6330 of file DefaultSettings.php.

◆ $wgGrantPermissions [15/74]

$wgGrantPermissions[ 'createeditmovepage'] = $wgGrantPermissions['editpage']

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6279 of file DefaultSettings.php.

◆ $wgGrantPermissions [16/74]

$wgGrantPermissions[ 'createeditmovepage'][ 'createpage'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6280 of file DefaultSettings.php.

◆ $wgGrantPermissions [17/74]

$wgGrantPermissions[ 'createeditmovepage'][ 'createtalk'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6281 of file DefaultSettings.php.

◆ $wgGrantPermissions [18/74]

$wgGrantPermissions[ 'createeditmovepage'][ 'move'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6282 of file DefaultSettings.php.

◆ $wgGrantPermissions [19/74]

$wgGrantPermissions[ 'createeditmovepage'][ 'move-categorypages'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6285 of file DefaultSettings.php.

◆ $wgGrantPermissions [20/74]

$wgGrantPermissions[ 'createeditmovepage'][ 'move-rootuserpages'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6283 of file DefaultSettings.php.

◆ $wgGrantPermissions [21/74]

$wgGrantPermissions[ 'createeditmovepage'][ 'move-subpages'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6284 of file DefaultSettings.php.

◆ $wgGrantPermissions [22/74]

$wgGrantPermissions[ 'createeditmovepage'][ 'suppressredirect'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6286 of file DefaultSettings.php.

◆ $wgGrantPermissions [23/74]

$wgGrantPermissions[ 'delete']
Initial value:
= $wgGrantPermissions['editpage'] +
$wgGrantPermissions['viewdeleted']

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6311 of file DefaultSettings.php.

◆ $wgGrantPermissions [24/74]

$wgGrantPermissions[ 'delete'][ 'bigdelete'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6314 of file DefaultSettings.php.

◆ $wgGrantPermissions [25/74]

$wgGrantPermissions[ 'delete'][ 'delete'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6313 of file DefaultSettings.php.

◆ $wgGrantPermissions [26/74]

$wgGrantPermissions[ 'delete'][ 'deletelogentry'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6315 of file DefaultSettings.php.

◆ $wgGrantPermissions [27/74]

$wgGrantPermissions[ 'delete'][ 'deleterevision'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6316 of file DefaultSettings.php.

◆ $wgGrantPermissions [28/74]

$wgGrantPermissions[ 'delete'][ 'undelete'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6317 of file DefaultSettings.php.

◆ $wgGrantPermissions [29/74]

$wgGrantPermissions[ 'editinterface'] = $wgGrantPermissions['editpage']

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6268 of file DefaultSettings.php.

◆ $wgGrantPermissions [30/74]

$wgGrantPermissions[ 'editinterface'][ 'editinterface'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6269 of file DefaultSettings.php.

◆ $wgGrantPermissions [31/74]

$wgGrantPermissions[ 'editinterface'][ 'editsitejson'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6271 of file DefaultSettings.php.

◆ $wgGrantPermissions [32/74]

$wgGrantPermissions[ 'editinterface'][ 'edituserjson'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6270 of file DefaultSettings.php.

◆ $wgGrantPermissions [33/74]

$wgGrantPermissions[ 'editmycssjs'] = $wgGrantPermissions['editpage']

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6260 of file DefaultSettings.php.

◆ $wgGrantPermissions [34/74]

$wgGrantPermissions[ 'editmycssjs'][ 'editmyusercss'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6261 of file DefaultSettings.php.

◆ $wgGrantPermissions [35/74]

$wgGrantPermissions[ 'editmycssjs'][ 'editmyuserjs'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6263 of file DefaultSettings.php.

◆ $wgGrantPermissions [36/74]

$wgGrantPermissions[ 'editmycssjs'][ 'editmyuserjson'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6262 of file DefaultSettings.php.

◆ $wgGrantPermissions [37/74]

$wgGrantPermissions[ 'editmyoptions'][ 'editmyoptions'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6265 of file DefaultSettings.php.

◆ $wgGrantPermissions [38/74]

$wgGrantPermissions[ 'editmyoptions'][ 'editmyuserjson'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6266 of file DefaultSettings.php.

◆ $wgGrantPermissions [39/74]

$wgGrantPermissions[ 'editmywatchlist'][ 'editmywatchlist'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6326 of file DefaultSettings.php.

◆ $wgGrantPermissions [40/74]

$wgGrantPermissions[ 'editpage'][ 'applychangetags'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6253 of file DefaultSettings.php.

◆ $wgGrantPermissions [41/74]

$wgGrantPermissions[ 'editpage'][ 'changetags'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6254 of file DefaultSettings.php.

◆ $wgGrantPermissions [42/74]

$wgGrantPermissions[ 'editpage'][ 'edit'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6251 of file DefaultSettings.php.

◆ $wgGrantPermissions [43/74]

$wgGrantPermissions[ 'editpage'][ 'minoredit'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6252 of file DefaultSettings.php.

◆ $wgGrantPermissions [44/74]

$wgGrantPermissions[ 'editprotected'] = $wgGrantPermissions['editpage']

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6256 of file DefaultSettings.php.

◆ $wgGrantPermissions [45/74]

$wgGrantPermissions[ 'editprotected'][ 'editprotected'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6257 of file DefaultSettings.php.

◆ $wgGrantPermissions [46/74]

$wgGrantPermissions[ 'editsiteconfig'] = $wgGrantPermissions['editinterface']

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6273 of file DefaultSettings.php.

◆ $wgGrantPermissions [47/74]

$wgGrantPermissions[ 'editsiteconfig'][ 'editsitecss'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6276 of file DefaultSettings.php.

◆ $wgGrantPermissions [48/74]

$wgGrantPermissions[ 'editsiteconfig'][ 'editsitejs'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6277 of file DefaultSettings.php.

◆ $wgGrantPermissions [49/74]

$wgGrantPermissions[ 'editsiteconfig'][ 'editusercss'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6274 of file DefaultSettings.php.

◆ $wgGrantPermissions [50/74]

$wgGrantPermissions[ 'editsiteconfig'][ 'edituserjs'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6275 of file DefaultSettings.php.

◆ $wgGrantPermissions [51/74]

$wgGrantPermissions[ 'highvolume'][ 'apihighlimits'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6247 of file DefaultSettings.php.

◆ $wgGrantPermissions [52/74]

$wgGrantPermissions[ 'highvolume'][ 'bot'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6246 of file DefaultSettings.php.

◆ $wgGrantPermissions [53/74]

$wgGrantPermissions[ 'highvolume'][ 'markbotedits'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6249 of file DefaultSettings.php.

◆ $wgGrantPermissions [54/74]

$wgGrantPermissions[ 'highvolume'][ 'noratelimit'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6248 of file DefaultSettings.php.

◆ $wgGrantPermissions [55/74]

$wgGrantPermissions[ 'oversight'][ 'suppressrevision'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6319 of file DefaultSettings.php.

◆ $wgGrantPermissions [56/74]

$wgGrantPermissions[ 'patrol'][ 'patrol'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6298 of file DefaultSettings.php.

◆ $wgGrantPermissions [57/74]

$wgGrantPermissions[ 'privateinfo'][ 'viewmyprivateinfo'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6332 of file DefaultSettings.php.

◆ $wgGrantPermissions [58/74]

$wgGrantPermissions[ 'protect'] = $wgGrantPermissions['editprotected']

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6321 of file DefaultSettings.php.

◆ $wgGrantPermissions [59/74]

$wgGrantPermissions[ 'protect'][ 'protect'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6322 of file DefaultSettings.php.

◆ $wgGrantPermissions [60/74]

$wgGrantPermissions[ 'rollback'][ 'rollback'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6300 of file DefaultSettings.php.

◆ $wgGrantPermissions [61/74]

$wgGrantPermissions[ 'sendemail'][ 'sendemail'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6328 of file DefaultSettings.php.

◆ $wgGrantPermissions [62/74]

$wgGrantPermissions[ 'uploadeditmovefile'] = $wgGrantPermissions['uploadfile']

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6291 of file DefaultSettings.php.

◆ $wgGrantPermissions [63/74]

$wgGrantPermissions[ 'uploadeditmovefile'][ 'movefile'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6295 of file DefaultSettings.php.

◆ $wgGrantPermissions [64/74]

$wgGrantPermissions[ 'uploadeditmovefile'][ 'reupload'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6292 of file DefaultSettings.php.

◆ $wgGrantPermissions [65/74]

$wgGrantPermissions[ 'uploadeditmovefile'][ 'reupload-shared'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6293 of file DefaultSettings.php.

◆ $wgGrantPermissions [66/74]

$wgGrantPermissions[ 'uploadeditmovefile'][ 'suppressredirect'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6296 of file DefaultSettings.php.

◆ $wgGrantPermissions [67/74]

$wgGrantPermissions[ 'uploadeditmovefile'][ 'upload_by_url'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6294 of file DefaultSettings.php.

◆ $wgGrantPermissions [68/74]

$wgGrantPermissions[ 'uploadfile'][ 'reupload-own'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6289 of file DefaultSettings.php.

◆ $wgGrantPermissions [69/74]

$wgGrantPermissions[ 'uploadfile'][ 'upload'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6288 of file DefaultSettings.php.

◆ $wgGrantPermissions [70/74]

$wgGrantPermissions[ 'viewdeleted'][ 'browsearchive'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6305 of file DefaultSettings.php.

◆ $wgGrantPermissions [71/74]

$wgGrantPermissions[ 'viewdeleted'][ 'deletedhistory'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6306 of file DefaultSettings.php.

◆ $wgGrantPermissions [72/74]

$wgGrantPermissions[ 'viewdeleted'][ 'deletedtext'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6307 of file DefaultSettings.php.

◆ $wgGrantPermissions [73/74]

$wgGrantPermissions[ 'viewmywatchlist'][ 'viewmywatchlist'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6324 of file DefaultSettings.php.

◆ $wgGrantPermissions [74/74]

$wgGrantPermissions[ 'viewrestrictedlogs'][ 'suppressionlog'] = true

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 6309 of file DefaultSettings.php.

◆ $wgGroupPermissions

$wgGroupPermissions = []

Permission keys given to users in each group.

This is an array where the keys are all groups and each value is an array of the format (right => boolean).

The second format is used to support per-namespace permissions. Note that this feature does not fully work for all permission types.

All users are implicitly in the '*' group including anonymous visitors; logged-in users are all implicitly in the 'user' group. These will be combined with the permissions of all groups that a given user is listed in in the user_groups table.

Note: Don't set $wgGroupPermissions = []; unless you know what you're doing! This will wipe all permissions, and may mean that your users are unable to perform certain essential tasks or access new functionality when new permissions are introduced and default grants established.

Functionality to make pages inaccessible has not been extensively tested for security. Use at your own risk!

This replaces $wgWhitelistAccount and $wgWhitelistEdit

Definition at line 5534 of file DefaultSettings.php.

◆ $wgGroupsAddToSelf

$wgGroupsAddToSelf = []

A map of group names that the user is in, to group names that those users are allowed to add or revoke.

Setting the list of groups to add or revoke to true is equivalent to "any group".

Example:
To allow sysops to add themselves to the "bot" group:
$wgGroupsAddToSelf = [ 'sysop' => [ 'bot' ] ];
Example:
Implicit groups may be used for the source group, for instance: This allows users in the '*' group (i.e. any user) to remove themselves from any group that they happen to be in.

Definition at line 5714 of file DefaultSettings.php.

Referenced by User\changeableByGroup().

◆ $wgGroupsRemoveFromSelf

$wgGroupsRemoveFromSelf = []
See also
$wgGroupsAddToSelf

Definition at line 5719 of file DefaultSettings.php.

Referenced by User\changeableByGroup().

◆ $wgHashedSharedUploadDirectory

bool $wgHashedSharedUploadDirectory = true

Shortcut for the 'hashLevels' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.3

Definition at line 702 of file DefaultSettings.php.

◆ $wgHashedUploadDirectory

bool $wgHashedUploadDirectory = true

Shortcut for setting hashLevels=2 in $wgLocalFileRepo.

Note
Only used if $wgLocalFileRepo is not set.

Definition at line 1017 of file DefaultSettings.php.

◆ $wgHiddenPrefs

$wgHiddenPrefs = []

An array of preferences to not show for the user.

Definition at line 5326 of file DefaultSettings.php.

Referenced by User\getTokenFromOption(), and User\resetTokenFromOption().

◆ $wgHideIdentifiableRedirects

$wgHideIdentifiableRedirects = true

Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public.

Definition at line 5508 of file DefaultSettings.php.

◆ $wgHideInterlanguageLinks

$wgHideInterlanguageLinks = false

Hide interlanguage links from the sidebar.

Definition at line 3125 of file DefaultSettings.php.

◆ $wgHideUserContribLimit

$wgHideUserContribLimit = 1000

The maximum number of edits a user can have and can still be hidden by users with the hideuser permission.

This is limited for performance reason. Set to false to disable the limit.

Since
1.23

Definition at line 5967 of file DefaultSettings.php.

◆ $wgHKDFAlgorithm

$wgHKDFAlgorithm = 'sha256'

Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers).

See also: $wgHKDFSecret

Since
1.24

Definition at line 9151 of file DefaultSettings.php.

◆ $wgHKDFSecret

$wgHKDFSecret = false

Secret for hmac-based key derivation function (fast, cryptographically secure random numbers).

This should be set in LocalSettings.php, otherwise $wgSecretKey will be used. See also: $wgHKDFAlgorithm

Since
1.24

Definition at line 9143 of file DefaultSettings.php.

◆ $wgHooks

$wgHooks = []

Global list of hooks.

The key is one of the events made available by MediaWiki, you can find a description for most of them in docs/hooks.txt. The array is used internally by Hook:run().

The value can be one of:

  • A function name:
    $wgHooks['event_name'][] = $function;
  • A function with some data:
    $wgHooks['event_name'][] = [ $function, $data ];
  • A an object method:
    $wgHooks['event_name'][] = [ $object, 'method' ];
  • A closure:
    $wgHooks['event_name'][] = function ( $hookParam ) {
    // Handler code goes here.
    };
Warning
You should always append to an event array or you will end up deleting a previous registered hook.
Hook handlers should be registered at file scope. Registering handlers after file scope can lead to unexpected results due to caching.

Definition at line 7921 of file DefaultSettings.php.

Referenced by BenchmarkHooks\execute(), DumpIterator\finalSetup(), MediaWiki\HookContainer\GlobalHookRegistry\getGlobalHooks(), SpecialVersion\getWgHooks(), Installer\includeExtensions(), DatabaseUpdater\loadExtensions(), and ParserOptions\setupFakeRevision().

◆ $wgHTCPMulticastTTL

$wgHTCPMulticastTTL = 1

HTCP multicast TTL.

See also
$wgHTCPRouting

Definition at line 3068 of file DefaultSettings.php.

Referenced by CdnCacheUpdate\HTCPPurge().

◆ $wgHTCPRouting

$wgHTCPRouting = []

Routing configuration for HTCP multicast purging.

Add elements here to enable HTCP and determine which purges are sent where. If set to an empty array, HTCP is disabled.

Each key in this array is a regular expression to match against the purged URL, or an empty string to match all URLs. The purged URL is matched against the regexes in the order specified, and the first rule whose regex matches is used, all remaining rules will thus be ignored.

Example configuration to send purges for upload.wikimedia.org to one
multicast group and all other purges to another:
'|^https?://upload\\.wikimedia\\.org|' => [
'host' => '239.128.0.113',
'port' => 4827,
],
'' => [
'host' => '239.128.0.112',
'port' => 4827,
],
];

You can also pass an array of hosts to send purges too. This is useful when you have several multicast groups or unicast address that should receive a given purge. Multiple hosts support was introduced in MediaWiki 1.22.

Example of sending purges to multiple hosts:
'' => [
// Purges to text caches using multicast
[ 'host' => '239.128.0.114', 'port' => '4827' ],
// Purges to a hardcoded list of caches
[ 'host' => '10.88.66.1', 'port' => '4827' ],
[ 'host' => '10.88.66.2', 'port' => '4827' ],
[ 'host' => '10.88.66.3', 'port' => '4827' ],
],
];
Since
1.22
See also
$wgHTCPMulticastTTL

Definition at line 3062 of file DefaultSettings.php.

Referenced by PurgeChangedPages\execute(), PurgeChangedFiles\execute(), CdnCacheUpdate\HTCPPurge(), and CdnCacheUpdate\purge().

◆ $wgHtml5Version

$wgHtml5Version = null

Defines the value of the version attribute in the <html> tag, if any.

If your wiki uses RDFa, set it to the correct value for RDFa+HTML5. Correct current values are 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'. See also https://www.w3.org/TR/rdfa-in-html/#document-conformance

Since
1.16

Definition at line 3392 of file DefaultSettings.php.

Referenced by Html\htmlHeader().

◆ $wgHTMLFormAllowTableFormat

$wgHTMLFormAllowTableFormat = true

Temporary variable that allows HTMLForms to be rendered as tables.

Table based layouts cause various issues when designing for mobile. This global allows skins or extensions a means to force non-table based rendering. Setting to false forces form components to always render as div elements.

Since
1.24

Definition at line 3401 of file DefaultSettings.php.

◆ $wgHTTPConnectTimeout

float int $wgHTTPConnectTimeout = 5.0

Timeout for connections done internally (in seconds).

Only supported if cURL is installed, ignored otherwise.

Since
1.22

Definition at line 8863 of file DefaultSettings.php.

Referenced by MWHttpRequest\__construct().

◆ $wgHTTPImportTimeout

$wgHTTPImportTimeout = 25

Timeout for HTTP requests done internally for transwiki imports, in seconds.

Since
1.29

Definition at line 8887 of file DefaultSettings.php.

Referenced by ImportStreamSource\newFromURL().

◆ $wgHTTPMaxConnectTimeout

float int $wgHTTPMaxConnectTimeout = INF

The maximum HTTP connect timeout in seconds.

If any specified or configured connect timeout is larger than this, then this value will be used instead.

Since
1.35

Definition at line 8881 of file DefaultSettings.php.

◆ $wgHTTPMaxTimeout

float int $wgHTTPMaxTimeout = INF

The maximum HTTP request timeout in seconds.

If any specified or configured request timeout is larger than this, then this value will be used instead.

Since
1.35

Definition at line 8872 of file DefaultSettings.php.

◆ $wgHTTPProxy

$wgHTTPProxy = ''

Proxy to use for CURL requests.

Definition at line 8897 of file DefaultSettings.php.

Referenced by Http\createMultiClient(), Http\getProxy(), and MWHttpRequest\proxySetup().

◆ $wgHttpsPort

$wgHttpsPort = 443

For installations where the canonical server is HTTP but HTTPS is optionally supported, you can specify a non-standard HTTPS port here.

$wgServer should be a protocol-relative URL.

If HTTPS is always used, just specify the port number in $wgServer.

See also
https://phabricator.wikimedia.org/T67184
Since
1.24

Definition at line 146 of file DefaultSettings.php.

Referenced by wfExpandUrl().

◆ $wgHTTPTimeout

float int $wgHTTPTimeout = 25

Timeout for HTTP requests done internally, in seconds.

Since
1.5

Definition at line 8853 of file DefaultSettings.php.

Referenced by MWHttpRequest\__construct().

◆ $wgIgnoreImageErrors

$wgIgnoreImageErrors = false

If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an error message.

This may be useful if errors are transitory, especially if the site is configured to automatically render thumbnails on request.

On the other hand, it may obscure error conditions from debugging. Enable the debug log or the 'thumbnail' log group to make sure errors are logged to a file for review.

Definition at line 1386 of file DefaultSettings.php.

Referenced by File\generateAndSaveThumb(), and File\transformErrorOutput().

◆ $wgIllegalFileChars

$wgIllegalFileChars = ":\\/\\\\"

Additional characters that are not allowed in filenames.

They are replaced with '-' when uploading. Like $wgLegalTitleChars, this is a regexp character class.

Slashes and backslashes are disallowed regardless of this setting, but included here for completeness.

Definition at line 497 of file DefaultSettings.php.

Referenced by wfStripIllegalFilenameChars().

◆ $wgImageLimits

$wgImageLimits
Initial value:
= [
[ 320, 240 ],
[ 640, 480 ],
[ 800, 600 ],
[ 1024, 768 ],
[ 1280, 1024 ]
]

Limit images on image description pages to a user-selectable limit.

In order to reduce disk usage, limits can only be selected from a list. The user preference is saved as an array offset in the database, by default the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you change it if you alter the array (see T10858). This is the list of settings the user can choose from:

Definition at line 1555 of file DefaultSettings.php.

Referenced by ImagePage\getThumbSizes(), and wfThumbIsStandard().

◆ $wgImageMagickConvertCommand

$wgImageMagickConvertCommand = '/usr/bin/convert'

The convert command shipped with ImageMagick.

Definition at line 1181 of file DefaultSettings.php.

Referenced by TransformationalImageHandler\getMagickVersion(), BitmapHandler\rotate(), and BitmapHandler\transformImageMagick().

◆ $wgImageMagickTempDir

$wgImageMagickTempDir = false

Temporary directory used for ImageMagick.

The directory must exist. Leave this set to false to let ImageMagick decide for itself.

Definition at line 1203 of file DefaultSettings.php.

Referenced by BitmapHandler\transformImageMagick().

◆ $wgImagePreconnect

$wgImagePreconnect = false

On pages containing images, tell the user agent to pre-connect to hosts from $wgForeignFileRepos.

This speeds up rendering, but may create unwanted traffic if there are many possible URLs from which images are served.

Since
1.35
Warning
EXPERIMENTAL!

Definition at line 1696 of file DefaultSettings.php.

◆ $wgImgAuthDetails

$wgImgAuthDetails = false

Set this to true if you use img_auth and want the user to see details on why access failed.

Definition at line 508 of file DefaultSettings.php.

Referenced by wfForbidden().

◆ $wgImgAuthPath

$wgImgAuthPath = false

The base path for img_auth.php.

This is used to interpret the request URL for requests to img_auth.php that do not match the base upload path. If false, "{$wgScriptPath}/img_auth.php" is used.

Normally, requests to img_auth.php have a REQUEST_URI which matches $wgUploadPath, and in that case, setting this should not be necessary. This variable is used in case img_auth.php is accessed via a different path than $wgUploadPath.

Since
1.35

Definition at line 287 of file DefaultSettings.php.

Referenced by wfImageAuthMain().

◆ $wgImgAuthUrlPathMap

$wgImgAuthUrlPathMap = []

Map of relative URL directories to match to internal mwstore:// base storage paths.

For img_auth.php requests, everything after "img_auth.php/" is checked to see if starts with any of the prefixes defined here. The prefixes should not overlap. The prefix that matches has a corresponding storage path, which the rest of the URL is assumed to be relative to. The file at that path (or a 404) is send to the client.

Example: $wgImgAuthUrlPathMap['/timeline/'] = 'mwstore://local-fs/timeline-render/'; The above maps ".../img_auth.php/timeline/X" to "mwstore://local-fs/timeline-render/". The name "local-fs" should correspond by name to an entry in $wgFileBackends.

See also
$wgFileBackends

Definition at line 524 of file DefaultSettings.php.

Referenced by wfImageAuthMain().

◆ $wgImplicitGroups

$wgImplicitGroups = [ '*', 'user', 'autoconfirmed' ]

Implicit groups, aren't shown on Special:Listusers or somewhere else.

Definition at line 5691 of file DefaultSettings.php.

◆ $wgImportSources

$wgImportSources = []

List of interwiki prefixes for wikis we'll accept as sources for Special:Import and API action=import.

Since complete page history can be imported, these should be 'trusted'.

This can either be a regular array, or an associative map specifying subprojects on the interwiki map of the target wiki, or a mix of the two, e.g.

'wikipedia' => [ 'cs', 'en', 'fr', 'zh' ],
'wikispecies',
'wikia' => [ 'animanga', 'brickipedia', 'desserts' ],
];

If you have a very complex import sources setup, you can lazy-load it using the ImportSources hook.

If a user has the 'import' permission but not the 'importupload' permission, they will only be able to run imports through this transwiki interface.

Definition at line 7622 of file DefaultSettings.php.

◆ $wgImportTargetNamespace

$wgImportTargetNamespace = null

Optional default target namespace for interwiki imports.

Can use this to create an incoming "transwiki"-style queue. Set to numeric key, not the name.

Users may override this in the Special:Import dialog.

Definition at line 7631 of file DefaultSettings.php.

◆ $wgIncludeLegacyJavaScript

$wgIncludeLegacyJavaScript = false

Whether to ensure the mediawiki.legacy library is loaded before other modules.

Deprecated:
since 1.26: Always declare dependencies.

Definition at line 4133 of file DefaultSettings.php.

◆ $wgInterlanguageLinkCodeMap

$wgInterlanguageLinkCodeMap = []

Map of interlanguage link codes to language codes.

This is useful to override what is shown as the language name when the interwiki code does not match it exactly

Since
1.35

Definition at line 3149 of file DefaultSettings.php.

◆ $wgInternalServer

$wgInternalServer = false

Internal server name as known to CDN, if different.

Example:
$wgInternalServer = 'http://yourinternal.tld:8000';

Definition at line 2904 of file DefaultSettings.php.

Referenced by Title\getInternalURL(), and wfExpandUrl().

◆ $wgInterwikiCache

bool array string $wgInterwikiCache = false

Interwiki cache, either as an associative array or a path to a constant database (.cdb) file.

This data structure database is generated by the dumpInterwiki maintenance script (which lives in the WikimediaMaintenance repository) and has key formats such as the following:

  • dbname:key - a simple key (e.g. enwiki:meta)
  • _sitename:key - site-scope key (e.g. wiktionary:meta)
  • __global:key - global-scope key (e.g. __global:meta)
  • __sites:dbname - site mapping (e.g. __sites:enwiki)

Sites mapping just specifies site name, other keys provide "local url" data layout.

Definition at line 4377 of file DefaultSettings.php.

◆ $wgInterwikiExpiry

$wgInterwikiExpiry = 10800

Expiry time for cache of interwiki table.

Definition at line 4352 of file DefaultSettings.php.

◆ $wgInterwikiFallbackSite

$wgInterwikiFallbackSite = 'wiki'

Fallback site, if unable to resolve from cache.

Definition at line 4390 of file DefaultSettings.php.

◆ $wgInterwikiMagic

$wgInterwikiMagic = true

Treat language links as magic connectors, not inline links.

Definition at line 3120 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgInterwikiPrefixDisplayTypes

$wgInterwikiPrefixDisplayTypes = []

Mapping of interwiki index prefixes to descriptors that can be used to change the display of interwiki search results.

Descriptors are appended to CSS classes of interwiki results which using InterwikiSearchResultWidget.

Predefined descriptors include the following words: definition, textbook, news, quotation, book, travel, course

Example:
'iwprefix' => 'definition'
];

Definition at line 9400 of file DefaultSettings.php.

◆ $wgInterwikiScopes

$wgInterwikiScopes = 3

Specify number of domains to check for messages.

  • 1: Just wiki(db)-level
  • 2: wiki and global levels
  • 3: site levels

Definition at line 4385 of file DefaultSettings.php.

◆ $wgInvalidateCacheOnLocalSettingsChange

$wgInvalidateCacheOnLocalSettingsChange = true

Invalidate various caches when LocalSettings.php changes.

This is equivalent to setting $wgCacheEpoch to the modification time of LocalSettings.php, as was previously done in the default LocalSettings.php file.

On high-traffic wikis, this should be set to false, to avoid the need to check the file modification time, and to avoid the performance impact of unnecessary cache invalidations.

Definition at line 2842 of file DefaultSettings.php.

◆ $wgInvalidPasswordReset

$wgInvalidPasswordReset = true

Specifies if users should be sent to a password-reset form on login, if their password doesn't meet the requirements of User::isValidPassword().

Since
1.23

Definition at line 5110 of file DefaultSettings.php.

◆ $wgInvalidRedirectTargets

$wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ]

Array of invalid page redirect targets.

Attempting to create a redirect to any of the pages in this array will make the redirect fail. Userlogout is hard-coded, so it does not need to be listed here. (T12569) Disallow Mypage and Mytalk as well.

As of now, this only checks special pages. Redirects to pages in other namespaces cannot be invalidated by this variable.

Definition at line 4514 of file DefaultSettings.php.

Referenced by Title\isValidRedirectTarget().

◆ $wgInvalidUsernameCharacters

$wgInvalidUsernameCharacters = '@:'

Characters to prevent during new account creations.

This is used in a regular expression character class during registration (regex metacharacters like / are escaped).

Definition at line 5333 of file DefaultSettings.php.

◆ $wgJobBackoffThrottling

float [] $wgJobBackoffThrottling = []

Map of job types to how many job "work items" should be run per second on each job runner process.

The meaning of "work items" varies per job, but typically would be something like "pages to update". A single job may have a variable number of work items, as is the case with batch jobs. This is used by runJobs.php and not jobs run via $wgJobRunRate. These settings should be global to all wikis.

Definition at line 7993 of file DefaultSettings.php.

◆ $wgJobClasses

$wgJobClasses
Initial value:
= [
'deletePage' => DeletePageJob::class,
'refreshLinks' => RefreshLinksJob::class,
'deleteLinks' => DeleteLinksJob::class,
'htmlCacheUpdate' => HTMLCacheUpdateJob::class,
'sendMail' => EmaillingJob::class,
'enotifNotify' => EnotifNotifyJob::class,
'fixDoubleRedirect' => DoubleRedirectJob::class,
'AssembleUploadChunks' => AssembleUploadChunksJob::class,
'PublishStashedFile' => PublishStashedFileJob::class,
'ThumbnailRender' => ThumbnailRenderJob::class,
'recentChangesUpdate' => RecentChangesUpdateJob::class,
'refreshLinksPrioritized' => RefreshLinksJob::class,
'refreshLinksDynamic' => RefreshLinksJob::class,
'activityUpdateJob' => ActivityUpdateJob::class,
'categoryMembershipChange' => CategoryMembershipChangeJob::class,
'clearUserWatchlist' => ClearUserWatchlistJob::class,
'watchlistExpiry' => WatchlistExpiryJob::class,
'cdnPurge' => CdnPurgeJob::class,
'userGroupExpiry' => UserGroupExpiryJob::class,
'clearWatchlistNotifications' => ClearWatchlistNotificationsJob::class,
'userOptionsUpdate' => UserOptionsUpdateJob::class,
'enqueue' => EnqueueJob::class,
'null' => NullJob::class,
]

Maps jobs to their handlers; extensions can add to this to provide custom jobs.

A job handler should either be a class name to be instantiated, or (since 1.30) a callback to use for creating the job object. The callback takes (Title, array map of parameters) as arguments.

Definition at line 7945 of file DefaultSettings.php.

Referenced by Job\factory(), and JobQueueGroup\pop().

◆ $wgJobQueueIncludeInMaxLagFactor

$wgJobQueueIncludeInMaxLagFactor = false

Whether to include the number of jobs that are queued for the API's maxlag parameter.

The total number of jobs will be divided by this to get an estimated second of maxlag. Typically bots backoff at maxlag=5, so setting this to the max number of jobs that should be in your queue divided by 5 should have the effect of stopping bots once that limit is hit.

Since
1.29

Definition at line 8031 of file DefaultSettings.php.

◆ $wgJobRunRate

$wgJobRunRate = 1

Number of jobs to perform per request.

May be less than one in which case jobs are performed probabalistically. If this is zero, jobs will not be done during ordinary apache requests. In this case, maintenance/runJobs.php should be run periodically.

Definition at line 8934 of file DefaultSettings.php.

◆ $wgJobSerialCommitThreshold

float bool $wgJobSerialCommitThreshold = false

Make job runners commit changes for replica DB-lag prone jobs one job at a time.

This is useful if there are many job workers that race on replica DB lag checks. If set, jobs taking this many seconds of DB write time have serialized commits.

Note that affected jobs may have worse lock contention. Also, if they affect several DBs at once they may have a smaller chance of being atomic due to the possibility of connection loss while queueing up to commit. Affected jobs may also fail due to the commit lock acquisition timeout.

Since
1.26

Definition at line 8008 of file DefaultSettings.php.

◆ $wgJobTypeConf

$wgJobTypeConf
Initial value:
= [
'default' => [ 'class' => JobQueueDB::class, 'order' => 'random', 'claimTTL' => 3600 ],
]

Map of job types to configuration arrays.

This determines which queue class and storage system is used for each job type. Job types that do not have explicit configuration will use the 'default' config. These settings should be global to all wikis.

Definition at line 8016 of file DefaultSettings.php.

Referenced by JobQueueGroup\get(), JobQueueGroup\getCoalescedQueues(), and JobQueueGroup\waitForBackups().

◆ $wgJobTypesExcludedFromDefaultQueue

$wgJobTypesExcludedFromDefaultQueue = [ 'AssembleUploadChunks', 'PublishStashedFile' ]

Jobs that must be explicitly requested, i.e.

aren't run by job runners unless special flags are set. The values here are keys of $wgJobClasses.

These can be:

  • Very long-running jobs.
  • Jobs that you would never want to run as part of a page rendering request.
  • Jobs that you want to run on specialized machines ( like transcoding, or a particular machine on your cluster has 'outside' web access you could restrict uploadFromUrl ) These settings should be global to all wikis.

Definition at line 7982 of file DefaultSettings.php.

Referenced by JobQueueGroup\getDefaultQueueTypes(), and JobQueueGroup\push().

◆ $wgJpegPixelFormat

$wgJpegPixelFormat = 'yuv420'

At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma subsampling to reduce file size, at the cost of possible color fringing at sharp edges.

See https://en.wikipedia.org/wiki/Chroma_subsampling

Supported values: false - use scaling system's default (same as pre-1.27 behavior) 'yuv444' - luma and chroma at same resolution 'yuv422' - chroma at 1/2 resolution horizontally, full vertically 'yuv420' - chroma at 1/2 resolution in both dimensions

This setting is currently supported only for the ImageMagick backend; others may default to 4:2:0 or 4:4:4 or maintaining the source file's sampling in the thumbnail.

Since
1.27

Definition at line 1245 of file DefaultSettings.php.

Referenced by BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().

◆ $wgJpegQuality

$wgJpegQuality = 80

When scaling a JPEG thumbnail, this is the quality we request from the backend.

It should be an int between 1 and 100, with 100 indicating 100% quality.

Since
1.32

Definition at line 1254 of file DefaultSettings.php.

Referenced by BitmapHandler\imageJpegWrapper(), BitmapHandler\transformImageMagick(), and BitmapHandler\transformImageMagickExt().

◆ $wgJpegTran

$wgJpegTran = '/usr/bin/jpegtran'

used for lossless jpeg rotation

Since
1.21

Definition at line 1224 of file DefaultSettings.php.

Referenced by JpegHandler\rotate().

◆ $wgLangObjCacheSize

$wgLangObjCacheSize = 10

Language cache size, or really how many languages can we handle simultaneously without degrading to crawl speed.

Definition at line 3104 of file DefaultSettings.php.