MediaWiki  REL1_31
DefaultSettings.php File Reference

Default values for MediaWiki configuration settings. More...

Go to the source code of this file.

Variables

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...
 
 $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...
 
 $wgExtraSignatureNamespaces = []
 Array of namespaces, in addition to the talk namespaces, where signatures (~~~~) are likely to be used. More...
 
 $wgInvalidRedirectTargets = [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ]
 Array of invalid page redirect targets. 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...
 
 $wgServer = WebRequest::detectServer()
 URL of the server. More...
 
 $wgServerName = false
 Server name. 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...
 
 $wgTrackingCategories = []
 Array holding default tracking category names. More...
 
 $wgVersion = MW_VERSION
 MediaWiki version number. More...
 
Script path settings
bool $wgForceHTTPS = false
 If this is true, when an insecure HTTP request is received, always redirect to HTTPS. More...
 
 $wgScriptPath = '/wiki'
 The path we should point to. More...
 
 $wgUsePathInfo
 Whether to support URLs like index.php/Page_title These often break when PHP is set up in CGI mode. More...
 
URLs and file paths

These various web and file path variables are set to their defaults in Setup.php if they are not explicitly set from LocalSettings.php.

These will relatively rarely need to be set manually, unless you are splitting style sheets or images outside the main document root.

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.

 $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...
 
 $wgExtensionAssetsPath = false
 The URL path of the extensions directory. More...
 
 $wgExtensionDirectory = "{$IP}/extensions"
 Filesystem extensions directory. More...
 
 $wgFavicon = '/favicon.ico'
 The URL path of the shortcut icon. More...
 
 $wgFileCacheDirectory = false
 Directory where the cached page will be saved. 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...
 
 $wgLogoHD = false
 Array with URL paths to HD versions of the wiki logo. More...
 
array string bool $wgReferrerPolicy = false
 Value for the referrer policy meta tag. More...
 
 $wgScript = false
 The URL path to index.php. More...
 
 $wgStyleDirectory = "{$IP}/skins"
 Filesystem stylesheets directory. More...
 
 $wgStylePath = false
 The URL path of the skins directory. More...
 
 $wgStyleSheetPath = &$wgStylePath
 The URL path to index.php. More...
 
 $wgTmpDirectory = false
 The local filesystem path to a temporary directory. 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...
 
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...
 
 $wgAllowTitlesInSVG = false
 Disallow <title> element in SVG files. 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...
 
 $wgCacheSharedUploads = true
 Cache shared metadata in memcached. 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
 Uploads have to be specially set up to be secure. 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...
 
 $wgFetchCommonsDescriptions = false
 Fetch commons image description pages and display them on the local wiki? 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 = []
 
 $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...
 
 $wgGenerateThumbnailOnParse = true
 Allow thumbnail rendering on page view. More...
 
 $wgHashedSharedUploadDirectory = true
 Set the following to false especially if you have a set of files that need to be accessible by all wikis, and you do not want to use the hash (path/a/aa/) directory layout. More...
 
 $wgHashedUploadDirectory = true
 Set this to false if you do not want MediaWiki to divide your images directory into many subdirectories, for improved performance. 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...
 
 $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...
 
 $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...
 
 $wgMimeDetectorCommand = null
 Sets an external MIME detector program. More...
 
 $wgMimeInfoFile = 'includes/mime.info'
 Sets the MIME type info file to use by MimeMagic.php. More...
 
 $wgMimeTypeBlacklist
 Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled. More...
 
 $wgMimeTypeFile = 'includes/mime.types'
 Sets the MIME type definition file to use by MimeMagic.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:"
 Base URL for a repository wiki. More...
 
 $wgResponsiveImages = true
 Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities. More...
 
 $wgSharedThumbnailScriptPath = false
 
 $wgSharedUploadDBname = false
 DB name with metadata about shared directory. More...
 
 $wgSharedUploadDBprefix = ''
 Optional table prefix used in database. More...
 
 $wgSharedUploadDirectory = null
 Path on the file system where shared uploads can be found. More...
 
 $wgSharedUploadPath = null
 Full path on the web server where shared uploads can be found. 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 = false
 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 Commons as a remote file repository. More...
 
 $wgUseSharedUploads = false
 If you operate multiple wikis, you can define a shared upload path here. 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...
 
 $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...
 
 $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...
 
 $wgEnotifFromEditor = false
 True: from page editor if s/he opted-in. 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...
 
 $wgEnotifRevealEditorAddress = false
 Set the Reply-to address in notifications to the editor's address, if user allowed this in the preferences. 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...
 
 $wgPasswordSenderName = 'MediaWiki Mail'
 Sender name 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...
 
 $wgDBerrorLog = false
 File to log database errors to. More...
 
 $wgDBerrorLogTZ = false
 Timezone to use in the error log. More...
 
 $wgDBmwschema = null
 Mediawiki schema. More...
 
 $wgDBmysql5 = false
 Set to true to engage MySQL 4.1/5.0 charset-related features; for now will just cause sending of 'SET NAMES=utf8' on connect. More...
 
 $wgDBname = 'my_wiki'
 Name of the database. More...
 
 $wgDBOracleDRCP = false
 Set true to enable Oracle DCRP (supported from 11gR1 onward) More...
 
 $wgDBpassword = ''
 Database user's password. More...
 
 $wgDBport = 5432
 Database port number (for PostgreSQL and Microsoft SQL Server). More...
 
 $wgDBprefix = ''
 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'
 MySQL table options to use during installation or update. More...
 
 $wgDBtype = 'mysql'
 Database type. More...
 
 $wgDBuser = 'wikiuser'
 Database username. More...
 
 $wgDBWindowsAuthentication = false
 Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server. 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...
 
 $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 Sometimes you want to support multiple search engines for testing. 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...
 
 $wgClockSkewFudge = 5
 Clock skew or the one-second resolution of time() can occasionally cause cache problems when the user requests two pages within a short period of time. More...
 
 $wgEnableParserCache = true
 Kept for extension compatibility; see $wgParserCacheType. 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...
 
 $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'
 Main object stash type. More...
 
 $wgMainWANCache = false
 Main Wide-Area-Network cache type. More...
 
 $wgMemCachedDebug = false
 If enabled, will send MemCached debugging information to $wgDebugLogFile. 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...
 
 $wgSessionHandler = null
 
 $wgSessionPbkdf2Iterations = 10001
 Number of internal PBKDF2 iterations to use when deriving session secrets. More...
 
 $wgSessionsInObjectCache = true
 
 $wgSidebarCacheExpiry = 86400
 Expiry time for the sidebar cache, in seconds. More...
 
 $wgStyleVersion = '303'
 Bump this number when changing the global style sheets and JavaScript. 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 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:Squid_caching for more details.

 $wgCdnMaxageLagged = 30
 Cache timeout for the CDN when DB replica DB lag is high. 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...
 
 $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...
 
 $wgSquidMaxage = 18000
 Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI). More...
 
 $wgSquidPurgeUseHostHeader = true
 Whether to use a Host header in purge requests sent to the proxy servers configured in $wgSquidServers. More...
 
 $wgSquidServers = []
 List of proxy servers to purge on changes; default port is 80. More...
 
 $wgSquidServersNoPurge = []
 As above, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc. More...
 
 $wgUseESI = false
 If you run Squid3 with ESI support, enable this (default:false): More...
 
 $wgUseKeyHeader = false
 Send the Key HTTP header for better caching. More...
 
 $wgUsePrivateIPs = false
 Should forwarded Private IPs be accepted? More...
 
 $wgUseSquid = false
 Enable/disable CDN. 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...
 
 $wgBrowserBlackList = []
 
 $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...
 
 $wgFixArabicUnicode = true
 Set this to true to replace Arabic presentation forms with their standard forms in the U+0600-U+06FF block. More...
 
 $wgFixMalayalamUnicode = true
 Set this to true to replace ZWJ-based chillu sequences in Malayalam text with their Unicode 5.1 equivalents. 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...
 
 $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...
 
 $wgMsgCacheExpiry = 86400
 Expiry time for the message cache key. 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...
 
 $wgExperimentalHtmlIds = false
 Abandoned experiment with HTML5-style ID escaping. 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...
 
 $wgHtml5 = true
 Previously used to determine if we should output an HTML5 doctype. 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...
 
 $wgJsMimeType = null
 Previously used as content type in HTML script tags. 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...
 
 $wgSiteSupportPage = ''
 If this is set, a "donate" link will appear in the sidebar. More...
 
 $wgSkipSkin = ''
 
 $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...
 
 $wgXhtmlDefaultNamespace = null
 The default xmlns attribute. 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...
 
 $wgResourceLoaderLESSImportPaths
 Default import paths for LESS modules. More...
 
 $wgResourceLoaderLESSVars
 Global LESS variables. More...
 
 $wgResourceLoaderMaxage
 Maximum time in seconds to cache resources served by ResourceLoader. More...
 
 $wgResourceLoaderMaxQueryLength = false
 If set to a positive number, 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...
 
 $wgResourceLoaderValidateJS = true
 If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it. More...
 
 $wgResourceLoaderValidateStaticJS = false
 If set to true, statically-sourced (file-backed) JavaScript resources will be parsed for validity before being bundled up into ResourceLoader modules. More...
 
 $wgResourceModules = []
 Client-side resource modules. More...
 
 $wgResourceModuleSkinStyles = []
 Skin-specific styles for resource modules. 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...
 
 $wgLocalInterwiki = false
 The interwiki prefix of the current wiki, or false if it doesn't have one. More...
 
 $wgLocalInterwikis = []
 Array for multiple $wgLocalInterwiki values, in case there are several 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 = []
 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...
 
SiteStore caching settings.
 $wgSitesCacheFile = false
 Specify the file location for the Sites json cache file. 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...
 
 $wgDebugTidy = false
 Put tidy warnings in HTML comments Only works for internal tidy. More...
 
 $wgEnableImageWhitelist = true
 If $wgAllowExternalImages is false, you can allow an on-wiki whitelist 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...
 
 $wgMaxGeneratedPPNodeCount = 1000000
 A complexity limit on template expansion: the maximum number of elements generated by Preprocessor::preprocessToObj(). 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...
 
 $wgTidyBin = 'tidy'
 The path to the tidy binary. More...
 
 $wgTidyConf = $IP . '/includes/tidy/tidy.conf'
 The path to the tidy config file. More...
 
 $wgTidyConfig = [ 'driver' => 'RemexHtml' ]
 Configuration for HTML postprocessing tool. More...
 
 $wgTidyInternal = extension_loaded( 'tidy' )
 Set this to true to use the tidy extension. More...
 
 $wgTidyOpts = ''
 The command line options to the tidy binary. More...
 
 $wgTranscludeCacheExpiry = 3600
 Expiry time for transcluded templates cached in transcache database table. More...
 
 $wgUrlProtocols
 URL schemes that should be recognized as valid by wfParseUrl(). More...
 
 $wgUseTidy = false
 Set this to true to use the deprecated tidy configuration parameters. 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
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 local wiki users. 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...
 
 $wgPasswordSalt = true
 For compatibility with old installations set to false. 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...
 
 $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...
 
 $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']['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']['skipcaptcha'] = 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 ['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']['editusercss'] = true
 Number of seconds before autoblock entries expire. More...
 
 $wgGrantPermissions ['editinterface']['edituserjs'] = 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 ['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 ['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 ['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...
 
 $wgSysopEmailBans = true
 Allow sysops to ban users from accessing Emailuser. 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...
 
string null $wgCookieSameSite = null
 The SameSite cookie attribute used for login cookies. More...
 
 $wgCookieSecure = 'detect'
 Whether the "secure" flag should be set on the cookie. More...
 
 $wgCookieSetOnAutoblock = false
 Whether to set a cookie when a user is autoblocked. 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...
 
bool $wgUseSameSiteLegacyCookies = false
 If true, when a cross-site cookie with SameSite=None is sent, a legacy cookie with an "ss0" prefix will also be sent, without SameSite=None. 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

To enable profiling, edit StartProfiler.php

 $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...
 
 $wgDebugPrintHttpHeaders = true
 Print HTTP headers for every request in the debug information. 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...
 
 $wgDebugTimestamps = false
 Prefix debug messages with relative timestamp. 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...
 
 $wgProfileLimit = 0.0
 Only record profiling info for pages that took longer than this. More...
 
 $wgProfileOnly = false
 Don't put non-profiling info into log file. 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 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...
 
 $wgSiteStatsAsyncFactor = false
 Set this to an integer to only do synchronous site_stats updates one every this many updates. 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
 Enable OpenSearch suggestions requested by MediaWiki. 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 = []
 Recentchanges items are periodically purged; entries older than this many seconds will go. 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...
 
 $wgStructuredChangeFiltersOnWatchlist = false
 Whether to enable RCFilters app on Special:Watchlist. More...
 
 $wgStructuredChangeFiltersShowPreference = false
 Whether a preference is displayed for structured change filters. 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
$wgAuth $wgAuth = null
 Authentication plugin. More...
 
 $wgAutoloadAttemptLowercase = true
 Switch controlling legacy case-insensitive classloading. More...
 
 $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 = []
 An array of information about installed extensions keyed by their 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...
 
 $wgJobQueueAggregator
 Which aggregator to use for tracking which queues have 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 Log/newusers? 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 and API

Note: The AJAX entry point which this section refers to is gradually being replaced by the 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...
 
 $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
 
 $wgEnableAPI = true
 Enable the MediaWiki API for convenient access to machine-readable data via api.php. More...
 
 $wgEnableWriteAPI = true
 Allow the API to be used to perform write operations (page edits, rollback, etc.) when an authorised user accesses it. 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
 $wgAsyncHTTPTimeout = 25
 Timeout for Asynchronous (background) HTTP requests, in seconds. More...
 
 $wgHTTPConnectTimeout = 5e0
 Timeout for connections done internally (in seconds) Only works for curl. More...
 
 $wgHTTPImportTimeout = 25
 Timeout for HTTP requests done internally for transwiki imports, in seconds. More...
 
 $wgHTTPProxy = false
 Proxy to use for CURL requests. More...
 
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
int $wgActorTableSchemaMigrationStage = MIGRATION_OLD
 Actor table schema migration stage. More...
 
int $wgCommentTableSchemaMigrationStage = MIGRATION_OLD
 Comment table schema migration stage. More...
 
 $wgContentHandlerTextFallback = 'ignore'
 How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText(): More...
 
 $wgContentHandlerUseDB = true
 Set to false to disable use of the database fields introduced by the ContentHandler facility. 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...
 
 $wgDisableHardRedirects = false
 Disable redirects to special pages and interwiki redirects, which use a 302 and have no "redirected from" link. More...
 
 $wgEventRelayerConfig
 Mapping of event channels (or channel categories) to EventRelayer configuration. More...
 
 $wgExperiencedUserEdits = 500
 Name of the external diff engine to use. More...
 
 $wgExperiencedUserMemberSince = 30
 Name of the external diff engine to use. More...
 
 $wgExternalDiffEngine = false
 Name of the external diff engine to use. 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...
 
 $wgHttpsPort = 443
 Port where you have HTTPS running Supports HTTPS on non-standard ports. 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
 Name of the external diff engine to use. More...
 
 $wgLinkHolderBatchSize = 1000
 LinkHolderArray batch size For debugging. More...
 
 $wgMaximumMovedPages = 100
 Maximum number of pages to move at once when moving subpages with a page. More...
 
 $wgMaxJobDBWriteDuration = false
 Name of the external diff engine to use. More...
 
 $wgMaxUserDBWriteDuration = false
 Name of the external diff engine to use. 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...
 
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...
 
string $wgPopularPasswordFile = __DIR__ . '/../serialized/commonpasswords.cdb'
 Where popular password file is located. More...
 
array $wgRangeContributionsCIDRLimit
 Shortest CIDR limits that can be checked in any individual range check at Special:Contributions. 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...
 
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 or mcrypt extensions, 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...
 
 $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...
 
 $wgWikiDiff2MovedParagraphDetectionCutoff = 0
 wikidiff2 supports detection of changes in moved paragraphs. 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 5562 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 7810 of file DefaultSettings.php.

Referenced by LogPager\limitAction().

◆ $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 391 of file DefaultSettings.php.

◆ $wgActions

$wgActions
Initial value:
= [
'credits' => true,
'delete' => true,
'edit' => true,
'editchangetags' => SpecialPageAction::class,
'history' => true,
'info' => true,
'markpatrolled' => true,
'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 7926 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 4461 of file DefaultSettings.php.

Referenced by RecentChangesUpdateJob\updateActiveUsers().

◆ $wgActorTableSchemaMigrationStage

◆ $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 2511 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 5513 of file DefaultSettings.php.

Referenced by User\changeableByGroup(), and ApiUserrightsTest\setPermissions().

◆ $wgAdditionalMailParams

$wgAdditionalMailParams = null

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

Definition at line 1696 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 6462 of file DefaultSettings.php.

Referenced by SearchResult\getTextSnippet().

◆ $wgAdvertisedFeedTypes

$wgAdvertisedFeedTypes = [ 'atom' ]

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

Definition at line 6962 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 8212 of file DefaultSettings.php.

Referenced by WikiPage\prepareContentForEdit().

◆ $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 8196 of file DefaultSettings.php.

◆ $wgAjaxLicensePreview

$wgAjaxLicensePreview = true

Enable previewing licences via AJAX.

Also requires $wgEnableAPI to be true.

Definition at line 8206 of file DefaultSettings.php.

◆ $wgAjaxUploadDestCheck

$wgAjaxUploadDestCheck = true

Enable AJAX check for file overwrite, pre-upload.

Definition at line 8201 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 752 of file DefaultSettings.php.

Referenced by UploadFromUrl\isEnabled().

◆ $wgAllowDisplayTitle

$wgAllowDisplayTitle = true

Allow DISPLAYTITLE to change title display.

Definition at line 4385 of file DefaultSettings.php.

Referenced by CoreParserFunctions\register().

◆ $wgAllowExternalImages

$wgAllowExternalImages = false

Whether to allow inline image pointing to other websites.

Definition at line 4235 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 4249 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $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 1702 of file DefaultSettings.php.

Referenced by UserMailer\send().

◆ $wgAllowImageMoving

$wgAllowImageMoving = true

Allows to move images and other media files.

Definition at line 413 of file DefaultSettings.php.

Referenced by MWNamespace\isMovable().

◆ $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.

Definition at line 4270 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 928 of file DefaultSettings.php.

Referenced by UploadBase\verifyPartialFile().

◆ $wgAllowSchemaUpdates

$wgAllowSchemaUpdates = true

Allow schema updates.

Definition at line 2216 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 4687 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 3838 of file DefaultSettings.php.

◆ $wgAllowSlowParserFunctions

$wgAllowSlowParserFunctions = false

Enable slow parser functions.

Definition at line 2211 of file DefaultSettings.php.

Referenced by CoreParserFunctions\register().

◆ $wgAllowSpecialInclusion

$wgAllowSpecialInclusion = true

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

Definition at line 7889 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgAllowTitlesInSVG

$wgAllowTitlesInSVG = false

Disallow <title> element in SVG files.

MediaWiki will reject HTMLesque tags in uploaded files due to idiotic browsers which can not perform basic stuff like MIME detection and which are vulnerable to further idiots uploading crap files as images.

When this directive is on, "<title>" will be allowed in files with an "image/svg+xml" MIME type. You should leave this disabled if your web server is misconfigured and doesn't send appropriate MIME types for SVG images.

Definition at line 1175 of file DefaultSettings.php.

Referenced by UploadBase\detectScript().

◆ $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 3312 of file DefaultSettings.php.

◆ $wgAllowUserCssPrefs

$wgAllowUserCssPrefs = true

Allow style-related user-preferences?

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

Definition at line 3320 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 3305 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.

See $wgFixArabicUnicode and $wgFixMalayalamUnicode for conversion details.

Since
1.17

Definition at line 2994 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 3031 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 1270 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 1324 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 1306 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 8172 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 8109 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 3369 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 8136 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 8142 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 8161 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 8148 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 8154 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 8118 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 8100 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 8127 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 8167 of file DefaultSettings.php.

◆ $wgAPIUselessQueryPages

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

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

Definition at line 8178 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 323 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 5637 of file DefaultSettings.php.

Referenced by User\getBlockedStatus().

◆ $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 4452 of file DefaultSettings.php.

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

◆ $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 259 of file DefaultSettings.php.

◆ $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 8005 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 88 of file DefaultSettings.php.

Referenced by WebRequest\detectServer().

◆ $wgAsyncHTTPTimeout

$wgAsyncHTTPTimeout = 25

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

Definition at line 8376 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 1229 of file DefaultSettings.php.

Referenced by wfGenerateThumbnail().

◆ $wgAuth

$wgAuth $wgAuth = null

Authentication plugin.

AuthPlugin

Deprecated:
since 1.27 use $wgAuthManagerConfig instead

Definition at line 7417 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), MediaWiki\Auth\AuthManager\callLegacyAuthPlugin(), and LoginSignupSpecialPage\getFakeTemplate().

◆ $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 4961 of file DefaultSettings.php.

Referenced by User\getToken().

◆ $wgAuthManagerAutoConfig

$wgAuthManagerAutoConfig
See also
$wgAuthManagerConfig
Since
1.27

Definition at line 4570 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 4564 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig().

◆ $wgAutoblockExpiry

$wgAutoblockExpiry = 86400

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 4997 of file DefaultSettings.php.

Referenced by Block\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 5386 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 5397 of file DefaultSettings.php.

◆ $wgAutoloadAttemptLowercase

$wgAutoloadAttemptLowercase = true

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.

Definition at line 7356 of file DefaultSettings.php.

Referenced by AutoLoader\autoload().

◆ $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 = array(
    '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 array( APCOND_EMAILCONFIRMED )
  • a single condition with arguments: e.g. array( APCOND_EDITCOUNT, 100 )
  • a set of conditions: e.g. ‘array( '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
  • array( APCOND_EMAILCONFIRMED ): true if user has a confirmed e-mail
  • array( APCOND_EDITCOUNT, number of edits ): true if user has the at least the number of edits as the passed parameter
  • array( 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
  • array( 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
  • array( APCOND_INGROUPS, group1, group2, ... ): true if the user is a member of each of the passed groups
  • array( APCOND_ISIP, ip ): true if the user has the passed IP address
  • array( APCOND_IPINRANGE, range ): true if the user has an IP address in the range of the passed parameter
  • array( APCOND_BLOCKED ): true if the user is blocked
  • array( 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 5456 of file DefaultSettings.php.

Referenced by Autopromote\getAutopromoteGroups().

◆ $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 5481 of file DefaultSettings.php.

Referenced by Autopromote\getAutopromoteOnceGroups().

◆ $wgAutopromoteOnceLogInRC

$wgAutopromoteOnceLogInRC = true

Put user rights log entries for autopromotion in recent changes?

Since
1.18

Definition at line 5489 of file DefaultSettings.php.

Referenced by User\addAutopromoteOnceGroups().

◆ $wgAvailableRights

$wgAvailableRights = []

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

For extensions only.

Definition at line 5524 of file DefaultSettings.php.

Referenced by User\getAllRights().

◆ $wgBlockAllowsUTEdit

$wgBlockAllowsUTEdit = true

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

Definition at line 5002 of file DefaultSettings.php.

Referenced by SpecialBlock\blockLogFlags(), SpecialBlock\getFormFields(), User\isBlockedFrom(), and SpecialBlock\processForm().

◆ $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 5023 of file DefaultSettings.php.

Referenced by Block\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 5035 of file DefaultSettings.php.

Referenced by EmailNotification\actuallyNotifyOnPageChange(), EmailNotification\canSendUserTalkEmail(), Title\checkUserBlock(), Block\insert(), and Block\prevents().

◆ $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 5944 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 5954 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 3336 of file DefaultSettings.php.

◆ $wgBrowserBlackList

$wgBrowserBlackList = []
Deprecated:
since 1.30, does nothing

Definition at line 3011 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 2252 of file DefaultSettings.php.

Referenced by LocalisationCache\__construct(), LCStoreCDB\__construct(), and LCStoreStaticArray\__construct().

◆ $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 2556 of file DefaultSettings.php.

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

◆ $wgCachePages

$wgCachePages = true

Allow client-side caching of pages.

Definition at line 2546 of file DefaultSettings.php.

Referenced by AjaxResponse\checkLastModified().

◆ $wgCachePrefix

$wgCachePrefix = false

Overwrite the caching key prefix with custom value.

Since
1.19

Definition at line 6435 of file DefaultSettings.php.

Referenced by ObjectCache\getDefaultKeyspace().

◆ $wgCacheSharedUploads

$wgCacheSharedUploads = true

Cache shared metadata in memcached.

Don't do this if the commons wiki is in a different memcached domain

Definition at line 745 of file DefaultSettings.php.

◆ $wgCacheVaryCookies

$wgCacheVaryCookies = []

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

Definition at line 6070 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 115 of file DefaultSettings.php.

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

◆ $wgCapitalLinkOverrides

$wgCapitalLinkOverrides = []
Since
1.16 - This can now be set per-namespace. Some special namespaces (such as Special, see MWNamespace::$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 4058 of file DefaultSettings.php.

Referenced by MWNamespace\isCapitalized(), and MWNamespaceTest\testIsCapitalizedWithWgCapitalLinkOverrides().

◆ $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 4042 of file DefaultSettings.php.

Referenced by XmlDumpWriter\caseSetting(), NamespaceConflictChecker\checkAll(), MWNamespace\isCapitalized(), and MWNamespaceTest\testIsCapitalizedWithWgCapitalLinks().

◆ $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 5330 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://secure.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 7636 of file DefaultSettings.php.

Referenced by UpdateCollation\__construct(), DatabaseUpdater\doCollationUpdate(), UpdateCollation\execute(), LinksUpdate\getCategoryInsertions(), MovePage\move(), 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 7604 of file DefaultSettings.php.

◆ $wgCategoryPagingLimit

$wgCategoryPagingLimit = 200

Paging limit for categories.

Definition at line 7609 of file DefaultSettings.php.

◆ $wgCdnMaxageLagged

$wgCdnMaxageLagged = 30

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

See also
$wgSquidMaxage
Since
1.27

Definition at line 2729 of file DefaultSettings.php.

◆ $wgCdnMaxageSubstitute

$wgCdnMaxageSubstitute = 60

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

See also
$wgSquidMaxage
Since
1.27

Definition at line 2752 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 puge will clear cdn2 after cdn1 was cleared.

Since
1.27

Definition at line 2745 of file DefaultSettings.php.

Referenced by CdnCacheUpdate\doUpdate().

◆ $wgCentralIdLookupProvider

string $wgCentralIdLookupProvider = 'local'

Central ID lookup provider to use by default.

Definition at line 4483 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 4475 of file DefaultSettings.php.

Referenced by CentralIdLookup\factory().

◆ $wgChangeCredentialsBlacklist

string [] $wgChangeCredentialsBlacklist
Initial value:

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 4700 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 935 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 4230 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgClockSkewFudge

$wgClockSkewFudge = 5

Clock skew or the one-second resolution of time() can occasionally cause cache problems when the user requests two pages within a short period of time.

This variable adds a given number of seconds to vulnerable timestamps, thereby giving a grace period.

Definition at line 2632 of file DefaultSettings.php.

Referenced by User\newTouchedTimestamp().

◆ $wgCommandLineDarkBg

$wgCommandLineDarkBg = false

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

Definition at line 6659 of file DefaultSettings.php.

Referenced by AnsiTermColorer\color().

◆ $wgCommentTableSchemaMigrationStage

◆ $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 2126 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

◆ $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 8565 of file DefaultSettings.php.

Referenced by ContentHandler\getContentText().

◆ $wgContentHandlerUseDB

$wgContentHandlerUseDB = true

Set to false to disable use of the database fields introduced by the ContentHandler facility.

This way, the ContentHandler facility can be used without any additional information in the database. A page's content model is then derived solely from the page's title. This however means that changing a page's default model (e.g. using $wgNamespaceContentModels) will break the page and/or make the content inaccessible. This also means that pages can not be moved to a title that would default to a different content model.

Overall, with $wgContentHandlerUseDB = false, no database updates are needed, but content handling is less robust and less flexible.

Since
1.21

Definition at line 8580 of file DefaultSettings.php.

Referenced by DatabaseUpdater\disableContentHandlerUseDB(), WikiPage\doDeleteArticleReal(), DatabaseUpdater\enableContentHandlerUseDB(), SpecialPageFactory\getPageList(), WikiPage\getQueryInfo(), LinkCache\getSelectFields(), Title\getSelectFields(), TextPassDumper\getText(), Title\isSingleRevRedirect(), MovePage\isValidMove(), Revision\selectArchiveFields(), WikiPage\selectFields(), Revision\selectFields(), WikiPageDbTestBase\testIsCountable(), and WikiPage\updateRevisionOn().

◆ $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 4103 of file DefaultSettings.php.

Referenced by MWNamespace\getContentNamespaces(), MWNamespace\isContent(), MWNamespaceTest\testGetContentNamespaces(), and MWNamespaceTest\testIsContentAdvanced().

◆ $wgCookieDomain

$wgCookieDomain = ''

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

Definition at line 6003 of file DefaultSettings.php.

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

◆ $wgCookieExpiration

$wgCookieExpiration = 30 * 86400

Default cookie lifetime, in seconds.

Setting to 0 makes all cookies session-only.

Definition at line 5989 of file DefaultSettings.php.

Referenced by WebResponse\setCookie(), and FauxResponse\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 6043 of file DefaultSettings.php.

Referenced by WebResponse\setCookie(), and FauxResponse\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 6009 of file DefaultSettings.php.

Referenced by WebResponse\setCookie(), and FauxResponse\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 6036 of file DefaultSettings.php.

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

◆ $wgCookieSameSite

string null $wgCookieSameSite = null

The SameSite cookie attribute used for login cookies.

This can be "Lax", "Strict", "None" or empty/null to omit the attribute.

This only applies to login cookies, since the correct value for other cookies depends on what kind of cookie it is.

Since
1.31.9

Definition at line 6055 of file DefaultSettings.php.

◆ $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 6021 of file DefaultSettings.php.

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

◆ $wgCookieSetOnAutoblock

$wgCookieSetOnAutoblock = false

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 6084 of file DefaultSettings.php.

◆ $wgCopyUploadProxy

$wgCopyUploadProxy = false

Proxy to use for copy upload requests.

Since
1.20

Definition at line 772 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 759 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 766 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 784 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 7901 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 8241 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 8234 of file DefaultSettings.php.

◆ $wgCSPFalsePositiveUrls

$wgCSPFalsePositiveUrls
Initial value:
= [
'https:
'https:
'https:
'https:
'https:
'https:
]

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 8806 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 1079 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 2014 of file DefaultSettings.php.

◆ $wgDBadminpassword

$wgDBadminpassword = null

Separate password for maintenance tasks.

Leave as null to use the default.

Definition at line 1849 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 1844 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 1839 of file DefaultSettings.php.

◆ $wgDBerrorLog

$wgDBerrorLog = false

File to log database errors to.

Definition at line 2019 of file DefaultSettings.php.

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

◆ $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://secure.php.net/manual/en/timezones.php

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

Definition at line 2039 of file DefaultSettings.php.

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

◆ $wgDBmwschema

$wgDBmwschema = null

Mediawiki schema.

Definition at line 1889 of file DefaultSettings.php.

Referenced by WikiMap\getCurrentWikiDbDomain().

◆ $wgDBmysql5

$wgDBmysql5 = false

Set to true to engage MySQL 4.1/5.0 charset-related features; for now will just cause sending of 'SET NAMES=utf8' on connect.

Warning
THIS IS EXPERIMENTAL!

May break if you're not using the table defs from mysql5/tables.sql. May break if you're upgrading an existing wiki if set differently. Broken symptoms likely to include incorrect behavior with page titles, usernames, comments etc containing non-ASCII characters. Might also cause failures on the object cache and other things.

Even correct usage may cause failures with Unicode supplementary characters (those not in the Basic Multilingual Plane) unless MySQL has enhanced their Unicode support.

Deprecated:
since 1.31

Definition at line 2059 of file DefaultSettings.php.

◆ $wgDBname

$wgDBname = 'my_wiki'

Name of the database.

Definition at line 1804 of file DefaultSettings.php.

◆ $wgDBOracleDRCP

$wgDBOracleDRCP = false

Set true to enable Oracle DCRP (supported from 11gR1 onward)

To use this feature set to true and use a datasource defined as POOLED (i.e. in tnsnames definition set server=pooled in connect_data block).

Starting from 11gR1 you can use DCRP (Database Resident Connection Pool) that maintains established sessions and reuses them on new connections.

Not completely tested, but it should fall back on normal connection in case the pool is full or the datasource is not configured as pooled. And the other way around; using oci_pconnect on a non pooled datasource should produce a normal connection.

When it comes to frequent shortlived DB connections like with MW Oracle tends to s***. The problem is the driver connects to the database reasonably fast, but establishing a session takes time and resources. MW does not rely on session state (as it does not use features such as package variables) so establishing a valid session is in this case an unwanted overhead that just slows things down.

Warning
EXPERIMENTAL!

Definition at line 2087 of file DefaultSettings.php.

Referenced by DatabaseOracle\open().

◆ $wgDBpassword

◆ $wgDBport

$wgDBport = 5432

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

Definition at line 1799 of file DefaultSettings.php.

◆ $wgDBprefix

◆ $wgDBserver

◆ $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: 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: bit field
    • DBO_DEFAULT – turns on DBO_TRX only if "cliMode" is off (recommended)
    • DBO_DEBUG – equivalent of $wgDebugDumpSql
    • DBO_TRX – wrap entire request in a transaction
    • DBO_NOBUFFER – turn off buffering (not useful in LocalSettings.php)
    • DBO_PERSISTENT – enables persistent database connections
    • DBO_SSL – uses SSL/TLS encryption in database connections, if available
    • DBO_COMPRESS – uses internal compression in database connections, if available
  • 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. [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 1994 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 1829 of file DefaultSettings.php.

◆ $wgDBTableOptions

$wgDBTableOptions = 'ENGINE=InnoDB'

MySQL table options to use during installation or update.

Definition at line 1876 of file DefaultSettings.php.

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

◆ $wgDBtype

◆ $wgDBuser

◆ $wgDBWindowsAuthentication

$wgDBWindowsAuthentication = false

Use Windows Authentication instead of $wgDBuser / $wgDBpassword for MS SQL Server.

Definition at line 2111 of file DefaultSettings.php.

Referenced by MssqlInstaller\openConnection().

◆ $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 8062 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 6145 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' and $wgDBservers is an empty array; otherwise the DBO_DEBUG flag must be set in the 'flags' option of the database connection to achieve the same functionality.

Definition at line 6155 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 6116 of file DefaultSettings.php.

Referenced by 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 6240 of file DefaultSettings.php.

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

◆ $wgDebugLogPrefix

$wgDebugLogPrefix = ''

Prefix for debug log lines.

Definition at line 6121 of file DefaultSettings.php.

Referenced by wfDebug().

◆ $wgDebugPrintHttpHeaders

$wgDebugPrintHttpHeaders = true

Print HTTP headers for every request in the debug information.

Definition at line 6283 of file DefaultSettings.php.

◆ $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 6135 of file DefaultSettings.php.

Referenced by wfDebug(), and wfLogProfilingData().

◆ $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 6128 of file DefaultSettings.php.

◆ $wgDebugTidy

$wgDebugTidy = false

Put tidy warnings in HTML comments Only works for internal tidy.

Definition at line 4333 of file DefaultSettings.php.

Referenced by MWTidy\singleton().

◆ $wgDebugTimestamps

$wgDebugTimestamps = false

Prefix debug messages with relative timestamp.

Very-poor man's profiler. Since 1.19 also includes memory usage.

Definition at line 6278 of file DefaultSettings.php.

Referenced by GlobalTest\testDebugFunctionTest(), and wfDebug().

◆ $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 $wgUseSquid is enabled.

Since
1.19

Definition at line 6444 of file DefaultSettings.php.

Referenced by RebuildFileCache\finalSetup(), and Article\view().

◆ $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 2171 of file DefaultSettings.php.

Referenced by ExternalStore\defaultStoresAreReadOnly(), MigrateArchiveText\doDBUpdates(), MediaWikiTestCase\getExternalStoreDatabaseConnections(), ExternalStoreDB\getSlave(), ExternalStore\insertToDefault(), and MediaWikiTestCase\isUsingExternalStoreDB().

◆ $wgDefaultLanguageVariant

◆ $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 7961 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 3279 of file DefaultSettings.php.

Referenced by User\getDefaultOptions(), 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 4856 of file DefaultSettings.php.

Referenced by CleanupPreferences\execute(), MediaWiki\Preferences\DefaultPreferencesFactory\getDateOptions(), User\getDefaultOptions(), and UserTest\testAnonOptions().

◆ $wgDeletedDirectory

$wgDeletedDirectory = false

What directory to place deleted uploads in.

Defaults to "{$wgUploadDirectory}/deleted".

Definition at line 438 of file DefaultSettings.php.

◆ $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 5530 of file DefaultSettings.php.

Referenced by Title\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 6349 of file DefaultSettings.php.

Referenced by MWDebug\deprecated().

◆ $wgDevelopmentWarnings

$wgDevelopmentWarnings = false

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

Definition at line 6342 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), MWDebug\deprecated(), ExtensionRegistry\loadFromQueue(), MWLBFactory\logDeprecation(), and MWDebug\warning().

◆ $wgDiff

$wgDiff = '/usr/bin/diff'

Path to the GNU diff utility.

Definition at line 6614 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 6609 of file DefaultSettings.php.

Referenced by MediaWikiTestCase\markTestSkippedIfNoDiff3(), ParserTestPrinter\quickDiff(), and wfMerge().

◆ $wgDirectoryMode

$wgDirectoryMode = 0777

Default value for chmoding of new directories.

Definition at line 1508 of file DefaultSettings.php.

Referenced by FileBackendGroup\initFromGlobals(), and 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 6991 of file DefaultSettings.php.

Referenced by User\getNewtalk(), 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 6029 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 3085 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 8475 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 6542 of file DefaultSettings.php.

Referenced by SpecialPageFactory\getPageList().

◆ $wgDisableLangConversion

◆ $wgDisableOutputCompression

$wgDisableOutputCompression = false

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

Definition at line 3374 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 2196 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.

Definition at line 7895 of file DefaultSettings.php.

Referenced by UpdateSpecialPages\execute().

◆ $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 6523 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 6456 of file DefaultSettings.php.

◆ $wgDisableTitleConversion

$wgDisableTitleConversion = false

Whether to enable language variant conversion for links.

Definition at line 3063 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 951 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 1532 of file DefaultSettings.php.

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

◆ $wgDjvuOutputExtension

$wgDjvuOutputExtension = 'jpg'

File extension for the DJVU post processor output.

Definition at line 1574 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 1569 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 1539 of file DefaultSettings.php.

Referenced by DjVuSupport\__construct(), DjVuHandler\doTransform(), DjVuHandler\isEnabled(), and DjVuSupport\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 1562 of file DefaultSettings.php.

Referenced by DjVuSupport\__construct(), DjVuHandler\isEnabled(), DjVuSupport\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 1546 of file DefaultSettings.php.

Referenced by DjVuSupport\__construct(), DjVuSupport\isEnabled(), and 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 5615 of file DefaultSettings.php.

Referenced by User\isDnsBlacklisted().

◆ $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 2961 of file DefaultSettings.php.

Referenced by Language\factory(), and WikiStatsOutput\heading().

◆ $wgEdititis

$wgEdititis = false

Display user edit counts in various prominent places.

Definition at line 3484 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 3357 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 3243 of file DefaultSettings.php.

◆ $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 1721 of file DefaultSettings.php.

Referenced by Autopromote\checkCondition(), SpecialPageFactory\getPageList(), 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 5091 of file DefaultSettings.php.

Referenced by Title\checkUserBlock(), LoginSignupSpecialPage\getFakeTemplate(), and LoginSignupSpecialPage\getFieldDefinitions().

◆ $wgEmergencyContact

$wgEmergencyContact = false

Site admin email address.

Defaults to "wikiadmin@$wgServerName".

Definition at line 1590 of file DefaultSettings.php.

◆ $wgEnableAPI

$wgEnableAPI = true

Enable the MediaWiki API for convenient access to machine-readable data via api.php.

See https://www.mediawiki.org/wiki/API

Deprecated:
since 1.31

Definition at line 8037 of file DefaultSettings.php.

Referenced by Skin\getDefaultModules(), DifferenceEngine\getMarkPatrolledLinkInfo(), and Article\showPatrolFooter().

◆ $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 423 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 1263 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 3516 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 5590 of file DefaultSettings.php.

Referenced by User\isDnsBlacklisted().

◆ $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 1620 of file DefaultSettings.php.

Referenced by User\canSendEmail(), LoginSignupSpecialPage\getFakeTemplate(), SpecialPageFactory\getPageList(), and User\setEmailWithConfirmation().

◆ $wgEnableImageWhitelist

$wgEnableImageWhitelist = true

If $wgAllowExternalImages is false, you can allow an on-wiki whitelist 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 whitelist (MediaWiki:External image whitelist) Or false to disable it

Definition at line 4260 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 6429 of file DefaultSettings.php.

Referenced by ResourcesTest\getAllModules(), and SpecialPageFactory\getPageList().

◆ $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 4423 of file DefaultSettings.php.

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

◆ $wgEnableOpenSearchSuggest

$wgEnableOpenSearchSuggest = true

Enable OpenSearch suggestions requested by MediaWiki.

Set this to false if you've disabled scripts that use api?action=opensearch and want reduce load caused by cached scripts still pulling suggestions. It will let the API fallback by responding with an empty array.

Definition at line 6501 of file DefaultSettings.php.

◆ $wgEnableParserCache

$wgEnableParserCache = true

Kept for extension compatibility; see $wgParserCacheType.

Deprecated:
since 1.26

Definition at line 2594 of file DefaultSettings.php.

◆ $wgEnableParserLimitReporting

$wgEnableParserLimitReporting = true

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

Definition at line 7326 of file DefaultSettings.php.

Referenced by ParserOptions\getCanonicalOverrides().

◆ $wgEnableScaryTranscluding

$wgEnableScaryTranscluding = false

Enable interwiki transcluding.

Only when iw_trans=1 in the interwiki table.

Definition at line 4409 of file DefaultSettings.php.

Referenced by Parser\interwikiTransclude().

◆ $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 6596 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 2611 of file DefaultSettings.php.

Referenced by Skin\buildSidebar(), and RebuildMessages\execute().

◆ $wgEnableUploads

$wgEnableUploads = false

Uploads have to be specially set up to be secure.

Definition at line 403 of file DefaultSettings.php.

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

◆ $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 1626 of file DefaultSettings.php.

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

◆ $wgEnableUserEmailBlacklist

$wgEnableUserEmailBlacklist = false

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

Since
1.30

Definition at line 1633 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 2407 of file DefaultSettings.php.

◆ $wgEnableWriteAPI

$wgEnableWriteAPI = true

Allow the API to be used to perform write operations (page edits, rollback, etc.) when an authorised user accesses it.

Deprecated:
since 1.31

Definition at line 8046 of file DefaultSettings.php.

Referenced by Skin\getDefaultModules(), DifferenceEngine\getMarkPatrolledLinkInfo(), and Article\showPatrolFooter().

◆ $wgEnotifFromEditor

$wgEnotifFromEditor = false

True: from page editor if s/he opted-in.

False: Enotif mails appear to come from $wgEmergencyContact

Definition at line 1708 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 1765 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 1771 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 1756 of file DefaultSettings.php.

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

◆ $wgEnotifRevealEditorAddress

$wgEnotifRevealEditorAddress = false

Set the Reply-to address in notifications to the editor's address, if user allowed this in the preferences.

Definition at line 1741 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 1776 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 1735 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 1726 of file DefaultSettings.php.

Referenced by EmailNotification\actuallyNotifyOnPageChange().

◆ $wgEventRelayerConfig

$wgEventRelayerConfig
Initial value:
= [
'default' => [
]
]

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 perfom 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 8773 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 8017 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 1120 of file DefaultSettings.php.

Referenced by JpegHandler\swapICCProfile(), and JpegTest\testSwappingICCProfile().

◆ $wgExiv2Command

$wgExiv2Command = '/usr/bin/exiv2'

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

Definition at line 1113 of file DefaultSettings.php.

Referenced by RandomImageGenerator\getImageWriteMethod(), and RandomImageGenerator\writeImageWithApi().

◆ $wgExpensiveParserFunctionLimit

$wgExpensiveParserFunctionLimit = 100

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

Definition at line 4398 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgExperiencedUserEdits

$wgExperiencedUserEdits = 500

Name of the external diff engine to use.

Supported values:

  • string: path to an external diff executable
  • false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
  • 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility

Definition at line 8847 of file DefaultSettings.php.

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

◆ $wgExperiencedUserMemberSince

$wgExperiencedUserMemberSince = 30

Name of the external diff engine to use.

Supported values:

  • string: path to an external diff executable
  • false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
  • 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility

Definition at line 8848 of file DefaultSettings.php.

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

◆ $wgExperimentalHtmlIds

$wgExperimentalHtmlIds = false

Abandoned experiment with HTML5-style ID escaping.

Normalized IDs a bit too aggressively, breaking preexisting content (particularly Cite). See T29733, T29694, T29474.

Deprecated:
since 1.30, use $wgFragmentMode

Definition at line 3383 of file DefaultSettings.php.

Referenced by Sanitizer\escapeId().

◆ $wgExportAllowAll

$wgExportAllowAll = false

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

Definition at line 7222 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 7187 of file DefaultSettings.php.

◆ $wgExportAllowListContributors

$wgExportAllowListContributors = false

Return distinct author list (when not returning full history)

Definition at line 7199 of file DefaultSettings.php.

◆ $wgExportFromNamespaces

$wgExportFromNamespaces = false

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

Definition at line 7217 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 7194 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 7212 of file DefaultSettings.php.

◆ $wgExportPagelistLimit

$wgExportPagelistLimit = 5000

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

Since
1.27

Definition at line 7230 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 5997 of file DefaultSettings.php.

◆ $wgExtensionAssetsPath

$wgExtensionAssetsPath = false

The URL path of the extensions directory.

Defaults to "{$wgResourceBasePath}/extensions".

Since
1.16

Definition at line 236 of file DefaultSettings.php.

Referenced by ResourceLoaderFileModule\extractBasePaths().

◆ $wgExtensionCredits

$wgExtensionCredits = []

An array of information about installed extensions keyed by their type.

All but 'name', 'path' and 'author' can be omitted.

'path' => __FILE__,
'name' => 'Example extension',
'namemsg' => 'exampleextension-name',
'author' => [
'Foo Barstein',
],
'version' => '1.9.0',
'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).

Definition at line 7410 of file DefaultSettings.php.

Referenced by SpecialVersion\execute(), HHVMMakeRepo\execute(), SpecialVersion\getExtensionCategory(), SpecialVersion\getExtensionCredits(), and SpecialVersion\getSkinCredits().

◆ $wgExtensionDirectory

$wgExtensionDirectory = "{$IP}/extensions"

Filesystem extensions directory.

Defaults to "{$IP}/extensions".

Since
1.25

Definition at line 243 of file DefaultSettings.php.

Referenced by Installer\getExistingLocalSettings(), 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 7305 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 7243 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 2660 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 7271 of file DefaultSettings.php.

◆ $wgExternalDiffEngine

$wgExternalDiffEngine = false

Name of the external diff engine to use.

Supported values:

  • string: path to an external diff executable
  • false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
  • 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility

Definition at line 8451 of file DefaultSettings.php.

Referenced by DifferenceEngine\getEngine().

◆ $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 3425 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 4351 of file DefaultSettings.php.

Referenced by Skin\addToSidebarPlain(), ParserOptions\getDefaults(), Skin\makeFooterIcon(), 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 2155 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 2139 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 3896 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 2929 of file DefaultSettings.php.

Referenced by Parser\replaceInternalLinks2().

◆ $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, and excludes them when running the transstat.php script.

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 2949 of file DefaultSettings.php.

Referenced by WebInstallerLanguage\getLanguageSelector().

◆ $wgExtraLanguageNames

$wgExtraLanguageNames = []

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

Definition at line 2934 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 3888 of file DefaultSettings.php.

Referenced by MWNamespace\getCanonicalNamespaces(), Language\getNamespaces(), Language\needsGenderDistinction(), ApiEditPageTest\setUp(), EditPageTest\setUp(), PagePropsTest\setUp(), and PagePropsTest\tearDown().

◆ $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 4120 of file DefaultSettings.php.

Referenced by MWNamespace\wantSignatures().

◆ $wgFallbackSkin

$wgFallbackSkin = 'fallback'

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

Since
1.24

Definition at line 3286 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 316 of file DefaultSettings.php.

Referenced by LocalRepo\getInfo().

◆ $wgFeed

$wgFeed = true

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

Definition at line 6910 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 6926 of file DefaultSettings.php.

Referenced by ChangesFeed\loadFromCache().

◆ $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 6953 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 6932 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 6916 of file DefaultSettings.php.

◆ $wgFetchCommonsDescriptions

$wgFetchCommonsDescriptions = false

Fetch commons image description pages and display them on the local wiki?

Definition at line 723 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)

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 'wikiId' 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 662 of file DefaultSettings.php.

Referenced by ParserTestRunner\createRepoGroup(), FileBackendGroup\initFromGlobals(), FileBackendTest\setUp(), and StoreBatchTest\setUp().

◆ $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',
# 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 896 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 2588 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 276 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 889 of file DefaultSettings.php.

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

◆ $wgFilterLogTypes

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

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 log-show-hide-[type] should be added, and will be used for the link text.

Definition at line 7698 of file DefaultSettings.php.

Referenced by LogPager\getFilterParams().

◆ $wgFixArabicUnicode

$wgFixArabicUnicode = true

Set this to true to replace Arabic presentation forms with their standard forms in the U+0600-U+06FF block.

This only works if $wgLanguageCode is set to "ar".

Note that pages with titles containing presentation forms will become inaccessible, run maintenance/cleanupTitles.php to fix this.

Definition at line 2971 of file DefaultSettings.php.

Referenced by LanguageAr\normalize().

◆ $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 8498 of file DefaultSettings.php.

◆ $wgFixMalayalamUnicode

$wgFixMalayalamUnicode = true

Set this to true to replace ZWJ-based chillu sequences in Malayalam text with their Unicode 5.1 equivalents.

This only works if $wgLanguageCode is set to "ml". Note that some clients (even new clients as of 2010) do not support these characters.

If you enable this on an existing wiki, run maintenance/cleanupTitles.php to fix any ZWJ sequences in existing page titles.

Definition at line 2982 of file DefaultSettings.php.

Referenced by LanguageMl\normalize().

◆ $wgFooterIcons

$wgFooterIcons
Initial value:
= [
"copyright" => [
"copyright" => [],
],
"poweredby" => [
"mediawiki" => [
"src" => null,
"url" => "//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 3457 of file DefaultSettings.php.

Referenced by Skin\getCopyrightIcon(), and SkinTemplate\prepareQuickTemplate().

◆ $wgForcedRawSMaxage

$wgForcedRawSMaxage = 300

Default maximum age for raw CSS/JS accesses.

300 seconds = 5 minutes.

Definition at line 2759 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.31.9

Definition at line 147 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 3132 of file DefaultSettings.php.

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

◆ $wgForeignFileRepos

$wgForeignFileRepos = []

◆ $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 562 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
  • 'html5-legacy' corresponds to DEPRECATED $wgExperimentalHtmlIds mode. DO NOT use it for anything but migration off that mode (see below).

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 3415 of file DefaultSettings.php.

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

◆ $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 1496 of file DefaultSettings.php.

◆ $wgGenerateThumbnailOnParse

$wgGenerateThumbnailOnParse = true

Allow thumbnail rendering on page view.

If this is false, a valid thumbnail URL is still output, but no file will be created at the target location. This may save some time if you have a thumb.php or 404 handler set up which is faster than the regular webserver(s).

Definition at line 1251 of file DefaultSettings.php.

◆ $wgGitBin

$wgGitBin = '/usr/bin/git'

Fully specified path to git binary.

Definition at line 6701 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 2562 of file DefaultSettings.php.

Referenced by GitInfo\getCacheFilePath().

◆ $wgGitRepositoryViewers

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

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 6716 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 5899 of file DefaultSettings.php.

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

◆ $wgGrantPermissions [1/67]

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 5800 of file DefaultSettings.php.

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

◆ $wgGrantPermissions [2/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5805 of file DefaultSettings.php.

◆ $wgGrantPermissions [3/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5806 of file DefaultSettings.php.

◆ $wgGrantPermissions [4/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5807 of file DefaultSettings.php.

◆ $wgGrantPermissions [5/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5808 of file DefaultSettings.php.

◆ $wgGrantPermissions [6/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5809 of file DefaultSettings.php.

◆ $wgGrantPermissions [7/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5810 of file DefaultSettings.php.

◆ $wgGrantPermissions [8/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5811 of file DefaultSettings.php.

◆ $wgGrantPermissions [9/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5812 of file DefaultSettings.php.

◆ $wgGrantPermissions [10/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5813 of file DefaultSettings.php.

◆ $wgGrantPermissions [11/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5814 of file DefaultSettings.php.

◆ $wgGrantPermissions [12/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5865 of file DefaultSettings.php.

◆ $wgGrantPermissions [13/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5866 of file DefaultSettings.php.

◆ $wgGrantPermissions [14/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5891 of file DefaultSettings.php.

◆ $wgGrantPermissions [15/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5843 of file DefaultSettings.php.

◆ $wgGrantPermissions [16/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5844 of file DefaultSettings.php.

◆ $wgGrantPermissions [17/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5845 of file DefaultSettings.php.

◆ $wgGrantPermissions [18/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5846 of file DefaultSettings.php.

◆ $wgGrantPermissions [19/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5849 of file DefaultSettings.php.

◆ $wgGrantPermissions [20/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5847 of file DefaultSettings.php.

◆ $wgGrantPermissions [21/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5848 of file DefaultSettings.php.

◆ $wgGrantPermissions [22/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5874 of file DefaultSettings.php.

◆ $wgGrantPermissions [23/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5877 of file DefaultSettings.php.

◆ $wgGrantPermissions [24/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5876 of file DefaultSettings.php.

◆ $wgGrantPermissions [25/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5878 of file DefaultSettings.php.

◆ $wgGrantPermissions [26/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5879 of file DefaultSettings.php.

◆ $wgGrantPermissions [27/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5880 of file DefaultSettings.php.

◆ $wgGrantPermissions [28/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5837 of file DefaultSettings.php.

◆ $wgGrantPermissions [29/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5838 of file DefaultSettings.php.

◆ $wgGrantPermissions [30/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5839 of file DefaultSettings.php.

◆ $wgGrantPermissions [31/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5841 of file DefaultSettings.php.

◆ $wgGrantPermissions [32/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5840 of file DefaultSettings.php.

◆ $wgGrantPermissions [33/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5830 of file DefaultSettings.php.

◆ $wgGrantPermissions [34/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5831 of file DefaultSettings.php.

◆ $wgGrantPermissions [35/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5833 of file DefaultSettings.php.

◆ $wgGrantPermissions [36/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5832 of file DefaultSettings.php.

◆ $wgGrantPermissions [37/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5835 of file DefaultSettings.php.

◆ $wgGrantPermissions [38/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5887 of file DefaultSettings.php.

◆ $wgGrantPermissions [39/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5823 of file DefaultSettings.php.

◆ $wgGrantPermissions [40/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5824 of file DefaultSettings.php.

◆ $wgGrantPermissions [41/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5821 of file DefaultSettings.php.

◆ $wgGrantPermissions [42/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5822 of file DefaultSettings.php.

◆ $wgGrantPermissions [43/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5826 of file DefaultSettings.php.

◆ $wgGrantPermissions [44/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5827 of file DefaultSettings.php.

◆ $wgGrantPermissions [45/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5817 of file DefaultSettings.php.

◆ $wgGrantPermissions [46/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5816 of file DefaultSettings.php.

◆ $wgGrantPermissions [47/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5819 of file DefaultSettings.php.

◆ $wgGrantPermissions [48/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5818 of file DefaultSettings.php.

◆ $wgGrantPermissions [49/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5861 of file DefaultSettings.php.

◆ $wgGrantPermissions [50/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5893 of file DefaultSettings.php.

◆ $wgGrantPermissions [51/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5882 of file DefaultSettings.php.

◆ $wgGrantPermissions [52/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5883 of file DefaultSettings.php.

◆ $wgGrantPermissions [53/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5863 of file DefaultSettings.php.

◆ $wgGrantPermissions [54/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5889 of file DefaultSettings.php.

◆ $wgGrantPermissions [55/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5854 of file DefaultSettings.php.

◆ $wgGrantPermissions [56/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5858 of file DefaultSettings.php.

◆ $wgGrantPermissions [57/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5855 of file DefaultSettings.php.

◆ $wgGrantPermissions [58/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5856 of file DefaultSettings.php.

◆ $wgGrantPermissions [59/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5859 of file DefaultSettings.php.

◆ $wgGrantPermissions [60/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5857 of file DefaultSettings.php.

◆ $wgGrantPermissions [61/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5852 of file DefaultSettings.php.

◆ $wgGrantPermissions [62/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5851 of file DefaultSettings.php.

◆ $wgGrantPermissions [63/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5868 of file DefaultSettings.php.

◆ $wgGrantPermissions [64/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5869 of file DefaultSettings.php.

◆ $wgGrantPermissions [65/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5870 of file DefaultSettings.php.

◆ $wgGrantPermissions [66/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5885 of file DefaultSettings.php.

◆ $wgGrantPermissions [67/67]

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

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 5872 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 5123 of file DefaultSettings.php.

Referenced by User\getAllGroups(), AvailableRightsTest\getAllVisibleRights(), User\getGroupPermissions(), User\getGroupsWithPermission(), User\groupHasPermission(), User\isEveryoneAllowed(), TitlePermissionTest\runGroupPermissions(), MediaWikiTestCase\setGroupPermissions(), AbstractChangesListSpecialPageTestCase\setUp(), LocalIdLookupTest\setUp(), UserTest\setUpPermissionGlobals(), AbstractChangesListSpecialPageTestCase\tearDown(), MediaWiki\Auth\AuthManagerTest\testAutoAccountCreation(), ApiBlockTest\testBlockWithHide(), MediaWiki\Auth\AuthManagerTest\testCheckAccountCreatePermissions(), TitlePermissionTest\testQuickPermissions(), and ApiUserrightsTest\testWithoutTagPermission().

◆ $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 5292 of file DefaultSettings.php.

Referenced by User\changeableByGroup().

◆ $wgGroupsRemoveFromSelf

$wgGroupsRemoveFromSelf = []
See also
$wgGroupsAddToSelf

Definition at line 5297 of file DefaultSettings.php.

Referenced by User\changeableByGroup().

◆ $wgHashedSharedUploadDirectory

$wgHashedSharedUploadDirectory = true

Set the following to false especially if you have a set of files that need to be accessible by all wikis, and you do not want to use the hash (path/a/aa/) directory layout.

Definition at line 869 of file DefaultSettings.php.

◆ $wgHashedUploadDirectory

$wgHashedUploadDirectory = true

Set this to false if you do not want MediaWiki to divide your images directory into many subdirectories, for improved performance.

It's almost always good to leave this enabled. In previous versions of MediaWiki, some users set this to false to allow images to be added to the wiki by simply copying them into $wgUploadDirectory and then running maintenance/rebuildImages.php to register them in the database. This is no longer recommended, use maintenance/importImages.php instead.

Note
That this variable may be ignored if $wgLocalFileRepo is set.
Todo:
Deprecate the setting and ultimately remove it from Core.

Definition at line 862 of file DefaultSettings.php.

◆ $wgHiddenPrefs

$wgHiddenPrefs = []

◆ $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 5097 of file DefaultSettings.php.

◆ $wgHideInterlanguageLinks

$wgHideInterlanguageLinks = false

Hide interlanguage links from the sidebar.

Definition at line 2914 of file DefaultSettings.php.

Referenced by SkinTemplate\getLanguages().

◆ $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 5539 of file DefaultSettings.php.

Referenced by SpecialBlock\processForm().

◆ $wgHKDFAlgorithm

$wgHKDFAlgorithm = 'sha256'

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

See also: $wgHKDFSecret

Since
1.24

Definition at line 8655 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 8647 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 7453 of file DefaultSettings.php.

◆ $wgHTCPMulticastTTL

$wgHTCPMulticastTTL = 1

HTCP multicast TTL.

See also
$wgHTCPRouting

Definition at line 2857 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

$wgHTCPRouting replaces $wgHTCPMulticastRouting that was introduced in 1.20. For back compatibility purposes, whenever its array is empty $wgHTCPMutlicastRouting will be used as a fallback if it not null.

See also
$wgHTCPMulticastTTL

Definition at line 2851 of file DefaultSettings.php.

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

◆ $wgHtml5

$wgHtml5 = true

Previously used to determine if we should output an HTML5 doctype.

This is no longer used as we always output HTML5 now. For compatibility with extensions that still check the value of this config it's value is now forced to true by Setup.php.

Deprecated:
since 1.22

Definition at line 3207 of file DefaultSettings.php.

◆ $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 3217 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 3226 of file DefaultSettings.php.

◆ $wgHTTPConnectTimeout

$wgHTTPConnectTimeout = 5e0

Timeout for connections done internally (in seconds) Only works for curl.

Definition at line 8402 of file DefaultSettings.php.

Referenced by MWHttpRequest\__construct(), and Http\createMultiClient().

◆ $wgHTTPImportTimeout

$wgHTTPImportTimeout = 25

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

Since
1.29

Definition at line 8371 of file DefaultSettings.php.

Referenced by ImportStreamSource\newFromURL().

◆ $wgHTTPProxy

$wgHTTPProxy = false

Proxy to use for CURL requests.

Definition at line 8381 of file DefaultSettings.php.

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

◆ $wgHttpsPort

$wgHttpsPort = 443

Port where you have HTTPS running Supports HTTPS on non-standard ports.

See also
T67184
Since
1.24

Definition at line 8620 of file DefaultSettings.php.

Referenced by wfExpandUrl().

◆ $wgHTTPTimeout

int $wgHTTPTimeout = 25

Timeout for HTTP requests done internally, in seconds.

Definition at line 8365 of file DefaultSettings.php.

Referenced by MWHttpRequest\__construct(), and Http\createMultiClient().

◆ $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 1242 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 432 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 1384 of file DefaultSettings.php.

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

◆ $wgImageMagickConvertCommand

$wgImageMagickConvertCommand = '/usr/bin/convert'

◆ $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 1065 of file DefaultSettings.php.

Referenced by BitmapHandler\transformImageMagick().

◆ $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 443 of file DefaultSettings.php.

◆ $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 459 of file DefaultSettings.php.

◆ $wgImplicitGroups

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

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

Definition at line 5269 of file DefaultSettings.php.

Referenced by User\getImplicitGroups().

◆ $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 7171 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 7180 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 3701 of file DefaultSettings.php.

Referenced by ResourceLoaderStartUpModule\getLegacyModules().

◆ $wgInternalServer

$wgInternalServer = false

Internal server name as known to CDN, if different.

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

Definition at line 2713 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 3989 of file DefaultSettings.php.

◆ $wgInterwikiExpiry

$wgInterwikiExpiry = 10800

Expiry time for cache of interwiki table.

Definition at line 3964 of file DefaultSettings.php.

◆ $wgInterwikiFallbackSite

$wgInterwikiFallbackSite = 'wiki'

Fallback site, if unable to resolve from cache.

Definition at line 4002 of file DefaultSettings.php.

◆ $wgInterwikiMagic

$wgInterwikiMagic = true

Treat language links as magic connectors, not inline links.

Definition at line 2909 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 8867 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 3997 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 2643 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 4748 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 4139 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 4930 of file DefaultSettings.php.

Referenced by User\isCreatableName().

◆ $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 7521 of file DefaultSettings.php.

◆ $wgJobClasses

$wgJobClasses
Initial value:
= [
'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,
'cdnPurge' => CdnPurgeJob::class,
'userGroupExpiry' => UserGroupExpiryJob::class,
'clearWatchlistNotifications' => ClearWatchlistNotificationsJob::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.

Definition at line 7476 of file DefaultSettings.php.

Referenced by Job\factory(), JobQueue\pop(), and MediaWikiTestCase\teardownTestDB().

◆ $wgJobQueueAggregator

$wgJobQueueAggregator
Initial value:

Which aggregator to use for tracking which queues have jobs.

These settings should be global to all wikis.

Definition at line 7552 of file DefaultSettings.php.

Referenced by JobQueueAggregator\singleton().

◆ $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 7567 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 8417 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 7536 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 7544 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), JobQueueGroup\get(), JobQueueGroup\getCoalescedQueues(), JobQueueTest\setUp(), 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 7510 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 1107 of file DefaultSettings.php.

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

◆ $wgJpegTran

$wgJpegTran = '/usr/bin/jpegtran'

used for lossless jpeg rotation

Since
1.21

Definition at line 1086 of file DefaultSettings.php.

Referenced by JpegHandler\rotate().

◆ $wgJsMimeType

$wgJsMimeType = null

Previously used as content type in HTML script tags.

This is now ignored since HTML5 doesn't require a MIME type for script tags (javascript is the default). It was also previously used by RawAction to determine the ctype query parameter value that will result in a javascript response.

Deprecated:
since 1.22

Definition at line 3189 of file DefaultSettings.php.

Referenced by SkinTemplate\prepareQuickTemplate().

◆ $wgLangObjCacheSize

$wgLangObjCacheSize = 10

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

Definition at line 2893 of file DefaultSettings.php.

Referenced by Language\factory().

◆ $wgLanguageCode

$wgLanguageCode = 'en'

Site language code.

See languages/data/Names.php for languages supported by MediaWiki out of the box. Not all languages listed there have translations, see languages/messages/ for the list of languages with some localisation.

Warning: Don't use any of MediaWiki's deprecated language codes listed in LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no" for Norwegian (use "nb" instead). If you do, things will break unexpectedly.

This defines the default interface language for all users, but users can change it in their preferences.

This also defines the language of pages in the wiki. The content is wrapped in a html element with lang=XX attribute. This behavior can be overridden via hooks, see Title::getPageLanguage.

Definition at line 2887 of file DefaultSettings.php.

Referenced by CliInstaller\__construct(), CheckLanguageCLI\__construct(), CheckExtensionsCLI\__construct(), ContentHandlerTest\dataGetPageLanguage(), ForeignAPIRepo\fetchImageQuery(), MessageCache\figureMessage(), RebuildLocalisationCache\finalSetup(), WebInstaller\getAcceptLanguage(), Language\getFallbacksIncludingSiteLanguage(), ChangesFeed\getFeedObject(), FeedItem\getLanguage(), MessageCache\getMessagePageName(), Title\getPageLanguage(), Parser\getVariableValue(), Xml\languageSelector(), MessageCache\loadFromDB(), MessageCache\replace(), RequestContext\sanitizeLangCode(), MediaWikiLangTestCase\setUp(), WebInstaller\setupLanguage(), ResourceFileCache\useFileCache(), and wfGetLangObj().

◆ $wgLanguageConverterCacheType

$wgLanguageConverterCacheType = CACHE_ANYTHING

The cache type for storing language conversion tables, which are used when parsing certain text and interface messages.

For available types see $wgMainCacheType.

Since
1.20

Definition at line 2304 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), and LanguageConverter\loadTables().

◆ $wgLBFactoryConf

$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().

The class identified here is responsible for reading $wgDBservers, $wgDBserver, etc., so overriding it may cause those globals to be ignored.

The LBFactoryMulti class is provided for this purpose, please see includes/db/LBFactoryMulti.php for configuration information.

Definition at line 2006 of file DefaultSettings.php.

Referenced by Maintenance\finalSetup().

◆ $wgLearnerEdits

$wgLearnerEdits = 10

The following variables define 3 user experience levels:

  • newcomer: has not yet reached the 'learner' level
  • learner: has at least $wgLearnerEdits and has been a member for $wgLearnerMemberSince days but has not yet reached the 'experienced' level.
  • experienced: has at least $wgExperiencedUserEdits edits and has been a member for $wgExperiencedUserMemberSince days.

Definition at line 8845 of file DefaultSettings.php.

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

◆ $wgLearnerMemberSince

$wgLearnerMemberSince = 4

Name of the external diff engine to use.

Supported values:

  • string: path to an external diff executable
  • false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
  • 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility

Definition at line 8846 of file DefaultSettings.php.

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

◆ $wgLegacyEncoding

$wgLegacyEncoding = false

Set this to eg 'ISO-8859-1' to perform character set conversion when loading old revisions not marked with "utf-8" flag.

Use this when converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the burdensome mass conversion of old text data.

Note
This DOES NOT touch any fields other than old_text. Titles, comments, user names, etc still must be converted en masse in the database before continuing as a UTF-8 wiki.

Definition at line 3006 of file DefaultSettings.php.

◆ $wgLegacyJavaScriptGlobals

$wgLegacyJavaScriptGlobals = true

Whether or not to assign configuration variables to the global window object.

If this is set to false, old code using deprecated variables will no longer work.

Example of legacy code:
if ( window.wgRestrictionEdit ) { ... }
or:
if ( wgIsArticle ) { ... }

Instead, one needs to use mw.config.

Example using mw.config global configuration:
if ( mw.config.exists('wgRestrictionEdit') ) { ... }
or:
if ( mw.config.get('wgIsArticle') ) { ... }

Definition at line 3728 of file DefaultSettings.php.

◆ $wgLegacySchemaConversion

$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'.

This will speed up the conversion step for large sites, but requires that the cur table be kept around for those revisions to remain viewable.

This option affects the updaters only. Any present cur stub revisions will be readable at runtime regardless of this setting.

Definition at line 3025 of file DefaultSettings.php.

Referenced by MysqlUpdater\doSchemaRestructuring().

◆ $wgLegalTitleChars

$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.

Problematic punctuation:

  • []{}|# Are needed for link syntax, never enable these
  • <> Causes problems with HTML escaping, don't use
  • % Enabled by default, minor problems with path to query rewrite rules, see below
  • + Enabled by default, but doesn't work with path to query rewrite rules, corrupted by apache
  • ? Enabled by default, but doesn't work with path to PATH_INFO rewrites

All three of these punctuation problems can be avoided by using an alias, instead of a rewrite rule of either variety.

The problem with % is that when using a path to query rewrite rule, URLs are double-unescaped: once by Apache's path conversion code, and again by PHP. So %253F, for example, becomes "?". Our code does not double-escape to compensate for this, indeed double escaping would break if the double-escaped title was passed in the query string rather than the path. This is a minor security issue because articles can be created such that they are hard to view or edit.

In some rare cases you may wish to remove + for compatibility with old links.

Definition at line 3942 of file DefaultSettings.php.

Referenced by Title\legalChars().

◆ $wgLinkHolderBatchSize

$wgLinkHolderBatchSize = 1000

LinkHolderArray batch size For debugging.

Definition at line 8481 of file DefaultSettings.php.

Referenced by LinkHolderArray\isBig().

◆ $wgLoadScript

$wgLoadScript = false

The URL path to load.php.

Defaults to "{$wgScriptPath}/load.php".

Since
1.17

Definition at line 214 of file DefaultSettings.php.

Referenced by wfScript().

◆ $wgLocalDatabases

$wgLocalDatabases = []

Other wikis on this site, can be administered from a single developer account.

Array numeric key => database name

Definition at line 2094 of file DefaultSettings.php.

Referenced by CleanupSpam\execute(), ClearInterwikiCache\execute(), RebuildMessages\execute(), JobQueueAggregator\findPendingWikiQueues(), WikiMap\getCanonicalServerInfoForAllWikis(), LocalIdLookup\isAttached(), JobQueueGroup\singleton(), and UserRightsProxy\validDatabase().

◆ $wgLocalFileRepo

$wgLocalFileRepo = false

File repository structures.

$wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is an array of such structures. Each repository structure is an associative array of properties configuring the repository.

Properties required for all repos:

  • class The class name for the repository. May come from the core or an extension. The core repository classes are FileRepo, LocalRepo, ForeignDBRepo.
  • name A unique name for the repository (but $wgLocalFileRepo should be 'local'). The name should consist of alpha-numeric characters.
  • backend A file backend name (see $wgFileBackends).

For most core repos:

  • zones Associative array of zone names that each map to an array with: container : backend container name the zone is in directory : root path within container for the zone url : base URL to the root of the zone urlsByExt : map of file extension types to base URLs (useful for using a different cache for videos) Zones default to using "<repo name>-<zone name>" as the container name and default to using the container root as the zone's root directory. Nesting of zone locations within other zones should be avoided.
  • url Public zone URL. The 'zones' settings take precedence.
  • hashLevels The number of directory levels for hash-based division of files
  • thumbScriptUrl The URL for thumb.php (optional, not recommended)
  • transformVia404 Whether to skip media file transformation on parse and rely on a 404 handler instead.
  • initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames implicitly start with a capital letter. The current implementation may give incorrect description page links when the local $wgCapitalLinks and initialCapital are mismatched.
  • pathDisclosureProtection May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchanged, or 'simple' to replace paths with placeholders. Default for LocalRepo is 'simple'.
  • fileMode This allows wikis to set the file mode when uploading/moving files. Default is 0644.
  • directory The local filesystem directory where public files are stored. Not used for some remote repos.
  • thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
  • thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
  • isPrivate Set this if measures should always be taken to keep the files private. One should not trust this to assure that the files are not web readable; the server configuration should be done manually depending on the backend.

These settings describe a foreign MediaWiki installation. They are optional, and will be ignored for local repositories:

  • descBaseUrl URL of image description pages, e.g. https://en.wikipedia.org/wiki/File:
  • scriptDirUrl URL of the MediaWiki installation, equivalent to $wgScriptPath, e.g. https://en.wikipedia.org/w
  • articleUrl Equivalent to $wgArticlePath, e.g. https://en.wikipedia.org/wiki/$1
  • fetchDescription Fetch the text of the remote file description page. Equivalent to $wgFetchCommonsDescriptions.
  • abbrvThreshold File names over this size will use the short form of thumbnail names. Short thumbnail names only have the width, parameters, and the extension.

ForeignDBRepo:

  • dbType, dbServer, dbUser, dbPassword, dbName, dbFlags equivalent to the corresponding member of $wgDBservers
  • tablePrefix Table prefix, the foreign wiki's $wgDBprefix
  • hasSharedCache True if the wiki's shared cache is accessible via the local $wgMemc

ForeignAPIRepo:

  • apibase Use for the foreign API's URL
  • apiThumbCacheExpiry How long to locally cache thumbs for

If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values. Otherwise, set $wgLocalFileRepo to a repository structure as described above. If you set $wgUseInstantCommons to true, it will add an entry for Commons. If you set $wgForeignFileRepos to an array of repository structures, those will be searched after the local file repo. Otherwise, you will only have access to local media files.

See also
Setup.php for an example usage and default initialization.

Definition at line 539 of file DefaultSettings.php.

Referenced by ForeignAPIRepo\__construct(), FileBackendGroup\initFromGlobals(), and RepoGroup\singleton().

◆ $wgLocalInterwiki

$wgLocalInterwiki = false

The interwiki prefix of the current wiki, or false if it doesn't have one.

Deprecated:
since 1.23; use $wgLocalInterwikis instead

Definition at line 3949 of file DefaultSettings.php.

◆ $wgLocalInterwikis

$wgLocalInterwikis = []

Array for multiple $wgLocalInterwiki values, in case there are several interwiki prefixes that point to the current wiki.

If $wgLocalInterwiki is set, its value is prepended to this array, for backwards compatibility.

Note, recent changes feeds use only the first entry in this array (or $wgLocalInterwiki, if it is set). See $wgRCFeeds

Definition at line 3959 of file DefaultSettings.php.

Referenced by IRCColourfulRCFeedFormatter\getLine().

◆ $wgLocalisationCacheConf

$wgLocalisationCacheConf
Initial value:
= [
'store' => 'detect',
'storeClass' => false,
'storeDirectory' => false,
'manualRecache' => false,
]

Localisation cache configuration.

Associative array with keys: class: The class to use. May be overridden by extensions.

store: The location to store cache data. May be 'files', 'array', 'db' or 'detect'. If set to "files", data will be in CDB files. If set to "db", data will be stored to the database. If set to "detect", files will be used if $wgCacheDirectory is set, otherwise the database will be used. "array" is an experimental option that uses PHP files that store static arrays.

storeClass: The class name for the underlying storage. If set to a class name, it overrides the "store" setting.

storeDirectory: If the store class puts its data in files, this is the directory it will use. If this is false, $wgCacheDirectory will be used.

manualRecache: Set this to true to disable cache updates on web requests. Use maintenance/rebuildLocalisationCache.php instead.

Definition at line 2535 of file DefaultSettings.php.

Referenced by UpdateMediaWiki\afterFinalSetup(), TestSetup\applyInitialConfig(), RebuildLocalisationCache\execute(), DumpIterator\finalSetup(), Language\getLocalisationCache(), and DatabaseUpdater\purgeCache().

◆ $wgLocalStylePath

$wgLocalStylePath = false

The URL path of the skins directory.

Should not point to an external domain. Defaults to "{$wgScriptPath}/skins".

Since
1.17

Definition at line 229 of file DefaultSettings.php.

◆ $wgLocaltimezone

$wgLocaltimezone = null

Fake out the timezone that the server thinks it's in.

This will be used for date display and not for what's stored in the DB. Leave to null to retain your server's OS-based timezone value.

This variable is currently used only for signature formatting and for local time/date parser variables ({{LOCALTIME}} etc.)

Timezones can be translated by editing MediaWiki messages of type timezone-nameinlowercase like timezone-utc.

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

Examples:
$wgLocaltimezone = 'PST8PDT';
$wgLocaltimezone = 'Europe/Sweden';

Definition at line 3157 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), and MWTimestamp\getLocalInstance().

◆ $wgLocalTZoffset

$wgLocalTZoffset = null

Set an offset from UTC in minutes to use for the default timezone setting for anonymous users and new user accounts.

This setting is used for most date/time displays in the software, and is overridable in user preferences. It is not used for signature timestamps.

By default, this will be set to match $wgLocaltimezone.

Definition at line 3168 of file DefaultSettings.php.

Referenced by MWTimestamp\offsetForUser(), TitlePermissionTest\testUserBlock(), and Language\userAdjust().

◆ $wgLocalVirtualHosts

$wgLocalVirtualHosts = []

Local virtual hosts.

This lists domains that are configured as virtual hosts on the same machine.

This affects the following:

  • MWHttpRequest: If a request is to be made to a domain listed here, or any subdomain thereof, then no proxy will be used. Command-line scripts are not affected by this setting and will always use the proxy if it is configured.
Since
1.25

Definition at line 8396 of file DefaultSettings.php.

Referenced by MWHttpRequest\isLocalURL().

◆ $wgLockManagers

$wgLockManagers = []

Array of configuration arrays for each lock manager.

Each backend configuration has the following parameters:

  • 'name' : A unique name for the lock manager
  • 'class' : The lock manger class to use

See LockManager::__construct() for more details. Additional parameters are specific to the lock manager class used. These settings should be global to all wikis.

When using DBLockManager, the 'dbsByBucket' map can reference 'localDBMaster' as a peer database in each bucket. This will result in an extra connection to the domain that the LockManager services, which must also be a valid wiki ID.

Definition at line 678 of file DefaultSettings.php.

Referenced by LockManagerGroup\initFromGlobals().

◆ $wgLogActions

$wgLogActions = []

Lists the message key string for formatting individual events of each type and action when listed in the logs.

Extensions with custom log types may add to this array.

Definition at line 7755 of file DefaultSettings.php.

Referenced by LogPage\actionText().

◆ $wgLogActionsHandlers

$wgLogActionsHandlers

The same as above, but here values are names of classes, not messages.

See also
LogPage::actionText
LogFormatter

Definition at line 7763 of file DefaultSettings.php.

Referenced by LogPage\actionText(), and LogFormatter\newFromEntry().

◆ $wgLogExceptionBacktrace

$wgLogExceptionBacktrace = true

If true, send the exception backtrace to the error log.

Definition at line 6318 of file DefaultSettings.php.

Referenced by MediaWiki\Logger\LegacyLogger\format(), and MWExceptionHandler\getStructuredExceptionData().

◆ $wgLogHeaders

$wgLogHeaders
Initial value:
= [
'' => 'alllogstext',
'block' => 'blocklogtext',
'delete' => 'dellogpagetext',
'import' => 'importlogpagetext',
'merge' => 'mergelogpagetext',
'move' => 'movelogpagetext',
'patrol' => 'patrol-log-header',
'protect' => 'protectlogtext',
'rights' => 'rightslogtext',
'suppress' => 'suppressionlogtext',
'upload' => 'uploadlogpagetext',
]

Lists the message key string for descriptive text to be shown at the top of each log type.

Extensions with custom log types may add to this array.

Since
1.19, if you follow the naming convention log-description-TYPE, where TYPE is your log type, yoy don't need to use this array.

Definition at line 7735 of file DefaultSettings.php.

Referenced by LogPage\getDescription().

◆ $wgLoginLanguageSelector

$wgLoginLanguageSelector = false

Show a bar of language selection links in the user login and user registration forms; edit the "loginlanguagelinks" message to customise these.

Definition at line 3111 of file DefaultSettings.php.

Referenced by LoginSignupSpecialPage\getPageHtml().

◆ $wgLogNames

$wgLogNames
Initial value:
= [
'' => 'all-logs-page',
'block' => 'blocklogpage',
'protect' => 'protectlogpage',
'rights' => 'rightslog',
'delete' => 'dellogpage',
'upload' => 'uploadlogpage',
'move' => 'movelogpage',
'import' => 'importlogpage',
'patrol' => 'patrol-log-page',
'merge' => 'mergelog',
'suppress' => 'suppressionlog',
]

Lists the message key string for each log type.

The localized messages will be listed in the user interface.

Extensions with custom log types may add to this array.

Since
1.19, if you follow the naming convention log-name-TYPE, where TYPE is your log type, yoy don't need to use this array.

Definition at line 7712 of file DefaultSettings.php.

Referenced by LogPage\getName().

◆ $wgLogo

$wgLogo = false

The URL path of the wiki logo.

The logo size should be 135x135 pixels. Defaults to "$wgResourceBasePath/resources/assets/wiki.png".

Definition at line 282 of file DefaultSettings.php.

Referenced by Skin\getLogo(), and SkinTemplate\prepareQuickTemplate().

◆ $wgLogoHD

$wgLogoHD = false

Array with URL paths to HD versions of the wiki logo.

The scaled logo size should be under 135x155 pixels. Only 1.5x and 2x versions are supported.

Example:
"1.5x" => "path/to/1.5x_version.png",
"2x" => "path/to/2x_version.png"
];

SVG is also supported but when enabled, it disables 1.5x and 2x as svg will already be optimised for screen resolution.

Example:
"svg" => "path/to/svg_version.svg",
];
Since
1.25

Definition at line 310 of file DefaultSettings.php.

◆ $wgLogRestrictions

$wgLogRestrictions
Initial value:
= [
'suppress' => 'suppressionlog'
]

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.

Definition at line 7675 of file DefaultSettings.php.

Referenced by LogEventsList\getExcludeClause(), LogPage\getRestriction(), LogPager\limitType(), RecentChange\notifyLog(), RebuildRecentchanges\rebuildRecentChangesTablePass3(), and LogPage\saveContent().

◆ $wgLogTypes

$wgLogTypes
Initial value:
= [
'',
'block',
'protect',
'rights',
'delete',
'upload',
'move',
'import',
'patrol',
'merge',
'suppress',
'tag',
'managetags',
'contentmodel',
]

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.

Definition at line 7651 of file DefaultSettings.php.

Referenced by RebuildRecentchanges\rebuildRecentChangesTablePass3(), and LogPage\validTypes().

◆ $wgMainCacheType

$wgMainCacheType = CACHE_NONE

Main cache type.

This should be a cache with fast access, but it may have limited space. By default, it is disabled, since the stock database cache is not fast enough to make it worthwhile.

The options are:

  • CACHE_ANYTHING: Use anything, as long as it works
  • CACHE_NONE: Do not cache
  • CACHE_DB: Store cache objects in the DB
  • CACHE_MEMCACHED: MemCached, must specify servers in $wgMemCachedServers
  • CACHE_ACCEL: APC, APCU or WinCache
  • (other): A string may be used which identifies a cache configuration in $wgObjectCaches.
See also
$wgMessageCacheType, $wgParserCacheType

Definition at line 2271 of file DefaultSettings.php.

◆ $wgMainStash

$wgMainStash = 'db-replicated'

Main object stash type.

This should be a fast storage system for storing lightweight data like hit counters and user activity. Sites with multiple data-centers should have this use a store that replicates all writes. The store should have enough consistency for CAS operations to be usable. Reads outside of those needed for merge() may be eventually consistent.

The options are:

  • db: Store cache objects in the DB
  • (other): A string may be used which identifies a cache configuration in $wgObjectCaches
Since
1.26

Definition at line 2423 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig().

◆ $wgMainWANCache

$wgMainWANCache = false

Main Wide-Area-Network cache type.

This should be a cache with fast access, but it may have limited space. By default, it is disabled, since the basic stock cache is not fast enough to make it worthwhile. For single data-center setups, this can simply be pointed to a cache in $wgWANObjectCaches that uses a local $wgObjectCaches cache with a relayer of type EventRelayerNull.

The options are:

  • false: Configure the cache using $wgMainCacheType, without using a relayer (only matters if there are multiple data-centers)
  • CACHE_NONE: Do not cache
  • (other): A string may be used which identifies a cache configuration in $wgWANObjectCaches
    Since
    1.26

Definition at line 2364 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig().

◆ $wgMangleFlashPolicy

$wgMangleFlashPolicy = true

When OutputHandler is used, mangle any output that contains <cross-domain-policy>.

Without this, an attacker can send their own cross-domain policy unless it is prevented by the crossdomain.xml file at the domain root.

Since
1.25

Definition at line 3526 of file DefaultSettings.php.

Referenced by MediaWiki\OutputHandler\handle().

◆ $wgMaxAnimatedGifArea

$wgMaxAnimatedGifArea = 1.25e7

Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnail.

As of MW 1.17 this limit is checked against the total size of all frames in the animation. It probably makes sense to keep this equal to $wgMaxImageArea.

Definition at line 1198 of file DefaultSettings.php.

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

◆ $wgMaxArticleSize

$wgMaxArticleSize = 2048

Maximum article size in kilobytes.

Definition at line 2221 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults(), User\getStubThreshold(), and WikiImporter\processRevision().

◆ $wgMaxCredits

$wgMaxCredits = 0

Set this to the number of authors that you want to be credited below an article text.

Set it to zero to hide the attribution block, and a negative number (like -1) to show all authors. Note that this will require 2-3 extra database hits, which can have a not insignificant impact on performance for large wikis.

Definition at line 7134 of file DefaultSettings.php.

Referenced by SkinTemplate\prepareQuickTemplate().

◆ $wgMaxGeneratedPPNodeCount

$wgMaxGeneratedPPNodeCount = 1000000

A complexity limit on template expansion: the maximum number of elements generated by Preprocessor::preprocessToObj().

This allows you to limit the amount of memory used by the Preprocessor_DOM node cache: testing indicates that each element uses about 160 bytes of memory on a 64-bit processor, so this default corresponds to about 155 MB.

When the limit is exceeded, an exception is thrown.

Definition at line 4195 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgMaxImageArea

$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.

This provides a limit on memory usage for the decompression side of the image scaler. The limit is used when scaling PNGs with any of the built-in image scalers, such as ImageMagick or GD. It is ignored for JPEGs with ImageMagick, and when using the VipsScaler extension.

The default is 50 MB if decompressed to RGBA form, which corresponds to 12.5 million pixels or 3500x3500.

Definition at line 1190 of file DefaultSettings.php.

Referenced by TransformationalImageHandler\doTransform(), and TransformationalImageHandler\isImageAreaOkForThumbnaling().

◆ $wgMaximalPasswordLength

$wgMaximalPasswordLength = false

Specifies the maximal length of a user password (T64685).

It is not recommended to make this greater than the default, as it can allow DoS attacks by users setting really long passwords. In addition, this should not be lowered too much, as it enforces weak passwords.

Warning
Unlike other password settings, user with passwords greater than the maximum will not be able to log in.
Deprecated:
since 1.26, use $wgPasswordPolicy's MaximalPasswordLength.

Definition at line 4741 of file DefaultSettings.php.

◆ $wgMaximumMovedPages

$wgMaximumMovedPages = 100

Maximum number of pages to move at once when moving subpages with a page.

Definition at line 8492 of file DefaultSettings.php.

Referenced by Title\moveSubpages().

◆ $wgMaxInterlacingAreas

$wgMaxInterlacingAreas = []

Array of max pixel areas for interlacing per MIME type.

Since
1.27

Definition at line 1049 of file DefaultSettings.php.

Referenced by BitmapHandler\normaliseParams().

◆ $wgMaxJobDBWriteDuration

$wgMaxJobDBWriteDuration = false

Name of the external diff engine to use.

Supported values:

  • string: path to an external diff executable
  • false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
  • 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility

Definition at line 8752 of file DefaultSettings.php.

◆ $wgMaxMsgCacheEntrySize

$wgMaxMsgCacheEntrySize = 10000

Maximum entry size in the message cache, in bytes.

Definition at line 3053 of file DefaultSettings.php.

Referenced by MessageCache\loadFromDB(), and MessageCache\replace().

◆ $wgMaxNameChars

$wgMaxNameChars = 255

Maximum number of bytes in username.

You want to run the maintenance script ./maintenance/checkUsernames.php once you have changed this value.

Definition at line 4829 of file DefaultSettings.php.

Referenced by User\isValidUserName().

◆ $wgMaxPPExpandDepth

$wgMaxPPExpandDepth = 40
See also
$wgMaxTemplateDepth

Definition at line 4208 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgMaxPPNodeCount

$wgMaxPPNodeCount = 1000000

A complexity limit on template expansion: the maximum number of nodes visited by PPFrame::expand()

Definition at line 4184 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgMaxRedirectLinksRetrieved

$wgMaxRedirectLinksRetrieved = 500

Maximum number of links to a redirect page listed on Special:Whatlinkshere/RedirectDestination.

Definition at line 7907 of file DefaultSettings.php.

◆ $wgMaxRedirects

$wgMaxRedirects = 1

Max number of redirects to follow when resolving redirects.

1 means only the first redirect is followed (default behavior). 0 or less means no redirects are followed.

Definition at line 4127 of file DefaultSettings.php.

Referenced by AbstractContent\getRedirectChain(), and WikitextContent\getRedirectTargetAndText().

◆ $wgMaxShellFileSize

$wgMaxShellFileSize = 102400

Maximum file size created by shell processes under linux, in KB ImageMagick convert for example can be fairly hungry for scratch space.

Definition at line 8259 of file DefaultSettings.php.

◆ $wgMaxShellMemory

$wgMaxShellMemory = 307200

Maximum amount of virtual memory available to shell processes under linux, in KB.

Definition at line 8253 of file DefaultSettings.php.

◆ $wgMaxShellTime

$wgMaxShellTime = 180

Maximum CPU time in seconds for shell processes under Linux.

Definition at line 8264 of file DefaultSettings.php.

◆ $wgMaxShellWallClockTime

$wgMaxShellWallClockTime = 180

Maximum wall clock time (i.e.

real time, of the kind the clock on the wall would measure) in seconds for shell processes under Linux

Definition at line 8270 of file DefaultSettings.php.

◆ $wgMaxSigChars

$wgMaxSigChars = 255

Maximum number of Unicode characters in signature.

Definition at line 4823 of file DefaultSettings.php.

Referenced by PPFuzzTest\__construct(), and Parser\getUserSig().

◆ $wgMaxTemplateDepth

$wgMaxTemplateDepth = 40

Maximum recursion depth for templates within templates.

The current parser adds two levels to the PHP call stack for each template, and xdebug limits the call stack to 100 by default. So this should hopefully stop the parser before it hits the xdebug limit.

Definition at line 4203 of file DefaultSettings.php.

Referenced by ParserOptions\getDefaults().

◆ $wgMaxTocLevel

$wgMaxTocLevel = 999

Maximum indent level of toc.

Definition at line 4178 of file DefaultSettings.php.

Referenced by Parser\formatHeadings().

◆ $wgMaxUploadSize

$wgMaxUploadSize = 1024 * 1024 * 100

Max size for uploads, in bytes.

If not set to an array, applies to all uploads. If set to an array, per upload type maximums can be set, using the file and url keys. If the * key is set this value will be used as maximum for non-specified types.

Example:
'*' => 250 * 1024,
'url' => 500 * 1024,
];
Sets the maximum for all uploads to 250 kB except for upload-by-url, which will have a maximum of 500 kB.

Definition at line 802 of file DefaultSettings.php.

Referenced by UploadBase\getMaxUploadSize().

◆ $wgMaxUserDBWriteDuration

$wgMaxUserDBWriteDuration = false

Name of the external diff engine to use.

Supported values:

  • string: path to an external diff executable
  • false: wikidiff2 PHP/HHVM module if installed, otherwise the default PHP implementation
  • 'wikidiff', 'wikidiff2', and 'wikidiff3' are treated as false for backwards compatibility

Definition at line 8743 of file DefaultSettings.php.

◆ $wgMediaHandlers

$wgMediaHandlers = []

Plugins for media file type handling.

Each entry in the array maps a MIME type to a class name

Core media handlers are listed in MediaHandlerFactory, and extensions should use extension.json.

Definition at line 984 of file DefaultSettings.php.

◆ $wgMemCachedDebug

$wgMemCachedDebug = false

If enabled, will send MemCached debugging information to $wgDebugLogFile.

Definition at line 2474 of file DefaultSettings.php.

◆ $wgMemCachedPersistent

$wgMemCachedPersistent = false

Use persistent connections to MemCached, which are shared across multiple requests.

Definition at line 2485 of file DefaultSettings.php.

◆ $wgMemCachedServers

$wgMemCachedServers = [ '127.0.0.1:11211' ]

The list of MemCached servers and port numbers.

Definition at line 2479 of file DefaultSettings.php.

◆ $wgMemCachedTimeout

$wgMemCachedTimeout = 500000

Read/write timeout for MemCached server communication, in microseconds.

Definition at line 2490 of file DefaultSettings.php.

Referenced by McTest\execute().

◆ $wgMemoryLimit

$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.

Definition at line 2227 of file DefaultSettings.php.

Referenced by wfMemoryLimit().

◆ $wgMessageCacheType

$wgMessageCacheType = CACHE_ANYTHING

The cache type for storing the contents of the MediaWiki namespace.

This cache is used for a small amount of data which is expensive to regenerate.

For available types see $wgMainCacheType.

Definition at line 2279 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), ObjectCache\newAnything(), and wfGetMessageCacheStorage().

◆ $wgMessagesDirs

$wgMessagesDirs = []

Extension messages directories.

Associative array mapping extension name to the path of the directory where message files can be found. The message files are expected to be JSON files named for their language code, e.g. en.json, de.json, etc. Extensions with messages in multiple places may specify an array of message directories.

Message directories in core should be added to LocalisationCache::getMessagesDirs()

Simple example:
$wgMessagesDirs['Example'] = __DIR__ . '/i18n';
Complex example:
$wgMessagesDirs['Example'] = [
__DIR__ . '/lib/ve/i18n',
__DIR__ . '/lib/oojs-ui/i18n',
__DIR__ . '/i18n',
]
Since
1.23

Definition at line 7298 of file DefaultSettings.php.

Referenced by UpdateMediaWiki\execute().

◆ $wgMetaNamespace

$wgMetaNamespace = false

Name of the project namespace.

If left set to false, $wgSitename will be used instead.

Definition at line 3851 of file DefaultSettings.php.

Referenced by Language\fixVariableInNamespace(), Language\getNamespaces(), ApiQueryTest\testTitlesGetNormalized(), and wfInstallerMain().

◆ $wgMetaNamespaceTalk

$wgMetaNamespaceTalk = false

Name of the project talk namespace.

Normally you can ignore this and it will be something like $wgMetaNamespace . "_talk". In some languages, you may want to set this manually for grammatical reasons.

Definition at line 3860 of file DefaultSettings.php.

Referenced by Language\getNamespaces().

◆ $wgMimeDetectorCommand

$wgMimeDetectorCommand = null

Sets an external MIME detector program.

The command must print only the MIME type to standard output. The name of the file to process will be appended to the command given here. If not set or NULL, PHP's mime_content_type function will be used.

Example:
#$wgMimeDetectorCommand = "file -bi"; # use external MIME detector (Linux)

Definition at line 1355 of file DefaultSettings.php.

◆ $wgMimeInfoFile

$wgMimeInfoFile = 'includes/mime.info'

Sets the MIME type info file to use by MimeMagic.php.

Set to null, to use built-in defaults only.

Definition at line 1342 of file DefaultSettings.php.

◆ $wgMimeType

$wgMimeType = 'text/html'

◆ $wgMimeTypeBlacklist

$wgMimeTypeBlacklist
Initial value:
= [
# HTML may contain cookie-stealing JavaScript and web bugs
'text/html', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
# PHP scripts may execute arbitrary code on the server
'application/x-php', 'text/x-php',
# Other types that may be interpreted by some servers
'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
# Client-side hazards on Internet Explorer
'text/scriptlet', 'application/x-msdownload',
# Windows metafile, client-side vulnerability on some systems
'application/x-msmetafile',
]

Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled.

Definition at line 910 of file DefaultSettings.php.

Referenced by StreamFile\contentTypeFromPath(), and UploadBase\verifyMimeType().

◆ $wgMimeTypeFile

$wgMimeTypeFile = 'includes/mime.types'

Sets the MIME type definition file to use by MimeMagic.php.

Set to null, to use built-in defaults only. example: $wgMimeTypeFile = '/etc/mime.types';

Definition at line 1336 of file DefaultSettings.php.

◆ $wgMinimalPasswordLength

$wgMinimalPasswordLength = false

Specifies the minimal length of a user password.

If set to 0, empty pass- words are allowed.

Deprecated:
since 1.26, use $wgPasswordPolicy's MinimalPasswordLength.

Definition at line 4728 of file DefaultSettings.php.

Referenced by User\randomPassword().

◆ $wgMinUploadChunkSize

$wgMinUploadChunkSize = 1024

Minimum upload chunk size, in bytes.

When using chunked upload, non-final chunks smaller than this will be rejected. May be reduced based on the 'upload_max_filesize' or 'post_max_size' PHP settings.

Since
1.26

Definition at line 810 of file DefaultSettings.php.

◆ $wgMiserMode

◆ $wgMsgCacheExpiry

$wgMsgCacheExpiry = 86400

Expiry time for the message cache key.

Definition at line 3048 of file DefaultSettings.php.

Referenced by MessageCache\singleton().

◆ $wgMWLoggerDefaultSpi

array $wgMWLoggerDefaultSpi
Initial value:

Default service provider for creating Psr\Log\LoggerInterface instances.

The value should be an array suitable for use with ObjectFactory::getObjectFromSpec(). The created object is expected to implement the MediaWiki\Logger\Spi interface. See ObjectFactory for additional details.

Alternately the MediaWiki\Logger\LoggerFactory::registerProvider method can be called to inject an MediaWiki\Logger\Spi instance into the LoggerFactory and bypass the use of this configuration variable entirely.

To completely disable logging:
Since
1.25
See also
MwLogger

Definition at line 6263 of file DefaultSettings.php.

Referenced by MediaWiki\Logger\LoggerFactory\getProvider().

◆ $wgNamespaceAliases

$wgNamespaceAliases = []

Namespace aliases.

These are alternate names for the primary localised namespace names, which are defined by $wgExtraNamespaces and the language file. If a page is requested with such a prefix, the request will be redirected to the primary name.

Set this to a map from namespace names to IDs.

Example:
'Wikipedian' => NS_USER,
'Help' => 100,
];

Definition at line 3916 of file DefaultSettings.php.

Referenced by NamespaceConflictChecker\checkAll(), Language\getNamespaceIds(), and UploadFromUrlTestSuite\setUp().

◆ $wgNamespaceContentModels

$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).

If no special content type is defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT (except for the special case of JS and CS pages).

Since
1.21

Definition at line 8553 of file DefaultSettings.php.

Referenced by MediaWikiTestCase\getDefaultWikitextNS(), MWNamespace\getNamespaceContentModel(), MediaWikiTestCase\isWikitextNS(), ApiEditPageTest\setUp(), EditPageTest\setUp(), PagePropsTest\setUp(), and PagePropsTest\tearDown().

◆ $wgNamespaceProtection

$wgNamespaceProtection = []

Set the minimum permissions required to edit pages in each namespace.

If you list more than one permission, a user must have all of them to edit pages in that namespace.

Note
NS_MEDIAWIKI is implicitly restricted to 'editinterface'.

Definition at line 5353 of file DefaultSettings.php.

Referenced by MWNamespace\getRestrictionLevels(), Title\isNamespaceProtected(), UploadFromUrlTestSuite\setUp(), and TitlePermissionTest\testSpecialsAndNSPermissions().

◆ $wgNamespaceRobotPolicies

$wgNamespaceRobotPolicies = []

Robot policies per namespaces.

The default policy is given above, the array is made of namespace constants as defined in includes/Defines.php. You can- not specify a different default policy for NS_SPECIAL: it is always noindex, nofollow. This is because a number of special pages (e.g., ListPages) have many permutations of options that display the same data under redundant URLs, so search engine spiders risk getting lost in a maze of twisty special pages, all alike, and never reaching your actual content.

Example:

Definition at line 7977 of file DefaultSettings.php.

Referenced by Article\getRobotPolicy().

◆ $wgNamespacesToBeSearchedDefault

$wgNamespacesToBeSearchedDefault
Initial value:
= [
NS_MAIN => true,
]

List of namespaces which are searched by default.

Example:

Definition at line 6534 of file DefaultSettings.php.

Referenced by User\getDefaultOptions().

◆ $wgNamespacesWithSubpages

$wgNamespacesWithSubpages
Initial value:
= [
NS_TALK => true,
NS_USER => true,
NS_USER_TALK => true,
NS_PROJECT => true,
NS_PROJECT_TALK => true,
NS_FILE_TALK => true,
NS_MEDIAWIKI => true,
NS_TEMPLATE => true,
NS_HELP => true,
NS_HELP_TALK => true,
]

Which namespaces should support subpages? See Language.php for a list of namespaces.

Definition at line 4064 of file DefaultSettings.php.

Referenced by MWNamespace\hasSubpages(), MWNamespaceTest\testHasSubpages(), and ApiMoveTest\testMoveSubpages().

◆ $wgNewPasswordExpiry

$wgNewPasswordExpiry = 3600 * 24 * 7

The time, in seconds, when an emailed temporary password expires.

Definition at line 1655 of file DefaultSettings.php.

◆ $wgNewUserLog

$wgNewUserLog = true

Maintain a log of newusers at Log/newusers?

Definition at line 7877 of file DefaultSettings.php.

◆ $wgNoFollowDomainExceptions

$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.

For instance:

$wgNoFollowDomainExceptions = [ 'en.wikipedia.org', 'wiktionary.org', 'mediawiki.org' ];

This would add rel="nofollow" to links to de.wikipedia.org, but not en.wikipedia.org, wiktionary.org, en.wiktionary.org, us.en.wikipedia.org, etc.

Defaults to mediawiki.org for the links included in the software by default.

Definition at line 4380 of file DefaultSettings.php.

Referenced by Skin\addToSidebarPlain(), and Parser\getExternalLinkRel().

◆ $wgNoFollowLinks

$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.

Definition at line 4359 of file DefaultSettings.php.

Referenced by Skin\addToSidebarPlain(), and Parser\getExternalLinkRel().

◆ $wgNoFollowNsExceptions

$wgNoFollowNsExceptions = []

Namespaces in which $wgNoFollowLinks doesn't apply.

See Language.php for a list of namespaces.

Definition at line 4365 of file DefaultSettings.php.

Referenced by Parser\getExternalLinkRel().

◆ $wgNonincludableNamespaces

$wgNonincludableNamespaces = []

Pages in namespaces in this array can not be used as templates.

Elements MUST be numeric namespace ids, you can safely use the MediaWiki namespaces constants (NS_USER, NS_MAIN...).

Among other things, this may be useful to enforce read-restrictions which may otherwise be bypassed by using the template mechanism.

Definition at line 5364 of file DefaultSettings.php.

Referenced by MWNamespace\isNonincludable(), and MWNamespaceTest\testIsNonincludable().

◆ $wgNoReplyAddress

$wgNoReplyAddress = false

Reply-To address for e-mail notifications.

Defaults to $wgPasswordSender.

Definition at line 1613 of file DefaultSettings.php.

Referenced by EmailNotification\composeCommonMailtext().

◆ $wgObjectCaches

$wgObjectCaches
Initial value:
= [
CACHE_NONE => [ 'class' => EmptyBagOStuff::class, 'reportDupes' => false ],
CACHE_DB => [ 'class' => SqlBagOStuff::class, 'loggroup' => 'SQLBagOStuff' ],
CACHE_ANYTHING => [ 'factory' => 'ObjectCache::newAnything' ],
CACHE_ACCEL => [ 'factory' => 'ObjectCache::getLocalServerInstance' ],
CACHE_MEMCACHED => [ 'class' => MemcachedPhpBagOStuff::class, 'loggroup' => 'memcached' ],
'db-replicated' => [
'readFactory' => [
'class' => SqlBagOStuff::class,
'args' => [ [ 'slaveOnly' => true ] ]
],
'writeFactory' => [
'class' => SqlBagOStuff::class,
'args' => [ [ 'slaveOnly' => false ] ]
],
'loggroup' => 'SQLBagOStuff',
'reportDupes' => false
],
'apc' => [ 'class' => APCBagOStuff::class, 'reportDupes' => false ],
'apcu' => [ 'class' => APCUBagOStuff::class, 'reportDupes' => false ],
'wincache' => [ 'class' => WinCacheBagOStuff::class, 'reportDupes' => false ],
'memcached-php' => [ 'class' => MemcachedPhpBagOStuff::class, 'loggroup' => 'memcached' ],
'memcached-pecl' => [ 'class' => MemcachedPeclBagOStuff::class, 'loggroup' => 'memcached' ],
'hash' => [ 'class' => HashBagOStuff::class, 'reportDupes' => false ],
]

Advanced object cache configuration.

Use this to define the class names and constructor parameters which are used for the various cache types. Custom cache types may be defined here and referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType, or $wgLanguageConverterCacheType.

The format is an associative array where the key is a cache identifier, and the value is an associative array of parameters. The "class" parameter is the class name which will be used. Alternatively, a "factory" parameter may be given, giving a callable function which will generate a suitable cache object.

Definition at line 2319 of file DefaultSettings.php.

Referenced by Installer\__construct(), McTest\execute(), ObjectCache\newFromId(), ObjectCache\newWANCacheFromId(), and ParserTestRunner\staticSetup().

◆ $wgObjectCacheSessionExpiry

$wgObjectCacheSessionExpiry = 3600

The expiry time to use for session storage, in seconds.

Definition at line 2439 of file DefaultSettings.php.

◆ $wgOpenSearchDefaultLimit

$wgOpenSearchDefaultLimit = 10

Integer defining default number of entries to show on OpenSearch call.

Definition at line 6507 of file DefaultSettings.php.

◆ $wgOpenSearchDescriptionLength

$wgOpenSearchDescriptionLength = 100

Minimum length of extract in .

Actual extracts will last until the end of sentence.

Definition at line 6512 of file DefaultSettings.php.

◆ $wgOpenSearchTemplate

$wgOpenSearchTemplate = false

Template for OpenSearch suggestions, defaults to API action=opensearch.

Sites with heavy load would typically have these point to a custom PHP wrapper to avoid firing up mediawiki for every keystroke

Placeholders: {searchTerms}

Deprecated:
since 1.25 Use $wgOpenSearchTemplates['application/x-suggestions+json'] instead

Definition at line 6480 of file DefaultSettings.php.

◆ $wgOpenSearchTemplates

$wgOpenSearchTemplates
Initial value:
= [
'application/x-suggestions+json' => false,
'application/x-suggestions+xml' => false,
]

Templates for OpenSearch suggestions, defaults to API action=opensearch.

Sites with heavy load would typically have these point to a custom PHP wrapper to avoid firing up mediawiki for every keystroke

Placeholders: {searchTerms}

Definition at line 6490 of file DefaultSettings.php.

◆ $wgOverrideHostname

$wgOverrideHostname = false

Override server hostname detection with a hardcoded value.

Should be a string, default false.

Since
1.20

Definition at line 6336 of file DefaultSettings.php.

Referenced by wfHostname().

◆ $wgOverrideSiteFeed

$wgOverrideSiteFeed = []

Override the site's default RSS/ATOM feed for recentchanges that appears on every page.

Some sites might have a different feed they'd like to promote instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one). Should be a format as key (either 'rss' or 'atom') and an URL to the feed as value.

Example:
Configure the 'atom' feed to https://example.com/somefeed.xml
$wgSiteFeed['atom'] = "https://example.com/somefeed.xml";

Definition at line 6946 of file DefaultSettings.php.

◆ $wgPageInfoTransclusionLimit

$wgPageInfoTransclusionLimit = 50

InfoAction retrieves a list of transclusion links (both to and from).

This number puts a limit on that query in the case of highly transcluded templates.

Definition at line 6401 of file DefaultSettings.php.

◆ $wgPageLanguageUseDB

bool $wgPageLanguageUseDB = false

◆ $wgPagePropLinkInvalidations

$wgPagePropLinkInvalidations
Initial value:
= [
'hiddencat' => 'categorylinks',
]

Page property link table invalidation lists.

When a page property changes, this may require other link tables to be updated (eg adding HIDDENCAT means the hiddencat tracking category will have been added, so the categorylinks table needs to be rebuilt). This array can be added to by extensions.

Definition at line 7584 of file DefaultSettings.php.

Referenced by LinksUpdate\invalidateProperties().

◆ $wgPagePropsHaveSortkey

$wgPagePropsHaveSortkey = true

Whether the page_props table has a pp_sortkey column.

Set to false in case the respective database schema change was not applied.

Since
1.23

Definition at line 8612 of file DefaultSettings.php.

Referenced by LinksUpdate\getPagePropRowData(), and LinksUpdateTest\testUpdate_page_props().

◆ $wgParserCacheExpireTime

$wgParserCacheExpireTime = 86400

The expiry time for the parser cache, in seconds.

The default is 86400 (one day).

Definition at line 2429 of file DefaultSettings.php.

Referenced by PurgeParserCache\execute(), CacheTime\getCacheExpiry(), and ParserOutput\hasDynamicContent().

◆ $wgParserCacheType

$wgParserCacheType = CACHE_ANYTHING

The cache type for storing article HTML.

This is used to store data which is expensive to regenerate, and benefits from having plenty of storage space.

For available types see $wgMainCacheType.

Definition at line 2287 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), ObjectCache\newAnything(), UploadFromUrlTestSuite\setUp(), and wfGetParserCacheStorage().

◆ $wgParserConf

$wgParserConf
Initial value:
= [
'class' => Parser::class,
# 'preprocessorClass' => Preprocessor_Hash::class,
]

Parser configuration.

Associative array with the following members:

class The class name

preprocessorClass The preprocessor class. Two classes are currently available: Preprocessor_Hash, which uses plain PHP arrays for temporary storage, and Preprocessor_DOM, which uses the DOM module for temporary storage. Preprocessor_DOM generally uses less memory; the speed of the two is roughly the same.

If this parameter is not given, it uses Preprocessor_DOM if the DOM module is available, otherwise it uses Preprocessor_Hash.

The entire associative array will be passed through to the constructor as the first parameter. Note that only Setup.php can use this variable – the configuration will change at runtime via $wgParser member functions, so the contents of this variable will be out-of-date. The variable can only be changed during LocalSettings.php, in particular, it can't be changed during an extension setup function.

Definition at line 4170 of file DefaultSettings.php.

Referenced by PreprocessDump\checkOptions(), DumpRenderer\execute(), Parser\getFreshParser(), ParserTestRunner\getParser(), MessageCache\getParser(), CLIParser\initParser(), DefaultPreferencesFactoryTest\setUp(), UploadFromUrlTestSuite\setUp(), TagHooksTest\testBadFunctionTagHooks(), TagHooksTest\testBadTagHooks(), TagHooksTest\testFunctionTagHooks(), MessageTest\testRawHtmlInMsg(), and TagHooksTest\testTagHooks().

◆ $wgParserOutputHooks

array $mOutputHooks Hook tags as per ParserOutput::$wgParserOutputHooks = []

Parser output hooks.

This is an associative array where the key is an extension-defined tag (typically the extension name), and the value is a PHP callback. These will be called as an OutputPageParserOutput hook, if the relevant tag has been registered with the parser output object.

Registration is done with $pout->addOutputHook( $tag, $data ).

The callback has the form:

function outputHook( $outputPage, $parserOutput, $data ) { ... }

Definition at line 7321 of file DefaultSettings.php.

◆ $wgParserTestFiles

$wgParserTestFiles = []

Parser test suite files to be run by parserTests.php when no specific filename is passed to it.

Extensions using extension.json will have any *.txt file in a tests/parser/ directory automatically run.

Core tests can be added to ParserTestRunner::$coreTestFiles.

Use full paths.

Deprecated:
since 1.30

Definition at line 6424 of file DefaultSettings.php.

Referenced by ParserTestRunner\getParserTestFiles().

◆ $wgParserTestMediaHandlers

$wgParserTestMediaHandlers
Initial value:
= [
'image/jpeg' => 'MockBitmapHandler',
'image/png' => 'MockBitmapHandler',
'image/gif' => 'MockBitmapHandler',
'image/tiff' => 'MockBitmapHandler',
'image/webp' => 'MockBitmapHandler',
'image/x-ms-bmp' => 'MockBitmapHandler',
'image/x-bmp' => 'MockBitmapHandler',
'image/x-xcf' => 'MockBitmapHandler',
'image/svg+xml' => 'MockSvgHandler',
'image/vnd.djvu' => 'MockDjVuHandler',
]

Media handler overrides for parser tests (they don't need to generate actual thumbnails, so a mock will do)

Definition at line 990 of file DefaultSettings.php.

◆ $wgPasswordAttemptThrottle

$wgPasswordAttemptThrottle
Initial value:
= [
[ 'count' => 5, 'seconds' => 300 ],
[ 'count' => 150, 'seconds' => 60 * 60 * 48 ],
]

Limit password attempts to X attempts per Y seconds per IP per account.

Value is an array of arrays. Each sub-array must have a key for count (ie count of how many attempts before throttle) and a key for seconds. If the key 'allIPs' (case sensitive) is present, then the limit is just per account instead of per IP per account.

Since
1.27 allIps support and multiple limits added in 1.27. Prior to 1.27 this only supported having a single throttle.
Warning
Requires $wgMainCacheType to be enabled

Definition at line 5781 of file DefaultSettings.php.

Referenced by BotPassword\login().

◆ $wgPasswordConfig

$wgPasswordConfig

Configuration for built-in password types.

Maps the password type to an array of options. The 'class' option is the Password class to use. All other options are class-dependent.

An advanced example:

$wgPasswordConfig['bcrypt-peppered'] = [
'underlying' => 'bcrypt',
'secrets' => [],
'cipher' => MCRYPT_RIJNDAEL_256,
'mode' => MCRYPT_MODE_CBC,
'cost' => 5,
];
Since
1.24

Definition at line 4776 of file DefaultSettings.php.

◆ $wgPasswordDefault

$wgPasswordDefault = 'pbkdf2'

Default password type to use when hashing user passwords.

Since
1.24

Definition at line 4755 of file DefaultSettings.php.

◆ $wgPasswordExpirationDays

$wgPasswordExpirationDays = false

The number of days that a user's password is good for.

After this number of days, the user will be asked to reset their password. Set to false to disable password expiration.

Definition at line 1666 of file DefaultSettings.php.

◆ $wgPasswordExpireGrace

$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.

Definition at line 1672 of file DefaultSettings.php.

◆ $wgPasswordPolicy

$wgPasswordPolicy

Password policy for local wiki users.

A user's effective policy is the superset of all policy statements from the policies for the groups where the user is a member. If more than one group policy include the same policy statement, the value is the max() of the values. Note true > false. The 'default' policy group is required, and serves as the minimum policy for all users. New statements can be added by appending to $wgPasswordPolicy['checks']. Statements:

  • MinimalPasswordLength - minimum length a user can set
  • MinimumPasswordLengthToLogin - passwords shorter than this will not be allowed to login, or offered a chance to reset their password as part of the login workflow, regardless if it is correct.
  • MaximalPasswordLength - maximum length password a user is allowed to attempt. Prevents DoS attacks with pbkdf2.
  • PasswordCannotMatchUsername - Password cannot match username to
  • PasswordCannotMatchBlacklist - Username/password combination cannot match a specific, hardcoded blacklist.
  • PasswordCannotBePopular - Blacklist passwords which are known to be commonly chosen. Set to integer n to ban the top n passwords. If you want to ban all common passwords on file, use the PHP_INT_MAX constant.
    Since
    1.26

Definition at line 4509 of file DefaultSettings.php.

Referenced by User\checkPasswordValidity(), WebInstallerName\submit(), and MediaWiki\Auth\TemporaryPasswordAuthenticationRequestTest\testNewRandom().

◆ $wgPasswordReminderResendTime

$wgPasswordReminderResendTime = 24

Minimum time, in hours, which must elapse between password reminder emails for a given account.

This is to prevent abuse by mail flooding.

Definition at line 1650 of file DefaultSettings.php.

◆ $wgPasswordResetRoutes

$wgPasswordResetRoutes
Initial value:
= [
'username' => true,
'email' => true,
]

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.

Setting all of these to false (or the whole variable to false) has the effect of disabling password resets entirely

Definition at line 4815 of file DefaultSettings.php.

Referenced by LoginSignupSpecialPage\getFakeTemplate().

◆ $wgPasswordSalt

$wgPasswordSalt = true

For compatibility with old installations set to false.

Deprecated:
since 1.24 will be removed in future

Definition at line 4721 of file DefaultSettings.php.

◆ $wgPasswordSender

$wgPasswordSender = false

Sender email address for e-mail notifications.

The address we use as sender when a user requests a password reminder.

Defaults to "apache@$wgServerName".

Definition at line 1599 of file DefaultSettings.php.

Referenced by EmailNotification\composeCommonMailtext(), and User\sendMail().

◆ $wgPasswordSenderName

$wgPasswordSenderName = 'MediaWiki Mail'

Sender name for e-mail notifications.

Deprecated:
since 1.23; use the system message 'emailsender' instead.

Definition at line 1606 of file DefaultSettings.php.

◆ $wgPhpCli

$wgPhpCli = '/usr/bin/php'

Executable path of the PHP cli binary.

Should be set up on install.

Definition at line 8300 of file DefaultSettings.php.

Referenced by MWDocGen\init(), MediaWiki\Shell\Shell\makeScriptCommand(), ShellTest\provideMakeScriptCommand(), GlobalTest\provideWfShellWikiCmdList(), and wfShellWikiCmd().

◆ $wgPHPSessionHandling

string $wgPHPSessionHandling = 'enable'

Whether to use PHP session handling ($_SESSION and session_*() functions)

If the constant MW_NO_SESSION is defined, this is forced to 'disable'.

If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP session handling will function independently of SessionHandler. SessionHandler and PHP's session handling may attempt to override each others' cookies.

Since
1.27
  • 'enable': Integrate with PHP's session handling as much as possible.
  • 'warn': Integrate but log warnings if anything changes $_SESSION.
  • 'disable': Throw exceptions if PHP session handling is used.

Definition at line 2462 of file DefaultSettings.php.

◆ $wgPingback

bool $wgPingback = false

Share data about this installation with MediaWiki developers.

When set to true, MediaWiki will periodically ping https://www.mediawiki.org/ with basic data about this MediaWiki instance. This data includes, for example, the type of system, PHP version, and chosen database backend. The Wikimedia Foundation shares this data with MediaWiki developers to help guide future development efforts.

For details about what data is sent, see: https://www.mediawiki.org/wiki/Manual:$wgPingback

For the pingback privacy policy, see: https://wikimediafoundation.org/wiki/MediaWiki_Pingback_Privacy_Statement

Aggregate pingback data is available at: https://pingback.wmflabs.org/

Since
1.28

Definition at line 8796 of file DefaultSettings.php.

◆ $wgPoolCounterConf

$wgPoolCounterConf = null

Configuration for processing pool control, for use in high-traffic wikis.

An implementation is provided in the PoolCounter extension.

This configuration array maps pool types to an associative array. The only defined key in the associative array is "class", which gives the class name. The remaining elements are passed through to the class as constructor parameters.

Example using local redis instance:
$wgPoolCounterConf = [ 'ArticleView' => [
'timeout' => 15, // wait timeout in seconds
'workers' => 1, // maximum number of active threads in each pool
'maxqueue' => 5, // maximum number of total threads in each pool
'servers' => [ '127.0.0.1' ],
'redisConfig' => []
] ];
Example using C daemon from https://www.mediawiki.org/wiki/Extension:PoolCounter:
$wgPoolCounterConf = [ 'ArticleView' => [
'timeout' => 15, // wait timeout in seconds
'workers' => 5, // maximum number of active threads in each pool
'maxqueue' => 50, // maximum number of total threads in each pool
... any extension-specific options...
] ];

Definition at line 8538 of file DefaultSettings.php.

Referenced by PoolCounter\factory().

◆ $wgPopularPasswordFile

string $wgPopularPasswordFile = __DIR__ . '/../serialized/commonpasswords.cdb'

Where popular password file is located.

Default in core contains 10,000 most popular. This config allows you to change which file, in case you want to generate a password file with > 10000 entries in it.

See also
maintenance/createCommonPasswordCdb.php
Since
1.27 path to file

Definition at line 8734 of file DefaultSettings.php.

Referenced by PasswordPolicyChecks\checkPopularPasswordBlacklist().

◆ $wgPreprocessorCacheThreshold

$wgPreprocessorCacheThreshold = 1000

Preprocessor caching threshold Setting it to 'false' will disable the preprocessor cache.

Definition at line 4404 of file DefaultSettings.php.

Referenced by PreprocessDump\checkOptions().

◆ $wgPreviewOnOpenNamespaces

$wgPreviewOnOpenNamespaces
Initial value:
= [
]

Which namespaces have special treatment where they should be preview-on-open Internally only Category: pages apply, but using this extensions (e.g.

Semantic MediaWiki) can specify namespaces of pages they have special treatment for

Definition at line 6621 of file DefaultSettings.php.

◆ $wgProfileLimit

$wgProfileLimit = 0.0

Only record profiling info for pages that took longer than this.

Deprecated:
since 1.25: set $wgProfiler['threshold'] instead.

Definition at line 6355 of file DefaultSettings.php.

Referenced by Maintenance\activateProfiler(), and Profiler\instance().

◆ $wgProfileOnly

$wgProfileOnly = false

Don't put non-profiling info into log file.

Deprecated:
since 1.23, set the log file in $wgDebugLogGroups['profileoutput'] instead.

Definition at line 6363 of file DefaultSettings.php.

◆ $wgPropagateErrors

$wgPropagateErrors = true

If true, the MediaWiki error handler passes errors/warnings to the default error handler after logging them.

The setting is ignored when the track_errors php.ini flag is true.

Definition at line 6324 of file DefaultSettings.php.

Referenced by MWExceptionHandler\handleError().

◆ $wgProxyList

$wgProxyList = []

Big list of banned IP addresses.

This can have the following formats:

  • An array of addresses, either in the values or the keys (for backward compatibility, deprecated since 1.30)
  • A string, in that case this is the path to a file containing the list of IP addresses, one per line

Definition at line 5977 of file DefaultSettings.php.

Referenced by User\isLocallyBlockedProxy().

◆ $wgProxyWhitelist

$wgProxyWhitelist = []

Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say.

Definition at line 5621 of file DefaultSettings.php.

Referenced by User\getBlockedStatus(), and User\isDnsBlacklisted().

◆ $wgPutIPinRC

$wgPutIPinRC = true

Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g.

CheckUser) or a DB admin Used for retroactive autoblocks

Definition at line 5761 of file DefaultSettings.php.

Referenced by Block\defaultRetroactiveAutoblock(), and RecentChange\save().

◆ $wgQueryCacheLimit

$wgQueryCacheLimit = 1000

Number of rows to cache in 'querycache' table when miser mode is on.

Definition at line 2201 of file DefaultSettings.php.

Referenced by UpdateSpecialPages\execute().

◆ $wgQueryPageDefaultLimit

$wgQueryPageDefaultLimit = 50

Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere.

Definition at line 5767 of file DefaultSettings.php.

◆ $wgRangeContributionsCIDRLimit

array $wgRangeContributionsCIDRLimit
Initial value:
= [
'IPv4' => 16,
'IPv6' => 32,
]

Shortest CIDR limits that can be checked in any individual range check at Special:Contributions.

Since
1.30

Definition at line 8828 of file DefaultSettings.php.

◆ $wgRateLimits

$wgRateLimits

Simple rate limiter options to brake edit floods.

Maximum number actions allowed in the given number of seconds; after that the violating client receives HTTP 500 error pages until the period elapses.

Example:
Limits per configured per action and then type of users.
'edit' => [
'anon' => [ x, y ], // any and all anonymous edits (aggregate)
'user' => [ x, y ], // each logged-in user
'user-global' => [ x, y ], // per username, across all sites (assumes names are global)
'newbie' => [ x, y ], // each new autoconfirmed accounts; overrides 'user'
'ip' => [ x, y ], // each anon and recent account, across all sites
'subnet' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
'ip-all' => [ x, y ], // per ip, across all sites
'subnet-all' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
'groupName' => [ x, y ], // by group membership
]
];
Normally, the 'noratelimit' right allows a user to bypass any rate
limit checks. This can be disabled on a per-action basis by setting the special '&can-bypass' key to false in that action's configuration.
'some-action' => [
'&can-bypass' => false,
'user' => [ x, y ],
];
Warning
Requires that $wgMainCacheType is set to something persistent

Definition at line 5677 of file DefaultSettings.php.

Referenced by User\pingLimiter(), and ApiMoveTest\testPingLimiter().

◆ $wgRateLimitsExcludedIPs

$wgRateLimitsExcludedIPs = []

Array of IPs / CIDR ranges which should be excluded from rate limits.

This may be useful for whitelisting NAT gateways for conferences, etc.

Definition at line 5754 of file DefaultSettings.php.

Referenced by User\isPingLimitable().

◆ $wgRawHtml

$wgRawHtml = false

Allow raw, unchecked HTML in "<html>...</html>" sections.

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

Definition at line 4340 of file DefaultSettings.php.

Referenced by CoreTagHooks\html(), and CoreTagHooks\register().

◆ $wgRCChangedSizeThreshold

$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.

Definition at line 6979 of file DefaultSettings.php.

◆ $wgRCEngines

$wgRCEngines
Initial value:

Used by RecentChange::getEngine to find the correct engine for a given URI scheme.

Keys are scheme names, values are names of FormattedRCFeed sub classes.

Since
1.22

Definition at line 6833 of file DefaultSettings.php.

Referenced by RecentChange\getEngine().

◆ $wgRCFeeds

$wgRCFeeds = []

Recentchanges items are periodically purged; entries older than this many seconds will go.

Default: 90 days = about three months

Definition at line 6826 of file DefaultSettings.php.

Referenced by RecentChange\notifyRCFeeds().

◆ $wgRCFilterByAge

$wgRCFilterByAge = false

Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers higher than what will be stored.

Note that this is disabled by default because we sometimes do have RC data which is beyond the limit for some reason, and some users may use the high numbers to display that data which is still there.

Definition at line 6759 of file DefaultSettings.php.

◆ $wgRCLinkDays

$wgRCLinkDays = [ 1, 3, 7, 14, 30 ]

List of Days options to list in the Special:Recentchanges and Special:Recentchangeslinked pages.

Definition at line 6771 of file DefaultSettings.php.

◆ $wgRCLinkLimits

$wgRCLinkLimits = [ 50, 100, 250, 500 ]

List of Limits options to list in the Special:Recentchanges and Special:Recentchangeslinked pages.

Definition at line 6765 of file DefaultSettings.php.

◆ $wgRCMaxAge

$wgRCMaxAge = 90 * 24 * 3600

Recentchanges items are periodically purged; entries older than this many seconds will go.

Default: 90 days = about three months

Definition at line 6735 of file DefaultSettings.php.

Referenced by RecentChange\isInRCLifespan(), RecentChangesUpdateJob\purgeExpiredRows(), and RebuildRecentchanges\rebuildRecentChangesTablePass1().

◆ $wgRCShowChangedSize

$wgRCShowChangedSize = true

Show the amount of changed characters in recent changes.

Definition at line 6972 of file DefaultSettings.php.

◆ $wgRCShowWatchingUsers

$wgRCShowWatchingUsers = false

Show watching users in recent changes, watchlist and page history views.

Definition at line 6967 of file DefaultSettings.php.

◆ $wgRCWatchCategoryMembership

$wgRCWatchCategoryMembership = false

Treat category membership changes as a RecentChange.

Changes are mentioned in RC for page actions as follows:

  • creation: pages created with categories are mentioned
  • edit: category additions/removals to existing pages are mentioned
  • move: nothing is mentioned (unless templates used depend on the title)
  • deletion: nothing is mentioned
  • undeletion: nothing is mentioned
Since
1.27

Definition at line 6849 of file DefaultSettings.php.

Referenced by WikiPage\doEditUpdates().

◆ $wgReadOnly

$wgReadOnly = null

Set this to a string to put the wiki into read-only mode.

The text will be used as an explanation to users.

This prevents most write operations via the web interface. Cache updates may still be possible. To prevent database writes completely, use the read_only option in MySQL.

Definition at line 6669 of file DefaultSettings.php.

Referenced by GlobalTest\testReadOnlyEmpty(), and GlobalTest\testReadOnlySet().

◆ $wgReadOnlyFile

$wgReadOnlyFile = false

If this lock file exists (size > 0), the wiki will be forced into read-only mode.

Its contents will be shown to users as part of the read-only warning message.

Will default to "{$wgUploadDirectory}/lock_yBgMBwiR" in Setup.php

Definition at line 6685 of file DefaultSettings.php.

Referenced by GlobalTest\testReadOnlySet().

◆ $wgReadOnlyWatchedItemStore

bool $wgReadOnlyWatchedItemStore = false

Set this to true to put the wiki watchlists into read-only mode.

Since
1.31

Definition at line 6676 of file DefaultSettings.php.

◆ $wgReauthenticateTime

int [] $wgReauthenticateTime
Initial value:
= [
'default' => 300,
]

Time frame for re-authentication.

With only password-based authentication, you'd just ask the user to re-enter their password to verify certain operations like changing the password or changing the account's email address. But under AuthManager, the user might not have a password (you might even have to redirect the browser to a third-party service or something complex like that), you might want to have both factors of a two-factor authentication, and so on. So, the options are:

  • Incorporate the whole multi-step authentication flow within everything that needs to do this.
  • Consider it good if they used Special:UserLogin during this session within the last X seconds.
  • Come up with a third option.

MediaWiki currently takes the second option. This setting configures the "X seconds".

This allows for configuring different time frames for different "operations". The operations used in MediaWiki core include:

  • LinkAccounts
  • UnlinkAccount
  • ChangeCredentials
  • RemoveCredentials
  • ChangeEmail

Additional operations may be used by extensions, either explicitly by calling AuthManager::securitySensitiveOperationStatus(), ApiAuthManagerHelper::securitySensitiveOperation() or SpecialPage::checkLoginSecurityLevel(), or implicitly by overriding SpecialPage::getLoginSecurityLevel() or by subclassing AuthManagerSpecialPage.

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

Since
1.27 operation => time in seconds. A 'default' key must always be provided.

Definition at line 4668 of file DefaultSettings.php.

◆ $wgRecentChangesFlags

$wgRecentChangesFlags
Initial value:
= [
'newpage' => [
'letter' => 'newpageletter',
'title' => 'recentchanges-label-newpage',
'legend' => 'recentchanges-legend-newpage',
'grouping' => 'any',
],
'minor' => [
'letter' => 'minoreditletter',
'title' => 'recentchanges-label-minor',
'legend' => 'recentchanges-legend-minor',
'class' => 'minoredit',
'grouping' => 'all',
],
'bot' => [
'letter' => 'boteditletter',
'title' => 'recentchanges-label-bot',
'legend' => 'recentchanges-legend-bot',
'class' => 'botedit',
'grouping' => 'all',
],
'unpatrolled' => [
'letter' => 'unpatrolledletter',
'title' => 'recentchanges-label-unpatrolled',
'legend' => 'recentchanges-legend-unpatrolled',
'grouping' => 'any',
],
]

Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits.

To register a new one:

// message for the letter displayed next to rows on changes lists
'letter' => 'letter-msg',
// message for the tooltip of the letter
'title' => 'tooltip-msg',
// optional (defaults to 'tooltip-msg'), message to use in the legend box
'legend' => 'legend-msg',
// optional (defaults to 'flag'), CSS class to put on changes lists rows
'class' => 'css-class',
// optional (defaults to 'any'), how top-level flag is determined. 'any'
// will set the top-level flag if any line contains the flag, 'all' will
// only be set if all lines contain the flag.
'grouping' => 'any',
];
Since
1.22

Definition at line 7057 of file DefaultSettings.php.

Referenced by ChangesList\flag().

◆ $wgRedirectOnLogin

$wgRedirectOnLogin = null

Allow redirection to another page when a user logs in.

To enable, set to a string like 'Main Page'

Definition at line 8504 of file DefaultSettings.php.

◆ $wgRedirectSources

$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.

Example:
It might look something like this:
$wgRedirectSources = '!^https?://[a-z-]+\\.wikipedia\\.org/!';

Leave at false to avoid displaying any incoming redirect markers. This does not affect intra-wiki redirects, which don't change the URL.

Definition at line 4033 of file DefaultSettings.php.

Referenced by Article\showRedirectedFromHeader().

◆ $wgReferrerPolicy

array string bool $wgReferrerPolicy = false

Value for the referrer policy meta tag.

One or more of the values defined in the Referrer Policy specification: https://w3c.github.io/webappsec-referrer-policy/ ('no-referrer', 'no-referrer-when-downgrade', 'same-origin', 'origin', 'strict-origin', 'origin-when-cross-origin', 'strict-origin-when-cross-origin', or 'unsafe-url') Setting it to false prevents the meta tag from being output (which results in falling back to the Referrer-Policy header, or 'no-referrer-when-downgrade' if that's not set either.) Setting it to an array (supported since 1.31) will create a meta tag for each value, in the reverse of the order (meaning that the first array element will be the default and the others used as fallbacks for browsers which do not understand it).

Since
1.25

Definition at line 343 of file DefaultSettings.php.

◆ $wgRegisterInternalExternals

$wgRegisterInternalExternals = false

By default MediaWiki does not register links pointing to same server in externallinks dataset, use this value to override:

Definition at line 8487 of file DefaultSettings.php.

Referenced by ParserOutput\addExternalLink().

◆ $wgRemoveCredentialsBlacklist

string [] $wgRemoveCredentialsBlacklist
Initial value:

List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata 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 4713 of file DefaultSettings.php.

◆ $wgRemoveGroups

$wgRemoveGroups = []
See also
$wgAddGroups

Definition at line 5518 of file DefaultSettings.php.

Referenced by User\changeableByGroup(), and ApiUserrightsTest\setPermissions().

◆ $wgRenderHashAppend

$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.

Definition at line 2600 of file DefaultSettings.php.

Referenced by ChangesFeed\execute(), Skin\getCachedNotice(), and ParserOptions\optionsHash().

◆ $wgRepositoryBaseUrl

$wgRepositoryBaseUrl = "https://commons.wikimedia.org/wiki/File:"

Base URL for a repository wiki.

Leave this blank if uploads are just stored in a shared directory and not meant to be accessible through a separate wiki. Otherwise the image description pages on the local wiki will link to the image description page on this wiki.

Please specify the namespace, as in the example below.

Definition at line 879 of file DefaultSettings.php.

◆ $wgReservedUsernames

$wgReservedUsernames
Initial value:
= [
'MediaWiki default',
'Conversion script',
'Maintenance script',
'Template namespace initialisation script',
'ScriptImporter',
'Unknown user',
'msg:double-redirect-fixer',
'msg:usermessage-editor',
'msg:proxyblocker',
'msg:sorbs',
'msg:spambot_username',
'msg:autochange-username',
]

Array of usernames which may not be registered or logged in from Maintenance scripts can still use these.

Definition at line 4835 of file DefaultSettings.php.

Referenced by User\isUsableName().

◆ $wgResourceBasePath

$wgResourceBasePath = null

The default 'remoteBasePath' value for instances of ResourceLoaderFileModule.

Defaults to $wgScriptPath.

Definition at line 3660 of file DefaultSettings.php.

Referenced by ResourceLoaderFileModule\extractBasePaths(), Skin\getPoweredBy(), and File\iconThumb().

◆ $wgResourceLoaderDebug

$wgResourceLoaderDebug = false

The default debug mode (on/off) for of ResourceLoader requests.

This will still be overridden when the debug URL parameter is used.

Definition at line 3694 of file DefaultSettings.php.

◆ $wgResourceLoaderLESSImportPaths

$wgResourceLoaderLESSImportPaths
Initial value:
= [
"$IP/resources/src/mediawiki.less/",
]

Default import paths for LESS modules.

LESS files referenced in @import statements will be looked up here first, and relative to the importing file second. To avoid collisions, it's important for the LESS files in these directories to have a common, predictable file name prefix.

Extensions need not (and should not) register paths in $wgResourceLoaderLESSImportPaths. The import path includes the path of the currently compiling LESS file, which allows each extension to freely import files from its own tree.

Since
1.22

Definition at line 3809 of file DefaultSettings.php.

◆ $wgResourceLoaderLESSVars

$wgResourceLoaderLESSVars
Initial value:
= [
'deviceWidthTablet' => '720px',
]

Global LESS variables.

An associative array binding variable names to LESS code snippets representing their values.

Adding an item here is equivalent to writing @variable: value; at the beginning of all your .less files, with all the consequences. In particular, string values must be escaped and quoted.

Changes to this configuration do NOT trigger cache invalidation.

Example:
'exampleFontSize' => '1em',
'exampleBlue' => '#36c',
];
Since
1.22
Deprecated:
since 1.30 Use ResourceLoaderModule::getLessVars() instead to add variables to individual modules that need them.

Definition at line 3785 of file DefaultSettings.php.

◆ $wgResourceLoaderMaxage

$wgResourceLoaderMaxage
Initial value:
= [
'versioned' => [
'server' => 30 * 24 * 60 * 60,
'client' => 30 * 24 * 60 * 60,
],
'unversioned' => [
'server' => 5 * 60,
'client' => 5 * 60,
],
]

Maximum time in seconds to cache resources served by ResourceLoader.

Used to set last modified headers (max-age/s-maxage).

Following options to distinguish:

  • versioned: Used for modules with a version, because changing version numbers causes cache misses. This normally has a long expiry time.
  • unversioned: Used for modules without a version to propagate changes quickly to clients. Also used for modules with errors to recover quickly. This normally has a short expiry time.

Expiry time for the options to distinguish:

  • server: Squid/Varnish but also any other public proxy cache between the client and MediaWiki.
  • client: On the client side (e.g. in the browser cache).

Definition at line 3678 of file DefaultSettings.php.

◆ $wgResourceLoaderMaxQueryLength

$wgResourceLoaderMaxQueryLength = false

If set to a positive number, 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.

This degrades performance, but may be needed if your web server has a low (less than, say 1024) query string length limit or a low value for suhosin.get.max_value_length that you can't increase.

If set to a negative number, ResourceLoader will assume there is no query string length limit.

Defaults to a value based on php configuration.

Definition at line 3743 of file DefaultSettings.php.

◆ $wgResourceLoaderSources

$wgResourceLoaderSources = []

Extensions should register foreign module sources here.

'local' is a built-in source that is not in this array, but defined by ResourceLoader::__construct() so that it cannot be unset.

Example:
$wgResourceLoaderSources['foo'] = 'http://example.org/w/load.php';

Definition at line 3654 of file DefaultSettings.php.

◆ $wgResourceLoaderStorageEnabled

$wgResourceLoaderStorageEnabled = true

Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API.

Definition at line 3817 of file DefaultSettings.php.

◆ $wgResourceLoaderStorageVersion

$wgResourceLoaderStorageVersion = 1

Cache version for client-side ResourceLoader module storage.

You can trigger invalidation of the contents of the module store by incrementing this value.

Since
1.23

Definition at line 3825 of file DefaultSettings.php.

◆ $wgResourceLoaderValidateJS

$wgResourceLoaderValidateJS = true

If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it.

Parse errors will result in a JS exception being thrown during module load, which avoids breaking other modules loaded in the same request.

Definition at line 3752 of file DefaultSettings.php.

◆ $wgResourceLoaderValidateStaticJS

$wgResourceLoaderValidateStaticJS = false

If set to true, statically-sourced (file-backed) JavaScript resources will be parsed for validity before being bundled up into ResourceLoader modules.

This can be helpful for development by providing better error messages in default (non-debug) mode, but JavaScript parsing is slow and memory hungry and may fail on large pre-bundled frameworks.

Definition at line 3762 of file DefaultSettings.php.

◆ $wgResourceModules

$wgResourceModules = []

Client-side resource modules.

Extensions should add their ResourceLoader module definitions to the $wgResourceModules variable.

Example:
$wgResourceModules['ext.myExtension'] = [
'scripts' => 'myExtension.js',
'styles' => 'myExtension.css',
'dependencies' => [ 'jquery.cookie', 'jquery.tabIndex' ],
'localBasePath' => __DIR__,
'remoteExtPath' => 'MyExtension',
];

Definition at line 3552 of file DefaultSettings.php.

◆ $wgResourceModuleSkinStyles

$wgResourceModuleSkinStyles = []

Skin-specific styles for resource modules.

These are later added to the 'skinStyles' list of the existing module. The 'styles' list can not be modified or disabled.

For example, here is a module "bar" and how skin Foo would provide additional styles for it.

Example:
'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/main.css',
];
'bar' => 'skins/Foo/bar.css',
];

This is mostly equivalent to:

Equivalent:
'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/main.css',
'skinStyles' => [
'foo' => skins/Foo/bar.css',
],
];

If the module already defines its own entry in skinStyles for a given skin, then $wgResourceModuleSkinStyles is ignored.

If a module defines a ‘skinStyles['default’]the skin may want to extend that instead of replacing them. This can be done using the+` prefix.

Example:
'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/basic.css',
'skinStyles' => [
'default' => 'resources/bar/additional.css',
],
];
// Note the '+' character:
'+bar' => 'skins/Foo/bar.css',
];

This is mostly equivalent to:

Equivalent:
'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/basic.css',
'skinStyles' => [
'default' => 'resources/bar/additional.css',
'foo' => [
'resources/bar/additional.css',
'skins/Foo/bar.css',
],
],
];

In other words, as a module author, use the styles list for stylesheets that may not be disabled by a skin. To provide default styles that may be extended or replaced, use ‘skinStyles['default’]`.

As with $wgResourceModules, paths default to being relative to the MediaWiki root. You should always provide a localBasePath and remoteBasePath (or remoteExtPath/remoteSkinPath).

Example:
'bar' => 'bar.css',
'quux' => 'quux.css',
'remoteSkinPath' => 'Foo',
'localBasePath' => __DIR__,
];

Definition at line 3642 of file DefaultSettings.php.

◆ $wgResponsiveImages

$wgResponsiveImages = true

Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.

This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480 thumbnails, output via the srcset attribute.

On older browsers, a JavaScript polyfill switches the appropriate images in after loading the original low-resolution versions depending on the reported window.devicePixelRatio. The polyfill can be found in the jquery.hidpi module.

Definition at line 1520 of file DefaultSettings.php.

Referenced by Linker\processResponsiveImages(), and wfThumbIsStandard().

◆ $wgRestrictDisplayTitle

$wgRestrictDisplayTitle = true

For consistency, restrict DISPLAYTITLE to text that normalizes to the same canonical DB key.

Also disallow some inline CSS rules like display: none; which can cause the text to be hidden or unselectable.

Definition at line 4392 of file DefaultSettings.php.

Referenced by CoreParserFunctions\displaytitle().

◆ $wgRestrictionLevels

$wgRestrictionLevels = [ '', 'autoconfirmed', 'sysop' ]

Rights which can be required for each protection level (via action=protect)

You can add a new protection level that requires a specific permission by manipulating this array. The ordering of elements dictates the order on the protection form's lists.

  • '' will be ignored (i.e. unprotected)
  • 'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility
  • 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility

Definition at line 5319 of file DefaultSettings.php.

Referenced by ImportImages\execute(), MWNamespace\getRestrictionLevels(), and Title\isProtected().

◆ $wgRestrictionTypes

$wgRestrictionTypes = [ 'create', 'edit', 'move', 'upload' ]

Set of available actions that can be restricted via action=protect You probably shouldn't change this.

Translated through restriction-* messages. Title::getRestrictionTypes() will remove restrictions that are not applicable to a specific title (create and upload)

Definition at line 5306 of file DefaultSettings.php.

Referenced by Title\getFilteredRestrictionTypes().

◆ $wgRevisionCacheExpiry

$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.

Set to 0 to disable, or number of seconds before cache expiry.

Definition at line 2179 of file DefaultSettings.php.

◆ $wgRevokePermissions

$wgRevokePermissions = []

Permission keys revoked from users in each group.

This acts the same way as wgGroupPermissions above, except that if the user is in a group here, the permission will be removed from them.

Improperly setting this could mean that your users will be unable to perform certain essential tasks, so use at your own risk!

Definition at line 5264 of file DefaultSettings.php.

Referenced by User\getAllGroups(), AvailableRightsTest\getAllVisibleRights(), User\getGroupPermissions(), User\groupHasPermission(), User\isEveryoneAllowed(), and UserTest\setUpPermissionGlobals().

◆ $wgRightsIcon

$wgRightsIcon = null

Override for copyright metadata.

Definition at line 7120 of file DefaultSettings.php.

Referenced by Skin\getCopyrightIcon().

◆ $wgRightsPage

$wgRightsPage = null

Override for copyright metadata.

This is the name of the page containing information about the wiki's copyright status, which will be added as a link in the footer if it is specified. It overrides $wgRightsUrl if both are specified.

Definition at line 7100 of file DefaultSettings.php.

Referenced by Skin\getCopyright().

◆ $wgRightsText

$wgRightsText = null

If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link.

If using $wgRightsUrl then this value must be specified. If using $wgRightsPage then the name of the page will also be used as the link if this variable is not set.

Definition at line 7115 of file DefaultSettings.php.

Referenced by Skin\getCopyright(), Skin\getCopyrightIcon(), and EditPage\getCopyrightWarning().

◆ $wgRightsUrl

$wgRightsUrl = null

Set this to specify an external URL containing details about the content license used on your wiki.

If $wgRightsPage is set then this setting is ignored.

Definition at line 7107 of file DefaultSettings.php.

Referenced by DumpCategoriesAsRdf\addDumpHeader(), Skin\getCopyright(), and Skin\getCopyrightIcon().

◆ $wgRunJobsAsync

$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.

Since
1.23

Definition at line 8426 of file DefaultSettings.php.

◆ $wgScript

◆ $wgScriptPath

$wgScriptPath = '/wiki'

The path we should point to.

It might be a virtual path in case with use apache mod_rewrite for example.

This needs to be set correctly.

Other paths will be set to defaults based on it unless they are directly set in LocalSettings.php

Definition at line 158 of file DefaultSettings.php.

Referenced by SpecialVersion\getEntryPointInfo(), MachineReadableRCFeedFormatter\getLine(), Parser\getVariableValue(), SkinTemplate\prepareQuickTemplate(), ApiLoginTest\testApiLoginGotCookie(), and wfScript().

◆ $wgSearchForwardUrl

$wgSearchForwardUrl = null

Set this to a URL to forward search requests to some external location.

If the URL includes '$1', this will be replaced with the URL-encoded search term.

Example:
To forward to Google you'd have something like:
'https://www.google.com/search?q=$1' .
'&domains=https://example.com' .
'&sitesearch=https://example.com' .
'&ie=utf-8&oe=utf-8';

Definition at line 6559 of file DefaultSettings.php.

◆ $wgSearchHighlightBoundaries

$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.

Definition at line 6468 of file DefaultSettings.php.

Referenced by SearchHighlighter\highlightText().

◆ $wgSearchRunSuggestedQuery

bool $wgSearchRunSuggestedQuery = true

Controls whether zero-result search queries with suggestions should display results for these suggestions.

Since
1.26

Definition at line 8721 of file DefaultSettings.php.

◆ $wgSearchSuggestCacheExpiry

$wgSearchSuggestCacheExpiry = 1200

Expiry time for search suggestion responses.

Definition at line 6517 of file DefaultSettings.php.

◆ $wgSearchType

$wgSearchType = null

Search type.

Leave as null to select the default search engine for the selected database type (eg SearchMySQL), or set to a class name to override to a custom search engine.

Definition at line 1857 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig().

◆ $wgSearchTypeAlternatives

$wgSearchTypeAlternatives = null

Alternative search types Sometimes you want to support multiple search engines for testing.

This allows users to select their search engine of choice via url parameters to Special:Search and the action=search API. If using this, there's no need to add $wgSearchType to it, that is handled automatically.

Definition at line 1866 of file DefaultSettings.php.

◆ $wgSecretKey

$wgSecretKey = false

This should always be customised in LocalSettings.php.

Definition at line 5966 of file DefaultSettings.php.

Referenced by MediaWiki\Session\Session\getSecretKeys().

◆ $wgSecureLogin

$wgSecureLogin = false

◆ $wgSemiprotectedRestrictionLevels

$wgSemiprotectedRestrictionLevels = [ 'autoconfirmed' ]

Restriction levels that should be considered "semiprotected".

Certain places in the interface recognize a dichotomy between "protected" and "semiprotected", without further distinguishing the specific levels. In general, if anyone can be eligible to edit a protection level merely by reaching some condition in $wgAutopromote, it should probably be considered "semiprotected".

'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility. 'sysop' is not changed, since it really shouldn't be here.

Definition at line 5344 of file DefaultSettings.php.

Referenced by Title\isSemiProtected().

◆ $wgSend404Code

$wgSend404Code = true

Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output.

If you are using such a host, you should start looking for a better one. While you're doing that, set this to false to convert some of MediaWiki's 404 responses to 200 so that the generated error pages can be seen.

In cases where for technical reasons it is more important for MediaWiki to send the correct status code than for the body to be transmitted intact, this configuration variable is ignored.

Definition at line 3497 of file DefaultSettings.php.

Referenced by SpecialPageFactory\executePath(), HistoryAction\onView(), ImagePage\openShowImage(), and Article\showMissingArticle().

◆ $wgServer

$wgServer = WebRequest::detectServer()

URL of the server.

Example:
$wgServer = 'http://example.com';

This is usually detected correctly by MediaWiki. If MediaWiki detects the wrong server, it will redirect incorrectly after you save a page. In that case, set this variable to fix it.

If you want to use protocol-relative URLs on your wiki, set this to a protocol-relative URL like '//example.com' and set $wgCanonicalServer to a fully qualified URL.

Definition at line 106 of file DefaultSettings.php.

Referenced by ParserOutput\addExternalLink(), DeleteSelfExternals\execute(), Maintenance\finalSetup(), Title\getInternalURL(), Title\getLocalURL(), Parser\getVariableValue(), UserMailer\makeMsgId(), SkinTemplate\prepareQuickTemplate(), BenchmarkPurge\randomUrl(), ApiTestCase\setUp(), ApiLoginTest\testApiLoginBadPass(), ApiLoginTest\testApiLoginGoodPass(), ApiLoginTest\testApiLoginGotCookie(), ApiLoginTest\testBotPassword(), and wfExpandUrl().

◆ $wgServerName

$wgServerName = false

Server name.

This is automatically computed by parsing the bare hostname out of $wgCanonicalServer. It should not be customized.

Since
1.24

Definition at line 122 of file DefaultSettings.php.

Referenced by MachineReadableRCFeedFormatter\getLine(), and Parser\getVariableValue().

◆ $wgServiceWiringFiles

$wgServiceWiringFiles
Initial value:
= [
__DIR__ . '/ServiceWiring.php'
]

List of service wiring files to be loaded by the default instance of MediaWikiServices.

Each file listed here is expected to return an associative array mapping service names to instantiator functions. Extensions may add wiring files to define their own services. However, this cannot be used to replace existing services - use the MediaWikiServices hook for that.

See also
MediaWikiServices
ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.
docs/injection.txt for an overview of dependency injection in MediaWiki.

Definition at line 7466 of file DefaultSettings.php.

◆ $wgSessionCacheType

$wgSessionCacheType = CACHE_ANYTHING

The cache type for storing session data.

For available types see $wgMainCacheType.

Definition at line 2294 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig().

◆ $wgSessionHandler

$wgSessionHandler = null
Deprecated:
since 1.27, MediaWiki\Session\SessionManager doesn't use PHP session storage.

Definition at line 2444 of file DefaultSettings.php.

◆ $wgSessionInsecureSecrets

$wgSessionInsecureSecrets = false

If for some reason you can't install the PHP OpenSSL or mcrypt extensions, you can set this to true to make MediaWiki work again at the cost of storing sensitive session data insecurely.

But it would be much more secure to just install the OpenSSL extension.

Since
1.27

Definition at line 8637 of file DefaultSettings.php.

Referenced by MediaWiki\Session\Session\getEncryptionAlgorithm().

◆ $wgSessionName

$wgSessionName = false

Override to customise the session name.

Definition at line 6075 of file DefaultSettings.php.

◆ $wgSessionPbkdf2Iterations

$wgSessionPbkdf2Iterations = 10001

Number of internal PBKDF2 iterations to use when deriving session secrets.

Since
1.28

Definition at line 2469 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), and MediaWiki\Session\Session\getSecretKeys().

◆ $wgSessionProviders

$wgSessionProviders
Initial value:
= [
'args' => [ [
'priority' => 30,
'callUserSetCookiesHook' => true,
] ],
],
'args' => [ [
'priority' => 75,
] ],
],
]

MediaWiki\Session\SessionProvider configuration.

Value is an array of ObjectFactory specifications for the SessionProviders to be used. Keys in the array are ignored. Order is not significant.

Since
1.27

Definition at line 4971 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), MediaWiki\Session\BotPasswordSessionProviderTest\getProvider(), and ApiLoginTest\testBotPassword().

◆ $wgSessionSecret

$wgSessionSecret = false

Secret for session storage.

This should be set in LocalSettings.php, otherwise wgSecretKey will be used.

Since
1.27

Definition at line 8628 of file DefaultSettings.php.

Referenced by MediaWiki\Session\Session\getSecretKeys().

◆ $wgSessionsInObjectCache

$wgSessionsInObjectCache = true
Deprecated:
since 1.27, session data is always stored in object cache.

Definition at line 2434 of file DefaultSettings.php.

◆ $wgSharedDB

$wgSharedDB = null

Shared database for multiple wikis.

Commonly used for storing a user table for single sign-on. The server for this database must be the same as for the main database.

For backwards compatibility the shared prefix is set to the same as the local prefix, and the user table is listed in the default list of shared tables. The user_properties table is also added so that users will continue to have their preferences shared (preferences were stored in the user table prior to 1.16)

$wgSharedTables may be customized with a list of tables to share in the shared database. However it is advised to limit what tables you do share as many of MediaWiki's tables may have side effects if you try to share them.

$wgSharedPrefix is the table prefix for the shared database. It defaults to $wgDBprefix.

$wgSharedSchema is the table schema for the shared database. It defaults to $wgDBmwschema.

Deprecated:
since 1.21 In new code, use the $wiki parameter to wfGetLB() to access remote databases. Using wfGetLB() allows the shared database to reside on separate servers to the wiki's own database, with suitable configuration of $wgLBFactoryConf.

Definition at line 1921 of file DefaultSettings.php.

Referenced by CloneDatabase\cloneTableStructure(), DatabaseUpdater\doTable(), AlterSharedConstraints\execute(), LocalIdLookup\isAttached(), and UserRightsProxy\newFromLookup().

◆ $wgSharedPrefix

$wgSharedPrefix = false
See also
$wgSharedDB

Definition at line 1926 of file DefaultSettings.php.

Referenced by AlterSharedConstraints\execute().

◆ $wgSharedSchema

$wgSharedSchema = false
See also
$wgSharedDB
Since
1.23

Definition at line 1937 of file DefaultSettings.php.

◆ $wgSharedTables

◆ $wgSharedThumbnailScriptPath

$wgSharedThumbnailScriptPath = false
See also
$wgThumbnailScriptPath

Definition at line 847 of file DefaultSettings.php.

◆ $wgSharedUploadDBname

$wgSharedUploadDBname = false

DB name with metadata about shared directory.

Set this to false if the uploads do not come from a wiki.

Definition at line 734 of file DefaultSettings.php.

◆ $wgSharedUploadDBprefix

$wgSharedUploadDBprefix = ''

Optional table prefix used in database.

Definition at line 739 of file DefaultSettings.php.

◆ $wgSharedUploadDirectory

$wgSharedUploadDirectory = null

Path on the file system where shared uploads can be found.

Definition at line 728 of file DefaultSettings.php.

◆ $wgSharedUploadPath

$wgSharedUploadPath = null

Full path on the web server where shared uploads can be found.

Definition at line 718 of file DefaultSettings.php.

◆ $wgSharpenParameter

$wgSharpenParameter = '0x0.4'

Sharpening parameter to ImageMagick.

Definition at line 1054 of file DefaultSettings.php.

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

◆ $wgSharpenReductionThreshold

$wgSharpenReductionThreshold = 0.85

Reduction in linear dimensions below which sharpening will be enabled.

Definition at line 1059 of file DefaultSettings.php.

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

◆ $wgShellCgroup

$wgShellCgroup = false

Under Linux: a cgroup directory used to constrain memory usage of shell commands.

The directory must be writable by the user which runs MediaWiki.

If specified, this is used instead of ulimit, which is inaccurate, and causes malloc() to return NULL, which exposes bugs in C applications, making them segfault or deadlock.

A wrapper script will create a cgroup for each shell command that runs, as a subgroup of the specified cgroup. If the memory limit is exceeded, the kernel will send a SIGKILL signal to a process in the subgroup.

Example:
mkdir -p /sys/fs/cgroup/memory/mediawiki
mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php

The reliability of cgroup cleanup can be improved by installing a notify_on_release script in the root cgroup, see e.g. https://gerrit.wikimedia.org/r/#/c/40784

Definition at line 8295 of file DefaultSettings.php.

◆ $wgShellLocale

$wgShellLocale = 'C.UTF-8'

Locale for LC_ALL, to provide a known environment for locale-sensitive operations.

For Unix-like operating systems, this should be set to C.UTF-8 or an equivalent to provide the most consistent behavior for locale-sensitive C library operations across different-language wikis. If that locale is not available, use another locale that has a UTF-8 character set.

This setting mainly affects the behavior of C library functions, including:

  • String collation (order when sorting using locale-sensitive comparison)
    • For example, whether "Å" and "A" are considered to be the same letter or different letters and if different whether it comes after "A" or after "Z", and whether sorting is case sensitive.
  • String character set (how characters beyond basic ASCII are represented)
  • Language used for low-level error messages.
  • Formatting of date/time and numeric values (e.g. '.' versus ',' as the decimal separator)

MediaWiki provides its own methods and classes to perform many locale-sensitive operations, which are designed to be able to vary locale based on wiki language or user preference:

  • MediaWiki's Collation class should generally be used instead of the C library collation functions when locale-sensitive sorting is needed.
  • MediaWiki's Message class should be used for localization of messages displayed to the user.
  • MediaWiki's Language class should be used for formatting numeric and date/time values.
Note
If multiple wikis are being served from the same process (e.g. the same fastCGI or Apache server), this setting must be the same on all those wikis.

Definition at line 8336 of file DefaultSettings.php.

◆ $wgShellRestrictionMethod

string bool $wgShellRestrictionMethod = false

Method to use to restrict shell commands.

Supported options:

  • 'autodetect': Autodetect if any restriction methods are available
  • 'firejail': Use firejail https://firejail.wordpress.com/
  • false: Don't use any restrictions
Note
If using firejail with MediaWiki running in a home directory different from the webserver user, firejail 0.9.44+ is required.
Since
1.31

Definition at line 8352 of file DefaultSettings.php.

◆ $wgShortPagesNamespaceBlacklist

$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.

Since
1.30

Definition at line 4111 of file DefaultSettings.php.

◆ $wgShowArchiveThumbnails

$wgShowArchiveThumbnails = true

Show thumbnails for old images on the image description page.

Definition at line 1256 of file DefaultSettings.php.

Referenced by ImageHistoryList\__construct().

◆ $wgShowCreditsIfMax

$wgShowCreditsIfMax = true

If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.

Otherwise, link to a separate credits page.

Definition at line 7140 of file DefaultSettings.php.

Referenced by SkinTemplate\prepareQuickTemplate().

◆ $wgShowDBErrorBacktrace

$wgShowDBErrorBacktrace = false

If true, show a backtrace for database errors.

Note
This setting only applies when connection errors and query errors are reported in the normal manner. $wgShowExceptionDetails applies in other cases, including those in which an uncaught exception is thrown from within the exception handler.

Definition at line 6313 of file DefaultSettings.php.

Referenced by MWExceptionRenderer\getShowBacktraceError(), MWExceptionRenderer\reportOutageHTML(), and MWExceptionRenderer\showBackTrace().

◆ $wgShowDebug

$wgShowDebug = false

Display debug data at the bottom of the main content area.

Useful for developers and technical users trying to working on a closed wiki.

Definition at line 6272 of file DefaultSettings.php.

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

◆ $wgShowExceptionDetails

$wgShowExceptionDetails = false

If set to true, uncaught exceptions will print a complete stack trace to output.

This should only be used for debugging, as it may reveal private information in function parameters due to PHP's backtrace formatting.

Definition at line 6303 of file DefaultSettings.php.

Referenced by ResourceLoader\formatExceptionNoComment(), MWException\getHTML(), MWExceptionRenderer\getShowBacktraceError(), MWException\getText(), and MWExceptionRenderer\showBackTrace().

◆ $wgShowEXIF

$wgShowEXIF = function_exists( 'exif_read_data' )

Show Exif data, on by default if available.

Requires PHP's Exif extension: https://secure.php.net/manual/en/ref.exif.php

Note
FOR WINDOWS USERS: To enable Exif functions, add the following line to the "Windows extensions" section of php.ini:
extension=extensions/php_exif.dll

Definition at line 691 of file DefaultSettings.php.

Referenced by BitmapMetadataHandler\getExif(), TiffHandler\getMetadata(), ExifBitmapHandler\isMetadataValid(), and ImagePage\view().

◆ $wgShowHostnames

$wgShowHostnames = false

Expose backend server host names through the API and various HTML comments.

Definition at line 6329 of file DefaultSettings.php.

Referenced by DifferenceEngine\debug(), Parser\makeLimitReport(), MWExceptionRenderer\reportOutageHTML(), wfReportTime(), and wfThumbError().

◆ $wgShowRollbackEditCount

$wgShowRollbackEditCount = 10

The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.

The numeric value of the variable controls how many edits MediaWiki will look back to determine whether a rollback is allowed (by checking that they are all from the same author). If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki from hiding some useless rollback links.

Since
1.20

Definition at line 3508 of file DefaultSettings.php.

Referenced by Linker\buildRollbackLink(), and Linker\getRollbackEditCount().

◆ $wgShowSQLErrors

$wgShowSQLErrors = false

Whether to show "we're sorry, but there has been a database error" pages.

Displaying errors aids in debugging, but may display information useful to an attacker.

Definition at line 6295 of file DefaultSettings.php.

Referenced by Maintenance\finalSetup(), and MWExceptionRenderer\reportOutageHTML().

◆ $wgShowUpdatedMarker

$wgShowUpdatedMarker = true

Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes.

Definition at line 6985 of file DefaultSettings.php.

Referenced by User\clearAllNotifications(), User\clearNotification(), and RecentChange\save().

◆ $wgSidebarCacheExpiry

$wgSidebarCacheExpiry = 86400

Expiry time for the sidebar cache, in seconds.

Definition at line 2616 of file DefaultSettings.php.

Referenced by Skin\buildSidebar().

◆ $wgSitemapNamespaces

$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.

Definition at line 6573 of file DefaultSettings.php.

Referenced by GenerateSitemap\generateNamespaces().

◆ $wgSitemapNamespacesPriorities

$wgSitemapNamespacesPriorities = false

Custom namespace priorities for sitemaps.

Setting this will allow you to set custom priorities to namespaces when sitemaps are generated using the maintenance/generateSitemap.php script.

This should be a map of namespace IDs to priority

Example:
NS_USER => '0.9',
NS_HELP => '0.0',
];

Definition at line 6589 of file DefaultSettings.php.

Referenced by GenerateSitemap\setNamespacePriorities().

◆ $wgSitename

◆ $wgSiteNotice

$wgSiteNotice = ''

Site notice shown at the top of each page.

MediaWiki:Sitenotice page, which will override this. You can also provide a separate message for logged-out users using the MediaWiki:Anonnotice page.

Definition at line 3268 of file DefaultSettings.php.

Referenced by Skin\getCachedNotice().

◆ $wgSitesCacheFile

$wgSitesCacheFile = false

Specify the file location for the Sites json cache file.

Definition at line 4014 of file DefaultSettings.php.

◆ $wgSiteStatsAsyncFactor

$wgSiteStatsAsyncFactor = false

Set this to an integer to only do synchronous site_stats updates one every this many updates.

The other requests go into pending delta values in $wgMemc. Make sure that $wgMemc is a global cache. If set to -1, updates only go to $wgMemc (useful for daemons).

Definition at line 6409 of file DefaultSettings.php.

◆ $wgSiteSupportPage

$wgSiteSupportPage = ''

If this is set, a "donate" link will appear in the sidebar.

Set it to a URL.

Definition at line 3273 of file DefaultSettings.php.

◆ $wgSiteTypes

$wgSiteTypes
Initial value:
= [
'mediawiki' => MediaWikiSite::class,
]

Register handlers for specific types of sites.

Since
1.20

Definition at line 8603 of file DefaultSettings.php.

Referenced by Site\newForType().

◆ $wgSkipSkin

$wgSkipSkin = ''
Deprecated:
since 1.23; use $wgSkipSkins instead

Definition at line 3298 of file DefaultSettings.php.

◆ $wgSkipSkins

$wgSkipSkins = []

Specify the names of skins that should not be presented in the list of available skins in user preferences.

If you want to remove a skin entirely, remove it from the skins/ directory and its entry from LocalSettings.php.

Definition at line 3293 of file DefaultSettings.php.

Referenced by Skin\getAllowedSkins().

◆ $wgSlaveLagCritical

$wgSlaveLagCritical = 30
See also
$wgSlaveLagWarning

Definition at line 2106 of file DefaultSettings.php.

◆ $wgSlaveLagWarning

$wgSlaveLagWarning = 10

If lag is higher than $wgSlaveLagWarning, show a warning in some special pages (like watchlist).

If the lag is higher than $wgSlaveLagCritical, show a more obvious warning.

Definition at line 2101 of file DefaultSettings.php.

◆ $wgSMTP

$wgSMTP = false

SMTP Mode.

For using a direct (authenticated) SMTP server connection. Default to false or fill an array :

'host' => 'SMTP domain',
'IDHost' => 'domain for MessageID',
'port' => '25',
'auth' => [true|false],
'username' => [SMTP username],
'password' => [SMTP password],
];

Definition at line 1691 of file DefaultSettings.php.

Referenced by UserMailer\makeMsgId(), and UserMailer\sendInternal().

◆ $wgSoftBlockRanges

string [] $wgSoftBlockRanges = []

IP ranges that should be considered soft-blocked (anon-only, account creation allowed).

The intent is to use this to prevent anonymous edits from shared resources such as Wikimedia Labs.

Since
1.29

Definition at line 5630 of file DefaultSettings.php.

Referenced by User\getBlockedStatus().

◆ $wgSoftwareTags

array $wgSoftwareTags
Initial value:
= [
'mw-contentmodelchange' => true,
'mw-new-redirect' => true,
'mw-removed-redirect' => true,
'mw-changed-redirect-target' => true,
'mw-blank' => true,
'mw-replace' => true,
'mw-rollback' => true,
'mw-undo' => true,
]

List of core tags to enable.

Available tags are:

  • 'mw-contentmodelchange': Edit changes content model of a page
  • 'mw-new-redirect': Edit makes new redirect page (new page or by changing content page)
  • 'mw-removed-redirect': Edit changes an existing redirect into a non-redirect
  • 'mw-changed-redirect-target': Edit changes redirect target
  • 'mw-blank': Edit completely blanks the page
  • 'mw-replace': Edit removes more than 90% of the content
  • 'mw-rollback': Edit is a rollback, made through the rollback link or rollback API
  • 'mw-undo': Edit made through an undo link
Since
1.31

Definition at line 7013 of file DefaultSettings.php.

Referenced by ChangeTags\getSoftwareTags().

◆ $wgSpamRegex

$wgSpamRegex = []

Edits matching these regular expressions in body text will be recognised as spam and rejected automatically.

There's no administrator override on-wiki, so be careful what you set. :) May be an array of regexes or a single string for backwards compatibility.

See also
https://en.wikipedia.org/wiki/Regular_expression
Note
Each regex needs a beginning/end delimiter, eg: # or /

Definition at line 5578 of file DefaultSettings.php.

Referenced by EditPage\matchSpamRegex().

◆ $wgSpecialPageCacheUpdates

$wgSpecialPageCacheUpdates
Initial value:
= [
'Statistics' => [ SiteStatsUpdate::class, 'cacheUpdate' ]
]

Additional functions to be performed with updateSpecialPages.

Expensive Querypages are already updated.

Definition at line 7573 of file DefaultSettings.php.

Referenced by UpdateSpecialPages\doSpecialPageCacheUpdates().

◆ $wgSpecialPages

$wgSpecialPages = []

Special page list.

This is an associative array mapping the (canonical) names of special pages to either a class name to be instantiated, or a callback to use for creating the special page object. In both cases, the result must be an instance of SpecialPage.

Definition at line 7344 of file DefaultSettings.php.

Referenced by SpecialPageFactory\getPageList().

◆ $wgSpecialVersionShowHooks

$wgSpecialVersionShowHooks = false

Show the contents of $wgHooks in Special:Version.

Definition at line 6288 of file DefaultSettings.php.

Referenced by SpecialVersion\getWgHooks().

◆ $wgSQLiteDataDir

◆ $wgSQLMode

$wgSQLMode = ''

SQL Mode - default is turning off all modes, including strict, if set.

null can be used to skip the setting for performance reasons and assume DBA has done his best job. String override can be used for some additional fun :-)

Definition at line 1884 of file DefaultSettings.php.

Referenced by MediaWikiTestCase\tearDown().

◆ $wgSquidMaxage

$wgSquidMaxage = 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.

Definition at line 2722 of file DefaultSettings.php.

Referenced by Skin\getDynamicStylesheetQuery(), and ApiMainTest\provideCheckConditionalRequestHeaders().

◆ $wgSquidPurgeUseHostHeader

$wgSquidPurgeUseHostHeader = true

Whether to use a Host header in purge requests sent to the proxy servers configured in $wgSquidServers.

Set this to false to support Squid configured in forward-proxy mode.

If this is set to true, a Host header will be sent, and only the path component of the URL will appear on the request line, as if the request were a non-proxy HTTP 1.1 request. Varnish only supports this style of request. Squid supports this style of request only if reverse-proxy mode (http_port ... accel) is enabled.

If this is set to false, no Host header will be sent, and the absolute URL will be sent in the request line, as is the standard for an HTTP proxy request in both HTTP 1.0 and 1.1. This style of request is not supported by Varnish, but is supported by Squid in either configuration (forward or reverse).

Since
1.21

Definition at line 2798 of file DefaultSettings.php.

Referenced by SquidPurgeClient\queuePurge().

◆ $wgSquidServers

$wgSquidServers = []

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.

Definition at line 2769 of file DefaultSettings.php.

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

◆ $wgSquidServersNoPurge

$wgSquidServersNoPurge = []

As above, 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

Definition at line 2777 of file DefaultSettings.php.

◆ $wgStatsdMetricPrefix

$wgStatsdMetricPrefix = 'MediaWiki'

Prefix for metric names sent to $wgStatsdServer.

See also
MediaWikiServices::getStatsdDataFactory
BufferingStatsdDataFactory
Since
1.25

Definition at line 6384 of file DefaultSettings.php.

◆ $wgStatsdSamplingRates

$wgStatsdSamplingRates
Initial value:
= [
'wanobjectcache:*' => 0.001
]

Sampling rate for statsd metrics as an associative array of patterns and rates.

Patterns are Unix shell patterns (e.g. 'MediaWiki.api.*'). Rates are sampling probabilities (e.g. 0.1 means 1 in 10 events are sampled).

Since
1.28

Definition at line 6392 of file DefaultSettings.php.

◆ $wgStatsdServer

$wgStatsdServer = false

Destination of statsd metrics.

A host or host:port of a statsd server. Port defaults to 8125.

If not set, statsd metrics will not be collected.

See also
wfLogProfilingData
Since
1.25

Definition at line 6375 of file DefaultSettings.php.

◆ $wgStrictFileExtensions

$wgStrictFileExtensions = true

If this is turned off, users may override the warning for files not covered by $wgFileExtensions.

Warning
Setting this to false is insecure for public wikis.

Definition at line 943 of file DefaultSettings.php.

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

◆ $wgStructuredChangeFiltersLiveUpdatePollingRate

$wgStructuredChangeFiltersLiveUpdatePollingRate = 3

Polling rate, in seconds, used by the 'live update' and 'view newest' features of the RCFilters app on SpecialRecentChanges and Special:Watchlist.

0 to disable completely.

Definition at line 6885 of file DefaultSettings.php.

◆ $wgStructuredChangeFiltersOnWatchlist

$wgStructuredChangeFiltersOnWatchlist = false

Whether to enable RCFilters app on Special:Watchlist.

Temporary variable during development and will be removed.

Definition at line 6878 of file DefaultSettings.php.

◆ $wgStructuredChangeFiltersShowPreference

$wgStructuredChangeFiltersShowPreference = false

Whether a preference is displayed for structured change filters.

If false, no preference is displayed and structured change filters are disabled. If true, structured change filters are enabled by default, and a preference is displayed that lets users disable them.

Temporary variable during development and will be removed.

Since
1.30

Definition at line 6871 of file DefaultSettings.php.

◆ $wgStyleDirectory

$wgStyleDirectory = "{$IP}/skins"

Filesystem stylesheets directory.

Defaults to "{$IP}/skins".

Since
1.3

Definition at line 250 of file DefaultSettings.php.

Referenced by WebInstallerOutput\getCSS(), Installer\getExistingLocalSettings(), UploadFromUrlTestSuite\setUp(), wfLoadSkin(), and wfLoadSkins().

◆ $wgStylePath

$wgStylePath = false

The URL path of the skins directory.

Defaults to "{$wgResourceBasePath}/skins".

Since
1.3

Definition at line 221 of file DefaultSettings.php.

Referenced by ResourceLoaderFileModule\extractBasePaths(), Skin\getSkinStylePath(), Parser\getVariableValue(), and SkinTemplate\prepareQuickTemplate().

◆ $wgStyleSheetPath

$wgStyleSheetPath = &$wgStylePath

The URL path to index.php.

Defaults to "{$wgScriptPath}/index.php".

Definition at line 222 of file DefaultSettings.php.

◆ $wgStyleVersion

$wgStyleVersion = '303'

Bump this number when changing the global style sheets and JavaScript.

It should be appended in the query string of static CSS and JS includes, to ensure that client-side caches do not keep obsolete copies of global styles.

Deprecated:
since 1.31

Definition at line 2573 of file DefaultSettings.php.

Referenced by Skin\getSkinStylePath().

◆ $wgSummarySpamRegex

$wgSummarySpamRegex = []

Same as the above except for edit summaries.

Definition at line 5583 of file DefaultSettings.php.

Referenced by EditPage\matchSummarySpamRegex().

◆ $wgSVGConverter

$wgSVGConverter = 'ImageMagick'

Pick a converter defined in $wgSVGConverters.

Definition at line 1146 of file DefaultSettings.php.

Referenced by SvgHandler\isEnabled(), SvgHandler\rasterize(), and ResourceLoaderImage\rasterize().

◆ $wgSVGConverterPath

$wgSVGConverterPath = ''

If not in the executable PATH, specify the SVG converter path.

Definition at line 1151 of file DefaultSettings.php.

Referenced by SvgHandler\rasterize(), and ResourceLoaderImage\rasterize().

◆ $wgSVGConverters

$wgSVGConverters
Initial value:
= [
'ImageMagick' =>
'$path/convert -background "#ffffff00" -thumbnail $widthx$height\! $input PNG:$output',
'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d '
. '$output $input',
'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt' ],
]

Scalable Vector Graphics (SVG) may be uploaded as images.

Since SVG support is not yet standard in browsers, it is necessary to rasterize SVGs to PNG as a fallback format.

An external program is required to perform this conversion. If set to an array, the first item is a PHP callable and any further items are passed as parameters after $srcPath, $dstPath, $width, $height

Definition at line 1131 of file DefaultSettings.php.

Referenced by SvgHandler\isEnabled(), and SvgHandler\rasterize().

◆ $wgSVGMaxSize

$wgSVGMaxSize = 5120

Don't scale a SVG larger than this.

Definition at line 1156 of file DefaultSettings.php.

Referenced by Linker\makeImageLink(), SvgHandler\normaliseParams(), and ImagePage\openShowImage().

◆ $wgSVGMetadataCutoff

$wgSVGMetadataCutoff = 262144

Don't read SVG metadata beyond this point.

Default is 1024*256 bytes

Definition at line 1162 of file DefaultSettings.php.

Referenced by SVGReader\__construct(), and UploadBase\checkXMLEncodingMissmatch().

◆ $wgSysopEmailBans

$wgSysopEmailBans = true

Allow sysops to ban users from accessing Emailuser.

Definition at line 5007 of file DefaultSettings.php.

Referenced by SpecialBlock\canBlockEmail().

◆ $wgTextModelsToParse

$wgTextModelsToParse
Initial value:

Determines which types of text are parsed as wikitext.

This does not imply that these kinds of texts are also rendered as wikitext, it only means that links, magic words, etc will have the effect on the database they would have on a wikitext page.

Todo:
On the long run, it would be nice to put categories etc into a separate structure, or at least parse only the contents of comments in the scripts.
Since
1.21

Definition at line 8592 of file DefaultSettings.php.

Referenced by TextContent\fillParserOutput().

◆ $wgThumbLimits

$wgThumbLimits
Initial value:
= [
120,
150,
180,
200,
250,
300
]

Adjust thumbnails on image pages according to a user setting.

In order to reduce disk usage, the values can only be selected from a list. This is the list of settings the user can choose from:

Definition at line 1397 of file DefaultSettings.php.

Referenced by Linker\makeImageLink(), and wfThumbIsStandard().

◆ $wgThumbnailBuckets

$wgThumbnailBuckets = null

When defined, is an array of image widths used as buckets for thumbnail generation.

The goal is to save resources by generating thumbnails based on reference buckets instead of always using the original. This will incur a speed gain but cause a quality loss.

The buckets generation is chained, with each bucket generated based on the above bucket when possible. File handlers have to opt into using that feature. For now only BitmapHandler supports it.

Definition at line 1415 of file DefaultSettings.php.

Referenced by File\getThumbnailBucket().

◆ $wgThumbnailEpoch

$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.

Update if there is some need to force thumbs and SVG rasterizations to rerender, such as fixes to rendering bugs.

Definition at line 1221 of file DefaultSettings.php.

Referenced by File\transform().

◆ $wgThumbnailMinimumBucketDistance

$wgThumbnailMinimumBucketDistance = 50

When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size.

The distance represents how many extra pixels of width the bucket needs in order to be used as the reference for a given thumbnail. For example, with the following buckets:

$wgThumbnailBuckets = [ 128, 256, 512 ];

and a distance of 50:

$wgThumbnailMinimumBucketDistance = 50;

If we want to render a thumbnail of width 220px, the 512px bucket will be used, because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.

Definition at line 1432 of file DefaultSettings.php.

Referenced by File\getThumbnailBucket().

◆ $wgThumbnailScriptPath

$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.

This is necessary if some of your apache servers don't have read/write access to the thumbnail path.

Example:
$wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";

Definition at line 842 of file DefaultSettings.php.

◆ $wgThumbUpright

$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.

Definition at line 1503 of file DefaultSettings.php.

Referenced by Linker\makeImageLink().

◆ $wgTidyBin

$wgTidyBin = 'tidy'

The path to the tidy binary.

Deprecated:
Use $wgTidyConfig['tidyBin']

Definition at line 4309 of file DefaultSettings.php.

Referenced by TidySupport\__construct(), and MWTidy\singleton().

◆ $wgTidyConf

$wgTidyConf = $IP . '/includes/tidy/tidy.conf'

The path to the tidy config file.

Deprecated:
Use $wgTidyConfig['tidyConfigFile']

Definition at line 4315 of file DefaultSettings.php.

Referenced by TidySupport\__construct(), and MWTidy\singleton().

◆ $wgTidyConfig

$wgTidyConfig = [ 'driver' => 'RemexHtml' ]

Configuration for HTML postprocessing tool.

Set this to a configuration array to enable an external tool. By default, we now use the RemexHtml library; historically, Dave Raggett's "HTML Tidy" was typically used. See https://www.w3.org/People/Raggett/tidy/

If this is null and $wgUseTidy is true, the deprecated configuration parameters will be used instead.

If this is null and $wgUseTidy is false, a pure PHP fallback will be used.

Keys are:

  • driver: May be:
    • RaggettInternalHHVM: Use the limited-functionality HHVM extension
    • RaggettInternalPHP: Use the PECL extension
    • RaggettExternal: Shell out to an external binary (tidyBin)
    • Html5Depurate: Use external Depurate service
    • Html5Internal: Use the Balancer library in PHP
    • RemexHtml: Use the RemexHtml library in PHP
  • tidyConfigFile: Path to configuration file for any of the Raggett drivers
  • debugComment: True to add a comment to the output with warning messages
  • tidyBin: For RaggettExternal, the path to the tidy binary.
  • tidyCommandLine: For RaggettExternal, additional command line options.

Definition at line 4297 of file DefaultSettings.php.

Referenced by TidySupport\__construct(), and MWTidy\singleton().

◆ $wgTidyInternal

$wgTidyInternal = extension_loaded( 'tidy' )

Set this to true to use the tidy extension.

Deprecated:
Use $wgTidyConfig['driver']

Definition at line 4327 of file DefaultSettings.php.

Referenced by TidySupport\__construct(), and MWTidy\singleton().

◆ $wgTidyOpts

$wgTidyOpts = ''

The command line options to the tidy binary.

Deprecated:
Use $wgTidyConfig['tidyCommandLine']

Definition at line 4321 of file DefaultSettings.php.

Referenced by TidySupport\__construct(), and MWTidy\singleton().

◆ $wgTiffThumbnailType

$wgTiffThumbnailType = false

Browsers don't support TIFF inline generally...

For inline display, we need to convert to PNG or JPEG. Note scaling should work with ImageMagick, but may not with GD scaling.

Example:
// PNG is lossless, but inefficient for photos
$wgTiffThumbnailType = [ 'png', 'image/png' ];
// JPEG is good for photos, but has no transparency support. Bad for diagrams.
$wgTiffThumbnailType = [ 'jpg', 'image/jpeg' ];

Definition at line 1213 of file DefaultSettings.php.

Referenced by TiffHandler\canRender(), and TiffHandler\getThumbType().

◆ $wgTmpDirectory

$wgTmpDirectory = false

The local filesystem path to a temporary directory.

This is not required to be web accessible.

When this setting is set to false, its value will be set through a call to wfTempDir(). See that methods implementation for the actual detection logic.

Developers should use the global function wfTempDir() instead of this variable.

See also
wfTempDir()
Note
Default changed to false in MediaWiki 1.20.

Definition at line 359 of file DefaultSettings.php.

Referenced by wfTempDir().

◆ $wgTrackingCategories

$wgTrackingCategories = []

Array holding default tracking category names.

Array contains the system messages for each tracking category. Tracking categories allow pages with certain characteristics to be tracked. It works by adding any such page to a category automatically.

A message with the suffix '-desc' should be added as a description message to have extra information on Special:TrackingCategories.

Deprecated:
since 1.25 Extensions should now register tracking categories using the new extension registration system.
Since
1.23

Definition at line 4095 of file DefaultSettings.php.

◆ $wgTransactionalTimeLimit

$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.

Since
1.26

Definition at line 2235 of file DefaultSettings.php.

Referenced by wfTransactionalTimeLimit().

◆ $wgTranscludeCacheExpiry

$wgTranscludeCacheExpiry = 3600

Expiry time for transcluded templates cached in transcache database table.

Only used $wgEnableInterwikiTranscluding is set to true.

Definition at line 4415 of file DefaultSettings.php.

Referenced by Parser\fetchScaryTemplateMaybeFromCache().

◆ $wgTranslateNumerals

$wgTranslateNumerals = true

For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface.

Definition at line 3037 of file DefaultSettings.php.

Referenced by Language\formatNum().

◆ $wgTrivialMimeDetection

$wgTrivialMimeDetection = false

Switch for trivial MIME detection.

Used by thumb.php to disable all fancy things, because only a few types of images are needed and file extensions can be trusted.

Definition at line 1362 of file DefaultSettings.php.

Referenced by StreamFile\contentTypeFromPath().

◆ $wgTrustedMediaFormats

$wgTrustedMediaFormats
Initial value:
= [
"image/svg+xml",
"application/pdf",
# "application/x-shockwave-flash",
]

list of trusted media-types and MIME types.

Use the MEDIATYPE_xxx constants to represent media types. This list is used by File::isSafeFile

Types not listed here will have a warning about unsafe content displayed on the images description page. It would also be possible to use this for further restrictions, like disabling direct [[media:...]] links for non-trusted formats.

Definition at line 968 of file DefaultSettings.php.

Referenced by File\getIsSafeFileUncached().

◆ $wgTrxProfilerLimits

$wgTrxProfilerLimits

Performance expectations for DB usage.

Since
1.26

Definition at line 6162 of file DefaultSettings.php.

Referenced by Maintenance\activateProfiler().

◆ $wgUniversalEditButton

$wgUniversalEditButton = true

Enable the UniversalEditButton for browsers that support it (currently only Firefox with an extension) See http://universaleditbutton.org for more background information.

Definition at line 6630 of file DefaultSettings.php.

◆ $wgUnwatchedPageSecret

$wgUnwatchedPageSecret = 1

If active watchers (per above) are this number or less, do not disclose it.

Left to 1, prevents unprivileged users from knowing for sure that there are 0. Set to -1 if you want to always complement watchers count with this info.

Since
1.26

Definition at line 6750 of file DefaultSettings.php.

◆ $wgUnwatchedPageThreshold

$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.

Since
1.21

Definition at line 7031 of file DefaultSettings.php.

◆ $wgUpdateCompatibleMetadata

$wgUpdateCompatibleMetadata = false

If to automatically update the img_metadata field if the metadata field is outdated but compatible with the current version.

Defaults to false.

Definition at line 698 of file DefaultSettings.php.

Referenced by ImageBuilder\__construct(), LocalFile\maybeUpgradeRow(), and RefreshImageMetadata\setupParameters().

◆ $wgUpdateRowsPerJob

$wgUpdateRowsPerJob = 300

Number of rows to update per job.

Definition at line 8431 of file DefaultSettings.php.

Referenced by BacklinkCache\getNumLinks(), HTMLCacheUpdateJob\run(), and RefreshLinksJob\run().

◆ $wgUpdateRowsPerQuery

◆ $wgUpgradeKey

$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.

It will subsequently be used as a password, to authorize further upgrades.

For security, do not set this to a guessable string. Use the value supplied by the install/upgrade process. To cause the upgrader to generate a new key, delete the old key from LocalSettings.php.

Definition at line 6696 of file DefaultSettings.php.

◆ $wgUploadBaseUrl

$wgUploadBaseUrl = ''

If set, this URL is added to the start of $wgUploadPath to form a complete upload URL.

Since
1.4

Definition at line 366 of file DefaultSettings.php.

◆ $wgUploadDialog

$wgUploadDialog

Configuration for file uploads using the embeddable upload dialog (https://www.mediawiki.org/wiki/Upload_dialog).

This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis using the action=query&meta=siteinfo API).

See below for documentation of each property. None of the properties may be omitted.

Definition at line 573 of file DefaultSettings.php.

◆ $wgUploadDirectory

$wgUploadDirectory = false

The filesystem path of the images directory.

Defaults to "{$IP}/images".

Definition at line 270 of file DefaultSettings.php.

Referenced by RepoGroupTest\setUpForeignRepo().

◆ $wgUploadMaintenance

$wgUploadMaintenance = false

To disable file delete/restore temporarily.

Definition at line 8543 of file DefaultSettings.php.

Referenced by FileDeleteForm\execute().

◆ $wgUploadMissingFileUrl

$wgUploadMissingFileUrl = false

Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl.

The URL will get "(?|&)wpDestFile=<filename>" appended to it as appropriate.

Definition at line 829 of file DefaultSettings.php.

Referenced by Linker\getUploadUrl(), and Linker\makeBrokenImageLinkObj().

◆ $wgUploadNavigationUrl

$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).

Example:
$wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';

Definition at line 822 of file DefaultSettings.php.

Referenced by SkinTemplate\buildNavUrls(), Linker\getUploadUrl(), and Linker\makeBrokenImageLinkObj().

◆ $wgUploadPath

$wgUploadPath = false

The URL path for the images directory.

Defaults to "{$wgScriptPath}/images".

Definition at line 265 of file DefaultSettings.php.

◆ $wgUploadSizeWarning

$wgUploadSizeWarning = false

Warn if uploaded files are larger than this (in bytes), or false to disable.

Definition at line 956 of file DefaultSettings.php.

Referenced by UploadBase\checkFileSize().

◆ $wgUploadStashMaxAge

$wgUploadStashMaxAge = 6 * 3600

The maximum age of temporary (incomplete) uploaded files.

Definition at line 408 of file DefaultSettings.php.

Referenced by UploadStashCleanup\execute().

◆ $wgUploadStashScalerBaseUrl

$wgUploadStashScalerBaseUrl = false

To enable remote on-demand scaling, set this to the thumbnail base URL.

Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg where 'e6' are the first two characters of the MD5 hash of the file name. If $wgUploadStashScalerBaseUrl is set to false, thumbs are rendered locally as needed.

Since
1.17

Definition at line 375 of file DefaultSettings.php.

◆ $wgUploadThumbnailRenderHttpCustomDomain

$wgUploadThumbnailRenderHttpCustomDomain = false

When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to.

Since
1.25

Definition at line 1472 of file DefaultSettings.php.

Referenced by ThumbnailRenderJob\hitThumbUrl().

◆ $wgUploadThumbnailRenderHttpCustomHost

$wgUploadThumbnailRenderHttpCustomHost = false

When using the "http" wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.

Since
1.25

Definition at line 1464 of file DefaultSettings.php.

Referenced by ThumbnailRenderJob\hitThumbUrl().

◆ $wgUploadThumbnailRenderMap

$wgUploadThumbnailRenderMap = []

When defined, is an array of thumbnail widths to be rendered at upload time.

The idea is to prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which has a performance impact for the first client to view a certain size.

This obviously means that more disk space is needed per upload upfront.

Since
1.25

Definition at line 1444 of file DefaultSettings.php.

Referenced by LocalFile\prerenderThumbnails().

◆ $wgUploadThumbnailRenderMethod

$wgUploadThumbnailRenderMethod = 'jobqueue'

The method through which the thumbnails will be prerendered for the entries in $wgUploadThumbnailRenderMap.

The method can be either "http" or "jobqueue". The former uses an http request to hit the thumbnail's URL. This method only works if thumbnails are configured to be rendered by a 404 handler. The latter option uses the job queue to render the thumbnail.

Since
1.25

Definition at line 1457 of file DefaultSettings.php.

Referenced by ThumbnailRenderJob\run().

◆ $wgUrlProtocols

$wgUrlProtocols
Initial value:
= [
'bitcoin:', 'ftp:
'nntp:
'svn:
]

URL schemes that should be recognized as valid by wfParseUrl().

WARNING: Do not add 'file:' to this or internal file links will be broken. Instead, if you want to support file links, add 'file://'. The same applies to any other protocols with the same name as a namespace. See task T46011 for more information.

See also
wfParseUrl

Definition at line 4220 of file DefaultSettings.php.

Referenced by ApiQueryExtLinksUsage\getProtocolPrefix(), ApiQueryExtLinksUsage\prepareProtocols(), wfEscapeWikiText(), wfParseUrl(), and wfUrlProtocols().

◆ $wgUseAjax

$wgUseAjax = true

Enable AJAX framework.

Deprecated:
(officially) since MediaWiki 1.31

Definition at line 8189 of file DefaultSettings.php.

Referenced by Skin\getDefaultModules().

◆ $wgUseAutomaticEditSummaries

$wgUseAutomaticEditSummaries = true

If user doesn't specify any edit summary when making a an edit, MediaWiki will try to automatically create one.

This feature can be disabled by set- ting this variable false.

Definition at line 6637 of file DefaultSettings.php.

Referenced by WikiPage\doEditContent().

◆ $wgUseCategoryBrowser

$wgUseCategoryBrowser = false

Use experimental, DMOZ-like category browser.

Definition at line 7598 of file DefaultSettings.php.

Referenced by Skin\getCategoryLinks().

◆ $wgUseCombinedLoginLink

$wgUseCombinedLoginLink = false

Login / create account link behavior when it's possible for anonymous users to create an account.

  • true = use a combined login / create account link
  • false = split login and create account into two separate links

Definition at line 3479 of file DefaultSettings.php.

Referenced by SkinTemplate\useCombinedLoginLink().

◆ $wgUseCopyrightUpload

$wgUseCopyrightUpload = false

Set this to true if you want detailed copyright information forms on Upload.

Definition at line 7125 of file DefaultSettings.php.

◆ $wgUseDatabaseMessages

$wgUseDatabaseMessages = true

Translation using MediaWiki: namespace.

Interface messages will be loaded from the database.

Definition at line 3043 of file DefaultSettings.php.

Referenced by TestSetup\applyInitialConfig(), DumpIterator\finalSetup(), and MessageCache\singleton().

◆ $wgUseESI

$wgUseESI = false

If you run Squid3 with ESI support, enable this (default:false):

Definition at line 2686 of file DefaultSettings.php.

◆ $wgUseFileCache

$wgUseFileCache = false

This will cache static pages for non-logged-in users to reduce database traffic on public sites.

ResourceLoader requests to default language and skins are cached as well as single module requests.

Definition at line 2580 of file DefaultSettings.php.

Referenced by PoolWorkArticleView\doWork(), PruneFileCache\execute(), RebuildFileCache\finalSetup(), HTMLCacheUpdateJob\invalidateTitles(), ResourceFileCache\useFileCache(), and Article\view().

◆ $wgUseFilePatrol

$wgUseFilePatrol = true

Use file patrolling to check new files on Special:Newfiles.

Note
If you disable all patrolling features, you probably also want to remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on Special:Log.
Since
1.27

Definition at line 6905 of file DefaultSettings.php.

Referenced by RecentChange\doMarkPatrolled(), Article\showPatrolFooter(), and User\useFilePatrol().

◆ $wgUseGzip

$wgUseGzip = false

When using the file cache, we can store the cached HTML gzipped to save disk space.

Pages will then also be served compressed to clients that support it.

Requires zlib support enabled in PHP.

Definition at line 2624 of file DefaultSettings.php.

Referenced by FileCacheBase\__construct().

◆ $wgUseImageMagick

$wgUseImageMagick = false

Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party converter, e.g.

GraphicMagick. These support more file formats than PHP, which only supports PNG, GIF, JPG, XBM and WBMP.

Use Image Magick instead of PHP builtin functions.

Definition at line 1038 of file DefaultSettings.php.

Referenced by RandomImageGenerator\getImageWriteMethod(), BitmapHandler\getScalerType(), and JpegPixelFormatTest\testPixelFormatRendering().

◆ $wgUseImageResize

$wgUseImageResize = true

Whether to enable server-side image thumbnailing.

If false, images will always be sent to the client in full resolution, with appropriate width= and height= attributes on the tag for the client to do its own scaling.

Definition at line 1028 of file DefaultSettings.php.

Referenced by BitmapHandler\getScalerType(), and JpegPixelFormatTest\testPixelFormatRendering().

◆ $wgUseInstantCommons

$wgUseInstantCommons = false

Use Commons as a remote file repository.

Essentially a wrapper, when this is enabled $wgForeignFileRepos will point at Commons with a set of default settings

Definition at line 551 of file DefaultSettings.php.

◆ $wgUseKeyHeader

$wgUseKeyHeader = false

Send the Key HTTP header for better caching.

See https://datatracker.ietf.org/doc/draft-fielding-http-key/ for details.

Since
1.27

Definition at line 2693 of file DefaultSettings.php.

Referenced by MediaWiki\OutputHandler\handleGzip().

◆ $wgUseLocalMessageCache

$wgUseLocalMessageCache = false

Set this to true to maintain a copy of the message cache on the local server.

This layer of message cache is in addition to the one configured by $wgMessageCacheType.

The local copy is put in APC. If APC is not installed, this setting does nothing.

Note that this is about the message cache, which stores interface messages maintained as wiki pages. This is separate from the localisation cache for interface messages provided by the software, which is configured by $wgLocalisationCacheConf.

Definition at line 2503 of file DefaultSettings.php.

Referenced by MessageCache\singleton().

◆ $wgUseMediaWikiUIEverywhere

$wgUseMediaWikiUIEverywhere = false

Temporary variable that applies MediaWiki UI wherever it can be supported.

Temporary variable that should be removed when mediawiki ui is more stable and change has been communicated.

Since
1.24

Definition at line 3234 of file DefaultSettings.php.

Referenced by LoginSignupSpecialPage\__construct(), Html\buttonAttributes(), Xml\checkLabel(), HTMLRadioField\formatOptions(), HTMLCheckField\getInputHTML(), Html\getTextInputAttributes(), and Xml\submitButton().

◆ $wgUseNPPatrol

$wgUseNPPatrol = true

Use new page patrolling to check new pages on Special:Newpages.

Note
If you disable all patrolling features, you probably also want to remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on Special:Log.

Definition at line 6894 of file DefaultSettings.php.

Referenced by WikiPage\doCreate(), RecentChange\doMarkPatrolled(), IRCColourfulRCFeedFormatter\getLine(), MachineReadableRCFeedFormatter\getLine(), Article\showPatrolFooter(), and User\useNPPatrol().

◆ $wgUsePathInfo

$wgUsePathInfo
Initial value:
= ( strpos( PHP_SAPI, 'cgi' ) === false ) &&
( strpos( PHP_SAPI, 'apache2filter' ) === false ) &&
( strpos( PHP_SAPI, 'isapi' ) === false )

Whether to support URLs like index.php/Page_title These often break when PHP is set up in CGI mode.

PATH_INFO may be correct if cgi.fix_pathinfo is set, but then again it may not; lighttpd converts incoming path data to lowercase on systems with case-insensitive filesystems, and there have been reports of problems on Apache as well.

To be safe we'll continue to keep it off by default.

Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly incorrect garbage, or to true if it is really correct.

The default $wgArticlePath will be set based on this value at runtime, but if you have customized it, having this incorrectly set to true can cause redirect loops when "pretty URLs" are used.

Since
1.2.1

Definition at line 177 of file DefaultSettings.php.

Referenced by WebRequest\getPathInfo().

◆ $wgUsePigLatinVariant

$wgUsePigLatinVariant = false

Whether to enable the pig latin variant of English (en-x-piglatin), used to ease variant development work.

Definition at line 3074 of file DefaultSettings.php.

Referenced by LanguageEn\__construct().

◆ $wgUsePrivateIPs

$wgUsePrivateIPs = false

Should forwarded Private IPs be accepted?

Definition at line 2862 of file DefaultSettings.php.

◆ $wgUseRCPatrol

$wgUseRCPatrol = true

Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files are included.

Note
If you disable all patrolling features, you probably also want to remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on Special:Log.

Definition at line 6859 of file DefaultSettings.php.

Referenced by WikiPage\commitRollback(), WikiPage\doCreate(), RecentChange\doMarkPatrolled(), WikiPage\doModify(), IRCColourfulRCFeedFormatter\getLine(), MachineReadableRCFeedFormatter\getLine(), DifferenceEngine\getMarkPatrolledLinkInfo(), RebuildRecentchanges\rebuildRecentChangesTablePass4(), Article\showPatrolFooter(), User\useFilePatrol(), User\useNPPatrol(), and User\useRCPatrol().

◆ $wgUserEmailConfirmationTokenExpiry

$wgUserEmailConfirmationTokenExpiry = 7 * 24 * 60 * 60

The time, in seconds, when an email confirmation email expires.

Definition at line 1660 of file DefaultSettings.php.

Referenced by User\confirmationToken().

◆ $wgUserEmailUseReplyTo

$wgUserEmailUseReplyTo = true

If true put the sending user's email in a Reply-To header instead of From (false).

($wgPasswordSender will be used as From.)

Some mailers (eg SMTP) set the SMTP envelope sender to the From value, which can cause problems with SPF validation and leak recipient addresses when bounces are sent to the sender. In addition, DMARC restrictions can cause emails to fail to be received when false.

Definition at line 1644 of file DefaultSettings.php.

◆ $wgUserrightsInterwikiDelimiter

$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.

"Someuser@enwiki").

It is recommended that you have this delimiter in $wgInvalidUsernameCharacters above, or you will not be able to modify the user rights of those users via Special:UserRights

Definition at line 4941 of file DefaultSettings.php.

Referenced by BotPassword\getSeparator(), LogPager\limitTitle(), and RightsLogFormatter\makePageLink().

◆ $wgUsersNotifiedOnAllChanges

$wgUsersNotifiedOnAllChanges = []

Array of usernames who will be sent a notification email for every change which occurs on a wiki.

Users will not be notified of their own changes.

Definition at line 1782 of file DefaultSettings.php.

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

◆ $wgUseSameSiteLegacyCookies

bool $wgUseSameSiteLegacyCookies = false

If true, when a cross-site cookie with SameSite=None is sent, a legacy cookie with an "ss0" prefix will also be sent, without SameSite=None.

This is a workaround for broken behaviour in Chrome 51-66 and similar browsers.

Since
1.31.9

Definition at line 6065 of file DefaultSettings.php.

Referenced by WebRequest\getCrossSiteCookie(), and WebResponse\setCookie().

◆ $wgUseSharedUploads

$wgUseSharedUploads = false

If you operate multiple wikis, you can define a shared upload path here.

Uploads to this wiki will NOT be put there - they will be put into $wgUploadDirectory. If $wgUseSharedUploads is set, the wiki will look in the shared repository if no file of the given name is found in the local repository (for [[File:..]], [[Media:..]] links). Thumbnails will also be looked for and generated in this directory.

Note that these configuration settings can now be defined on a per- repository basis for an arbitrary number of file repositories, using the $wgForeignFileRepos variable.

Definition at line 713 of file DefaultSettings.php.

◆ $wgUseSiteCss

$wgUseSiteCss = true

Use the site's Cascading Style Sheets (CSS)?

Definition at line 3330 of file DefaultSettings.php.

◆ $wgUseSiteJs

$wgUseSiteJs = true

Use the site's Javascript page?

Definition at line 3325 of file DefaultSettings.php.

◆ $wgUseSquid

$wgUseSquid = false

Enable/disable CDN.

See https://www.mediawiki.org/wiki/Manual:Squid_caching

Definition at line 2681 of file DefaultSettings.php.

Referenced by BenchmarkPurge\execute().

◆ $wgUseTagFilter

$wgUseTagFilter = true

Allow filtering by change tag in recentchanges, history, etc Has no effect if no tags are defined in valid_tag.

Definition at line 6997 of file DefaultSettings.php.

Referenced by ChangeTags\modifyDisplayQuery().

◆ $wgUseTeX

$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.

Please see math/README for more information.

Definition at line 6099 of file DefaultSettings.php.

◆ $wgUseTidy

$wgUseTidy = false

Set this to true to use the deprecated tidy configuration parameters.

Deprecated:
use $wgTidyConfig

Definition at line 4303 of file DefaultSettings.php.

Referenced by TidySupport\__construct(), CompareParsers\checkOptions(), and MWTidy\singleton().

◆ $wgUseTinyRGBForJPGThumbnails

$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.

Since
1.26

Definition at line 1480 of file DefaultSettings.php.

Referenced by JpegHandler\transformImageMagick().

◆ $wgUseTwoButtonsSearchForm

$wgUseTwoButtonsSearchForm = true

Search form behavior.

  • true = use Go & Search buttons
  • false = use Go button & Advanced search link

Definition at line 6566 of file DefaultSettings.php.

◆ $wgValidSkinNames

$wgValidSkinNames = []

List of valid skin names.

The key should be the name in all lower case, the value should be a properly cased name for the skin. This value will be prefixed with "Skin" to create the class name of the skin to load. Use Skin::getSkinNames() as an accessor if you wish to have access to the full list.

Definition at line 7336 of file DefaultSettings.php.

◆ $wgVariantArticlePath

$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.

Example:
$wgArticlePath = '/wiki/$1';

A link to /wiki/ would be redirected to /sr/Главна_страна

It is important that $wgArticlePath not overlap with possible values of $wgVariantArticlePath.

Definition at line 3104 of file DefaultSettings.php.

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

◆ $wgVaryOnXFP

$wgVaryOnXFP = false

Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds.

Use this if you have an SSL termination setup and need to split the cache between HTTP and HTTPS for API requests, feed requests and HTTP redirect responses in order to prevent cache pollution. This does not affect 'normal' requests to index.php other than HTTP redirects.

Definition at line 2703 of file DefaultSettings.php.

Referenced by ChannelFeed\httpHeaders(), and wfStreamThumb().

◆ $wgVerifyMimeType

$wgVerifyMimeType = true

Determines if the MIME type of uploaded files should be checked.

Definition at line 1329 of file DefaultSettings.php.

Referenced by StreamFile\contentTypeFromPath(), UploadBase\verifyFile(), and UploadBase\verifyMimeType().

◆ $wgVersion

◆ $wgVirtualRestConfig

array $wgVirtualRestConfig
Initial value:
= [
'paths' => [],
'modules' => [],
'global' => [
# Timeout in seconds
'timeout' => 360,
# 'domain' is set to $wgCanonicalServer in Setup.php
'forwardCookies' => false,
'HTTPProxy' => null
]
]

Global configuration variable for Virtual REST Services.

Use the 'path' key to define automatically mounted services. The value for this key is a map of path prefixes to service configuration. The latter is an array of:

  • class : the fully qualified class name
  • options : map of arguments to the class constructor Such services will be available to handle queries under their path from the VRS singleton, e.g. MediaWikiServices::getInstance()->getVirtualRESTServiceClient();

Auto-mounting example for Parsoid:

$wgVirtualRestConfig['paths']['/parsoid/'] = [ 'class' => ParsoidVirtualRESTService::class, 'options' => [ 'url' => 'http://localhost:8000', 'prefix' => 'enwiki', 'domain' => 'en.wikipedia.org' ] ];

Parameters for different services can also be declared inside the 'modules' value, which is to be treated as an associative array. The parameters in 'global' will be merged with service-specific ones. The result will then be passed to VirtualRESTService::__construct() in the module.

Example config for Parsoid:

$wgVirtualRestConfig['modules']['parsoid'] = [ 'url' => 'http://localhost:8000', 'prefix' => 'enwiki', 'domain' => 'en.wikipedia.org', ];

Since
1.25

Definition at line 8702 of file DefaultSettings.php.

◆ $wgWANObjectCaches

$wgWANObjectCaches
Initial value:
= [
'cacheId' => CACHE_NONE,
'channels' => []
]
]

Advanced WAN object cache configuration.

Each WAN cache wraps a registered object cache (for the local cluster) and it must also be configured to point to a PubSub instance. Subscribers must be configured to relay purges to the actual cache servers.

The format is an associative array where the key is a cache identifier, and the value is an associative array of parameters. The "cacheId" parameter is a cache identifier from $wgObjectCaches. The "channels" parameter is a map of actions ('purge') to PubSub channels defined in $wgEventRelayerConfig. The "loggroup" parameter controls where log events are sent.

Since
1.26

Definition at line 2381 of file DefaultSettings.php.

Referenced by ObjectCache\newWANCacheFromId().

◆ $wgWantedPagesThreshold

$wgWantedPagesThreshold = 1

Number of links to a page required before it is deemed "wanted".

Definition at line 2206 of file DefaultSettings.php.

◆ $wgWatchersMaxAge

$wgWatchersMaxAge = 180 * 24 * 3600

Page watchers inactive for more than this many seconds are considered inactive.

Used mainly by action=info. Default: 180 days = about six months.

Since
1.26

Definition at line 6742 of file DefaultSettings.php.

◆ $wgWhitelistRead

$wgWhitelistRead = false

Pages anonymous user may see, set as an array of pages titles.

Example:
$wgWhitelistRead = array ( "Main Page", "Wikipedia:Help");

Special:Userlogin and Special:ChangePassword are always whitelisted.

Note
This will only work if $wgGroupPermissions['*']['read'] is false – see below. Otherwise, ALL pages are accessible, regardless of this setting.
Also that this will only protect pages in the wiki. Uploaded files will remain readable. You can use img_auth.php to protect uploaded files, see https://www.mediawiki.org/wiki/Manual:Image_Authorization
Extensions should not modify this, but use the TitleReadWhitelist hook instead.

Definition at line 5057 of file DefaultSettings.php.

Referenced by Title\checkReadPermissions().

◆ $wgWhitelistReadRegexp

$wgWhitelistReadRegexp = false

Pages anonymous user may see, set as an array of regular expressions.

This function will match the regexp against the title name, which is without underscore.

Example:
To whitelist [[Main Page]]:
$wgWhitelistReadRegexp = [ "/Main Page/" ];
Note
Unless ^ and/or $ is specified, a regular expression might match pages not intended to be whitelisted. The above example will also whitelist a page named 'Security Main Page'.
Example:
To allow reading any page starting with 'User' regardless of the case:
$wgWhitelistReadRegexp = [ "@^UsEr.*@i" ];
Will allow both [[User is banned]] and [[User:JohnDoe]]
Note
This will only work if $wgGroupPermissions['*']['read'] is false – see below. Otherwise, ALL pages are accessible, regardless of this setting.

Definition at line 5085 of file DefaultSettings.php.

Referenced by Title\checkReadPermissions().

◆ $wgWikiDiff2MovedParagraphDetectionCutoff

$wgWikiDiff2MovedParagraphDetectionCutoff = 0

wikidiff2 supports detection of changes in moved paragraphs.

This setting controls the maximum number of paragraphs to compare before it bails out. Supported values:

  • 0: detection of moved paragraphs is disabled
  • int > 0: maximum number of paragraphs to compare Note: number of paragraph comparisons is in O(n^2). This setting is only effective if the wikidiff2 PHP/HHVM module is used as diffengine. See $wgExternalDiffEngine.
Since
1.30

Definition at line 8465 of file DefaultSettings.php.

◆ $wgXhtmlDefaultNamespace

$wgXhtmlDefaultNamespace = null

The default xmlns attribute.

The option to define this has been removed. The value of this variable is no longer used by core and is set to a fixed value in Setup.php for compatibility with extensions that depend on the value of this variable being set. Such a dependency however is deprecated.

Deprecated:
since 1.22

Definition at line 3198 of file DefaultSettings.php.

◆ $wgXhtmlNamespaces

$wgXhtmlNamespaces = []

Permit other namespaces in addition to the w3.org default.

Use the prefix for the key and the namespace for the value.

Example:
$wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';
Normally we wouldn't have to define this in the root "<html>" element, but IE needs it there in some circumstances.

This is ignored if $wgMimeType is set to a non-XML MIME type.

Definition at line 3259 of file DefaultSettings.php.

Referenced by Html\htmlHeader().

◆ $wgXMLMimeTypes

$wgXMLMimeTypes
Initial value:
= [
'http:
'svg' => 'image/svg+xml',
'http:
'http:
'html' => 'text/html',
]

Additional XML types we can allow via MIME-detection.

array = [ 'rootElement' => 'associatedMimeType' ]

Definition at line 1368 of file DefaultSettings.php.

AV_NO_VIRUS
const AV_NO_VIRUS
Definition: Defines.php:121
CONTENT_MODEL_JSON
const CONTENT_MODEL_JSON
Definition: Defines.php:249
$wgSitemapNamespacesPriorities
$wgSitemapNamespacesPriorities
Custom namespace priorities for sitemaps.
Definition: DefaultSettings.php:6589
NS_HELP
const NS_HELP
Definition: Defines.php:86
MEDIATYPE_AUDIO
const MEDIATYPE_AUDIO
Definition: defines.php:32
$wgAPIModules
$wgAPIModules
API module extensions.
Definition: DefaultSettings.php:8100
$wgDisabledVariants
$wgDisabledVariants
Disabled variants array of language variant conversion.
Definition: DefaultSettings.php:3085
$wgExemptFromUserRobotsControl
$wgExemptFromUserRobotsControl
An array of namespace keys in which the INDEX/__NOINDEX__ magic words will not function,...
Definition: DefaultSettings.php:8017
$wgExternalStores
$wgExternalStores
External stores allow including content from non database sources following URL links.
Definition: DefaultSettings.php:2139
array
the array() calling protocol came about after MediaWiki 1.4rc1.
AV_SCAN_FAILED
const AV_SCAN_FAILED
Definition: Defines.php:124
NS_TEMPLATE_TALK
const NS_TEMPLATE_TALK
Definition: Defines.php:85
$wgWhitelistReadRegexp
$wgWhitelistReadRegexp
Pages anonymous user may see, set as an array of regular expressions.
Definition: DefaultSettings.php:5085
text
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at etc Handles the details of getting and saving to the user table of the and dealing with sessions and cookies OutputPage Encapsulates the entire HTML page that will be sent in response to any server request It is used by calling its functions to add text
Definition: design.txt:18
CACHE_NONE
const CACHE_NONE
Definition: Defines.php:112
CONTENT_MODEL_CSS
const CONTENT_MODEL_CSS
Definition: Defines.php:247
CACHE_MEMCACHED
const CACHE_MEMCACHED
Definition: Defines.php:114
$wgMessagesDirs
$wgMessagesDirs
Extension messages directories.
Definition: DefaultSettings.php:7298
$wgMaxUploadSize
$wgMaxUploadSize
Max size for uploads, in bytes.
Definition: DefaultSettings.php:802
$wgExternalServers
$wgExternalServers
An array of external MySQL servers.
Definition: DefaultSettings.php:2155
CACHE_ACCEL
const CACHE_ACCEL
Definition: Defines.php:115
APCOND_EDITCOUNT
const APCOND_EDITCOUNT
Definition: Defines.php:215
NS_FILE
const NS_FILE
Definition: Defines.php:80
NS_TEMPLATE
const NS_TEMPLATE
Definition: Defines.php:84
APCOND_AGE
const APCOND_AGE
Definition: Defines.php:216
$wgArticleRobotPolicies
$wgArticleRobotPolicies
Robot policies per article.
Definition: DefaultSettings.php:8005
CONTENT_MODEL_WIKITEXT
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:245
http
Apache License January http
Definition: APACHE-LICENSE-2.0.txt:6
$wgDefaultExternalStore
array $wgDefaultExternalStore
The place to put new revisions, false to put them in the local text table.
Definition: DefaultSettings.php:2171
memory
MediaWiki has optional support for a high distributed memory object caching system For general information on but for a larger site with heavy like it should help lighten the load on the database servers by caching data and objects in memory
Definition: memcached.txt:10
skins
skin txt MediaWiki includes four core skins
Definition: skin.txt:5
true
null means default in associative array with keys and values unescaped Should be merged with default with a value of false meaning to suppress the attribute in associative array with keys and values unescaped noclasses just before the function returns a value If you return true
Definition: hooks.txt:2006
AV_SCAN_ABORTED
const AV_SCAN_ABORTED
Definition: Defines.php:123
$wgWhitelistRead
$wgWhitelistRead
Pages anonymous user may see, set as an array of pages titles.
Definition: DefaultSettings.php:5057
NS_MAIN
const NS_MAIN
Definition: Defines.php:74
$wgResourceModules
$wgResourceModules
Client-side resource modules.
Definition: DefaultSettings.php:3552
file
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing we can concentrate it all in an extension file
Definition: hooks.txt:106
$wgDBservers
$wgDBservers
Database load balancer This is a two-dimensional array, an array of server info structures Fields are...
Definition: DefaultSettings.php:1994
$wgRecentChangesFlags
$wgRecentChangesFlags
Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits.
Definition: DefaultSettings.php:7057
$wgGrantPermissions
array $wgGrantPermissions
Map of (grant => right => boolean) Users authorize consumers (like Apps) to act on their behalf but o...
Definition: DefaultSettings.php:5800
NS_PROJECT
const NS_PROJECT
Definition: Defines.php:78
$wgFilterLogTypes
$wgFilterLogTypes
Show/hide links on Special:Log will be shown for these log types.
Definition: DefaultSettings.php:7698
$wgCrossSiteAJAXdomains
$wgCrossSiteAJAXdomains
Settings for incoming cross-site AJAX requests: Newer browsers support cross-site AJAX when the targe...
Definition: DefaultSettings.php:8234
$wgAllowExternalImagesFrom
$wgAllowExternalImagesFrom
If the above is false, you can specify an exception here.
Definition: DefaultSettings.php:4249
$wgDjvuToXML
$wgDjvuToXML
Path of the djvutoxml executable This works like djvudump except much, much slower as of version 3....
Definition: DefaultSettings.php:1562
NS_MEDIAWIKI_TALK
const NS_MEDIAWIKI_TALK
Definition: Defines.php:83
$wgDebugLogGroups
$wgDebugLogGroups
Map of string log group names to log destinations.
Definition: DefaultSettings.php:6240
$wgHTCPRouting
$wgHTCPRouting
Routing configuration for HTCP multicast purging.
Definition: DefaultSettings.php:2851
$wgResourceLoaderSources
$wgResourceLoaderSources
Extensions should register foreign module sources here.
Definition: DefaultSettings.php:3654
AV_VIRUS_FOUND
const AV_VIRUS_FOUND
Definition: Defines.php:122
MEDIATYPE_BITMAP
const MEDIATYPE_BITMAP
Definition: defines.php:28
$wgImportSources
$wgImportSources
List of interwiki prefixes for wikis we'll accept as sources for Special:Import and API action=import...
Definition: DefaultSettings.php:7171
NS_CATEGORY
const NS_CATEGORY
Definition: Defines.php:88
$wgExtensionCredits
$wgExtensionCredits
An array of information about installed extensions keyed by their type.
Definition: DefaultSettings.php:7410
$wgAutoConfirmAge
$wgAutoConfirmAge
Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group me...
Definition: DefaultSettings.php:5386
$wgRemoveGroups
$wgRemoveGroups
Definition: DefaultSettings.php:5518
$wgSearchForwardUrl
$wgSearchForwardUrl
Set this to a URL to forward search requests to some external location.
Definition: DefaultSettings.php:6559
$wgHooks
$wgHooks['ArticleShow'][]
Definition: hooks.txt:108
will
</td >< td > &</td >< td > t want your writing to be edited mercilessly and redistributed at will
Definition: All_system_messages.txt:914
$wgResourceLoaderLESSVars
$wgResourceLoaderLESSVars
Global LESS variables.
Definition: DefaultSettings.php:3785
$wgNamespaceAliases
$wgNamespaceAliases
Namespace aliases.
Definition: DefaultSettings.php:3916
NS_USER_TALK
const NS_USER_TALK
Definition: Defines.php:77
$wgRateLimits
$wgRateLimits
Simple rate limiter options to brake edit floods.
Definition: DefaultSettings.php:5677
$wgLogoHD
$wgLogoHD
Array with URL paths to HD versions of the wiki logo.
Definition: DefaultSettings.php:310
options
We ve cleaned up the code here by removing clumps of infrequently used code and moving them off somewhere else It s much easier for someone working with this code to see what s _really_ going and make changes or fix bugs In we can take all the code that deals with the little used title reversing options(say) and put it in one place. Instead of having little title-reversing if-blocks spread all over the codebase in showAnArticle
$wgServer
$wgServer
URL of the server.
Definition: DefaultSettings.php:106
$wgLanguageCode
$wgLanguageCode
Site language code.
Definition: DefaultSettings.php:2887
CACHE_ANYTHING
const CACHE_ANYTHING
Definition: Defines.php:111
NS_PROJECT_TALK
const NS_PROJECT_TALK
Definition: Defines.php:79
$wgNamespaceRobotPolicies
$wgNamespaceRobotPolicies
Robot policies per namespaces.
Definition: DefaultSettings.php:7977
$wgTiffThumbnailType
$wgTiffThumbnailType
Browsers don't support TIFF inline generally...
Definition: DefaultSettings.php:1213
$wgAddGroups
$wgAddGroups
$wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups a...
Definition: DefaultSettings.php:5513
$wgSMTP
$wgSMTP
SMTP Mode.
Definition: DefaultSettings.php:1691
$wgCustomConvertCommand
$wgCustomConvertCommand
Use another resizing converter, e.g.
Definition: DefaultSettings.php:1079
$wgUploadNavigationUrl
$wgUploadNavigationUrl
Point the upload navigation link to an external URL Useful if you want to use a shared repository by ...
Definition: DefaultSettings.php:822
$wgForceUIMsgAsContentMsg
$wgForceUIMsgAsContentMsg
When translating messages with wfMessage(), it is not always clear what should be considered UI messa...
Definition: DefaultSettings.php:3132
$wgArticlePath
$wgArticlePath
Definition: img_auth.php:45
$wgMWLoggerDefaultSpi
$wgMWLoggerDefaultSpi
Default service provider for creating Psr\Log\LoggerInterface instances.
Definition: DefaultSettings.php:6263
$wgAutoConfirmCount
$wgAutoConfirmCount
Number of edits an account requires before it is autoconfirmed.
Definition: DefaultSettings.php:5397
$name
Allows to change the fields on the form that will be generated $name
Definition: hooks.txt:302
$wgPoolCounterConf
$wgPoolCounterConf
Configuration for processing pool control, for use in high-traffic wikis.
Definition: DefaultSettings.php:8538
MEDIATYPE_VIDEO
const MEDIATYPE_VIDEO
Definition: defines.php:35
NS_HELP_TALK
const NS_HELP_TALK
Definition: Defines.php:87
$wgThumbnailScriptPath
$wgThumbnailScriptPath
Give a path here to use thumb.php for thumbnail generation on client request, instead of generating t...
Definition: DefaultSettings.php:842
https
design txt This is a brief overview of the new design More thorough and up to date information is available on the documentation wiki at https
Definition: design.txt:12
$wgGrammarForms
$wgGrammarForms
Some languages need different word forms, usually for different cases.
Definition: DefaultSettings.php:2904
$wgExtensionMessagesFiles
$wgExtensionMessagesFiles['ExtensionNameMagic']
Definition: magicword.txt:43
$wgLocaltimezone
$wgLocaltimezone
Fake out the timezone that the server thinks it's in.
Definition: DefaultSettings.php:3157
format
if the prop value should be in the metadata multi language array format
Definition: hooks.txt:1656
as
This document is intended to provide useful advice for parties seeking to redistribute MediaWiki to end users It s targeted particularly at maintainers for Linux since it s been observed that distribution packages of MediaWiki often break We ve consistently had to recommend that users seeking support use official tarballs instead of their distribution s and this often solves whatever problem the user is having It would be nice if this could such as
Definition: distributors.txt:22
$wgCapitalLinkOverrides
$wgCapitalLinkOverrides
Definition: DefaultSettings.php:4058
$wgDnsBlacklistUrls
$wgDnsBlacklistUrls
List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
Definition: DefaultSettings.php:5615
NS_USER
const NS_USER
Definition: Defines.php:76
$wgGroupsRemoveFromSelf
$wgGroupsRemoveFromSelf
Definition: DefaultSettings.php:5297
NS_TALK
const NS_TALK
Definition: Defines.php:75
in
null for the wiki Added in
Definition: hooks.txt:1591
$wgRedirectSources
$wgRedirectSources
If local interwikis are set up which allow redirects, set this regexp to restrict URLs which will be ...
Definition: DefaultSettings.php:4033
$wgXhtmlNamespaces
$wgXhtmlNamespaces
Permit other namespaces in addition to the w3.org default.
Definition: DefaultSettings.php:3259
NS_MEDIAWIKI
const NS_MEDIAWIKI
Definition: Defines.php:82
class
you have access to all of the normal MediaWiki so you can get a DB use the etc For full docs on the Maintenance class
Definition: maintenance.txt:56
CONTENT_MODEL_JAVASCRIPT
const CONTENT_MODEL_JAVASCRIPT
Definition: Defines.php:246
$wgDBerrorLogTZ
$wgDBerrorLogTZ
Timezone to use in the error log.
Definition: DefaultSettings.php:2039
$wgResourceModuleSkinStyles
$wgResourceModuleSkinStyles
Skin-specific styles for resource modules.
Definition: DefaultSettings.php:3642
$wgGroupsAddToSelf
$wgGroupsAddToSelf
A map of group names that the user is in, to group names that those users are allowed to add or revok...
Definition: DefaultSettings.php:5292
CONTENT_MODEL_TEXT
const CONTENT_MODEL_TEXT
Definition: Defines.php:248
NS_FILE_TALK
const NS_FILE_TALK
Definition: Defines.php:81
NS_CATEGORY_TALK
const NS_CATEGORY_TALK
Definition: Defines.php:89
$wgPasswordConfig
$wgPasswordConfig
Configuration for built-in password types.
Definition: DefaultSettings.php:4776
$wgVariantArticlePath
$wgVariantArticlePath
Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which par...
Definition: DefaultSettings.php:3104
$wgAccountCreationThrottle
$wgAccountCreationThrottle
Number of accounts each IP address may create per specified period(s).
Definition: DefaultSettings.php:5562
false
processing should stop and the error should be shown to the user * false
Definition: hooks.txt:187
$wgExtraNamespaces
$wgExtraNamespaces
Additional namespaces.
Definition: DefaultSettings.php:3888
addresses
storage can be distributed across multiple and multiple web servers can use the same cache cluster *********************W A R N I N G ***********************Memcached has no security or authentication Please ensure that your server is appropriately and that the anyone on the internet can put data into and read data from your cache An attacker familiar with MediaWiki internals could use this to steal passwords and email addresses
Definition: memcached.txt:43
$wgNamespacesToBeSearchedDefault
$wgNamespacesToBeSearchedDefault
List of namespaces which are searched by default.
Definition: DefaultSettings.php:6534
CACHE_DB
const CACHE_DB
Definition: Defines.php:113
$wgInternalServer
$wgInternalServer
Internal server name as known to CDN, if different.
Definition: DefaultSettings.php:2713
$wgInterwikiPrefixDisplayTypes
$wgInterwikiPrefixDisplayTypes
Mapping of interwiki index prefixes to descriptors that can be used to change the display of interwik...
Definition: DefaultSettings.php:8867
MediaWiki
The MediaWiki class is the helper class for the index.php entry point.
Definition: MediaWiki.php:34
$type
$type
Definition: testCompression.php:48