MediaWiki  master
MediaWiki\MainConfigSchema Class Reference

This class contains schema declarations for all configuration variables known to MediaWiki core. More...

Static Public Member Functions

static getDefaultValue (string $name)
 Returns the default value of the given config setting. More...
 
static listDefaultValues (string $prefix='')
 Returns a generator for iterating over all config settings and their default values. More...
 

Public Attributes

const ConfigRegistry
 Registry of factory functions to create config objects: The 'main' key must be set, and the value should be a valid callable. More...
 
const Sitename
 Name of the site. More...
 
DJVU settings
const DjvuDump
 Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';. More...
 
const DjvuRenderer
 Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';. More...
 
const DjvuTxt
 Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';. More...
 
const DjvuPostProcessor
 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...
 
const DjvuOutputExtension
 File extension for the DJVU post processor output. More...
 
Email settings
const EmergencyContact
 Site admin email address. More...
 
const PasswordSender
 Sender email address for e-mail notifications. More...
 
const NoReplyAddress
 Reply-To address for e-mail notifications. More...
 
const EnableEmail
 Set to true to enable the e-mail basic features: Password reminders, etc. More...
 
const EnableUserEmail
 Set to true to enable user-to-user e-mail. More...
 
const EnableSpecialMute
 Set to true to enable the Special Mute page. More...
 
const EnableUserEmailMuteList
 Set to true to enable user-to-user e-mail mutelist. More...
 
const UserEmailUseReplyTo
 If true put the sending user's email in a Reply-To header instead of From (false). More...
 
const PasswordReminderResendTime
 Minimum time, in hours, which must elapse between password reminder emails for a given account. More...
 
const NewPasswordExpiry
 The time, in seconds, when an emailed temporary password expires. More...
 
const UserEmailConfirmationTokenExpiry
 The time, in seconds, when an email confirmation email expires. More...
 
const PasswordExpirationDays
 The number of days that a user's password is good for. More...
 
const PasswordExpireGrace
 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...
 
const SMTP
 SMTP Mode. More...
 
const AdditionalMailParams
 Additional email parameters, will be passed as the last argument to mail() call. More...
 
const AllowHTMLEmail
 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...
 
const EnotifFromEditor
 Allow sending of e-mail notifications with the editor's address as sender. More...
 
const EmailAuthentication
 Require email authentication before sending mail to an email address. More...
 
const EnotifWatchlist
 Allow users to enable email notification ("enotif") on watchlist changes. More...
 
const EnotifUserTalk
 Allow users to enable email notification ("enotif") when someone edits their user talk page. More...
 
const EnotifRevealEditorAddress
 Allow sending of e-mail notifications with the editor's address in "Reply-To". More...
 
const EnotifMinorEdits
 Potentially send notification mails on minor edits to pages. More...
 
const EnotifImpersonal
 Send a generic mail instead of a personalised mail for each user. More...
 
const EnotifMaxRecips
 Maximum number of users to mail at once when using impersonal mail. More...
 
const EnotifUseRealName
 Use real name instead of username in e-mail "from" field. More...
 
const UsersNotifiedOnAllChanges
 Array of usernames who will be sent a notification email for every change which occurs on a wiki. More...
 
Content handlers and storage
const ContentHandlers
 Plugins for page content model handling. More...
 
const NamespaceContentModels
 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...
 
const ContentHandlerTextFallback
 How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText(): More...
 
const TextModelsToParse
 Determines which types of text are parsed as wikitext. More...
 
const CompressRevisions
 We can also compress text stored in the 'text' table. More...
 
const ExternalStores
 List of enabled ExternalStore protocols. More...
 
const ExternalServers
 Shortcut for setting $wgLBFactoryConf["externalClusters"]. More...
 
const DefaultExternalStore
 The place to put new text blobs or false to put them in the text table of the local wiki database. More...
 
const RevisionCacheExpiry
 Revision text may be cached in the main WAN cache to reduce load on external storage servers and object extraction overhead for frequently-loaded revisions. More...
 
const PageLanguageUseDB
 Enable page language feature Allows setting page language in database. More...
 
const DiffEngine
 Specify the difference engine to use. More...
 
const ExternalDiffEngine
 Name of the external diff engine to use. More...
 
Performance hacks and limits
const RequestTimeLimit
 Set a limit on server request wall clock time. More...
 
const TransactionalTimeLimit
 The request time limit for "slow" write requests that should not be interrupted due to the risk of data corruption. More...
 
const CriticalSectionTimeLimit
 The maximum time critical sections are allowed to stay open. More...
 
const MiserMode
 Disable database-intensive features. More...
 
const DisableQueryPages
 Disable all query pages if miser mode is on, not just some. More...
 
const QueryCacheLimit
 Number of rows to cache in 'querycache' table when miser mode is on. More...
 
const WantedPagesThreshold
 Number of links to a page required before it is deemed "wanted". More...
 
const AllowSlowParserFunctions
 Enable slow parser functions. More...
 
const AllowSchemaUpdates
 Allow schema updates. More...
 
const MaxArticleSize
 Maximum article size in kibibytes. More...
 
const MemoryLimit
 The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount. More...
 
const PoolCounterConf
 Configuration for processing pool control, for use in high-traffic wikis. More...
 
const MaxUserDBWriteDuration
 Max time (in seconds) a user-generated transaction can spend in writes. More...
 
const MaxJobDBWriteDuration
 Max time (in seconds) a job-generated transaction can spend in writes. More...
 
const LinkHolderBatchSize
 LinkHolderArray batch size For debugging. More...
 
const MaximumMovedPages
 Maximum number of pages to move at once when moving subpages with a page. More...
 
const ForceDeferredUpdatesPreSend
 Force deferred updates to be run before sending a response to the client, instead of attempting to run them after sending the response. More...
 
const MultiShardSiteStats
 Whether site_stats table should have multiple rows. More...
 
Cache settings
const CacheDirectory
 Directory for caching data in the local filesystem. More...
 
const MainCacheType
 Main cache type. More...
 
const MessageCacheType
 The cache type for storing the contents of the MediaWiki namespace. More...
 
const ParserCacheType
 The cache type for storing article HTML. More...
 
const SessionCacheType
 The cache backend for storing session data. More...
 
const LanguageConverterCacheType
 The cache type for storing language conversion tables, which are used when parsing certain text and interface messages. More...
 
const StatsCacheType
 The object cache type for stats storage. More...
 
const ObjectCaches
 Advanced object cache configuration. More...
 
const MainWANCache
 Main Wide-Area-Network cache type. More...
 
const WANObjectCaches
 Advanced WAN object cache configuration. More...
 
const MainStash
 The object store type of the main stash. More...
 
const ParsoidCacheConfig
 Configuration for the caching related to parsoid output. More...
 
const ChronologyProtectorStash
 The object store type for the ChronologyProtector store. More...
 
const ParserCacheExpireTime
 The expiry time for the parser cache, in seconds. More...
 
const OldRevisionParserCacheExpireTime
 The expiry time for the parser cache for old revisions, in seconds. More...
 
const ObjectCacheSessionExpiry
 The expiry time to use for session storage, in seconds. More...
 
const PHPSessionHandling
 Whether to use PHP session handling ($_SESSION and session_*() functions) More...
 
const SuspiciousIpExpiry
 Time in seconds to remember IPs for, for the purposes of logging IP changes within the same session. More...
 
const SessionPbkdf2Iterations
 Number of internal PBKDF2 iterations to use when deriving session secrets. More...
 
const MemCachedServers
 The list of MemCached servers and port numbers. More...
 
const MemCachedPersistent
 Use persistent connections to MemCached, which are shared across multiple requests. More...
 
const MemCachedTimeout
 Read/write timeout for MemCached server communication, in microseconds. More...
 
const UseLocalMessageCache
 Set this to true to maintain a copy of the message cache on the local server. More...
 
const AdaptiveMessageCache
 Instead of caching everything, only cache those messages which have been customised in the site content language. More...
 
const LocalisationCacheConf
 Localisation cache configuration. More...
 
const CachePages
 Allow client-side caching of pages. More...
 
const CacheEpoch
 Set this to current time to invalidate all prior cached pages. More...
 
const GitInfoCacheDirectory
 Directory where GitInfo will look for pre-computed cache files. More...
 
const UseFileCache
 This will cache static pages for non-logged-in users to reduce database traffic on public sites. More...
 
const FileCacheDepth
 Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory. More...
 
const RenderHashAppend
 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...
 
const EnableSidebarCache
 If on, the sidebar navigation links are cached for users with the current language set. More...
 
const SidebarCacheExpiry
 Expiry time for the sidebar cache, in seconds. More...
 
const UseGzip
 When using the file cache, we can store the cached HTML gzipped to save disk space. More...
 
const InvalidateCacheOnLocalSettingsChange
 Invalidate various caches when LocalSettings.php changes. More...
 
const ExtensionInfoMTime
 When loading extensions through the extension registration system, this can be used to invalidate the cache. More...
 
const EnableRemoteBagOStuffTests
 If this is set to true, phpunit will run integration tests against remote caches defined in $wgObjectCaches. More...
 
HTTP proxy (CDN) settings

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

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

const UseCdn
 Enable/disable CDN. More...
 
const VaryOnXFP
 Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds. More...
 
const InternalServer
 Internal server name as known to CDN, if different. More...
 
const CdnMaxAge
 Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI). More...
 
const CdnMaxageLagged
 Cache timeout for the CDN when DB replica DB lag is high. More...
 
const CdnMaxageStale
 Cache timeout when delivering a stale ParserCache response due to PoolCounter contention. More...
 
const CdnReboundPurgeDelay
 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...
 
const CdnMaxageSubstitute
 Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load) More...
 
const ForcedRawSMaxage
 Default maximum age for raw CSS/JS accesses. More...
 
const CdnServers
 List of proxy servers to purge on changes; default port is 80. More...
 
const CdnServersNoPurge
 As with $wgCdnServers, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc. More...
 
const SquidPurgeUseHostHeader
 Whether to use a Host header in purge requests sent to the proxy servers configured in $wgCdnServers. More...
 
const HTCPRouting
 Routing configuration for HTCP multicast purging. More...
 
const HTCPMulticastTTL
 HTCP multicast TTL. More...
 
const UsePrivateIPs
 Should forwarded Private IPs be accepted? More...
 
const CdnMatchParameterOrder
 Set this to false if MediaWiki is behind a CDN that re-orders query parameters on incoming requests. More...
 
Output format and skin settings
const MimeType
 The default Content-Type header. More...
 
const Html5Version
 Defines the value of the version attribute in the <html> tag, if any. More...
 
const HTMLFormAllowTableFormat
 Temporary variable that allows HTMLForms to be rendered as tables. More...
 
const UseMediaWikiUIEverywhere
 Temporary variable that applies MediaWiki UI wherever it can be supported. More...
 
const EditSubmitButtonLabelPublish
 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...
 
const XhtmlNamespaces
 Permit other namespaces in addition to the w3.org default. More...
 
const SiteNotice
 Site notice shown at the top of each page. More...
 
const BrowserFormatDetection
 Override ability of certains browsers to attempt to autodetect dataformats in pages. More...
 
const SkinMetaTags
 An array of open graph tags which should be added by all skins. More...
 
const DefaultSkin
 Default skin, for new users and anonymous visitors. More...
 
const FallbackSkin
 Fallback skin used when the skin defined by $wgDefaultSkin can't be found. More...
 
const SkipSkins
 Specify the names of skins that should not be presented in the list of available skins in user preferences. More...
 
const DisableOutputCompression
 Disable output compression (enabled by default if zlib is available) More...
 
const FragmentMode
 How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of: More...
 
const ExternalInterwikiFragmentMode
 Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragmentMode above for details of each mode. More...
 
const FooterIcons
 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...
 
const UseCombinedLoginLink
 Login / create account link behavior when it's possible for anonymous users to create an account. More...
 
const Edititis
 Display user edit counts in various prominent places. More...
 
const Send404Code
 Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output. More...
 
const ShowRollbackEditCount
 The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back. More...
 
const EnableCanonicalServerLink
 Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e. More...
 
User rights, access control and monitoring
const AutoblockExpiry
 Number of seconds before autoblock entries expire. More...
 
const BlockAllowsUTEdit
 Set this to true to allow blocked users to edit their own user talk page. More...
 
const BlockCIDRLimit
 Limits on the possible sizes of range blocks. More...
 
const BlockDisablesLogin
 If true, sitewide blocked users will not be allowed to login. More...
 
const EnablePartialActionBlocks
 Flag to enable partial blocks against performing certain actions. More...
 
const WhitelistRead
 Pages anonymous user may see, set as an array of pages titles. More...
 
const WhitelistReadRegexp
 Pages anonymous user may see, set as an array of regular expressions. More...
 
const EmailConfirmToEdit
 Should editors be required to have a validated e-mail address before being allowed to edit? More...
 
const HideIdentifiableRedirects
 Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public. More...
 
const GroupPermissions
 Permission keys given to users in each group. More...
 
const RevokePermissions
 Permission keys revoked from users in each group. More...
 
const GroupInheritsPermissions
 Groups that should inherit permissions from another group. More...
 
const ImplicitGroups
 Implicit groups, aren't shown on Special:Listusers or somewhere else. More...
 
const GroupsAddToSelf
 A map of group names that the user is in, to group names that those users are allowed to add or revoke. More...
 
const GroupsRemoveFromSelf
 
const RestrictionTypes
 Set of available actions that can be restricted via action=protect You probably shouldn't change this. More...
 
const RestrictionLevels
 Rights which can be required for each protection level (via action=protect) More...
 
const CascadingRestrictionLevels
 Restriction levels that can be used with cascading protection. More...
 
const SemiprotectedRestrictionLevels
 Restriction levels that should be considered "semiprotected". More...
 
const NamespaceProtection
 Set the minimum permissions required to edit pages in each namespace. More...
 
const NonincludableNamespaces
 Pages in namespaces in this array can not be used as templates. More...
 
const AutoConfirmAge
 Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group membership. More...
 
const AutoConfirmCount
 Number of edits an account requires before it is autoconfirmed. More...
 
const Autopromote
 Array containing the conditions of automatic promotion of a user to specific groups. More...
 
const AutopromoteOnce
 Automatically add a usergroup to any user who matches certain conditions. More...
 
const AutopromoteOnceLogInRC
 Put user rights log entries for autopromotion in recent changes? More...
 
const AddGroups
 $wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups at Special:Userrights. More...
 
const RemoveGroups
 
const AvailableRights
 A list of available rights, in addition to the ones defined by the core. More...
 
const DeleteRevisionsLimit
 Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission. More...
 
const DeleteRevisionsBatchSize
 Page deletions with > this number of revisions will use the job queue. More...
 
const HideUserContribLimit
 The maximum number of edits a user can have and can still be hidden by users with the hideuser permission. More...
 
const AccountCreationThrottle
 Number of accounts each IP address may create per specified period(s). More...
 
const SpamRegex
 Edits matching these regular expressions in body text will be recognised as spam and rejected automatically. More...
 
const SummarySpamRegex
 Same as SpamRegex except for edit summaries. More...
 
const EnableDnsBlacklist
 Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies. More...
 
const DnsBlacklistUrls
 List of DNS blacklists to use, if $wgEnableDnsBlacklist is true. More...
 
const ProxyList
 List of banned IP addresses. More...
 
const ProxyWhitelist
 Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say. More...
 
const SoftBlockRanges
 IP ranges that should be considered soft-blocked (anon-only, account creation allowed). More...
 
const ApplyIpBlocksToXff
 Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them. More...
 
const RateLimits
 Simple rate limiter options to brake edit floods. More...
 
const RateLimitsExcludedIPs
 Array of IPs / CIDR ranges which should be excluded from rate limits. More...
 
const PutIPinRC
 Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g. More...
 
const QueryPageDefaultLimit
 Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere. More...
 
const PasswordAttemptThrottle
 Limit password attempts to X attempts per Y seconds per IP per account. More...
 
const GrantPermissions
 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...
 
const GrantPermissionGroups
 
const EnableBotPasswords
 
const BotPasswordsCluster
 Cluster for the bot_passwords table. More...
 
const BotPasswordsDatabase
 Database name for the bot_passwords table. More...
 
Security
const SecretKey
 This should always be customised in LocalSettings.php. More...
 
const AllowUserJs
 Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load. More...
 
const AllowUserCss
 Allow user Cascading Style Sheets (CSS)? This enables a lot of neat customizations, but may increase security risk to users and server load. More...
 
const AllowUserCssPrefs
 Allow style-related user-preferences? More...
 
const UseSiteJs
 Use the site's Javascript page? More...
 
const UseSiteCss
 Use the site's Cascading Style Sheets (CSS)? More...
 
const BreakFrames
 Break out of framesets. More...
 
const EditPageFrameOptions
 The X-Frame-Options header to send on pages sensitive to clickjacking attacks, such as edit pages. More...
 
const ApiFrameOptions
 Disallow framing of API pages directly, by setting the X-Frame-Options header. More...
 
const CSPHeader
 Controls Content-Security-Policy header [Experimental]. More...
 
const CSPReportOnlyHeader
 Controls Content-Security-Policy-Report-Only header. More...
 
const CSPFalsePositiveUrls
 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...
 
const AllowCrossOrigin
 Allow anonymous cross origin requests. More...
 
const RestAllowCrossOriginCookieAuth
 Allows authenticated cross-origin requests to the REST API with session cookies. More...
 
const SessionSecret
 Secret for session storage. More...
 
const SessionInsecureSecrets
 If for some reason you can't install the PHP OpenSSL extension, you can set this to true to make MediaWiki work again at the cost of storing sensitive session data insecurely. More...
 
const HKDFSecret
 Secret for hmac-based key derivation function (fast, cryptographically secure random numbers). More...
 
const HKDFAlgorithm
 Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers). More...
 
Cookie settings
const CookieExpiration
 Default cookie lifetime, in seconds. More...
 
const ExtendedLoginCookieExpiration
 Default login cookie lifetime, in seconds. More...
 
const CookieDomain
 Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net". More...
 

Server URLs and file paths

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

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

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

const Server
 URL of the server. More...
 
const CanonicalServer
 Canonical URL of the server, to use in IRC feeds and notification e-mails. More...
 
const ServerName
 Server name. More...
 
const AssumeProxiesUseDefaultProtocolPorts
 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...
 
const HttpsPort
 For installations where the canonical server is HTTP but HTTPS is optionally supported, you can specify a non-standard HTTPS port here. More...
 
const ForceHTTPS
 If this is true, when an insecure HTTP request is received, always redirect to HTTPS. More...
 
const ScriptPath
 The path we should point to. More...
 
const UsePathInfo
 Whether to support URLs like index.php/Page_title. More...
 
const Script
 The URL path to index.php. More...
 
const LoadScript
 The URL path to load.php. More...
 
const RestPath
 The URL path to the REST API Defaults to "{$wgScriptPath}/rest.php". More...
 
const StylePath
 The URL path of the skins directory. More...
 
const LocalStylePath
 The URL path of the skins directory. More...
 
const ExtensionAssetsPath
 The URL path of the extensions directory. More...
 
const ExtensionDirectory
 Extensions directory in the file system. More...
 
const StyleDirectory
 Skins directory in the file system. More...
 
const BaseDirectory
 Absolute filesystem path of the root directory of the MediaWiki installation. More...
 
const ArticlePath
 The URL path for primary article page views. More...
 
const UploadPath
 The URL path for the images directory. More...
 
const ImgAuthPath
 The base path for img_auth.php. More...
 
const ThumbPath
 The base path for thumb_handler.php. More...
 
const UploadDirectory
 The filesystem path of the images directory. More...
 
const FileCacheDirectory
 Directory where the cached page will be saved. More...
 
const Logo
 The URL path of the wiki logo. More...
 
const Logos
 Specification for different versions of the wiki logo. More...
 
const LogoHD
 Array with URL paths to HD versions of the wiki logo. More...
 
const Favicon
 The URL path of the icon. More...
 
const AppleTouchIcon
 The URL path of the icon for iPhone and iPod Touch web app bookmarks. More...
 
const ReferrerPolicy
 Value for the referrer policy meta tag. More...
 
const TmpDirectory
 The local filesystem path to a temporary directory. More...
 
const UploadBaseUrl
 If set, this URL is added to the start of $wgUploadPath to form a complete upload URL. More...
 
const UploadStashScalerBaseUrl
 To enable remote on-demand scaling, set this to the thumbnail base URL. More...
 
const ActionPaths
 To set 'pretty' URL paths for actions other than plain page views, add to this array. More...
 
const MainPageIsDomainRoot
 Option to whether serve the main page as the domain root. More...
 
static getDefaultUsePathInfo ()
 
static getDefaultScript ( $scriptPath)
 
static getDefaultLoadScript ( $scriptPath)
 
static getDefaultRestPath ( $scriptPath)
 
static getDefaultStylePath ( $resourceBasePath)
 
static getDefaultLocalStylePath ( $scriptPath)
 
static getDefaultExtensionAssetsPath ( $resourceBasePath)
 
static getDefaultArticlePath (string $script, $usePathInfo)
 
static getDefaultUploadPath ( $scriptPath)
 
static getDefaultUploadDirectory ( $baseDirectory)
 
static getDefaultFileCacheDirectory ( $uploadDirectory)
 
static getDefaultLogo ( $resourceBasePath)
 

Files and file uploads

const EnableUploads
 Allow users to upload files. More...
 
const UploadStashMaxAge
 The maximum age of temporary (incomplete) uploaded files. More...
 
const EnableAsyncUploads
 Enable deferred upload tasks that use the job queue. More...
 
const UploadMaintenance
 To disable file delete/restore temporarily. More...
 
const IllegalFileChars
 Additional characters that are not allowed in filenames. More...
 
const DeletedDirectory
 What directory to place deleted uploads in. More...
 
const ImgAuthDetails
 Set this to true if you use img_auth and want the user to see details on why access failed. More...
 
const ImgAuthUrlPathMap
 Map of relative URL directories to match to internal mwstore:// base storage paths. More...
 
const LocalFileRepo
 File repository structures. More...
 
const ForeignFileRepos
 Enable the use of files from one or more other wikis. More...
 
const UseInstantCommons
 Use Wikimedia Commons as a foreign file repository. More...
 
const UseSharedUploads
 Shortcut for adding an entry to $wgForeignFileRepos. More...
 
const SharedUploadDirectory
 Shortcut for the 'directory' setting of $wgForeignFileRepos. More...
 
const SharedUploadPath
 Shortcut for the 'url' setting of $wgForeignFileRepos. More...
 
const HashedSharedUploadDirectory
 Shortcut for the 'hashLevels' setting of $wgForeignFileRepos. More...
 
const RepositoryBaseUrl
 Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos. More...
 
const FetchCommonsDescriptions
 Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos. More...
 
const SharedUploadDBname
 Shortcut for the ForeignDBRepo 'dbName' setting in $wgForeignFileRepos. More...
 
const SharedUploadDBprefix
 Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos. More...
 
const CacheSharedUploads
 Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos. More...
 
const ForeignUploadTargets
 Array of foreign file repo names (set in $wgForeignFileRepos above) that are allowable upload targets. More...
 
const UploadDialog
 Configuration for file uploads using the embeddable upload dialog (https://www.mediawiki.org/wiki/Upload_dialog). More...
 
const FileBackends
 File backend structure configuration. More...
 
const LockManagers
 List of lock manager backend configurations. More...
 
const ShowEXIF
 Whether to show Exif data. More...
 
const UpdateCompatibleMetadata
 Shortcut for the 'updateCompatibleMetadata' setting of $wgLocalFileRepo. More...
 
const AllowCopyUploads
 Allow for upload to be copied from an URL. More...
 
const CopyUploadsDomains
 A list of domains copy uploads can come from. More...
 
const CopyUploadsFromSpecialUpload
 Enable copy uploads from Special:Upload. More...
 
const CopyUploadProxy
 Proxy to use for copy upload requests. More...
 
const CopyUploadTimeout
 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...
 
const CopyUploadAllowOnWikiDomainConfig
 If true, the value of $wgCopyUploadsDomains will be merged with the contents of MediaWiki:Copyupload-allowed-domains. More...
 
const MaxUploadSize
 Max size for uploads, in bytes. More...
 
const MinUploadChunkSize
 Minimum upload chunk size, in bytes. More...
 
const UploadNavigationUrl
 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...
 
const UploadMissingFileUrl
 Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl. More...
 
const ThumbnailScriptPath
 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...
 
const SharedThumbnailScriptPath
 Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos. More...
 
const HashedUploadDirectory
 Shortcut for setting hashLevels=2 in $wgLocalFileRepo. More...
 
const FileExtensions
 This is the list of preferred extensions for uploading files. More...
 
const ProhibitedFileExtensions
 Files with these extensions will never be allowed as uploads. More...
 
const MimeTypeExclusions
 Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled. More...
 
const CheckFileExtensions
 This is a flag to determine whether or not to check file extensions on upload. More...
 
const StrictFileExtensions
 If this is turned off, users may override the warning for files not covered by $wgFileExtensions. More...
 
const DisableUploadScriptChecks
 Setting this to true will disable the upload system's checks for HTML/JavaScript. More...
 
const UploadSizeWarning
 Warn if uploaded files are larger than this (in bytes), or false to disable. More...
 
const TrustedMediaFormats
 list of trusted media-types and MIME types. More...
 
const MediaHandlers
 Plugins for media file type handling. More...
 
const NativeImageLazyLoading
 Toggles native image lazy loading, via the "loading" attribute. More...
 
const ParserTestMediaHandlers
 Media handler overrides for parser tests (they don't need to generate actual thumbnails, so a mock will do) More...
 
const UseImageResize
 Whether to enable server-side image thumbnailing. More...
 
const UseImageMagick
 Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party converter, e.g. More...
 
const ImageMagickConvertCommand
 The convert command shipped with ImageMagick. More...
 
const MaxInterlacingAreas
 Array of max pixel areas for interlacing per MIME type. More...
 
const SharpenParameter
 Sharpening parameter to ImageMagick. More...
 
const SharpenReductionThreshold
 Reduction in linear dimensions below which sharpening will be enabled. More...
 
const ImageMagickTempDir
 Temporary directory used for ImageMagick. More...
 
const CustomConvertCommand
 Use another resizing converter, e.g. More...
 
const JpegTran
 used for lossless jpeg rotation More...
 
const JpegPixelFormat
 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...
 
const JpegQuality
 When scaling a JPEG thumbnail, this is the quality we request from the backend. More...
 
const Exiv2Command
 Some tests and extensions use exiv2 to manipulate the Exif metadata in some image formats. More...
 
const Exiftool
 Path to exiftool binary. More...
 
const SVGConverters
 Scalable Vector Graphics (SVG) may be uploaded as images. More...
 
const SVGConverter
 Pick a converter defined in $wgSVGConverters. More...
 
const SVGConverterPath
 If not in the executable PATH, specify the SVG converter path. More...
 
const SVGMaxSize
 Don't scale a SVG larger than this. More...
 
const SVGMetadataCutoff
 Don't read SVG metadata beyond this point. More...
 
const MediaInTargetLanguage
 Whether thumbnails should be generated in target language (usually, same as page language), if available. More...
 
const MaxImageArea
 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...
 
const MaxAnimatedGifArea
 Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnail. More...
 
const TiffThumbnailType
 Browsers don't support TIFF inline generally... More...
 
const ThumbnailEpoch
 If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if the file didn't already exist. More...
 
const AttemptFailureEpoch
 Certain operations are avoided if there were too many recent failures, for example, thumbnail generation. More...
 
const IgnoreImageErrors
 If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an error message. More...
 
const GenerateThumbnailOnParse
 Render thumbnails while parsing wikitext. More...
 
const ShowArchiveThumbnails
 Show thumbnails for old images on the image description page. More...
 
const EnableAutoRotation
 If set to true, images that contain certain the exif orientation tag will be rotated accordingly. More...
 
const Antivirus
 Internal name of virus scanner. More...
 
const AntivirusSetup
 Configuration for different virus scanners. More...
 
const AntivirusRequired
 Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected. More...
 
const VerifyMimeType
 Determines if the MIME type of uploaded files should be checked. More...
 
const VerifyMimeTypeIE
 Determines whether extra checks for IE type detection should be applied. More...
 
const MimeTypeFile
 Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php. More...
 
const MimeInfoFile
 Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php. More...
 
const MimeDetectorCommand
 Sets an external MIME detector program. More...
 
const TrivialMimeDetection
 Switch for trivial MIME detection. More...
 
const XMLMimeTypes
 Additional XML types we can allow via MIME-detection. More...
 
const ImageLimits
 Limit images on image description pages to a user-selectable limit. More...
 
const ThumbLimits
 Adjust thumbnails on image pages according to a user setting. More...
 
const ThumbnailNamespaces
 Defines what namespaces thumbnails will be displayed for in Special:Search. More...
 
const ThumbnailBuckets
 When defined, is an array of image widths used as buckets for thumbnail generation. More...
 
const ThumbnailMinimumBucketDistance
 When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size. More...
 
const UploadThumbnailRenderMap
 When defined, is an array of thumbnail widths to be rendered at upload time. More...
 
const UploadThumbnailRenderMethod
 The method through which the thumbnails will be prerendered for the entries in $wgUploadThumbnailRenderMap. More...
 
const UploadThumbnailRenderHttpCustomHost
 When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header. More...
 
const UploadThumbnailRenderHttpCustomDomain
 When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to. More...
 
const UseTinyRGBForJPGThumbnails
 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...
 
const GalleryOptions
 Parameters for the "<gallery>" tag. More...
 
const ThumbUpright
 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...
 
const DirectoryMode
 Default value for chmoding of new directories. More...
 
const ResponsiveImages
 Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities. More...
 
const ImagePreconnect
 Add a preconnect link for browsers to a remote FileRepo host. More...
 
static getDefaultDeletedDirectory ( $uploadDirectory)
 
static getDefaultLocalFileRepo ( $uploadDirectory, $scriptPath, $favicon, $uploadBaseUrl, $uploadPath, $hashedUploadDirectory, $thumbnailScriptPath, $generateThumbnailOnParse, $deletedDirectory, $updateCompatibleMetadata)
 Allow users to upload files. More...
 
static getDefaultShowEXIF ()
 

Database settings

const DBname
 Current wiki database name. More...
 
const DBmwschema
 Current wiki database schema name. More...
 
const DBprefix
 Current wiki database table name prefix. More...
 
const DBserver
 Database host name or IP address. More...
 
const DBport
 Database port number. More...
 
const DBuser
 Database username. More...
 
const DBpassword
 Database user's password. More...
 
const DBtype
 Database type. More...
 
const DBssl
 Whether to use SSL in DB connection. More...
 
const DBcompress
 Whether to use compression in DB connection. More...
 
const DBadminuser
 Separate username for maintenance tasks. More...
 
const DBadminpassword
 Separate password for maintenance tasks. More...
 
const SearchType
 Search type. More...
 
const SearchTypeAlternatives
 Alternative search types. More...
 
const DBTableOptions
 MySQL table options to use during installation or update. More...
 
const SQLMode
 SQL Mode - default is turning off all modes, including strict, if set. More...
 
const DBDefaultGroup
 Default group to use when getting database connections. More...
 
const SQLiteDataDir
 To override default SQLite data directory ($docroot/../data) More...
 
const SharedDB
 Shared database for multiple wikis. More...
 
const SharedPrefix
 
const SharedTables
 
const SharedSchema
 
const DBservers
 Database load balancer This is a two-dimensional array, a list of server info structures Fields are: More...
 
const LBFactoryConf
 Load balancer factory configuration To set up a multi-primary wiki farm, set the class here to something that can return a LoadBalancer with an appropriate primary on a call to getMainLB(). More...
 
const DataCenterUpdateStickTTL
 After a state-changing request is done by a client, this determines how many seconds that client should keep using the primary datacenter. More...
 
const DBerrorLog
 File to log database errors to. More...
 
const DBerrorLogTZ
 Timezone to use in the error log. More...
 
const LocalDatabases
 Other wikis on this site, can be administered from a single developer account. More...
 
const DatabaseReplicaLagWarning
 If lag is higher than $wgDatabaseReplicaLagWarning, show a warning in some special pages (like watchlist). More...
 
const DatabaseReplicaLagCritical
 
const MaxExecutionTimeForExpensiveQueries
 Max execution time for queries of several expensive special pages such as RecentChanges in milliseconds. More...
 
const TemplateLinksSchemaMigrationStage
 Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields. More...
 
const ExternalLinksSchemaMigrationStage
 Externallinks table schema migration stage. More...
 
static getDefaultSharedPrefix ( $dbPrefix)
 
static getDefaultSharedSchema ( $dbMwschema)
 
static getDefaultDBerrorLogTZ ( $localtimezone)
 Current wiki database name. More...
 

Language, regional and character encoding settings

const LanguageCode
 Site language code. More...
 
const GrammarForms
 Some languages need different word forms, usually for different cases. More...
 
const InterwikiMagic
 Treat language links as magic connectors, not inline links. More...
 
const HideInterlanguageLinks
 Hide interlanguage links from the sidebar. More...
 
const ExtraInterlanguageLinkPrefixes
 List of additional interwiki prefixes that should be treated as interlanguage links (i.e. More...
 
const InterlanguageLinkCodeMap
 Map of interlanguage link codes to language codes. More...
 
const ExtraLanguageNames
 List of language names or overrides for default names in Names.php. More...
 
const ExtraLanguageCodes
 List of mappings from one language code to another. More...
 
const DummyLanguageCodes
 Functionally the same as $wgExtraLanguageCodes, but deprecated. More...
 
const AllUnicodeFixes
 Set this to always convert certain Unicode sequences to modern ones regardless of the content language. More...
 
const LegacyEncoding
 Set this to eg 'ISO-8859-1' to perform character set conversion when loading old revisions not marked with "utf-8" flag. More...
 
const AmericanDates
 Enable dates like 'May 12' instead of '12 May', if the default date format is 'dmy or mdy'. More...
 
const TranslateNumerals
 For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface. More...
 
const UseDatabaseMessages
 Translation using MediaWiki: namespace. More...
 
const MaxMsgCacheEntrySize
 Maximum entry size in the message cache, in bytes. More...
 
const DisableLangConversion
 Whether to enable language variant conversion. More...
 
const DisableTitleConversion
 Whether to enable language variant conversion for links. More...
 
const DefaultLanguageVariant
 Default variant code. More...
 
const UsePigLatinVariant
 Whether to enable the pig Latin variant of English (en-x-piglatin), used to ease variant development work. More...
 
const DisabledVariants
 Disabled variants array of language variant conversion. More...
 
const VariantArticlePath
 Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which parts of the URL contain the language variant. More...
 
const LoginLanguageSelector
 Show a bar of language selection links in the user login and user registration forms; edit the "loginlanguagelinks" message to customise these. More...
 
const ForceUIMsgAsContentMsg
 When translating messages with wfMessage(), it is not always clear what should be considered UI messages and what should be content messages. More...
 
const RawHtmlMessages
 List of messages which might contain raw HTML. More...
 
const Localtimezone
 Fake out the timezone that the server thinks it's in. More...
 
const LocalTZoffset
 Set an offset from UTC in minutes to use for the default timezone setting for anonymous users and new user accounts. More...
 
const OverrideUcfirstCharacters
 Map of Unicode characters for which capitalization is overridden in Language::ucfirst. More...
 
static getDefaultLocaltimezone ()
 Site language code. More...
 
static getDefaultLocalTZoffset ( $localtimezone)
 Site language code. More...
 

ResourceLoader settings

const MangleFlashPolicy
 Formerly a workaround for a security vulnerability caused by installation of Flash as a browser extension. More...
 
const ResourceModules
 Define extra client-side modules to be registered with ResourceLoader. More...
 
const ResourceModuleSkinStyles
 Add extra skin-specific styles to a resource module. More...
 
const ResourceLoaderSources
 Extensions should register foreign module sources here. More...
 
const ResourceBasePath
 The default 'remoteBasePath' value for instances of MediaWiki\ResourceLoader\FileModule. More...
 
const ResourceLoaderMaxage
 Override how long a CDN or browser may cache a ResourceLoader HTTP response. More...
 
const ResourceLoaderUseObjectCacheForDeps
 Use the main stash instead of the module_deps table for indirect dependency tracking. More...
 
const ResourceLoaderDebug
 The default debug mode (on/off) for of ResourceLoader requests. More...
 
const ResourceLoaderMaxQueryLength
 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...
 
const ResourceLoaderValidateJS
 If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it. More...
 
const ResourceLoaderEnableJSProfiler
 When enabled, execution of JavaScript modules is profiled client-side. More...
 
const ResourceLoaderStorageEnabled
 Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API. More...
 
const ResourceLoaderStorageVersion
 Cache version for client-side ResourceLoader module storage. More...
 
const AllowSiteCSSOnRestrictedPages
 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...
 
const VueDevelopmentMode
 Whether to use the development version of Vue.js. More...
 
static getDefaultResourceBasePath ( $scriptPath)
 

Page titles and redirects

const MetaNamespace
 Name of the project namespace. More...
 
const MetaNamespaceTalk
 Name of the project talk namespace. More...
 
const CanonicalNamespaceNames
 Canonical namespace names. More...
 
const ExtraNamespaces
 Additional namespaces. More...
 
const ExtraGenderNamespaces
 Same as above, but for namespaces with gender distinction. More...
 
const NamespaceAliases
 Define extra namespace aliases. More...
 
const LegalTitleChars
 Allowed title characters – regex character class Don't change this unless you know what you're doing. More...
 
const RememberMe
 Configures RememberMe authentication request added by AuthManager. More...
 
const ReauthenticateTime
 Time frame for re-authentication. More...
 
const AllowSecuritySensitiveOperationIfCannotReauthenticate
 Whether to allow security-sensitive operations when re-authentication is not possible. More...
 
const ChangeCredentialsBlacklist
 List of AuthenticationRequest class names which are not changeable through Special:ChangeCredentials and the changeauthenticationdata API. More...
 
const RemoveCredentialsBlacklist
 List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata API. More...
 
const MinimalPasswordLength
 Specifies the minimal length of a user password. More...
 
const MaximalPasswordLength
 Specifies the maximal length of a user password (T64685). More...
 
const InvalidPasswordReset
 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...
 
const PasswordDefault
 Default password type to use when hashing user passwords. More...
 
const PasswordConfig
 Configuration for built-in password types. More...
 
const PasswordResetRoutes
 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...
 
const MaxSigChars
 Maximum number of Unicode characters in signature. More...
 
const SignatureValidation
 Behavior of signature validation. More...
 
const SignatureAllowedLintErrors
 List of lint error codes which don't cause signature validation to fail. More...
 
const MaxNameChars
 Maximum number of bytes in username. More...
 
const ReservedUsernames
 Array of usernames which may not be registered or logged in from Maintenance scripts can still use these. More...
 
const DefaultUserOptions
 Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts. More...
 
const HiddenPrefs
 An array of preferences to not show for the user. More...
 
const InvalidUsernameCharacters
 Characters to prevent during new account creations. More...
 
const UserrightsInterwikiDelimiter
 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...
 
const SecureLogin
 This is to let user authenticate using https when they come from http. More...
 
const AuthenticationTokenVersion
 Versioning for authentication tokens. More...
 
const SessionProviders
 MediaWiki\Session\SessionProvider configuration. More...
 
const AllowRequiringEmailForResets
 Temporary feature flag that controls whether users will see a checkbox allowing them to require providing email during password resets. More...
 
const AutoCreateTempUser
 Configuration for automatic creation of temporary accounts on page save. More...
 
static getDefaultMetaNamespace ( $sitename)
 

Detailed Description

This class contains schema declarations for all configuration variables known to MediaWiki core.

The schema definitions follow the JSON Schema specification.

See also
https://json-schema.org/learn/getting-started-step-by-step.html
https://json-schema.org/understanding-json-schema/

The following JSON schema keys are used by MediaWiki:

  • default: the configuration variable's default value.
  • type: identifies the allowed value type or types. In addition to JSON Schema types, PHPDoc style type definitions are supported for convenience. Note that 'array' must not be used for associative arrays. To avoid confusion, use 'list' for sequential arrays and 'map' for associative arrays with uniform values. The 'object' type should be used for structures that have a known set of meaningful properties, especially if each property may have a different kind of value. See MediaWiki\\Settings\\Source\\JsonTypeHelper for details.

The following additional keys are used by MediaWiki:

Note
After changing this file, run maintenance/generateConfigSchema.php to update all the files derived from the information in MainConfigSchema.
Since
1.39

Definition at line 118 of file MainConfigSchema.php.

Member Function Documentation

◆ getDefaultArticlePath()

static MediaWiki\MainConfigSchema::getDefaultArticlePath ( string  $script,
  $usePathInfo 
)
static
Parameters
string$scriptValue of Script
mixed$usePathInfoValue of UsePathInfo
Returns
string

Definition at line 531 of file MainConfigSchema.php.

◆ getDefaultDBerrorLogTZ()

static MediaWiki\MainConfigSchema::getDefaultDBerrorLogTZ (   $localtimezone)
static

Current wiki database name.

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

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

Definition at line 3164 of file MainConfigSchema.php.

◆ getDefaultDeletedDirectory()

static MediaWiki\MainConfigSchema::getDefaultDeletedDirectory (   $uploadDirectory)
static
Parameters
mixed$uploadDirectoryValue of UploadDirectory
Returns
string

Definition at line 921 of file MainConfigSchema.php.

◆ getDefaultExtensionAssetsPath()

static MediaWiki\MainConfigSchema::getDefaultExtensionAssetsPath (   $resourceBasePath)
static
Parameters
mixed$resourceBasePathValue of ResourceBasePath
Returns
string

Definition at line 473 of file MainConfigSchema.php.

◆ getDefaultFileCacheDirectory()

static MediaWiki\MainConfigSchema::getDefaultFileCacheDirectory (   $uploadDirectory)
static
Parameters
mixed$uploadDirectoryValue of UploadDirectory
Returns
string

Definition at line 612 of file MainConfigSchema.php.

◆ getDefaultLoadScript()

static MediaWiki\MainConfigSchema::getDefaultLoadScript (   $scriptPath)
static
Parameters
mixed$scriptPathValue of ScriptPath
Returns
string

Definition at line 393 of file MainConfigSchema.php.

◆ getDefaultLocalFileRepo()

static MediaWiki\MainConfigSchema::getDefaultLocalFileRepo (   $uploadDirectory,
  $scriptPath,
  $favicon,
  $uploadBaseUrl,
  $uploadPath,
  $hashedUploadDirectory,
  $thumbnailScriptPath,
  $generateThumbnailOnParse,
  $deletedDirectory,
  $updateCompatibleMetadata 
)
static

Allow users to upload files.

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

Since
1.5

Definition at line 1094 of file MainConfigSchema.php.

◆ getDefaultLocalStylePath()

static MediaWiki\MainConfigSchema::getDefaultLocalStylePath (   $scriptPath)
static
Parameters
mixed$scriptPathValue of ScriptPath
Returns
string

Definition at line 452 of file MainConfigSchema.php.

◆ getDefaultLocaltimezone()

static MediaWiki\MainConfigSchema::getDefaultLocaltimezone ( )
static

Site language code.

See includes/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 4906 of file MainConfigSchema.php.

◆ getDefaultLocalTZoffset()

static MediaWiki\MainConfigSchema::getDefaultLocalTZoffset (   $localtimezone)
static

Site language code.

See includes/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 4932 of file MainConfigSchema.php.

◆ getDefaultLogo()

static MediaWiki\MainConfigSchema::getDefaultLogo (   $resourceBasePath)
static
Parameters
mixed$resourceBasePathValue of ResourceBasePath
Returns
string

Definition at line 633 of file MainConfigSchema.php.

◆ getDefaultMetaNamespace()

static MediaWiki\MainConfigSchema::getDefaultMetaNamespace (   $sitename)
static
Parameters
mixed$sitenameValue of Sitename
Returns
string

Definition at line 5891 of file MainConfigSchema.php.

◆ getDefaultResourceBasePath()

static MediaWiki\MainConfigSchema::getDefaultResourceBasePath (   $scriptPath)
static
Parameters
mixed$scriptPathValue of ScriptPath
Returns
string

Definition at line 5745 of file MainConfigSchema.php.

◆ getDefaultRestPath()

static MediaWiki\MainConfigSchema::getDefaultRestPath (   $scriptPath)
static
Parameters
mixed$scriptPathValue of ScriptPath
Returns
string

Definition at line 412 of file MainConfigSchema.php.

◆ getDefaultScript()

static MediaWiki\MainConfigSchema::getDefaultScript (   $scriptPath)
static
Parameters
mixed$scriptPathValue of ScriptPath
Returns
string

Definition at line 373 of file MainConfigSchema.php.

◆ getDefaultSharedPrefix()

static MediaWiki\MainConfigSchema::getDefaultSharedPrefix (   $dbPrefix)
static
Parameters
mixed$dbPrefixValue of DBprefix
Returns
mixed

Definition at line 3005 of file MainConfigSchema.php.

◆ getDefaultSharedSchema()

static MediaWiki\MainConfigSchema::getDefaultSharedSchema (   $dbMwschema)
static
Parameters
mixed$dbMwschemaValue of DBmwschema
Returns
mixed

Definition at line 3035 of file MainConfigSchema.php.

◆ getDefaultShowEXIF()

static MediaWiki\MainConfigSchema::getDefaultShowEXIF ( )
static
Returns
bool

Definition at line 1409 of file MainConfigSchema.php.

◆ getDefaultStylePath()

static MediaWiki\MainConfigSchema::getDefaultStylePath (   $resourceBasePath)
static
Parameters
mixed$resourceBasePathValue of ResourceBasePath
Returns
string

Definition at line 432 of file MainConfigSchema.php.

◆ getDefaultUploadDirectory()

static MediaWiki\MainConfigSchema::getDefaultUploadDirectory (   $baseDirectory)
static
Parameters
mixed$baseDirectoryValue of BaseDirectory
Returns
string

Definition at line 594 of file MainConfigSchema.php.

◆ getDefaultUploadPath()

static MediaWiki\MainConfigSchema::getDefaultUploadPath (   $scriptPath)
static
Parameters
mixed$scriptPathValue of ScriptPath
Returns
string

Definition at line 552 of file MainConfigSchema.php.

◆ getDefaultUsePathInfo()

static MediaWiki\MainConfigSchema::getDefaultUsePathInfo ( )
static
Returns
bool

Definition at line 349 of file MainConfigSchema.php.

◆ getDefaultValue()

static MediaWiki\MainConfigSchema::getDefaultValue ( string  $name)
static

Returns the default value of the given config setting.

Note
This method is relatively slow, it should not be used by performance critical code. Application logic should generally use ConfigSchema instead
Parameters
string$nameThe config setting name.
Returns
mixed The given config setting's default value, or null if no default value is specified in the schema.

Definition at line 177 of file MainConfigSchema.php.

◆ listDefaultValues()

static MediaWiki\MainConfigSchema::listDefaultValues ( string  $prefix = '')
static

Returns a generator for iterating over all config settings and their default values.

The primary use of this method is to import default values into local scope.

foreach ( MainConfigSchema::listDefaultValues( 'wg' ) as $var => $value ) {
$$var = $value;
}
static listDefaultValues(string $prefix='')
Returns a generator for iterating over all config settings and their default values.

There should be no reason for application logic to do this.

Note
This method is relatively slow, it should not be used by performance critical code. Application logic should generally use ConfigSchema instead
Parameters
string$prefixA prefix to prepend to each setting name. Typically, this will be "wg" when constructing global variable names.
Returns
Generator<string,mixed> $settingName => $defaultValue

Definition at line 142 of file MainConfigSchema.php.

Member Data Documentation

◆ AccountCreationThrottle

const MediaWiki\MainConfigSchema::AccountCreationThrottle
Initial value:
= [
'default' => [ [
'count' => 0,
'seconds' => 86400,
] ],
'type' => 'int|list',
]

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,
],
];
$wgAccountCreationThrottle
Config variable stub for the AccountCreationThrottle setting, for use by phpdoc and IDEs.
Note
For backwards compatibility reasons, this my also be given as a single integer, representing the number of account creations per day.
Warning
Requires $wgMainCacheType to be enabled

Definition at line 8183 of file MainConfigSchema.php.

◆ ActionPaths

const MediaWiki\MainConfigSchema::ActionPaths
Initial value:
= [
'default' => [],
'type' => 'map',
]

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 837 of file MainConfigSchema.php.

◆ AdaptiveMessageCache

const MediaWiki\MainConfigSchema::AdaptiveMessageCache
Initial value:
= [
'default' => 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 4130 of file MainConfigSchema.php.

◆ AddGroups

const MediaWiki\MainConfigSchema::AddGroups
Initial value:
= [
'default' => [],
'type' => 'map',
]

$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;
$wgAddGroups
Config variable stub for the AddGroups setting, for use by phpdoc and IDEs.

Bureaucrats can only remove bots and sysops:

$wgRemoveGroups['bureaucrat'] = [ 'bot', 'sysop' ];
$wgRemoveGroups
Config variable stub for the RemoveGroups setting, for use by phpdoc and IDEs.

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 8105 of file MainConfigSchema.php.

◆ AdditionalMailParams

const MediaWiki\MainConfigSchema::AdditionalMailParams
Initial value:
= [
'default' => null,
]

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

Definition at line 2655 of file MainConfigSchema.php.

◆ AllowCopyUploads

const MediaWiki\MainConfigSchema::AllowCopyUploads
Initial value:
= [
'default' => 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 1426 of file MainConfigSchema.php.

◆ AllowCrossOrigin

const MediaWiki\MainConfigSchema::AllowCrossOrigin
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

Allow anonymous cross origin requests.

This should be disabled for intranet sites (sites behind a firewall).

Since
1.36

Definition at line 8902 of file MainConfigSchema.php.

◆ AllowHTMLEmail

const MediaWiki\MainConfigSchema::AllowHTMLEmail
Initial value:
= [
'default' => 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 2663 of file MainConfigSchema.php.

◆ AllowRequiringEmailForResets

const MediaWiki\MainConfigSchema::AllowRequiringEmailForResets
Initial value:
= [
'default' => false,
]

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

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

Definition at line 7415 of file MainConfigSchema.php.

◆ AllowSchemaUpdates

const MediaWiki\MainConfigSchema::AllowSchemaUpdates
Initial value:
= [
'default' => true,
]

Allow schema updates.

Definition at line 3545 of file MainConfigSchema.php.

◆ AllowSecuritySensitiveOperationIfCannotReauthenticate

const MediaWiki\MainConfigSchema::AllowSecuritySensitiveOperationIfCannotReauthenticate
Initial value:
= [
'default' => [ 'default' => true, ],
'type' => 'map',
'additionalProperties' => [ 'type' => 'boolean', ],
]

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

Definition at line 6991 of file MainConfigSchema.php.

◆ AllowSiteCSSOnRestrictedPages

const MediaWiki\MainConfigSchema::AllowSiteCSSOnRestrictedPages
Initial value:
= [
'default' => 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 5854 of file MainConfigSchema.php.

◆ AllowSlowParserFunctions

const MediaWiki\MainConfigSchema::AllowSlowParserFunctions
Initial value:
= [
'default' => false,
]

Enable slow parser functions.

Definition at line 3538 of file MainConfigSchema.php.

◆ AllowUserCss

const MediaWiki\MainConfigSchema::AllowUserCss
Initial value:
= [
'default' => 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 8769 of file MainConfigSchema.php.

◆ AllowUserCssPrefs

const MediaWiki\MainConfigSchema::AllowUserCssPrefs
Initial value:
= [
'default' => true,
]

Allow style-related user-preferences?

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

Definition at line 8779 of file MainConfigSchema.php.

◆ AllowUserJs

const MediaWiki\MainConfigSchema::AllowUserJs
Initial value:
= [
'default' => 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 8760 of file MainConfigSchema.php.

◆ AllUnicodeFixes

const MediaWiki\MainConfigSchema::AllUnicodeFixes
Initial value:
= [
'default' => false,
]

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

This has a small performance impact.

Since
1.17

Definition at line 4703 of file MainConfigSchema.php.

◆ AmericanDates

const MediaWiki\MainConfigSchema::AmericanDates
Initial value:
= [
'default' => false,
]

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

Definition at line 4725 of file MainConfigSchema.php.

◆ Antivirus

const MediaWiki\MainConfigSchema::Antivirus
Initial value:
= [
'default' => null,
'type' => '?string',
]

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 2092 of file MainConfigSchema.php.

◆ AntivirusRequired

const MediaWiki\MainConfigSchema::AntivirusRequired
Initial value:
= [
'default' => true,
]

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

Definition at line 2152 of file MainConfigSchema.php.

◆ AntivirusSetup

const MediaWiki\MainConfigSchema::AntivirusSetup
Initial value:
= [
'default' => [
# 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',
],
],
'type' => 'map',
]
const AV_SCAN_FAILED
Definition: Defines.php:99
const AV_VIRUS_FOUND
Definition: Defines.php:97
const AV_SCAN_ABORTED
Definition: Defines.php:98
const AV_NO_VIRUS
Definition: Defines.php:96

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 2132 of file MainConfigSchema.php.

◆ ApiFrameOptions

const MediaWiki\MainConfigSchema::ApiFrameOptions
Initial value:
= [
'default' => '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 8839 of file MainConfigSchema.php.

◆ AppleTouchIcon

const MediaWiki\MainConfigSchema::AppleTouchIcon
Initial value:
= [
'default' => 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 744 of file MainConfigSchema.php.

◆ ApplyIpBlocksToXff

const MediaWiki\MainConfigSchema::ApplyIpBlocksToXff
Initial value:
= [
'default' => 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 8293 of file MainConfigSchema.php.

◆ ArticlePath

const MediaWiki\MainConfigSchema::ArticlePath
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'Script', 'UsePathInfo' ] ]
]

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 521 of file MainConfigSchema.php.

◆ AssumeProxiesUseDefaultProtocolPorts

const MediaWiki\MainConfigSchema::AssumeProxiesUseDefaultProtocolPorts
Initial value:
= [
'default' => true,
'type' => 'boolean',
]

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 273 of file MainConfigSchema.php.

◆ AttemptFailureEpoch

const MediaWiki\MainConfigSchema::AttemptFailureEpoch
Initial value:
= [
'default' => 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 2026 of file MainConfigSchema.php.

◆ AuthenticationTokenVersion

const MediaWiki\MainConfigSchema::AuthenticationTokenVersion
Initial value:
= [
'default' => null,
'type' => '?string',
]

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 7373 of file MainConfigSchema.php.

◆ AutoblockExpiry

const MediaWiki\MainConfigSchema::AutoblockExpiry
Initial value:
= [
'default' => 86400,
]

Number of seconds before autoblock entries expire.

Default 86400 = 1 day.

Definition at line 7487 of file MainConfigSchema.php.

◆ AutoConfirmAge

const MediaWiki\MainConfigSchema::AutoConfirmAge
Initial value:
= [
'default' => 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
$wgAutoConfirmAge
Config variable stub for the AutoConfirmAge setting, for use by phpdoc and IDEs.

Set age to one day:

$wgAutoConfirmAge = 3600*24; // one day

Definition at line 7956 of file MainConfigSchema.php.

◆ AutoConfirmCount

const MediaWiki\MainConfigSchema::AutoConfirmCount
Initial value:
= [
'default' => 0,
]

Number of edits an account requires before it is autoconfirmed.

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

Example:

$wgAutoConfirmCount
Config variable stub for the AutoConfirmCount setting, for use by phpdoc and IDEs.

Definition at line 7971 of file MainConfigSchema.php.

◆ AutoCreateTempUser

const MediaWiki\MainConfigSchema::AutoCreateTempUser
Initial value:
= [
'properties' => [
'enabled' => [ 'type' => 'bool', 'default' => false ],
'actions' => [ 'type' => 'list', 'default' => [ 'edit' ] ],
'genPattern' => [ 'type' => 'string', 'default' => '*Unregistered $1' ],
'matchPattern' => [ 'type' => 'string', 'default' => '*$1' ],
'serialProvider' => [ 'type' => 'object', 'default' => [ 'type' => 'local' ] ],
'serialMapping' => [ 'type' => 'object', 'default' => [ 'type' => 'plain-numeric' ] ]
],
'type' => 'object',
]

Configuration for automatic creation of temporary accounts on page save.

This can be enabled to avoid exposing the IP addresses of casual editors who do not explicitly create an account.

EXPERIMENTAL – enabling may break extensions.

An associative array with the following keys:

  • enabled: (bool) Whether auto-creation is enabled.
  • actions: (array) A list of actions for which the feature is enabled. Currently only "edit" is supported.
  • genPattern: (string) The pattern used when generating new usernames. This should have "$1" indicating the place where the serial string will be substituted.
  • matchPattern: (string) The pattern used when determining whether a username is a temporary user. This affects the rights of the user and also prevents explicit creation of users with matching names.
  • serialProvider: (array) Configuration for generation of unique integer indexes which are used to make temporary usernames.
    • type: (string) May be "local" to allocate indexes using the local database. If the CentralAuth extension is enabled, it may be "centralauth". Extensions may plug in additional types using the TempUserSerialProviders attribute.
    • numShards (int, default 1): A small integer. This can be set to a value greater than 1 to avoid acquiring a global lock when allocating IDs, at the expense of making the IDs be non-monotonic.
  • serialMapping: (array) Configuration for mapping integer indexes to strings to substitute into genPattern.
    • type: (string) May be
      • "plain-numeric" to use ASCII decimal numbers
      • "localized-numeric" to use numbers localized using a specific language
      • "filtered-radix" to use numbers in an arbitrary base between 2 and 36, with an optional list of "bad" IDs to skip over.
      • "scramble": to use ASCII decimal numbers that are short but non-consecutive.
    • language: (string) With "localized-numeric", the language code
    • radix: (int) With "filtered-radix", the base
    • badIndexes: (array) With "filtered-radix", an array with the bad unmapped indexes in the values. The integers must be sorted and the list must never change after the indexes have been allocated. The keys must be zero-based array indexes.
    • uppercase: (bool) With "filtered-radix", whether to use uppercase letters, default false.
Since
1.39

Definition at line 7466 of file MainConfigSchema.php.

◆ Autopromote

const MediaWiki\MainConfigSchema::Autopromote
Initial value:
= [
'default' => [
'autoconfirmed' => [ '&',
[ APCOND_EDITCOUNT, null ],
[ APCOND_AGE, null ],
],
],
'type' => 'map',
]
const APCOND_AGE
Definition: Defines.php:179
const APCOND_EDITCOUNT
Definition: Defines.php:178

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

The basic syntax for $wgAutopromote is:

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

A cond may be:

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

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

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

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

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

Definition at line 8032 of file MainConfigSchema.php.

◆ AutopromoteOnce

const MediaWiki\MainConfigSchema::AutopromoteOnce
Initial value:
= [
'default' => [ 'onEdit' => [], ],
'type' => 'map',
]

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 8062 of file MainConfigSchema.php.

◆ AutopromoteOnceLogInRC

const MediaWiki\MainConfigSchema::AutopromoteOnceLogInRC
Initial value:
= [
'default' => true,
]

Put user rights log entries for autopromotion in recent changes?

Since
1.18

Definition at line 8072 of file MainConfigSchema.php.

◆ AvailableRights

const MediaWiki\MainConfigSchema::AvailableRights
Initial value:
= [
'default' => [],
'type' => 'list',
]

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

For extensions only.

Definition at line 8123 of file MainConfigSchema.php.

◆ BaseDirectory

const MediaWiki\MainConfigSchema::BaseDirectory
Initial value:
= [
'default' => null,
]

Absolute filesystem path of the root directory of the MediaWiki installation.

The MW_INSTALL_PATH environment variable can be used to set this.

Note
Automatically set in Setup.php before loading local settings.
Do not modify in settings files! Must remain equal to the MW_INSTALL_PATH constant defined in Setup.php.
Since
1.38

Definition at line 510 of file MainConfigSchema.php.

◆ BlockAllowsUTEdit

const MediaWiki\MainConfigSchema::BlockAllowsUTEdit
Initial value:
= [
'default' => true,
]

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

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

Definition at line 7498 of file MainConfigSchema.php.

◆ BlockCIDRLimit

const MediaWiki\MainConfigSchema::BlockCIDRLimit
Initial value:
= [
'default' => [
'IPv4' => 16,
'IPv6' => 19,
],
'type' => 'map',
]

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 7516 of file MainConfigSchema.php.

◆ BlockDisablesLogin

const MediaWiki\MainConfigSchema::BlockDisablesLogin
Initial value:
= [
'default' => false,
]

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

(Direct blocks only; IP blocks are ignored.) This can be used to remove users' read access on a private wiki.

Definition at line 7529 of file MainConfigSchema.php.

◆ BotPasswordsCluster

const MediaWiki\MainConfigSchema::BotPasswordsCluster
Initial value:
= [
'default' => false,
'type' => 'string|false',
]

Cluster for the bot_passwords table.

Since
1.27

Definition at line 8724 of file MainConfigSchema.php.

◆ BotPasswordsDatabase

const MediaWiki\MainConfigSchema::BotPasswordsDatabase
Initial value:
= [
'default' => false,
'type' => 'string|false',
]

Database name for the bot_passwords table.

To use a database with a table prefix, set this variable to "{$database}-{$prefix}".

Since
1.27

Definition at line 8737 of file MainConfigSchema.php.

◆ BreakFrames

const MediaWiki\MainConfigSchema::BreakFrames
Initial value:
= [
'default' => 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 8801 of file MainConfigSchema.php.

◆ BrowserFormatDetection

const MediaWiki\MainConfigSchema::BrowserFormatDetection
Initial value:
= [
'default' => 'telephone=no',
'type' => 'string',
]

Override ability of certains browsers to attempt to autodetect dataformats in pages.

This is a default feature of many mobile browsers, but can have a lot of false positives, where for instance year ranges are confused with phone numbers. The default of this setting is to disable telephone number data detection. Set BrowserFormatDetection to false to fallback to browser defaults.

Since
1.37
See also
https://developer.apple.com/ library/archive/documentation/AppleApplications/Reference/SafariHTMLRef/Articles/MetaTags.html

Definition at line 5061 of file MainConfigSchema.php.

◆ CacheDirectory

const MediaWiki\MainConfigSchema::CacheDirectory
Initial value:
= [
'default' => 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 3687 of file MainConfigSchema.php.

◆ CacheEpoch

const MediaWiki\MainConfigSchema::CacheEpoch
Initial value:
= [
'default' => '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 4194 of file MainConfigSchema.php.

◆ CachePages

const MediaWiki\MainConfigSchema::CachePages
Initial value:
= [
'default' => true,
]

Allow client-side caching of pages.

Definition at line 4181 of file MainConfigSchema.php.

◆ CacheSharedUploads

const MediaWiki\MainConfigSchema::CacheSharedUploads
Initial value:
= [
'default' => true,
'type' => 'boolean',
]

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

Only used if $wgUseSharedUploads is enabled.

Since
1.5

Definition at line 1270 of file MainConfigSchema.php.

◆ CanonicalNamespaceNames

const MediaWiki\MainConfigSchema::CanonicalNamespaceNames
Initial value:
= [
'type' => 'map',
]
const CANONICAL_NAMES
Definitions of the NS_ constants are in Defines.php.

Canonical namespace names.

Must not be changed directly in configuration or by extensions, use $wgExtraNamespaces instead.

Definition at line 5912 of file MainConfigSchema.php.

◆ CanonicalServer

const MediaWiki\MainConfigSchema::CanonicalServer
Initial value:
= [
'default' => 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 253 of file MainConfigSchema.php.

◆ CascadingRestrictionLevels

const MediaWiki\MainConfigSchema::CascadingRestrictionLevels
Initial value:
= [
'default' => [ 'sysop', ],
'type' => 'list',
]

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 7885 of file MainConfigSchema.php.

◆ CdnMatchParameterOrder

const MediaWiki\MainConfigSchema::CdnMatchParameterOrder
Initial value:
= [
'default' => true,
]

Set this to false if MediaWiki is behind a CDN that re-orders query parameters on incoming requests.

MediaWiki sets a large 'Cache-Control: s-maxage=' directive on page views only if the request URL matches one of the normal CDN URL forms. When 'CdnMatchParameterOrder' is false, the matching algorithm ignores the order of URL parameters.

Since
1.39

Definition at line 4560 of file MainConfigSchema.php.

◆ CdnMaxAge

const MediaWiki\MainConfigSchema::CdnMaxAge
Initial value:
= [
'default' => 18000,
]

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

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

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

Since
1.34 Renamed from $wgSquidMaxage

Definition at line 4365 of file MainConfigSchema.php.

◆ CdnMaxageLagged

const MediaWiki\MainConfigSchema::CdnMaxageLagged
Initial value:
= [
'default' => 30,
]

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

See also
$wgCdnMaxAge
Since
1.27

Definition at line 4375 of file MainConfigSchema.php.

◆ CdnMaxageStale

const MediaWiki\MainConfigSchema::CdnMaxageStale
Initial value:
= [
'default' => 10,
]

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

Since
1.35

Definition at line 4385 of file MainConfigSchema.php.

◆ CdnMaxageSubstitute

const MediaWiki\MainConfigSchema::CdnMaxageSubstitute
Initial value:
= [
'default' => 60,
]

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

See also
$wgCdnMaxAge
Since
1.27

Definition at line 4414 of file MainConfigSchema.php.

◆ CdnReboundPurgeDelay

const MediaWiki\MainConfigSchema::CdnReboundPurgeDelay
Initial value:
= [
'default' => 0,
]

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

This requires delayed job support.

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

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

Since
1.27

Definition at line 4404 of file MainConfigSchema.php.

◆ CdnServers

const MediaWiki\MainConfigSchema::CdnServers
Initial value:
= [
'default' => [],
'type' => 'map',
]

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

Use IP addresses.

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

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

Since
1.34 Renamed from $wgSquidServers.

Definition at line 4437 of file MainConfigSchema.php.

◆ CdnServersNoPurge

const MediaWiki\MainConfigSchema::CdnServersNoPurge
Initial value:
= [
'default' => [],
'type' => 'map',
]

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

Supports both individual IP addresses and CIDR blocks.

Since
1.23 Supports CIDR ranges
1.34 Renamed from $wgSquidServersNoPurge

Definition at line 4450 of file MainConfigSchema.php.

◆ ChangeCredentialsBlacklist

const MediaWiki\MainConfigSchema::ChangeCredentialsBlacklist
Initial value:
= [
'default' => [
\MediaWiki\Auth\TemporaryPasswordAuthenticationRequest::class,
],
'type' => 'list',
'items' => [ 'type' => 'string', ],
]

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 7007 of file MainConfigSchema.php.

◆ CheckFileExtensions

const MediaWiki\MainConfigSchema::CheckFileExtensions
Initial value:
= [
'default' => 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 1652 of file MainConfigSchema.php.

◆ ChronologyProtectorStash

const MediaWiki\MainConfigSchema::ChronologyProtectorStash
Initial value:
= [
'default' => null,
'type' => '?string',
]

The object store type for the ChronologyProtector store.

This should be a fast storage system optimized for lightweight ephemeral data. Data stored should be readable by all application servers in the local datacenter.

See ChronologyProtector requirements for more detailed system administrator requirements (especially for multi-dc operations).

Valid options are the keys of $wgObjectCaches, e.g. CACHE_* constants. Defaults to $wgMainCacheType (in ServiceWiring.php).

Since
1.36

Definition at line 4017 of file MainConfigSchema.php.

◆ CompressRevisions

const MediaWiki\MainConfigSchema::CompressRevisions
Initial value:
= [
'default' => 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 3349 of file MainConfigSchema.php.

◆ ConfigRegistry

const MediaWiki\MainConfigSchema::ConfigRegistry
Initial value:
= [
'default' => [
'main' => 'GlobalVarConfig::newInstance',
],
'type' => 'map',
]

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 200 of file MainConfigSchema.php.

◆ ContentHandlers

const MediaWiki\MainConfigSchema::ContentHandlers
Initial value:
= [
'default' =>
[
CONTENT_MODEL_WIKITEXT => WikitextContentHandler::class,
CONTENT_MODEL_JAVASCRIPT => JavaScriptContentHandler::class,
CONTENT_MODEL_JSON => JsonContentHandler::class,
CONTENT_MODEL_CSS => CssContentHandler::class,
CONTENT_MODEL_TEXT => TextContentHandler::class,
CONTENT_MODEL_UNKNOWN => FallbackContentHandler::class,
],
'type' => 'map',
]
const CONTENT_MODEL_CSS
Definition: Defines.php:213
const CONTENT_MODEL_WIKITEXT
Definition: Defines.php:211
const CONTENT_MODEL_JSON
Definition: Defines.php:215
const CONTENT_MODEL_TEXT
Definition: Defines.php:214
const CONTENT_MODEL_UNKNOWN
Definition: Defines.php:216
const CONTENT_MODEL_JAVASCRIPT
Definition: Defines.php:212

Plugins for page content model handling.

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

Since
1.21

Definition at line 3268 of file MainConfigSchema.php.

◆ ContentHandlerTextFallback

const MediaWiki\MainConfigSchema::ContentHandlerTextFallback
Initial value:
= [
'default' => 'ignore',
'deprecated' => 'since 1.37',
]

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
Deprecated:
since 1.37

Definition at line 3314 of file MainConfigSchema.php.

◆ CookieDomain

const MediaWiki\MainConfigSchema::CookieDomain
Initial value:
= [
'default' => '',
]

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

Definition at line 9002 of file MainConfigSchema.php.

◆ CookieExpiration

const MediaWiki\MainConfigSchema::CookieExpiration
Initial value:
= [
'default' => 30 * 86400,
]

Default cookie lifetime, in seconds.

Setting to 0 makes all cookies session-only.

Definition at line 8984 of file MainConfigSchema.php.

◆ CopyUploadAllowOnWikiDomainConfig

const MediaWiki\MainConfigSchema::CopyUploadAllowOnWikiDomainConfig
Initial value:
= [
'default' => false,
]

If true, the value of $wgCopyUploadsDomains will be merged with the contents of MediaWiki:Copyupload-allowed-domains.

Since
1.39

Definition at line 1477 of file MainConfigSchema.php.

◆ CopyUploadProxy

const MediaWiki\MainConfigSchema::CopyUploadProxy
Initial value:
= [
'default' => false,
]

Proxy to use for copy upload requests.

Since
1.20

Definition at line 1454 of file MainConfigSchema.php.

◆ CopyUploadsDomains

const MediaWiki\MainConfigSchema::CopyUploadsDomains
Initial value:
= [
'default' => [],
'type' => 'list',
]

A list of domains copy uploads can come from.

Since
1.20

Definition at line 1435 of file MainConfigSchema.php.

◆ CopyUploadsFromSpecialUpload

const MediaWiki\MainConfigSchema::CopyUploadsFromSpecialUpload
Initial value:
= [
'default' => 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 1445 of file MainConfigSchema.php.

◆ CopyUploadTimeout

const MediaWiki\MainConfigSchema::CopyUploadTimeout
Initial value:
= [
'default' => false,
'type' => 'false|integer',
]

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 1466 of file MainConfigSchema.php.

◆ CriticalSectionTimeLimit

const MediaWiki\MainConfigSchema::CriticalSectionTimeLimit
Initial value:
= [
'default' => 180.0,
'type' => 'float',
]

The maximum time critical sections are allowed to stay open.

Critical sections are used to defer Excimer request timeouts. If Excimer is available and this time limit is exceeded, an exception will be thrown at the next opportunity, typically after a long-running function like a DB query returns.

Critical sections may wrap long-running queries, and it's generally better for the timeout to be handled a few milliseconds later when the critical section exits, so this should be a large number.

This limit is ignored in command-line mode.

Since
1.36

Definition at line 3502 of file MainConfigSchema.php.

◆ CSPFalsePositiveUrls

const MediaWiki\MainConfigSchema::CSPFalsePositiveUrls
Initial value:
= [
'default' => [
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'https:
'chrome-extension' => true,
],
'type' => 'map',
]

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 8874 of file MainConfigSchema.php.

◆ CSPHeader

const MediaWiki\MainConfigSchema::CSPHeader
Initial value:
= [
'default' => false,
'type' => 'false|object',
]

Controls Content-Security-Policy header [Experimental].

See also
https://www.w3.org/TR/CSP2/
Since
1.32
Warning
May cause slowness on windows due to slow random number generator.

Definition at line 8850 of file MainConfigSchema.php.

◆ CSPReportOnlyHeader

const MediaWiki\MainConfigSchema::CSPReportOnlyHeader
Initial value:
= [
'default' => false,
'type' => 'false|object',
]

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

Since
1.32

Definition at line 8860 of file MainConfigSchema.php.

◆ CustomConvertCommand

const MediaWiki\MainConfigSchema::CustomConvertCommand
Initial value:
= [
'default' => 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"
$wgCustomConvertCommand
Config variable stub for the CustomConvertCommand setting, for use by phpdoc and IDEs.

Leave as false to skip this.

Definition at line 1823 of file MainConfigSchema.php.

◆ DatabaseReplicaLagCritical

const MediaWiki\MainConfigSchema::DatabaseReplicaLagCritical
Initial value:
= [
'default' => 30,
]
See also
$wgDatabaseReplicaLagWarning
Since
1.36

Definition at line 3205 of file MainConfigSchema.php.

◆ DatabaseReplicaLagWarning

const MediaWiki\MainConfigSchema::DatabaseReplicaLagWarning
Initial value:
= [
'default' => 10,
]

If lag is higher than $wgDatabaseReplicaLagWarning, show a warning in some special pages (like watchlist).

If the lag is higher than $wgDatabaseReplicaLagCritical, show a more obvious warning.

Since
1.36

Definition at line 3197 of file MainConfigSchema.php.

◆ DataCenterUpdateStickTTL

const MediaWiki\MainConfigSchema::DataCenterUpdateStickTTL
Initial value:
= [
'default' => 10,
]

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

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

This must be greater than or equal to Wikimedia\Rdbms\ChronologyProtector::POSITION_COOKIE_TTL.

Since
1.27

Definition at line 3128 of file MainConfigSchema.php.

◆ DBadminpassword

const MediaWiki\MainConfigSchema::DBadminpassword
Initial value:
= [
'default' => null,
]

Separate password for maintenance tasks.

Leave as null to use the default.

Definition at line 2889 of file MainConfigSchema.php.

◆ DBadminuser

const MediaWiki\MainConfigSchema::DBadminuser
Initial value:
= [
'default' => null,
]

Separate username for maintenance tasks.

Leave as null to use the default.

Definition at line 2882 of file MainConfigSchema.php.

◆ DBcompress

const MediaWiki\MainConfigSchema::DBcompress
Initial value:
= [
'default' => 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 2875 of file MainConfigSchema.php.

◆ DBDefaultGroup

const MediaWiki\MainConfigSchema::DBDefaultGroup
Initial value:
= [
'default' => null,
]

Default group to use when getting database connections.

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

Since
1.32

Definition at line 2949 of file MainConfigSchema.php.

◆ DBerrorLog

const MediaWiki\MainConfigSchema::DBerrorLog
Initial value:
= [
'default' => false,
]

File to log database errors to.

Definition at line 3135 of file MainConfigSchema.php.

◆ DBerrorLogTZ

const MediaWiki\MainConfigSchema::DBerrorLogTZ
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'Localtimezone' ] ]
]

Timezone to use in the error log.

Defaults to the wiki timezone ($wgLocaltimezone).

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

Examples:

$wgDBerrorLogTZ = 'PST8PDT';
$wgDBerrorLogTZ = 'Europe/Sweden';
$wgDBerrorLogTZ
Config variable stub for the DBerrorLogTZ setting, for use by phpdoc and IDEs.
Since
1.20

Definition at line 3159 of file MainConfigSchema.php.

◆ DBmwschema

const MediaWiki\MainConfigSchema::DBmwschema
Initial value:
= [
'default' => null,
'type' => '?string',
]

Current wiki database schema name.

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

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

Definition at line 2804 of file MainConfigSchema.php.

◆ DBname

const MediaWiki\MainConfigSchema::DBname
Initial value:
= [
'default' => 'my_wiki',
]

Current wiki database name.

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

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

Definition at line 2792 of file MainConfigSchema.php.

◆ DBpassword

const MediaWiki\MainConfigSchema::DBpassword
Initial value:
= [
'default' => '',
]

Database user's password.

Definition at line 2845 of file MainConfigSchema.php.

◆ DBport

const MediaWiki\MainConfigSchema::DBport
Initial value:
= [
'default' => 5432,
]

Database port number.

Definition at line 2831 of file MainConfigSchema.php.

◆ DBprefix

const MediaWiki\MainConfigSchema::DBprefix
Initial value:
= [
'default' => '',
]

Current wiki database table name prefix.

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

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

Definition at line 2817 of file MainConfigSchema.php.

◆ DBserver

const MediaWiki\MainConfigSchema::DBserver
Initial value:
= [
'default' => 'localhost',
]

Database host name or IP address.

Definition at line 2824 of file MainConfigSchema.php.

◆ DBservers

const MediaWiki\MainConfigSchema::DBservers
Initial value:
= [
'default' => false,
'type' => 'false|list',
]

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

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

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

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

The first server listed in this array (with key 0) will be the primary. 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 primaries, and then set read_only=0 on primaries at runtime.

Definition at line 3093 of file MainConfigSchema.php.

◆ DBssl

const MediaWiki\MainConfigSchema::DBssl
Initial value:
= [
'default' => 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 'ssl' parameter of the server array must be set to achieve the same functionality.

Definition at line 2863 of file MainConfigSchema.php.

◆ DBTableOptions

const MediaWiki\MainConfigSchema::DBTableOptions
Initial value:
= [
'default' => 'ENGINE=InnoDB, DEFAULT CHARSET=binary',
]

MySQL table options to use during installation or update.

Definition at line 2927 of file MainConfigSchema.php.

◆ DBtype

const MediaWiki\MainConfigSchema::DBtype
Initial value:
= [
'default' => 'mysql',
]

Database type.

Definition at line 2852 of file MainConfigSchema.php.

◆ DBuser

const MediaWiki\MainConfigSchema::DBuser
Initial value:
= [
'default' => 'wikiuser',
]

Database username.

Definition at line 2838 of file MainConfigSchema.php.

◆ DefaultExternalStore

const MediaWiki\MainConfigSchema::DefaultExternalStore
Initial value:
= [
'default' => false,
'type' => 'list|false',
]

The place to put new text blobs or false to put them in the text table of the local wiki database.

See also
ExternalStoreAccess

Example:

$wgDefaultExternalStore = [ 'DB://cluster1', 'DB://cluster2' ];
$wgDefaultExternalStore
Config variable stub for the DefaultExternalStore setting, for use by phpdoc and IDEs.

Definition at line 3403 of file MainConfigSchema.php.

◆ DefaultLanguageVariant

const MediaWiki\MainConfigSchema::DefaultLanguageVariant
Initial value:
= [
'default' => false,
]

Default variant code.

If false, the default will be the static default variant of the language.

Definition at line 4771 of file MainConfigSchema.php.

◆ DefaultSkin

const MediaWiki\MainConfigSchema::DefaultSkin
Initial value:
= [
'default' => '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 5083 of file MainConfigSchema.php.

◆ DefaultUserOptions

const MediaWiki\MainConfigSchema::DefaultUserOptions

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 7250 of file MainConfigSchema.php.

◆ DeletedDirectory

const MediaWiki\MainConfigSchema::DeletedDirectory
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'UploadDirectory' ] ]
]

What directory to place deleted uploads in.

Defaults to "{$wgUploadDirectory}/deleted".

Definition at line 912 of file MainConfigSchema.php.

◆ DeleteRevisionsBatchSize

const MediaWiki\MainConfigSchema::DeleteRevisionsBatchSize
Initial value:
= [
'default' => 1000,
]

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

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

Definition at line 8141 of file MainConfigSchema.php.

◆ DeleteRevisionsLimit

const MediaWiki\MainConfigSchema::DeleteRevisionsLimit
Initial value:
= [
'default' => 0,
]

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

(Default given to sysops.)

Definition at line 8132 of file MainConfigSchema.php.

◆ DiffEngine

const MediaWiki\MainConfigSchema::DiffEngine
Initial value:
= [
'default' => null,
'type' => '?string',
]

Specify the difference engine to use.

Supported values:

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

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

Since
1.35

Definition at line 3442 of file MainConfigSchema.php.

◆ DirectoryMode

const MediaWiki\MainConfigSchema::DirectoryMode
Initial value:
= [
'default' => 0777,
]

Default value for chmoding of new directories.

Definition at line 2418 of file MainConfigSchema.php.

◆ DisabledVariants

const MediaWiki\MainConfigSchema::DisabledVariants
Initial value:
= [
'default' => [],
'type' => 'map',
]

Disabled variants array of language variant conversion.

Example:

$wgDisabledVariants[] = 'zh-mo';
$wgDisabledVariants[] = 'zh-my';
$wgDisabledVariants
Config variable stub for the DisabledVariants setting, for use by phpdoc and IDEs.

Definition at line 4793 of file MainConfigSchema.php.

◆ DisableLangConversion

const MediaWiki\MainConfigSchema::DisableLangConversion
Initial value:
= [
'default' => false,
]

Whether to enable language variant conversion.

Definition at line 4756 of file MainConfigSchema.php.

◆ DisableOutputCompression

const MediaWiki\MainConfigSchema::DisableOutputCompression
Initial value:
= [
'default' => false,
]

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

Definition at line 5114 of file MainConfigSchema.php.

◆ DisableQueryPages

const MediaWiki\MainConfigSchema::DisableQueryPages
Initial value:
= [
'default' => false,
]

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

Definition at line 3517 of file MainConfigSchema.php.

◆ DisableTitleConversion

const MediaWiki\MainConfigSchema::DisableTitleConversion
Initial value:
= [
'default' => false,
]

Whether to enable language variant conversion for links.

Definition at line 4763 of file MainConfigSchema.php.

◆ DisableUploadScriptChecks

const MediaWiki\MainConfigSchema::DisableUploadScriptChecks
Initial value:
= [
'default' => 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 1672 of file MainConfigSchema.php.

◆ DjvuDump

const MediaWiki\MainConfigSchema::DjvuDump
Initial value:
= [
'default' => null,
'type' => '?string',
]

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

Definition at line 2461 of file MainConfigSchema.php.

◆ DjvuOutputExtension

const MediaWiki\MainConfigSchema::DjvuOutputExtension
Initial value:
= [
'default' => 'jpg',
]

File extension for the DJVU post processor output.

Definition at line 2499 of file MainConfigSchema.php.

◆ DjvuPostProcessor

const MediaWiki\MainConfigSchema::DjvuPostProcessor
Initial value:
= [
'default' => 'pnmtojpeg',
'type' => '?string',
]

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 2491 of file MainConfigSchema.php.

◆ DjvuRenderer

const MediaWiki\MainConfigSchema::DjvuRenderer
Initial value:
= [
'default' => null,
'type' => '?string',
]

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

Definition at line 2471 of file MainConfigSchema.php.

◆ DjvuTxt

const MediaWiki\MainConfigSchema::DjvuTxt
Initial value:
= [
'default' => null,
'type' => '?string',
]

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 2481 of file MainConfigSchema.php.

◆ DnsBlacklistUrls

const MediaWiki\MainConfigSchema::DnsBlacklistUrls
Initial value:
= [
'default' => [ 'http.dnsbl.sorbs.net.', ],
'type' => 'list',
]

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.' ]
];
$wgDnsBlacklistUrls
Config variable stub for the DnsBlacklistUrls setting, for use by phpdoc and IDEs.
Note
You should end the domain name with a . to avoid searching your eventual domain search suffixes.
Since
1.16

Definition at line 8248 of file MainConfigSchema.php.

◆ DummyLanguageCodes

const MediaWiki\MainConfigSchema::DummyLanguageCodes
Initial value:
= [
'default' => [],
'type' => 'map',
]

Functionally the same as $wgExtraLanguageCodes, but deprecated.

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

Note
Since 1.29, this should not be set directly in LocalSettings, ExtraLanguageCodes should be set instead. However, DummyLanguageCodes will be initialized and can be read internally.

Definition at line 4691 of file MainConfigSchema.php.

◆ Edititis

const MediaWiki\MainConfigSchema::Edititis
Initial value:
= [
'default' => false,
]

Display user edit counts in various prominent places.

Definition at line 5228 of file MainConfigSchema.php.

◆ EditPageFrameOptions

const MediaWiki\MainConfigSchema::EditPageFrameOptions
Initial value:
= [
'default' => '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 8824 of file MainConfigSchema.php.

◆ EditSubmitButtonLabelPublish

const MediaWiki\MainConfigSchema::EditSubmitButtonLabelPublish
Initial value:
= [
'default' => 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 5013 of file MainConfigSchema.php.

◆ EmailAuthentication

const MediaWiki\MainConfigSchema::EmailAuthentication
Initial value:
= [
'default' => 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 2687 of file MainConfigSchema.php.

◆ EmailConfirmToEdit

const MediaWiki\MainConfigSchema::EmailConfirmToEdit
Initial value:
= [
'default' => false,
]

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

Definition at line 7601 of file MainConfigSchema.php.

◆ EmergencyContact

const MediaWiki\MainConfigSchema::EmergencyContact
Initial value:
= [
'default' => false,
]

Site admin email address.

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

Definition at line 2516 of file MainConfigSchema.php.

◆ EnableAsyncUploads

const MediaWiki\MainConfigSchema::EnableAsyncUploads
Initial value:
= [
'default' => 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.

Definition at line 885 of file MainConfigSchema.php.

◆ EnableAutoRotation

const MediaWiki\MainConfigSchema::EnableAutoRotation
Initial value:
= [
'default' => null,
'type' => '?boolean',
]

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 2082 of file MainConfigSchema.php.

◆ EnableBotPasswords

const MediaWiki\MainConfigSchema::EnableBotPasswords
Initial value:
= [
'default' => true,
'type' => 'boolean',
]
Since
1.27

Definition at line 8714 of file MainConfigSchema.php.

◆ EnableCanonicalServerLink

const MediaWiki\MainConfigSchema::EnableCanonicalServerLink
Initial value:
= [
'default' => 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 5267 of file MainConfigSchema.php.

◆ EnableDnsBlacklist

const MediaWiki\MainConfigSchema::EnableDnsBlacklist
Initial value:
= [
'default' => false,
]

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

Since
1.16

Definition at line 8220 of file MainConfigSchema.php.

◆ EnableEmail

const MediaWiki\MainConfigSchema::EnableEmail
Initial value:
= [
'default' => 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 2546 of file MainConfigSchema.php.

◆ EnablePartialActionBlocks

const MediaWiki\MainConfigSchema::EnablePartialActionBlocks
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

Flag to enable partial blocks against performing certain actions.

Stability: unstable
Temporary feature flag, to be removed before the release of 1.38: T280532

Definition at line 7538 of file MainConfigSchema.php.

◆ EnableRemoteBagOStuffTests

const MediaWiki\MainConfigSchema::EnableRemoteBagOStuffTests
Initial value:
= [
'default' => false,
]

If this is set to true, phpunit will run integration tests against remote caches defined in $wgObjectCaches.

Since
1.38

Definition at line 4301 of file MainConfigSchema.php.

◆ EnableSidebarCache

const MediaWiki\MainConfigSchema::EnableSidebarCache
Initial value:
= [
'default' => 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 4242 of file MainConfigSchema.php.

◆ EnableSpecialMute

const MediaWiki\MainConfigSchema::EnableSpecialMute
Initial value:
= [
'default' => false,
]

Set to true to enable the Special Mute page.

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

Since
1.34

Definition at line 2566 of file MainConfigSchema.php.

◆ EnableUploads

const MediaWiki\MainConfigSchema::EnableUploads
Initial value:
= [
'default' => false,
]

Allow users to upload files.

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

Since
1.5

Definition at line 868 of file MainConfigSchema.php.

◆ EnableUserEmail

const MediaWiki\MainConfigSchema::EnableUserEmail
Initial value:
= [
'default' => 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 2555 of file MainConfigSchema.php.

◆ EnableUserEmailMuteList

const MediaWiki\MainConfigSchema::EnableUserEmailMuteList
Initial value:
= [
'default' => false,
]

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

Since
1.37; previously $wgEnableUserEmailBlacklist

Definition at line 2575 of file MainConfigSchema.php.

◆ EnotifFromEditor

const MediaWiki\MainConfigSchema::EnotifFromEditor
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

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

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

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

Definition at line 2676 of file MainConfigSchema.php.

◆ EnotifImpersonal

const MediaWiki\MainConfigSchema::EnotifImpersonal
Initial value:
= [
'default' => 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 2750 of file MainConfigSchema.php.

◆ EnotifMaxRecips

const MediaWiki\MainConfigSchema::EnotifMaxRecips
Initial value:
= [
'default' => 500,
]

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

Should match the limit on your mail server.

Definition at line 2758 of file MainConfigSchema.php.

◆ EnotifMinorEdits

const MediaWiki\MainConfigSchema::EnotifMinorEdits
Initial value:
= [
'default' => 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 2739 of file MainConfigSchema.php.

◆ EnotifRevealEditorAddress

const MediaWiki\MainConfigSchema::EnotifRevealEditorAddress
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

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

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

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

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

Definition at line 2721 of file MainConfigSchema.php.

◆ EnotifUseRealName

const MediaWiki\MainConfigSchema::EnotifUseRealName
Initial value:
= [
'default' => false,
]

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

Definition at line 2765 of file MainConfigSchema.php.

◆ EnotifUserTalk

const MediaWiki\MainConfigSchema::EnotifUserTalk
Initial value:
= [
'default' => 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 2705 of file MainConfigSchema.php.

◆ EnotifWatchlist

const MediaWiki\MainConfigSchema::EnotifWatchlist
Initial value:
= [
'default' => false,
]

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

Definition at line 2694 of file MainConfigSchema.php.

◆ Exiftool

const MediaWiki\MainConfigSchema::Exiftool
Initial value:
= [
'default' => '/usr/bin/exiftool',
]

Path to exiftool binary.

Used for lossless ICC profile swapping.

Since
1.26

Definition at line 1883 of file MainConfigSchema.php.

◆ Exiv2Command

const MediaWiki\MainConfigSchema::Exiv2Command
Initial value:
= [
'default' => '/usr/bin/exiv2',
]

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

Definition at line 1874 of file MainConfigSchema.php.

◆ ExtendedLoginCookieExpiration

const MediaWiki\MainConfigSchema::ExtendedLoginCookieExpiration
Initial value:
= [
'default' => 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 8994 of file MainConfigSchema.php.

◆ ExtensionAssetsPath

const MediaWiki\MainConfigSchema::ExtensionAssetsPath
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'ResourceBasePath' ] ]
]

The URL path of the extensions directory.

Defaults to "{$wgResourceBasePath}/extensions".

Since
1.16

Definition at line 464 of file MainConfigSchema.php.

◆ ExtensionDirectory

const MediaWiki\MainConfigSchema::ExtensionDirectory
Initial value:
= [
'default' => null,
'type' => '?string',
]

Extensions directory in the file system.

Note
Set to "{$IP}/extensions" by Setup.php before loading local settings.
this configuration variable is used to locate extensions while loading settings.
Since
1.25

Definition at line 484 of file MainConfigSchema.php.

◆ ExtensionInfoMTime

const MediaWiki\MainConfigSchema::ExtensionInfoMTime
Initial value:
= [
'default' => false,
'type' => 'integer|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" );
$wgExtensionInfoMTime
Config variable stub for the ExtensionInfoMTime setting, for use by phpdoc and IDEs.

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 4290 of file MainConfigSchema.php.

◆ ExternalDiffEngine

const MediaWiki\MainConfigSchema::ExternalDiffEngine
Initial value:
= [
'default' => false,
'type' => 'string|false',
]

Name of the external diff engine to use.

Definition at line 3450 of file MainConfigSchema.php.

◆ ExternalInterwikiFragmentMode

const MediaWiki\MainConfigSchema::ExternalInterwikiFragmentMode
Initial value:
= [
'default' => '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 5160 of file MainConfigSchema.php.

◆ ExternalLinksSchemaMigrationStage

const MediaWiki\MainConfigSchema::ExternalLinksSchemaMigrationStage
Initial value:
= [
'default' => SCHEMA_COMPAT_OLD,
'type' => 'integer',
]
const SCHEMA_COMPAT_OLD
Definition: Defines.php:277

Externallinks table schema migration stage.

Use the SCHEMA_COMPAT_XXX flags. Supported values:

  • SCHEMA_COMPAT_OLD
  • SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD

History:

  • 1.40: Added

Definition at line 3249 of file MainConfigSchema.php.

◆ ExternalServers

const MediaWiki\MainConfigSchema::ExternalServers
Initial value:
= [
'default' => [],
'type' => 'map',
]

Shortcut for setting $wgLBFactoryConf["externalClusters"].

This is only applicable when using the default LBFactory of LBFactorySimple. It is ignored if a different LBFactory is set, or if externalClusters is already set explicitly.

See also
ExternalStoreAccess

Example: Create a cluster named 'blobs_cluster1':

'blobs_cluster1' => <array in the same format as $wgDBservers>
];
$wgDBservers
Config variable stub for the DBservers setting, for use by phpdoc and IDEs.
$wgExternalServers
Config variable stub for the ExternalServers setting, for use by phpdoc and IDEs.

Definition at line 3386 of file MainConfigSchema.php.

◆ ExternalStores

const MediaWiki\MainConfigSchema::ExternalStores
Initial value:
= [
'default' => [],
'type' => 'list',
]

List of enabled ExternalStore protocols.

See also
ExternalStoreAccess
$wgExternalStores = [ "DB" ];
$wgExternalStores
Config variable stub for the ExternalStores setting, for use by phpdoc and IDEs.

Definition at line 3362 of file MainConfigSchema.php.

◆ ExtraGenderNamespaces

const MediaWiki\MainConfigSchema::ExtraGenderNamespaces
Initial value:
= [
'default' => [],
'type' => 'map',
]

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 5956 of file MainConfigSchema.php.

◆ ExtraInterlanguageLinkPrefixes

const MediaWiki\MainConfigSchema::ExtraInterlanguageLinkPrefixes
Initial value:
= [
'default' => [],
'type' => 'map',
]

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 4635 of file MainConfigSchema.php.

◆ ExtraLanguageCodes

const MediaWiki\MainConfigSchema::ExtraLanguageCodes
Initial value:
= [
'default' => [
'bh' => 'bho',
'no' => 'nb',
'simple' => 'en',
],
'type' => 'map',
]

List of mappings from one language code to another.

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

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

Since
1.29

Definition at line 4674 of file MainConfigSchema.php.

◆ ExtraLanguageNames

const MediaWiki\MainConfigSchema::ExtraLanguageNames
Initial value:
= [
'default' => [],
'type' => 'map',
]

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

Definition at line 4655 of file MainConfigSchema.php.

◆ ExtraNamespaces

const MediaWiki\MainConfigSchema::ExtraNamespaces
Initial value:
= [
'default' => [],
'type' => 'map',
]

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"
];
$wgExtraNamespaces
Config variable stub for the ExtraNamespaces setting, for use by phpdoc and IDEs.
Todo:
Add a note about maintenance/namespaceDupes.php

Definition at line 5943 of file MainConfigSchema.php.

◆ FallbackSkin

const MediaWiki\MainConfigSchema::FallbackSkin
Initial value:
= [
'default' => 'fallback',
]

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

Since
1.24

Definition at line 5092 of file MainConfigSchema.php.

◆ Favicon

const MediaWiki\MainConfigSchema::Favicon
Initial value:
= [
'default' => '/favicon.ico',
]

The URL path of the icon.

Since
1.6

Definition at line 733 of file MainConfigSchema.php.

◆ FetchCommonsDescriptions

const MediaWiki\MainConfigSchema::FetchCommonsDescriptions
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.5

Definition at line 1233 of file MainConfigSchema.php.

◆ FileBackends

const MediaWiki\MainConfigSchema::FileBackends
Initial value:
= [
'default' => [],
'type' => 'map',
]

File backend structure configuration.

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

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

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

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

There are two particularly important aspects about each backend:

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

Definition at line 1366 of file MainConfigSchema.php.

◆ FileCacheDepth

const MediaWiki\MainConfigSchema::FileCacheDepth
Initial value:
= [
'default' => 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 4221 of file MainConfigSchema.php.

◆ FileCacheDirectory

const MediaWiki\MainConfigSchema::FileCacheDirectory
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'UploadDirectory' ] ]
]

Directory where the cached page will be saved.

Defaults to "{$wgUploadDirectory}/cache".

Definition at line 603 of file MainConfigSchema.php.

◆ FileExtensions

const MediaWiki\MainConfigSchema::FileExtensions
Initial value:
= [
'default' => [ 'png', 'gif', 'jpg', 'jpeg', 'webp', ],
'type' => 'list',
]

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 1594 of file MainConfigSchema.php.

◆ FooterIcons

const MediaWiki\MainConfigSchema::FooterIcons
Initial value:
= [
'default' => [
"copyright" => [
"copyright" => [],
],
"poweredby" => [
"mediawiki" => [
"src" => null,
"url" => "https://www.mediawiki.org/",
"alt" => "Powered by MediaWiki",
]
],
],
'type' => 'map',
]

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 5195 of file MainConfigSchema.php.

◆ ForceDeferredUpdatesPreSend

const MediaWiki\MainConfigSchema::ForceDeferredUpdatesPreSend
Initial value:
= [
'default' => false,
]

Force deferred updates to be run before sending a response to the client, instead of attempting to run them after sending the response.

Setting this to true is useful for end-to-end testing, to ensure that the effects of a request are visible to any subsequent requests, even if they are made immediately after the first one. Note however that this does not ensure that database replication is complete, nor does it execute any jobs enqueued for later. There should be no reason to set this in a normal production environment.

Since
1.38

Definition at line 3655 of file MainConfigSchema.php.

◆ ForcedRawSMaxage

const MediaWiki\MainConfigSchema::ForcedRawSMaxage
Initial value:
= [
'default' => 300,
]

Default maximum age for raw CSS/JS accesses.

300 seconds = 5 minutes.

Definition at line 4423 of file MainConfigSchema.php.

◆ ForceHTTPS

const MediaWiki\MainConfigSchema::ForceHTTPS
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

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.

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

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

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

Since
1.35

Definition at line 309 of file MainConfigSchema.php.

◆ ForceUIMsgAsContentMsg

const MediaWiki\MainConfigSchema::ForceUIMsgAsContentMsg
Initial value:
= [
'default' => [],
'type' => 'map',
]

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' ];
$wgForceUIMsgAsContentMsg
Config variable stub for the ForceUIMsgAsContentMsg setting, for use by phpdoc and IDEs.

Definition at line 4849 of file MainConfigSchema.php.

◆ ForeignFileRepos

const MediaWiki\MainConfigSchema::ForeignFileRepos
Initial value:
= [
'default' => [],
'type' => 'list',
]

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

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

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

Since
1.11
See also
$wgLocalFileRepo

Definition at line 1129 of file MainConfigSchema.php.

◆ ForeignUploadTargets

const MediaWiki\MainConfigSchema::ForeignUploadTargets
Initial value:
= [
'default' => [ 'local', ],
'type' => 'list',
]

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 1285 of file MainConfigSchema.php.

◆ FragmentMode

const MediaWiki\MainConfigSchema::FragmentMode
Initial value:
= [
'default' => [ 'html5', 'legacy', ],
'type' => 'list',
]

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

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

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

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

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

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

Since
1.30

Definition at line 5147 of file MainConfigSchema.php.

◆ GalleryOptions

const MediaWiki\MainConfigSchema::GalleryOptions
Initial value:
= [
'default' => [],
'type' => 'map',
]

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 2401 of file MainConfigSchema.php.

◆ GenerateThumbnailOnParse

const MediaWiki\MainConfigSchema::GenerateThumbnailOnParse
Initial value:
= [
'default' => true,
'type' => 'boolean',
]

Render thumbnails while parsing wikitext.

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

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

$wgLocalFileRepo['transformVia404'] = true;
$wgLocalFileRepo
Config variable stub for the LocalFileRepo setting, for use by phpdoc and IDEs.
Since
1.7.0

Definition at line 2065 of file MainConfigSchema.php.

◆ GitInfoCacheDirectory

const MediaWiki\MainConfigSchema::GitInfoCacheDirectory
Initial value:
= [
'default' => false,
]

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

If false, $wgCacheDirectory/gitinfo will be used.

Definition at line 4202 of file MainConfigSchema.php.

◆ GrammarForms

const MediaWiki\MainConfigSchema::GrammarForms
Initial value:
= [
'default' => [],
'type' => 'map',
]

Some languages need different word forms, usually for different cases.

Used in Language::convertGrammar().

Example:

$wgGrammarForms['en']['genitive']['car'] = 'car\\'s';
$wgGrammarForms
Config variable stub for the GrammarForms setting, for use by phpdoc and IDEs.

Definition at line 4602 of file MainConfigSchema.php.

◆ GrantPermissionGroups

const MediaWiki\MainConfigSchema::GrantPermissionGroups
Since
1.27

Definition at line 8668 of file MainConfigSchema.php.

◆ GrantPermissions

const MediaWiki\MainConfigSchema::GrantPermissions

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 8486 of file MainConfigSchema.php.

◆ GroupInheritsPermissions

const MediaWiki\MainConfigSchema::GroupInheritsPermissions
Initial value:
= [
'default' => [],
'type' => 'map',
'additionalProperties' => [ 'type' => 'string', ],
]

Groups that should inherit permissions from another group.

This allows defining a group that inherits its permissions from another group without having to copy all the permission grants over. For example, if you wanted a manual "confirmed" group that had the same permissions as "autoconfirmed":

$wgGroupInheritsPermissions['confirmed'] = 'autoconfirmed';
$wgGroupInheritsPermissions
Config variable stub for the GroupInheritsPermissions setting, for use by phpdoc and IDEs.

Recursive inheritance is currently not supported. In the above example, confirmed will only gain the permissions explicitly granted (or revoked) from autoconfirmed, not any permissions that autoconfirmed might inherit.

Since
1.38

Definition at line 7796 of file MainConfigSchema.php.

◆ GroupPermissions

const MediaWiki\MainConfigSchema::GroupPermissions

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 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 7637 of file MainConfigSchema.php.

◆ GroupsAddToSelf

const MediaWiki\MainConfigSchema::GroupsAddToSelf
Initial value:
= [
'default' => [],
'type' => 'map',
]

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' ] ];
$wgGroupsAddToSelf
Config variable stub for the GroupsAddToSelf setting, for use by phpdoc and IDEs.

Example: Implicit groups may be used for the source group, for instance:

$wgGroupsRemoveFromSelf
Config variable stub for the GroupsRemoveFromSelf setting, for use by phpdoc and IDEs.
return true
Definition: router.php:90

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 7834 of file MainConfigSchema.php.

◆ GroupsRemoveFromSelf

const MediaWiki\MainConfigSchema::GroupsRemoveFromSelf
Initial value:
= [
'default' => [],
'type' => 'map',
]
See also
$wgGroupsAddToSelf

Definition at line 7842 of file MainConfigSchema.php.

◆ HashedSharedUploadDirectory

const MediaWiki\MainConfigSchema::HashedSharedUploadDirectory
Initial value:
= [
'default' => true,
'type' => 'boolean',
]

Shortcut for the 'hashLevels' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.3

Definition at line 1210 of file MainConfigSchema.php.

◆ HashedUploadDirectory

const MediaWiki\MainConfigSchema::HashedUploadDirectory
Initial value:
= [
'default' => true,
'type' => 'boolean',
]

Shortcut for setting hashLevels=2 in $wgLocalFileRepo.

Note
Only used if $wgLocalFileRepo is not set.

Definition at line 1581 of file MainConfigSchema.php.

◆ HiddenPrefs

const MediaWiki\MainConfigSchema::HiddenPrefs
Initial value:
= [
'default' => [],
'type' => 'list',
]

An array of preferences to not show for the user.

Definition at line 7324 of file MainConfigSchema.php.

◆ HideIdentifiableRedirects

const MediaWiki\MainConfigSchema::HideIdentifiableRedirects
Initial value:
= [
'default' => 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 7609 of file MainConfigSchema.php.

◆ HideInterlanguageLinks

const MediaWiki\MainConfigSchema::HideInterlanguageLinks
Initial value:
= [
'default' => false,
]

Hide interlanguage links from the sidebar.

Definition at line 4617 of file MainConfigSchema.php.

◆ HideUserContribLimit

const MediaWiki\MainConfigSchema::HideUserContribLimit
Initial value:
= [
'default' => 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 8154 of file MainConfigSchema.php.

◆ HKDFAlgorithm

const MediaWiki\MainConfigSchema::HKDFAlgorithm
Initial value:
= [
'default' => 'sha256',
]

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

See also: $wgHKDFSecret

Since
1.24

Definition at line 8971 of file MainConfigSchema.php.

◆ HKDFSecret

const MediaWiki\MainConfigSchema::HKDFSecret
Initial value:
= [
'default' => 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 8959 of file MainConfigSchema.php.

◆ HTCPMulticastTTL

const MediaWiki\MainConfigSchema::HTCPMulticastTTL
Initial value:
= [
'default' => 1,
]

HTCP multicast TTL.

See also
$wgHTCPRouting

Definition at line 4538 of file MainConfigSchema.php.

◆ HTCPRouting

const MediaWiki\MainConfigSchema::HTCPRouting
Initial value:
= [
'default' => [],
'type' => 'map',
]

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,
],
];
$wgHTCPRouting
Config variable stub for the HTCPRouting setting, for use by phpdoc and IDEs.

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

Example of sending purges to multiple hosts:

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

Definition at line 4528 of file MainConfigSchema.php.

◆ Html5Version

const MediaWiki\MainConfigSchema::Html5Version
Initial value:
= [
'default' => 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 4977 of file MainConfigSchema.php.

◆ HTMLFormAllowTableFormat

const MediaWiki\MainConfigSchema::HTMLFormAllowTableFormat
Initial value:
= [
'default' => 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 4990 of file MainConfigSchema.php.

◆ HttpsPort

const MediaWiki\MainConfigSchema::HttpsPort
Initial value:
= [
'default' => 443,
]

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

$wgServer should be a protocol-relative URL.

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

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

Definition at line 288 of file MainConfigSchema.php.

◆ IgnoreImageErrors

const MediaWiki\MainConfigSchema::IgnoreImageErrors
Initial value:
= [
'default' => 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 2041 of file MainConfigSchema.php.

◆ IllegalFileChars

const MediaWiki\MainConfigSchema::IllegalFileChars
Initial value:
= [
'default' => ':\\/\\\\',
]

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 903 of file MainConfigSchema.php.

◆ ImageLimits

const MediaWiki\MainConfigSchema::ImageLimits
Initial value:
= [
'default' => [
[ 320, 240 ],
[ 640, 480 ],
[ 800, 600 ],
[ 1024, 768 ],
[ 1280, 1024 ],
[ 2560, 2048 ],
],
'type' => 'list',
]

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

In order to reduce disk usage, limits can only be selected from this 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 list is also used by ImagePage for alternate size links.

Definition at line 2252 of file MainConfigSchema.php.

◆ ImageMagickConvertCommand

const MediaWiki\MainConfigSchema::ImageMagickConvertCommand
Initial value:
= [
'default' => '/usr/bin/convert',
]

The convert command shipped with ImageMagick.

Definition at line 1775 of file MainConfigSchema.php.

◆ ImageMagickTempDir

const MediaWiki\MainConfigSchema::ImageMagickTempDir
Initial value:
= [
'default' => false,
]

Temporary directory used for ImageMagick.

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

Definition at line 1807 of file MainConfigSchema.php.

◆ ImagePreconnect

const MediaWiki\MainConfigSchema::ImagePreconnect
Initial value:
= [
'default' => false,
]

Add a preconnect link for browsers to a remote FileRepo host.

This is an optional performance enhancement designed for wiki farm where $wgForeignFileRepos or $wgLocalFileRepo is set to serve thumbnails from a separate hostname (e.g. not local /w/images). The feature expects at most a single remote hostname to be used.

If multiple foreign repos are registered that serve images from different hostnames, only the first will be preconnected.

This may cause unneeded HTTP connections in browsers on wikis where a foreign repo is enabled but where a local repo is more commonly used.

Since
1.35

Definition at line 2448 of file MainConfigSchema.php.

◆ ImgAuthDetails

const MediaWiki\MainConfigSchema::ImgAuthDetails
Initial value:
= [
'default' => false,
]

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

Definition at line 928 of file MainConfigSchema.php.

◆ ImgAuthPath

const MediaWiki\MainConfigSchema::ImgAuthPath
Initial value:
= [
'default' => false,
]

The base path for img_auth.php.

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

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

Since
1.35

Definition at line 568 of file MainConfigSchema.php.

◆ ImgAuthUrlPathMap

const MediaWiki\MainConfigSchema::ImgAuthUrlPathMap
Initial value:
= [
'default' => [],
'type' => 'map',
]

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 947 of file MainConfigSchema.php.

◆ ImplicitGroups

const MediaWiki\MainConfigSchema::ImplicitGroups
Initial value:
= [
'default' => [ '*', 'user', 'autoconfirmed' ],
'type' => 'list',
]

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

Definition at line 7805 of file MainConfigSchema.php.

◆ InterlanguageLinkCodeMap

const MediaWiki\MainConfigSchema::InterlanguageLinkCodeMap
Initial value:
= [
'default' => [],
'type' => 'map',
]

Map of interlanguage link codes to language codes.

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

Since
1.35

Definition at line 4647 of file MainConfigSchema.php.

◆ InternalServer

const MediaWiki\MainConfigSchema::InternalServer
Initial value:
= [
'default' => false,
]

Internal server name as known to CDN, if different.

Example:

$wgInternalServer = 'http://yourinternal.tld:8000';
$wgInternalServer
Config variable stub for the InternalServer setting, for use by phpdoc and IDEs.

Definition at line 4352 of file MainConfigSchema.php.

◆ InterwikiMagic

const MediaWiki\MainConfigSchema::InterwikiMagic
Initial value:
= [
'default' => true,
]

Treat language links as magic connectors, not inline links.

Definition at line 4610 of file MainConfigSchema.php.

◆ InvalidateCacheOnLocalSettingsChange

const MediaWiki\MainConfigSchema::InvalidateCacheOnLocalSettingsChange
Initial value:
= [
'default' => 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 4272 of file MainConfigSchema.php.

◆ InvalidPasswordReset

const MediaWiki\MainConfigSchema::InvalidPasswordReset
Initial value:
= [
'default' => 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 7066 of file MainConfigSchema.php.

◆ InvalidUsernameCharacters

const MediaWiki\MainConfigSchema::InvalidUsernameCharacters
Initial value:
= [
'default' => '@:>=',
]

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 7335 of file MainConfigSchema.php.

◆ JpegPixelFormat

const MediaWiki\MainConfigSchema::JpegPixelFormat
Initial value:
= [
'default' => '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 1855 of file MainConfigSchema.php.

◆ JpegQuality

const MediaWiki\MainConfigSchema::JpegQuality
Initial value:
= [
'default' => 80,
]

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

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

Since
1.32

Definition at line 1866 of file MainConfigSchema.php.

◆ JpegTran

const MediaWiki\MainConfigSchema::JpegTran
Initial value:
= [
'default' => '/usr/bin/jpegtran',
]

used for lossless jpeg rotation

Since
1.21

Definition at line 1832 of file MainConfigSchema.php.

◆ LanguageCode

const MediaWiki\MainConfigSchema::LanguageCode
Initial value:
= [
'default' => 'en',
]

Site language code.

See includes/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 4587 of file MainConfigSchema.php.

◆ LanguageConverterCacheType

const MediaWiki\MainConfigSchema::LanguageConverterCacheType
Initial value:
= [
'default' => CACHE_ANYTHING,
]
const CACHE_ANYTHING
Definition: Defines.php:85

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 3751 of file MainConfigSchema.php.

◆ LBFactoryConf

const MediaWiki\MainConfigSchema::LBFactoryConf
Initial value:
= [
'default' => [
'class' => 'Wikimedia\\Rdbms\\LBFactorySimple',
],
'type' => 'map',
'mergeStrategy' => 'replace',
]

Load balancer factory configuration To set up a multi-primary wiki farm, set the class here to something that can return a LoadBalancer with an appropriate primary 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 3109 of file MainConfigSchema.php.

◆ LegacyEncoding

const MediaWiki\MainConfigSchema::LegacyEncoding
Initial value:
= [
'default' => 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 4717 of file MainConfigSchema.php.

◆ LegalTitleChars

const MediaWiki\MainConfigSchema::LegalTitleChars

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 6012 of file MainConfigSchema.php.

◆ LinkHolderBatchSize

const MediaWiki\MainConfigSchema::LinkHolderBatchSize
Initial value:
= [
'default' => 1000,
]

LinkHolderArray batch size For debugging.

Definition at line 3632 of file MainConfigSchema.php.

◆ LoadScript

const MediaWiki\MainConfigSchema::LoadScript
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
]

The URL path to load.php.

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

Since
1.17

Definition at line 384 of file MainConfigSchema.php.

◆ LocalDatabases

const MediaWiki\MainConfigSchema::LocalDatabases
Initial value:
= [
'default' => [],
'type' => 'list',
'items' => [ 'type' => 'string', ],
]

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

List of wiki DB domain IDs; the format of each ID consist of 1-3 hyphen delimited alphanumeric components (each with no hyphens nor spaces) of any of the forms:

  • "<DB NAME>-<DB SCHEMA>-<TABLE PREFIX>"
  • "<DB NAME>-<TABLE PREFIX>"
  • "<DB NAME>" If hyphens appear in any of the components, then the domain ID parsing may not work in all cases and site functionality might be affected. If the schema ($wgDBmwschema) is left to the default "mediawiki" for all wikis, then the schema should be omitted from these IDs.

Definition at line 3184 of file MainConfigSchema.php.

◆ LocalFileRepo

const MediaWiki\MainConfigSchema::LocalFileRepo
Initial value:
= [
'default' => false,
'type' => 'map|false',
'dynamicDefault' => [ 'use' => [ 'UploadDirectory', 'ScriptPath', 'Favicon', 'UploadBaseUrl',
'UploadPath', 'HashedUploadDirectory', 'ThumbnailScriptPath',
'GenerateThumbnailOnParse', 'DeletedDirectory', 'UpdateCompatibleMetadata' ] ],
]

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.

Optional common properties:

  • backend A file backend name (see $wgFileBackends). If not specified, or if the name is not present in $wgFileBackends, an FSFileBackend will automatically be configured.
  • lockManager If a file backend is automatically configured, this will be lock manager name used. A lock manager named in $wgLockManagers, or one of the default lock managers "fsLockManager" or "nullLockManager". Default "fsLockManager".
  • favicon URL to a favicon. This is exposed via FileRepo::getInfo and ApiQueryFileRepoInfo. Originally for use by MediaViewer (T77093).

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.
                 Set this to 0 if you do not want MediaWiki to divide your images
                 directory into many subdirectories.
    
                 It is recommended 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 copying them into $wgUploadDirectory and then running
                 maintenance/rebuildImages.php to register them in the database.
                 This is no longer supported, use maintenance/importImages.php instead.
    
                 Default: 2.
    
  • deletedHashLevels Optional 'hashLevels' override for the 'deleted' zone.
  • 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.
  • thumbProxyUrl Optional. URL of where to proxy thumb.php requests to. This is also used internally for remote thumbnailing of upload stash files. Example: http://127.0.0.1:8888/wiki/dev/thumb/
  • thumbProxySecret Optional value of the X-Swift-Secret header to use in requests to thumbProxyUrl
  • disableLocalTransform If present and true, local image scaling will be disabled – it will throw an exception if attempted. thumbProxyUrl must be set for this to work, as well as either transformVia404 (preferred) or thumbScriptUrl.
  • 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.
  • useJsonMetadata Whether handler metadata should be stored in JSON format. Default: true.
  • useSplitMetadata Whether handler metadata should be split up and stored in the text table. Default: false.
  • splitMetadataThreshold If the media handler opts in, large metadata items will be split into a separate blob in the database if the item is larger than this threshold. Default: 1000
  • updateCompatibleMetadata When true, image metadata will be upgraded by reloading it from the original file, if the handler indicates that it is out of date.

    By default, when purging a file or otherwise refreshing file metadata, it is only reloaded when the metadata is invalid. Valid data originally loaded by a current or older compatible version is left unchanged. Enable this to also reload and upgrade metadata that was stored by an older compatible version. See also MediaHandler::isMetadataValid, and RefreshImageMetadata.

    Default: false.

  • reserializeMetadata If true, image metadata will be automatically rewritten to the database if its serialization format is out of date. Default: false

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 and display them on the local wiki.
  • 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 Set to true if the foreign wiki's $wgMainCacheType is identical to, and accessible from, this wiki.

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
FileRepo::__construct for the default options.
Setup.php for an example usage and default initialization.

Definition at line 1086 of file MainConfigSchema.php.

◆ LocalisationCacheConf

const MediaWiki\MainConfigSchema::LocalisationCacheConf
Initial value:
= [
'properties' => [
'class' => [ 'type' => 'string', 'default' => LocalisationCache::class ],
'store' => [ 'type' => 'string', 'default' => 'detect' ],
'storeClass' => [ 'type' => 'false|string', 'default' => false ],
'storeDirectory' => [ 'type' => 'false|string', 'default' => false ],
'storeServer' => [ 'type' => 'object', 'default' => [] ],
'forceRecache' => [ 'type' => 'bool', 'default' => false ],
'manualRecache' => [ 'type' => 'bool', 'default' => false ],
],
'type' => 'object',
]

Localisation cache configuration.

Used by Language::getLocalisationCache() to decide how to construct the LocalisationCache instance. Associative array with keys:

class: The class to use for constructing the LocalisationCache object. This may be overridden by extensions to a subclass of LocalisationCache. Sub classes are expected to still honor the 'storeClass', 'storeDirectory' and 'manualRecache' options where applicable.

storeClass: Which LCStore class implementation to use. This is optional. The default LocalisationCache class offers the 'store' option as abstraction for this.

store: How and where to store localisation cache data. This option is ignored if 'storeClass' is explicitly set to a class name. Must be one of:

  • 'detect' (default): Automatically select 'files' if 'storeDirectory' or $wgCacheDirectory is set, and fall back to 'db' otherwise.
  • 'files': Store in $wgCacheDirectory as CDB files.
  • 'array': Store in $wgCacheDirectory as PHP static array files.
  • 'db': Store in the l10n_cache database table.

storeDirectory: If the selected LCStore class puts its data in files, then it will use this directory. If set to false (default), then $wgCacheDirectory is used instead.

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

Definition at line 4165 of file MainConfigSchema.php.

◆ LocalStylePath

const MediaWiki\MainConfigSchema::LocalStylePath
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
]

The URL path of the skins directory.

Should not point to an external domain.

Defaults to "{$wgScriptPath}/skins".

Since
1.17

Definition at line 443 of file MainConfigSchema.php.

◆ Localtimezone

const MediaWiki\MainConfigSchema::Localtimezone
Initial value:
= [
'dynamicDefault' => true,
]

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

Examples:

$wgLocaltimezone = 'PST8PDT';
$wgLocaltimezone = 'Europe/Sweden';
$wgLocaltimezone
Config variable stub for the Localtimezone setting, for use by phpdoc and IDEs.

Definition at line 4902 of file MainConfigSchema.php.

◆ LocalTZoffset

const MediaWiki\MainConfigSchema::LocalTZoffset
Initial value:
= [
'dynamicDefault' => [ 'use' => [ 'Localtimezone' ] ]
]

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 4928 of file MainConfigSchema.php.

◆ LockManagers

const MediaWiki\MainConfigSchema::LockManagers
Initial value:
= [
'default' => [],
'type' => 'list',
]

List of lock manager backend configurations.

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.

Definition at line 1382 of file MainConfigSchema.php.

◆ LoginLanguageSelector

const MediaWiki\MainConfigSchema::LoginLanguageSelector
Initial value:
= [
'default' => 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 4825 of file MainConfigSchema.php.

◆ Logo

const MediaWiki\MainConfigSchema::Logo
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'ResourceBasePath' ] ]
]

The URL path of the wiki logo.

The logo size should be 135x135 pixels.

Defaults to "$wgResourceBasePath/resources/assets/change-your-logo.svg". Developers should retrieve this logo (and other variants) using the static function MediaWiki\ResourceLoader\SkinModule::getAvailableLogos Ignored if $wgLogos is set.

Definition at line 624 of file MainConfigSchema.php.

◆ LogoHD

const MediaWiki\MainConfigSchema::LogoHD
Initial value:
= [
'default' => false,
'type' => 'map|false',
'deprecated' => 'since 1.35. Developers should retrieve this logo (and other variants) ' .
'using the static function MediaWiki\ResourceLoader\SkinModule::getAvailableLogos. $wgLogos ' .
'should be used instead.',
]

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"
];
$wgLogoHD
Config variable stub for the LogoHD setting, for use by phpdoc and IDEs.

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
Deprecated:
since 1.35. Developers should retrieve this logo (and other variants) using the static function MediaWiki\ResourceLoader\SkinModule::getAvailableLogos. $wgLogos should be used instead.

Definition at line 720 of file MainConfigSchema.php.

◆ Logos

const MediaWiki\MainConfigSchema::Logos
Initial value:
= [
'default' => false,
'type' => 'map|false',
]

Specification for different versions of the wiki logo.

This is an array which should have the following k/v pairs: All path values can be either absolute or relative URIs

The 1x key is a path to the 1x version of square logo (should be 135x135 pixels) The 1.5x key is a path to the 1.5x version of square logo The 2x key is a path to the 2x version of square logo The svg key is a path to the svg version of square logo The icon key is a path to the version of the logo without wordmark and tagline The wordmark key may be null or an array with the following fields

  • src path to wordmark version
  • 1x path to svg wordmark version (if you want to support browsers with SVG support with an SVG logo)
  • width width of the logo in pixels
  • height height of the logo in pixels The tagline key may be null or array with the following fields
  • src path to tagline image
  • width width of the tagline in pixels
  • height height of the tagline in pixels
Example:
'1x' => 'path/to/1x_version.png',
'1.5x' => 'path/to/1.5x_version.png',
'2x' => 'path/to/2x_version.png',
'svg' => 'path/to/svg_version.svg',
'icon' => 'path/to/icon.png',
'wordmark' => [
'src' => 'path/to/wordmark_version.png',
'1x' => 'path/to/wordmark_version.svg',
'width' => 135,
'height' => 20,
],
'tagline' => [
'src' => 'path/to/tagline_version.png',
'width' => 135,
'height' => 15,
]
];
$wgLogos
Config variable stub for the Logos setting, for use by phpdoc and IDEs.

Defaults to [ "1x" => $wgLogo ], or [ "1x" => "$wgResourceBasePath/resources/assets/change-your-logo.svg" ] if $wgLogo is not set.

Since
1.35

Definition at line 686 of file MainConfigSchema.php.

◆ MainCacheType

const MediaWiki\MainConfigSchema::MainCacheType
Initial value:
= [
'default' => CACHE_NONE,
]
const CACHE_NONE
Definition: Defines.php:86

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 3708 of file MainConfigSchema.php.

◆ MainPageIsDomainRoot

const MediaWiki\MainConfigSchema::MainPageIsDomainRoot
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

Option to whether serve the main page as the domain root.

Warning
EXPERIMENTAL!
Since
1.34

Definition at line 848 of file MainConfigSchema.php.

◆ MainStash

const MediaWiki\MainConfigSchema::MainStash
Initial value:
= [
'default' => 'db-replicated',
]

The object store type of the main stash.

This should be a fast storage system optimized for lightweight data, both ephemeral and permanent, for things like counters, tokens, and blobs. The dataset access scope should include all the application servers in all datacenters. Thus, the data must be replicated among all datacenters. The store should have "Last Write Wins" eventual consistency. Per https://en.wikipedia.org/wiki/PACELC_theorem, the store should act as a PA/EL distributed system for these operations.

The multi-datacenter strategy for MediaWiki is to have CDN route HTTP POST requests to the primary datacenter and HTTP GET/HEAD/OPTIONS requests to the closest datacenter to the client. The stash accepts write operations from any datacenter, but cross-datacenter replication is asynchronous.

Modules that use the main stash can expect race conditions to occur if a key can receive write operations originating from multiple datacenters. To improve consistency, callers should avoid main stash updates during non-POST requests. In any case, callers should gracefully tolerate occasional key evictions, temporary inconsistencies among datacenters, and violations of linearizability (e.g. during timeouts). Modules that can never handle these kind of anamolies should use other storage mediums.

Valid options are the keys of $wgObjectCaches, e.g. CACHE_* constants.

See also
\BagOStuff
Since
1.26

Definition at line 3960 of file MainConfigSchema.php.

◆ MainWANCache

const MediaWiki\MainConfigSchema::MainWANCache
Initial value:
= [
'default' => false,
'type' => 'integer|string|false',
]

Main Wide-Area-Network cache type.

By default, this will wrap $wgMainCacheType (which is disabled, since the basic stock default of CACHE_DB is not fast enough to make it worthwhile).

For single server or single datacenter setup, setting $wgMainCacheType is enough.

For a multiple datacenter setup, WANObjectCache should be configured to broadcast some if its operations using Mcrouter or Dynomite. See Deploying WANObjectCache.

The options are:

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

Definition at line 3891 of file MainConfigSchema.php.

◆ MangleFlashPolicy

const MediaWiki\MainConfigSchema::MangleFlashPolicy
Initial value:
= [
'default' => true,
'obsolete' => 'Since 1.39; no longer has any effect.',
'description' => 'Has been emitting warnings since 1.39 (LTS). ' .
'Can be removed completely in 1.44, assuming 1.43 is an LTS release.'
]

Formerly a workaround for a security vulnerability caused by installation of Flash as a browser extension.

Since
1.25
Deprecated:
since 1.39

Definition at line 5284 of file MainConfigSchema.php.

◆ MaxAnimatedGifArea

const MediaWiki\MainConfigSchema::MaxAnimatedGifArea
Initial value:
= [
'default' => 12500000,
]

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 1983 of file MainConfigSchema.php.

◆ MaxArticleSize

const MediaWiki\MainConfigSchema::MaxArticleSize
Initial value:
= [
'default' => 2048,
]

Maximum article size in kibibytes.

Definition at line 3552 of file MainConfigSchema.php.

◆ MaxExecutionTimeForExpensiveQueries

const MediaWiki\MainConfigSchema::MaxExecutionTimeForExpensiveQueries
Initial value:
= [
'default' => 0,
]

Max execution time for queries of several expensive special pages such as RecentChanges in milliseconds.

Since
1.38

Definition at line 3215 of file MainConfigSchema.php.

◆ MaxImageArea

const MediaWiki\MainConfigSchema::MaxImageArea
Initial value:
= [
'default' => 12500000,
'type' => 'string|integer|false',
]

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.

If set to false, MediaWiki will not check the size of the image before attempting to scale it. Extensions may still override this setting by using the BitmapHandlerCheckImageArea hook.

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

Definition at line 1970 of file MainConfigSchema.php.

◆ MaximalPasswordLength

const MediaWiki\MainConfigSchema::MaximalPasswordLength
Initial value:
= [
'default' => false,
'deprecated' => 'since 1.26, use $wgPasswordPolicy\'s MaximalPasswordLength.',
]

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 7055 of file MainConfigSchema.php.

◆ MaximumMovedPages

const MediaWiki\MainConfigSchema::MaximumMovedPages
Initial value:
= [
'default' => 100,
]

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

Definition at line 3639 of file MainConfigSchema.php.

◆ MaxInterlacingAreas

const MediaWiki\MainConfigSchema::MaxInterlacingAreas
Initial value:
= [
'default' => [],
'type' => 'map',
]

Array of max pixel areas for interlacing per MIME type.

Since
1.27

Definition at line 1784 of file MainConfigSchema.php.

◆ MaxJobDBWriteDuration

const MediaWiki\MainConfigSchema::MaxJobDBWriteDuration
Initial value:
= [
'default' => false,
'type' => 'integer|false',
]

Max time (in seconds) a job-generated transaction can spend in writes.

If exceeded, the transaction is rolled back with an error instead of being committed.

Since
1.30

Definition at line 3623 of file MainConfigSchema.php.

◆ MaxMsgCacheEntrySize

const MediaWiki\MainConfigSchema::MaxMsgCacheEntrySize
Initial value:
= [
'default' => 10000,
]

Maximum entry size in the message cache, in bytes.

Definition at line 4749 of file MainConfigSchema.php.

◆ MaxNameChars

const MediaWiki\MainConfigSchema::MaxNameChars
Initial value:
= [
'default' => 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 7215 of file MainConfigSchema.php.

◆ MaxSigChars

const MediaWiki\MainConfigSchema::MaxSigChars
Initial value:
= [
'default' => 255,
]

Maximum number of Unicode characters in signature.

Definition at line 7180 of file MainConfigSchema.php.

◆ MaxUploadSize

const MediaWiki\MainConfigSchema::MaxUploadSize
Initial value:
= [
'default' => 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.

The below example would set the maximum for all uploads to 250 KiB except, for upload-by-url, which would have a maximum of 500 KiB.

Example:

'*' => 250 * 1024,
'url' => 500 * 1024,
];
$wgMaxUploadSize
Config variable stub for the MaxUploadSize setting, for use by phpdoc and IDEs.

Default: 100 MiB.

Definition at line 1501 of file MainConfigSchema.php.

◆ MaxUserDBWriteDuration

const MediaWiki\MainConfigSchema::MaxUserDBWriteDuration
Initial value:
= [
'default' => false,
'type' => 'integer|false',
]

Max time (in seconds) a user-generated transaction can spend in writes.

If exceeded, the transaction is rolled back with an error instead of being committed.

Since
1.27

Definition at line 3611 of file MainConfigSchema.php.

◆ MediaHandlers

const MediaWiki\MainConfigSchema::MediaHandlers
Initial value:
= [
'default' => [],
'type' => 'map',
]

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 1714 of file MainConfigSchema.php.

◆ MediaInTargetLanguage

const MediaWiki\MainConfigSchema::MediaInTargetLanguage
Initial value:
= [
'default' => true,
]

Whether thumbnails should be generated in target language (usually, same as page language), if available.

Currently, applies only to SVG images that use the systemLanguage attribute to specify text language.

Since
1.33

Definition at line 1949 of file MainConfigSchema.php.

◆ MemCachedPersistent

const MediaWiki\MainConfigSchema::MemCachedPersistent
Initial value:
= [
'default' => false,
]

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

Definition at line 4097 of file MainConfigSchema.php.

◆ MemCachedServers

const MediaWiki\MainConfigSchema::MemCachedServers
Initial value:
= [
'default' => [ '127.0.0.1:11211', ],
'type' => 'list',
]

The list of MemCached servers and port numbers.

Definition at line 4088 of file MainConfigSchema.php.

◆ MemCachedTimeout

const MediaWiki\MainConfigSchema::MemCachedTimeout
Initial value:
= [
'default' => 500000,
]

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

Definition at line 4104 of file MainConfigSchema.php.

◆ MemoryLimit

const MediaWiki\MainConfigSchema::MemoryLimit
Initial value:
= [
'default' => '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 3560 of file MainConfigSchema.php.

◆ MessageCacheType

const MediaWiki\MainConfigSchema::MessageCacheType
Initial value:
= [
'default' => 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 3718 of file MainConfigSchema.php.

◆ MetaNamespace

const MediaWiki\MainConfigSchema::MetaNamespace
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'Sitename' ] ]
]

Name of the project namespace.

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

Definition at line 5882 of file MainConfigSchema.php.

◆ MetaNamespaceTalk

const MediaWiki\MainConfigSchema::MetaNamespaceTalk
Initial value:
= [
'default' => 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 5902 of file MainConfigSchema.php.

◆ MimeDetectorCommand

const MediaWiki\MainConfigSchema::MimeDetectorCommand
Initial value:
= [
'default' => null,
'type' => '?string',
]

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 2212 of file MainConfigSchema.php.

◆ MimeInfoFile

const MediaWiki\MainConfigSchema::MimeInfoFile
Initial value:
= [
'default' => 'internal',
]

Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php.

Set to null to use the minimum set of built-in defaults only.

Definition at line 2195 of file MainConfigSchema.php.

◆ MimeType

const MediaWiki\MainConfigSchema::MimeType
Initial value:
= [
'default' => 'text/html',
]

The default Content-Type header.

Definition at line 4964 of file MainConfigSchema.php.

◆ MimeTypeExclusions

const MediaWiki\MainConfigSchema::MimeTypeExclusions
Initial value:
= [
'default' => [
# HTML may contain cookie-stealing JavaScript and web bugs
'text/html',
# Similarly with JavaScript itself
'application/javascript', '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 that look like java files
'application/java'
],
'type' => 'list',
]

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

Since
1.37; previously $wgMimeTypeBlacklist

Definition at line 1627 of file MainConfigSchema.php.

◆ MimeTypeFile

const MediaWiki\MainConfigSchema::MimeTypeFile
Initial value:
= [
'default' => 'internal',
]

Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php.

When this is set to the path of a mime.types file, MediaWiki will use this file to map MIME types to file extensions and vice versa, in lieu of its internal MIME map. Note that some MIME mappings are considered "baked in" and cannot be overridden. See includes/libs/mime/MimeMapMinimal.php for a full list. example: $wgMimeTypeFile = '/etc/mime.types';

Definition at line 2186 of file MainConfigSchema.php.

◆ MinimalPasswordLength

const MediaWiki\MainConfigSchema::MinimalPasswordLength
Initial value:
= [
'default' => false,
'deprecated' => 'since 1.26, use $wgPasswordPolicy\'s MinimalPasswordLength.',
]

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 7039 of file MainConfigSchema.php.

◆ MinUploadChunkSize

const MediaWiki\MainConfigSchema::MinUploadChunkSize
Initial value:
= [
'default' => 1024,
]

Minimum upload chunk size, in bytes.

When using chunked upload, non-final chunks smaller than this will be rejected.

Note that this may be further reduced by the upload_max_filesize and post_max_size PHP settings. Use ApiUpload::getMinUploadChunkSize to get the effective minimum chunk size used by MediaWiki.

Default: 1 KiB.

Since
1.26
See also
\ApiUpload::getMinUploadChunkSize

Definition at line 1519 of file MainConfigSchema.php.

◆ MiserMode

const MediaWiki\MainConfigSchema::MiserMode
Initial value:
= [
'default' => false,
]

Disable database-intensive features.

Definition at line 3510 of file MainConfigSchema.php.

◆ MultiShardSiteStats

const MediaWiki\MainConfigSchema::MultiShardSiteStats
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

Whether site_stats table should have multiple rows.

If set to true, in each update, one of ten rows gets updated at random to reduce lock wait time in wikis that have lots of concurrent edits. It should be set to true in really large wikis with big flow of edits, Otherwise it can cause inaccuracy in data.

Since
1.39

Definition at line 3668 of file MainConfigSchema.php.

◆ NamespaceAliases

const MediaWiki\MainConfigSchema::NamespaceAliases
Initial value:
= [
'default' => [],
'type' => 'map',
]

Define extra 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,
];
const NS_USER
Definition: Defines.php:66
$wgNamespaceAliases
Config variable stub for the NamespaceAliases setting, for use by phpdoc and IDEs.
See also
\Language::getNamespaceAliases for accessing the full list of aliases, including those defined by other means.

Definition at line 5983 of file MainConfigSchema.php.

◆ NamespaceContentModels

const MediaWiki\MainConfigSchema::NamespaceContentModels
Initial value:
= [
'default' => [],
'type' => 'map',
]

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

Note
To determine the default model for a new page's main slot, or any slot in general, use SlotRoleHandler::getDefaultModel() together with SlotRoleRegistry::getRoleHandler().
Since
1.21

Definition at line 3298 of file MainConfigSchema.php.

◆ NamespaceProtection

const MediaWiki\MainConfigSchema::NamespaceProtection
Initial value:
= [
'default' => [],
'type' => 'map',
]

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 7914 of file MainConfigSchema.php.

◆ NativeImageLazyLoading

const MediaWiki\MainConfigSchema::NativeImageLazyLoading
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

Toggles native image lazy loading, via the "loading" attribute.

Warning
EXPERIMENTAL!
Since
1.34

Definition at line 1725 of file MainConfigSchema.php.

◆ NewPasswordExpiry

const MediaWiki\MainConfigSchema::NewPasswordExpiry
Initial value:
= [
'default' => 3600 * 24 * 7,
]

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

Definition at line 2603 of file MainConfigSchema.php.

◆ NonincludableNamespaces

const MediaWiki\MainConfigSchema::NonincludableNamespaces
Initial value:
= [
'default' => [],
'type' => 'map',
]

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 7928 of file MainConfigSchema.php.

◆ NoReplyAddress

const MediaWiki\MainConfigSchema::NoReplyAddress
Initial value:
= [
'default' => false,
]

Reply-To address for e-mail notifications.

Defaults to $wgPasswordSender (in Setup.php).

Definition at line 2537 of file MainConfigSchema.php.

◆ ObjectCaches

const MediaWiki\MainConfigSchema::ObjectCaches

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. One of the following parameters specifying the class must be given:

  • class: The class name which will be used.
  • factory: A callable function which will generate a suitable cache object.

The following parameters are shared and understood by most classes:

  • loggroup: The log channel to use.

For SqlBagOStuff, the main configured database will be used, unless one of the following three parameters is given:

  • server: Server config map for Database::factory() that describes the database to use for all key operations in the current region. This is overridden by "servers".
  • servers: Map of tag strings to server config maps, each for Database::factory(), describing the set of database servers on which to distribute key operations in the current region. Data is distributed among the servers via key hashing based on the server tags. Therefore, each tag represents a shard of the dataset. Tags are useful for failover using cold-standby servers and for managing shards with replica servers in multiple regions (each having different hostnames).
  • cluster: The ExternalStore cluster name to use.

SqlBagOStuff also accepts the following optional parameters:

  • dbDomain: The database name to pass to the LoadBalancer.
  • multiPrimaryMode: Whether the portion of the dataset belonging to each tag/shard is replicated among one or more regions, with one "co-primary" server in each region. Queries are issued in a manner that provides Last-Write-Wins eventual consistency. This option requires the "server" or "servers" options. Only MySQL, with statment based replication (log_bin='ON' and binlog_format='STATEMENT') is supported. Also, the modtoken column must exist on the objectcache table(s).
  • purgePeriod: The average number of object cache writes in between garbage collection operations, where expired entries are removed from the database. Or in other words, the probability of performing a purge is one in every this number. If set to zero, purging will never be done at runtime (for use with PurgeParserCache).
  • purgeLimit: Maximum number of rows to purge at once.
  • tableName: The table name to use, default is "objectcache".
  • shards: The number of tables to use for data storage on each server. If greater than 1, table names are formed in the style objectcacheNNN where NNN is the shard index, between 0 and shards-1. The number of digits used in the suffix is the minimum number required to hold the largest shard index. Data is distributed among the tables via key hashing. This helps mitigate MySQL bugs 61735 and 61736.
  • replicaOnly: Whether to only use replica servers and only support read operations. This option requires the use of LoadBalancer and should only be used by ReplicatedBagOStuff.
  • writeBatchSize: Default maximum number of rows to change in each query for write operations that can be chunked into a set of smaller writes.

For MemcachedPhpBagOStuff parameters see MemcachedPhpBagOStuff::__construct

For MemcachedPeclBagOStuff parameters see MemcachedPeclBagOStuff::__construct

For RedisBagOStuff parameters see RedisBagOStuff::__construct

Definition at line 3827 of file MainConfigSchema.php.

◆ ObjectCacheSessionExpiry

const MediaWiki\MainConfigSchema::ObjectCacheSessionExpiry
Initial value:
= [
'default' => 60 * 60,
]

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

Definition at line 4043 of file MainConfigSchema.php.

◆ OldRevisionParserCacheExpireTime

const MediaWiki\MainConfigSchema::OldRevisionParserCacheExpireTime
Initial value:
= [
'default' => 60 * 60,
]

The expiry time for the parser cache for old revisions, in seconds.

The default is 3600 (cache disabled).

Definition at line 4036 of file MainConfigSchema.php.

◆ OverrideUcfirstCharacters

const MediaWiki\MainConfigSchema::OverrideUcfirstCharacters
Initial value:
= [
'default' => [],
'type' => 'map',
]

Map of Unicode characters for which capitalization is overridden in Language::ucfirst.

The characters should be represented as char_to_convert => conversion_override. See T219279 for details on why this is useful during php version transitions.

Since
1.34

Definition at line 4950 of file MainConfigSchema.php.

◆ PageLanguageUseDB

const MediaWiki\MainConfigSchema::PageLanguageUseDB
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

Enable page language feature Allows setting page language in database.

Since
1.24

Definition at line 3425 of file MainConfigSchema.php.

◆ ParserCacheExpireTime

const MediaWiki\MainConfigSchema::ParserCacheExpireTime
Initial value:
= [
'default' => 60 * 60 * 24,
]

The expiry time for the parser cache, in seconds.

The default is 86400 (one day).

Definition at line 4027 of file MainConfigSchema.php.

◆ ParserCacheType

const MediaWiki\MainConfigSchema::ParserCacheType
Initial value:
= [
'default' => 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 3728 of file MainConfigSchema.php.

◆ ParserTestMediaHandlers

const MediaWiki\MainConfigSchema::ParserTestMediaHandlers
Initial value:
= [
'default' => [
'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',
],
'type' => 'map',
]

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

Definition at line 1734 of file MainConfigSchema.php.

◆ ParsoidCacheConfig

const MediaWiki\MainConfigSchema::ParsoidCacheConfig
Initial value:
= [
'type' => 'object',
'properties' => [
'StashType' => [ 'type' => 'int|string|null', 'default' => null ],
'StashDuration' => [ 'type' => 'int', 'default' => 24 * 60 * 60 ],
'CacheThresholdTime' => [ 'type' => 'float', 'default' => 0.0 ],
'WarmParsoidParserCache' => [ 'type' => 'bool', 'default' => false ],
]
]

Configuration for the caching related to parsoid output.

The configuration contains the following keys:

  • StashType: The type of object store to be used by the ParsoidOutputStash service, which stores the base state of HTML based edits. Valid options are the keys of $wgObjectCaches, e.g. CACHE_* constants. Per default, the value of the MainStash setting will be used. This should be an object store that provides fairly solid persistence guarantees, since losing an entry from the stash may mean that the user can't save their edit. If null, the value of the MainStash configuration setting will be used.
  • StashDuration: The number of seconds for which an entry in the stash should be kept. Should be long enough for users to finish editing, since losing an entry from the stash may mean that the user can't save their edit. This is set to one day per default.
  • CacheThresholdTime: If parsing is completed before this time (in seconds), assume it's a small page that is fast for parsing and does not need caching. Setting this to zero causes all outputs to be cached.
  • WarmParsoidParserCache: Setting this to true will pre-populate the parsoid parser cache with parsoid outputs on page edits. This speeds up loading HTML into Visual Editor.
Since
1.39
Stability: unstable
Per MediaWiki 1.39, the structure of this configuration is still subject to change.

Definition at line 3992 of file MainConfigSchema.php.

◆ PasswordAttemptThrottle

const MediaWiki\MainConfigSchema::PasswordAttemptThrottle
Initial value:
= [
'default' => [
[ 'count' => 5, 'seconds' => 300 ],
[ 'count' => 150, 'seconds' => 60 * 60 * 48 ],
],
'type' => 'list',
]

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 8464 of file MainConfigSchema.php.

◆ PasswordConfig

const MediaWiki\MainConfigSchema::PasswordConfig

Configuration for built-in password types.

Maps the password type to an array of options:

  • class: The Password class to use.
  • factory (since 1.40): A function that creates and returns a suitable Password object. This option is intended only for internal use; the function signature is unstable and subject to change in future versions.

All other options are class-dependent.

An advanced example:

$wgPasswordConfig['bcrypt-peppered'] = [
'class' => EncryptedPassword::class,
'underlying' => 'bcrypt',
'secrets' => [
hash( 'sha256', 'secret', true ),
],
'cipher' => 'aes-256-cbc',
];
$wgPasswordConfig
Config variable stub for the PasswordConfig setting, for use by phpdoc and IDEs.
Since
1.24

Definition at line 7109 of file MainConfigSchema.php.

◆ PasswordDefault

const MediaWiki\MainConfigSchema::PasswordDefault
Initial value:
= [
'default' => 'pbkdf2',
]

Default password type to use when hashing user passwords.

Must be set to a type defined in $wgPasswordConfig, or a type that is registered by default in PasswordFactory.php.

Since
1.24

Definition at line 7078 of file MainConfigSchema.php.

◆ PasswordExpirationDays

const MediaWiki\MainConfigSchema::PasswordExpirationDays
Initial value:
= [
'default' => 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 2618 of file MainConfigSchema.php.

◆ PasswordExpireGrace

const MediaWiki\MainConfigSchema::PasswordExpireGrace
Initial value:
= [
'default' => 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 2626 of file MainConfigSchema.php.

◆ PasswordReminderResendTime

const MediaWiki\MainConfigSchema::PasswordReminderResendTime
Initial value:
= [
'default' => 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 2596 of file MainConfigSchema.php.

◆ PasswordResetRoutes

const MediaWiki\MainConfigSchema::PasswordResetRoutes
Initial value:
= [
'default' => [
'username' => true,
'email' => true,
],
'type' => 'map',
]

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 7169 of file MainConfigSchema.php.

◆ PasswordSender

const MediaWiki\MainConfigSchema::PasswordSender
Initial value:
= [
'default' => false,
]

Sender email address for e-mail notifications.

The address we use as sender when a user requests a password reminder, as well as other e-mail notifications.

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

Definition at line 2528 of file MainConfigSchema.php.

◆ PHPSessionHandling

const MediaWiki\MainConfigSchema::PHPSessionHandling
Initial value:
= [
'default' => 'enable',
'type' => 'string',
]

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

Definition at line 4059 of file MainConfigSchema.php.

◆ PoolCounterConf

const MediaWiki\MainConfigSchema::PoolCounterConf
Initial value:
= [
'default' => null,
'type' => '?map',
]

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' => [
'class' => PoolCounterRedis::class,
'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' => []
] ];
$wgPoolCounterConf
Config variable stub for the PoolCounterConf setting, for use by phpdoc and IDEs.

Example using C daemon from https://www.mediawiki.org/wiki/Extension:PoolCounter:

$wgPoolCounterConf = [ 'ArticleView' => [
'class' => MediaWiki\\Extension\\PoolCounter\\Client::class,
'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...
] ];
The MediaWiki class is the helper class for the index.php entry point.
Definition: MediaWiki.php:39
Semaphore semantics to restrict how many workers may concurrently perform a task.
Definition: PoolCounter.php:50

Definition at line 3599 of file MainConfigSchema.php.

◆ ProhibitedFileExtensions

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

Files with these extensions will never be allowed as uploads.

An array of file extensions to prevent being uploaded. You should append to this array if you want to prevent additional file extensions.

Since
1.37; previously $wgFileBlacklist

Definition at line 1607 of file MainConfigSchema.php.

◆ ProxyList

const MediaWiki\MainConfigSchema::ProxyList
Initial value:
= [
'default' => [],
'type' => 'string|list',
]

List of banned IP addresses.

This can have the following formats:

  • An array of addresses
  • A string, in which case this is the path to a file containing the list of IP addresses, one per line

Definition at line 8261 of file MainConfigSchema.php.

◆ ProxyWhitelist

const MediaWiki\MainConfigSchema::ProxyWhitelist
Initial value:
= [
'default' => [],
'type' => 'list',
]

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

Definition at line 8270 of file MainConfigSchema.php.

◆ PutIPinRC

const MediaWiki\MainConfigSchema::PutIPinRC
Initial value:
= [
'default' => 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 8440 of file MainConfigSchema.php.

◆ QueryCacheLimit

const MediaWiki\MainConfigSchema::QueryCacheLimit
Initial value:
= [
'default' => 1000,
]

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

Definition at line 3524 of file MainConfigSchema.php.

◆ QueryPageDefaultLimit

const MediaWiki\MainConfigSchema::QueryPageDefaultLimit
Initial value:
= [
'default' => 50,
]

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

Definition at line 8448 of file MainConfigSchema.php.

◆ RateLimits

const MediaWiki\MainConfigSchema::RateLimits

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
]
];
$wgRateLimits
Config variable stub for the RateLimits setting, for use by phpdoc and IDEs.

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 8338 of file MainConfigSchema.php.

◆ RateLimitsExcludedIPs

const MediaWiki\MainConfigSchema::RateLimitsExcludedIPs
Initial value:
= [
'default' => [],
'type' => 'list',
]

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

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

Definition at line 8430 of file MainConfigSchema.php.

◆ RawHtmlMessages

const MediaWiki\MainConfigSchema::RawHtmlMessages
Initial value:
= [
'default' => [
'copyright',
'history_copyright',
'googlesearch',
'feedback-terms',
'feedback-termsofuse',
],
'type' => 'list',
'items' => [ 'type' => 'string', ],
]

List of messages which might contain raw HTML.

Extensions should add their insecure raw HTML messages to extension.json. The list is used for access control: changing messages listed here will require editsitecss and editsitejs rights.

Message names must be given with underscores rather than spaces and with lowercase first letter.

Since
1.32

Definition at line 4866 of file MainConfigSchema.php.

◆ ReauthenticateTime

const MediaWiki\MainConfigSchema::ReauthenticateTime
Initial value:
= [
'default' => [ 'default' => 300, ],
'type' => 'map',
'additionalProperties' => [ 'type' => 'integer', ],
]

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

Definition at line 6971 of file MainConfigSchema.php.

◆ ReferrerPolicy

const MediaWiki\MainConfigSchema::ReferrerPolicy
Initial value:
= [
'default' => false,
'type' => 'list|string|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 766 of file MainConfigSchema.php.

◆ RememberMe

const MediaWiki\MainConfigSchema::RememberMe
Initial value:
= [
'default' => 'choose',
'type' => 'string',
]

Configures RememberMe authentication request added by AuthManager.

It can show a "remember me" checkbox that, when checked, will cause it to take more time for the authenticated session to expire. It can also be configured to always or to never extend the authentication session.

Valid values are listed in RememberMeAuthenticationRequest::ALLOWED_FLAGS.

Since
1.36

Definition at line 6929 of file MainConfigSchema.php.

◆ RemoveCredentialsBlacklist

const MediaWiki\MainConfigSchema::RemoveCredentialsBlacklist
Initial value:
= [
'default' => [
\MediaWiki\Auth\PasswordAuthenticationRequest::class,
],
'type' => 'list',
'items' => [ 'type' => 'string', ],
]

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 7025 of file MainConfigSchema.php.

◆ RemoveGroups

const MediaWiki\MainConfigSchema::RemoveGroups
Initial value:
= [
'default' => [],
'type' => 'map',
]
See also
$wgAddGroups

Definition at line 8113 of file MainConfigSchema.php.

◆ RenderHashAppend

const MediaWiki\MainConfigSchema::RenderHashAppend
Initial value:
= [
'default' => '',
]

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 4229 of file MainConfigSchema.php.

◆ RepositoryBaseUrl

const MediaWiki\MainConfigSchema::RepositoryBaseUrl
Initial value:
= [
'default' => 'https:
]

Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.5

Definition at line 1222 of file MainConfigSchema.php.

◆ RequestTimeLimit

const MediaWiki\MainConfigSchema::RequestTimeLimit
Initial value:
= [
'default' => null,
'type' => '?integer',
]

Set a limit on server request wall clock time.

If the Excimer extension is enabled, setting this will cause an exception to be thrown after the specified number of seconds. If the extension is not available, set_time_limit() will be called instead.

Since
1.36

Definition at line 3470 of file MainConfigSchema.php.

◆ ReservedUsernames

const MediaWiki\MainConfigSchema::ReservedUsernames
Initial value:
= [
'default' => [
'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',
],
'type' => 'list',
]

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

See also
\User::MAINTENANCE_SCRIPT_USER

Definition at line 7225 of file MainConfigSchema.php.

◆ ResourceBasePath

const MediaWiki\MainConfigSchema::ResourceBasePath
Initial value:
= [
'default' => null,
'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
]

The default 'remoteBasePath' value for instances of MediaWiki\ResourceLoader\FileModule.

Defaults to $wgScriptPath.

Definition at line 5736 of file MainConfigSchema.php.

◆ ResourceLoaderDebug

const MediaWiki\MainConfigSchema::ResourceLoaderDebug
Initial value:
= [
'default' => 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 5781 of file MainConfigSchema.php.

◆ ResourceLoaderEnableJSProfiler

const MediaWiki\MainConfigSchema::ResourceLoaderEnableJSProfiler
Initial value:
= [
'default' => false,
]

When enabled, execution of JavaScript modules is profiled client-side.

Instrumentation happens in mw.loader.profiler. Use ‘mw.inspect('time’)` from the browser console to display the data.

Since
1.32

Definition at line 5821 of file MainConfigSchema.php.

◆ ResourceLoaderMaxage

const MediaWiki\MainConfigSchema::ResourceLoaderMaxage
Initial value:
= [
'default' => [],
'type' => 'map',
]

Override how long a CDN or browser may cache a ResourceLoader HTTP response.

Maximum time in seconds. Used for the max-age and s-maxage Cache-Control headers.

Valid keys:

  • versioned
  • unversioned
See also
ResourceLoader::__construct
Since
1.35

Definition at line 5761 of file MainConfigSchema.php.

◆ ResourceLoaderMaxQueryLength

const MediaWiki\MainConfigSchema::ResourceLoaderMaxQueryLength
Initial value:
= [
'default' => false,
'type' => 'integer|false',
]

ResourceLoader will not generate URLs whose query string is more than this many characters long, and will instead use multiple requests with shorter query strings.

Using multiple requests may degrade performance, but may be needed based on the query string limit supported by your web server and/or your user's web browsers.

Default: 2000.

See also
\MediaWiki\ResourceLoader\StartUpModule::getMaxQueryLength
Since
1.17

Definition at line 5797 of file MainConfigSchema.php.

◆ ResourceLoaderSources

const MediaWiki\MainConfigSchema::ResourceLoaderSources
Initial value:
= [
'default' => [],
'type' => 'map',
]

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';
$wgResourceLoaderSources
Config variable stub for the ResourceLoaderSources setting, for use by phpdoc and IDEs.

Definition at line 5726 of file MainConfigSchema.php.

◆ ResourceLoaderStorageEnabled

const MediaWiki\MainConfigSchema::ResourceLoaderStorageEnabled
Initial value:
= [
'default' => true,
]

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

Definition at line 5829 of file MainConfigSchema.php.

◆ ResourceLoaderStorageVersion

const MediaWiki\MainConfigSchema::ResourceLoaderStorageVersion
Initial value:
= [
'default' => 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 5839 of file MainConfigSchema.php.

◆ ResourceLoaderUseObjectCacheForDeps

const MediaWiki\MainConfigSchema::ResourceLoaderUseObjectCacheForDeps
Initial value:
= [
'default' => false,
]

Use the main stash instead of the module_deps table for indirect dependency tracking.

Since
1.35
Warning
EXPERIMENTAL

Definition at line 5772 of file MainConfigSchema.php.

◆ ResourceLoaderValidateJS

const MediaWiki\MainConfigSchema::ResourceLoaderValidateJS
Initial value:
= [
'default' => 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 5809 of file MainConfigSchema.php.

◆ ResourceModules

const MediaWiki\MainConfigSchema::ResourceModules
Initial value:
= [
'default' => [],
'type' => 'map',
]

Define extra client-side modules to be registered with ResourceLoader.

Note
It is recommended to define modules using the ResourceModule attribute in extension.json or skin.json when possible (instead of via PHP global variables).

Registration is internally handled by ResourceLoader::register.

Available modules

Modules that ship with MediaWiki core are registered via resources/Resources.php. For a full list with documentation, see: ResourceLoader/Core_modules.

Options

  • class {string}: By default a module is assumed to bundle file resources as handled by the MediaWiki\ResourceLoader\FileModule class. Use this option to use a different implementation of MediaWiki\ResourceLoader\Module instead.

    Default: \\MediaWiki\\ResourceLoader\\FileModule

  • factory {string}: Override the instantiation of the MediaWiki\ResourceLoader\Module class using a PHP callback. This allows dependency injection to be used. This option cannot be combined with the class option.

    Since: MW 1.30

  • dependencies {string[]|string}: Modules that must be executed before this module. Module name string or list of module name strings.

    Default: []

  • deprecated {boolean|string}: Whether the module is deprecated and usage is discouraged. Set to boolean true, or a string to include in the warning message.

    Default: false

  • group {string}: Optional request group to override which modules may be downloaded together in an HTTP batch request. By default, any two modules may be loaded together in the same batch request. Set this option to a descriptive string to give the module its own HTTP request. To allow other modules to join this new request, give those the same request group.

    Use this option with caution. The default behaviour is well-tuned already, and setting this often does more harm than good. For more about request balancing optimisations, see ResourceLoader/Architecture#Balance.

  • skipFunction {string}: Allow this module to be satisfied as dependency without actually loading or executing scripts from the server, if the specified JavaScript function returns true.

    Use this to provide polyfills that are natively available in newer browsers. Specify the relative path to a JavaScript file containing a top-level return statement. The contents of the file should not contain any wrapping function, it will be wrapped by ResourceLoader in an anonymous function and invoked when the module is considered for loading.

  • targets {string[]} List of ResourceLoader targets where the module may be loaded from. This is used by the MobileFrontend extension to prevent certain modules from being loaded.

    This option is deprecated. See T127268.

    Default: ["desktop"]

FileModule options

  • localBasePath {string}: Base file path to prepend to relative file paths specified in other options.

    Default: $IP

  • remoteBasePath {string}: Base URL path to prepend to relative file paths specified in other options. This is used to form URLs for files, such as when referencing images in stylesheets, or in debug mode to serve JavaScript files directly.

    Default: $wgResourceBasePath (which defaults to $wgScriptPath)

  • remoteExtPath {string}: Shortcut for remoteBasePath that is relative to $wgExtensionAssetsPath. Use this when defining modules from an extension, so as to avoid hardcoding the script path of the MediaWiki install or the location of the extensions directory.

    This option is mutually exclusive with remoteBasePath.

  • styles {string[]|string|array<string,array>}: Styles to always include in the module. File path or list of file paths, relative to localBasePath. The stylesheet can be automatically wrapped in a @media query by specifying the file path as the key in an object (instead of the value), with the value specifying a media query.

    See Stylesheet examples below.

    See also $wgResourceModuleSkinStyles.

    Extended options:

    • skinStyles {string[]|string}: Styles to include in specific skin contexts. Array keyed is by skin name with file path or list of file paths as value, relative to localBasePath.

    Default: []

  • noflip {boolean}: By default, CSSJanus will be used automatically to perform LTR-to-RTL flipping when loaded in a right-to-left (RTL) interface language context. Use this option to skip CSSJanus LTR-to-RTL flipping for this module, for example when registering an external library that already handles RTL styles.

    Default: false

  • packageFiles {string[]|array[]} Specify script files and (virtual) data files to include in the module. Each internal JavaScript file retains its own local module scope and its private exports can be accessed separately by other client-side code in the same module, via the local require() function.

    Modules that use package files should export any public API methods using module.exports.

    See examples at ResourceLoader/Package_files on mediawiki.org.

    The packageFiles feature cannot be combined with legacy scripts that use the scripts option, including its extended variants languageScripts, skinScripts, and debugScripts.

    Since: MW 1.33

    Default: []

  • scripts {string[]|string}: Scripts to always include in the module. File path or list of file paths, relative to localBasePath.

    These files are concatenated blindly and executed as a single client-side script. Modules using this option are sometimes referred to as "legacy scripts" to distinguish them from those that use the packageFiles option.

    Modules that use legacy scripts usually attach any public APIs they have to the mw global variable. If a module contains just one file, it is also supported to use the newer module.exports mechanism, though if the module contains more than one legacy script, it is considered unsafe and unsupported to use this mechanism (use packageFiles instead). See also Coding conventions/JavaScript.

    Default: []

    Extended options, concatenated in this order:

    • languageScripts {string[]|string}: Scripts to include in specific language contexts. Array is keyed by language code with file path or list of file path.
    • skinScripts {string[]|string}: Scripts to include in specific skin contexts. Array keyed is by skin name with file path or list of file paths.
    • debugScripts {string[]|string}: Scripts to include in debug contexts. File path or list of file paths.
  • messages {string[]} Localisation messages to bundle with this module, for client-side use via mw.msg() and mw.message(). List of message keys.

    Default: []

  • templates {string[]} List of template files to be loaded for client-side usage via mw.templates.

    Default: []

  • es6 {boolean}: If true, this module will only be executed in browsers that support ES6. You should set this flag for modules that use ES6 in their JavaScript. Only use this for modules that provide progressive enhancements that are safe to not load in browsers that are not modern but still have a substantial user base, like IE11.

    Since: MW 1.36

    Default: false

Examples

Example: Using an alternate subclass

$wgResourceModules['ext.myExtension'] = [
'class' => \\MediaWiki\\ResourceLoader\\WikiModule::class,
];
$wgResourceModules
Config variable stub for the ResourceModules setting, for use by phpdoc and IDEs.

Example: Deprecated module

$wgResourceModules['ext.myExtension'] = [
'deprecated' => 'You should use ext.myExtension2 instead',
];

Example: Base paths in extension.json

"ext.myExtension": {
"localBasePath": "modules/ext.MyExtension",
"remoteExtPath": "MyExtension/modules/ext.MyExtension"
}

Example: Base paths in core with PHP

$wgResourceModules['mediawiki.example'] = [
'localBasePath' => "$IP/resources/src/mediawiki.example",
'remoteBasePath' => "$wgResourceBasePath/resources/src/mediawiki.example",
];

Example: Define a skip function

$wgResourceModules['ext.myExtension.SomeWebAPI'] = [
'skipFunction' => 'skip-SomeWebAPI.js',
];

Example: Contents of skip function file

return typeof SomeWebAPI === 'function' && SomeWebAPI.prototype.duckMethod;

Example: Module targets

$wgResourceModules['ext.myExtension'] = [
'targets' => [ 'desktop', 'mobile' ],
];

Example: Stylesheets

$wgResourceModules['example'] = [
'styles' => [
'foo.css',
'bar.css',
],
];
$wgResourceModules['example.media'] = [
'styles' => [
'foo.css' => [ 'media' => 'print' ],
];
$wgResourceModules['example.mixed'] = [
'styles' => [
'foo.css',
'bar.css' => [ 'media' => 'print' ],
],
];

Example: Package files

"ext.myExtension": {
"localBasePath": "modules/ext.MyExtension",
"remoteExtPath": "MyExtension/modules/ext.MyExtension",
"packageFiles": [
"index.js",
"utils.js",
"data.json"
]
}
}

Example: Legacy scripts

$wgResourceModules['ext.myExtension'] = [
'scripts' => [
'modules/ext.myExtension/utils.js',
'modules/ext.myExtension/myExtension.js',
],
'languageScripts' => [
'bs' => 'modules/ext.myExtension/languages/bs.js',
'fi' => 'modules/ext.myExtension/languages/fi.js',
],
'skinScripts' => [
'default' => 'modules/ext.myExtension/skin-default.js',
],
'debugScripts' => [
'modules/ext.myExtension/debug.js',
],
];

Example: Template files

$wgResourceModules['ext.myExtension'] = [
'templates' => [
'templates/template.html',
'templates/template2.html',
],
];
Since
1.17

Definition at line 5611 of file MainConfigSchema.php.

◆ ResourceModuleSkinStyles

const MediaWiki\MainConfigSchema::ResourceModuleSkinStyles
Initial value:
= [
'default' => [],
'type' => 'map',
]

Add extra skin-specific styles to a resource module.

These are automatically added by ResourceLoader to the 'skinStyles' list of the existing module. The 'styles' list cannot be modified or disabled.

For example, below a module "bar" is defined and skin Foo provides additional styles for it:

Example:

'scripts' => 'resources/bar/bar.js',
'styles' => 'resources/bar/main.css',
];
'bar' => 'skins/Foo/bar.css',
];
$wgResourceModuleSkinStyles
Config variable stub for the ResourceModuleSkinStyles setting, for use by phpdoc and IDEs.

This is effectively 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 it. 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 effectively 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, always set the localBasePath and remoteBasePath keys (or one of remoteExtPath/remoteSkinPath).

Example:

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

Definition at line 5710 of file MainConfigSchema.php.

◆ ResponsiveImages

const MediaWiki\MainConfigSchema::ResponsiveImages
Initial value:
= [
'default' => 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.

Definition at line 2428 of file MainConfigSchema.php.

◆ RestAllowCrossOriginCookieAuth

const MediaWiki\MainConfigSchema::RestAllowCrossOriginCookieAuth
Initial value:
= [
'default' => false,
'type' => 'boolean',
]

Allows authenticated cross-origin requests to the REST API with session cookies.

With this option enabled, any orgin specified in $wgCrossSiteAJAXdomains may send session cookies for authorization in the REST API.

There is a performance impact by enabling this option. Therefore, it should be left disabled for most wikis and clients should instead use OAuth to make cross-origin authenticated requests.

See also
https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Access-Control-Allow-Credentials
Since
1.36

Definition at line 8920 of file MainConfigSchema.php.

◆ RestPath

const MediaWiki\MainConfigSchema::RestPath
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
]

The URL path to the REST API Defaults to "{$wgScriptPath}/rest.php".

Since
1.34

Definition at line 403 of file MainConfigSchema.php.

◆ RestrictionLevels

const MediaWiki\MainConfigSchema::RestrictionLevels
Initial value:
= [
'default' => [ '', 'autoconfirmed', 'sysop' ],
'type' => 'list',
]

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 7871 of file MainConfigSchema.php.

◆ RestrictionTypes

const MediaWiki\MainConfigSchema::RestrictionTypes
Initial value:
= [
'default' => [ 'create', 'edit', 'move', 'upload' ],
'type' => 'list',
]

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 7855 of file MainConfigSchema.php.

◆ RevisionCacheExpiry

const MediaWiki\MainConfigSchema::RevisionCacheExpiry
Initial value:
= [
'default' => 86400 * 7,
'type' => 'integer',
]

Revision text may be cached in the main WAN cache 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 3414 of file MainConfigSchema.php.

◆ RevokePermissions

const MediaWiki\MainConfigSchema::RevokePermissions
Initial value:
= [
'default' => [],
'type' => 'map',
'mergeStrategy' => 'array_plus_2d',
]

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 7771 of file MainConfigSchema.php.

◆ Script

const MediaWiki\MainConfigSchema::Script
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
]

The URL path to index.php.

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

Definition at line 364 of file MainConfigSchema.php.

◆ ScriptPath

const MediaWiki\MainConfigSchema::ScriptPath
Initial value:
= [
'default' => '/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 324 of file MainConfigSchema.php.

◆ SearchType

const MediaWiki\MainConfigSchema::SearchType
Initial value:
= [
'default' => 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.

If the canonical name for the search engine doesn't match the class name (because it's namespaced for example), you can add a mapping for this in SearchMappings in extension.json.

Definition at line 2904 of file MainConfigSchema.php.

◆ SearchTypeAlternatives

const MediaWiki\MainConfigSchema::SearchTypeAlternatives
Initial value:
= [
'default' => 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.

If the canonical name for the search engine doesn't match the class name (because it's namespaced for example), you can add a mapping for this in SearchMappings in extension.json.

Definition at line 2920 of file MainConfigSchema.php.

◆ SecretKey

const MediaWiki\MainConfigSchema::SecretKey
Initial value:
= [
'default' => false,
]

This should always be customised in LocalSettings.php.

Definition at line 8751 of file MainConfigSchema.php.

◆ SecureLogin

const MediaWiki\MainConfigSchema::SecureLogin
Initial value:
= [
'default' => false,
]

This is to let user authenticate using https when they come from http.

Based on an idea by George Herbert on wikitech-l: https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html

Since
1.17

Definition at line 7360 of file MainConfigSchema.php.

◆ SemiprotectedRestrictionLevels

const MediaWiki\MainConfigSchema::SemiprotectedRestrictionLevels
Initial value:
= [
'default' => [ 'autoconfirmed', ],
'type' => 'list',
]

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 7902 of file MainConfigSchema.php.

◆ Send404Code

const MediaWiki\MainConfigSchema::Send404Code
Initial value:
= [
'default' => 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 5243 of file MainConfigSchema.php.

◆ Server

const MediaWiki\MainConfigSchema::Server
Initial value:
= [
'default' => false,
]

URL of the server.

Example:

$wgServer = 'http://example.com';
$wgServer
Config variable stub for the Server setting, for use by phpdoc and IDEs.
Definition: config-vars.php:25

This must be set in LocalSettings.php. The MediaWiki installer does this automatically since 1.18.

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 240 of file MainConfigSchema.php.

◆ ServerName

const MediaWiki\MainConfigSchema::ServerName
Initial value:
= [
'default' => 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 263 of file MainConfigSchema.php.

◆ SessionCacheType

const MediaWiki\MainConfigSchema::SessionCacheType
Initial value:
= [
'default' => CACHE_ANYTHING,
]

The cache backend for storing session data.

Used by MediaWiki\Session\SessionManager. See $wgMainCacheType for available types.

See SessionManager Storage expectations.

Definition at line 3739 of file MainConfigSchema.php.

◆ SessionInsecureSecrets

const MediaWiki\MainConfigSchema::SessionInsecureSecrets
Initial value:
= [
'default' => false,
]

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

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

Since
1.27

Definition at line 8945 of file MainConfigSchema.php.

◆ SessionPbkdf2Iterations

const MediaWiki\MainConfigSchema::SessionPbkdf2Iterations
Initial value:
= [
'default' => 10001,
]

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

Since
1.28

Definition at line 4081 of file MainConfigSchema.php.

◆ SessionProviders

const MediaWiki\MainConfigSchema::SessionProviders
Initial value:
= [
'type' => 'map',
'default' => [
\MediaWiki\Session\CookieSessionProvider::class => [
'class' => \MediaWiki\Session\CookieSessionProvider::class,
'args' => [ [
'priority' => 30,
] ],
],
\MediaWiki\Session\BotPasswordSessionProvider::class => [
'class' => \MediaWiki\Session\BotPasswordSessionProvider::class,
'args' => [ [
'priority' => 75,
] ],
'services' => [
'GrantsInfo'
],
],
],
]

MediaWiki\Session\SessionProvider configuration.

Values are ObjectFactory specifications for the SessionProviders to be used. Keys in the array are ignored; the class name is conventionally used as the key to avoid collisions. Order is not significant.

Since
1.27

Definition at line 7387 of file MainConfigSchema.php.

◆ SessionSecret

const MediaWiki\MainConfigSchema::SessionSecret
Initial value:
= [
'default' => false,
]

Secret for session storage.

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

Since
1.27

Definition at line 8933 of file MainConfigSchema.php.

◆ SharedDB

const MediaWiki\MainConfigSchema::SharedDB
Initial value:
= [
'default' => null,
'deprecated' => 'since 1.21 In new code, use the $wiki parameter to ' .
'LBFactory::getMainLB() to access remote databases. Using LBFactory::getMainLB() ' .
'allows the shared database to reside on separate servers to the wiki\'s own ' .
'database, with suitable configuration of $wgLBFactoryConf',
]

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 LBFactory::getMainLB() to access remote databases. Using LBFactory::getMainLB() allows the shared database to reside on separate servers to the wiki's own database, with suitable configuration of $wgLBFactoryConf.

Definition at line 2985 of file MainConfigSchema.php.

◆ SharedPrefix

const MediaWiki\MainConfigSchema::SharedPrefix
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'DBprefix' ] ]
]
See also
$wgSharedDB

Definition at line 2996 of file MainConfigSchema.php.

◆ SharedSchema

const MediaWiki\MainConfigSchema::SharedSchema
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'DBmwschema' ] ]
]
See also
$wgSharedDB
Since
1.23

Definition at line 3026 of file MainConfigSchema.php.

◆ SharedTables

const MediaWiki\MainConfigSchema::SharedTables
Initial value:
= [
'default' => [
'user',
'user_properties',
'user_autocreate_serial',
],
'type' => 'list',
]
See also
$wgSharedDB The installer will add 'actor' to this list for all new wikis.

Definition at line 3013 of file MainConfigSchema.php.

◆ SharedThumbnailScriptPath

const MediaWiki\MainConfigSchema::SharedThumbnailScriptPath
Initial value:
= [
'default' => false,
'type' => 'string|false',
]

Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.3

Definition at line 1571 of file MainConfigSchema.php.

◆ SharedUploadDBname

const MediaWiki\MainConfigSchema::SharedUploadDBname
Initial value:
= [
'default' => false,
'type' => 'false|string',
]

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

Set this to false if the uploads do not come from a wiki. Only used if $wgUseSharedUploads is enabled.

Since
1.4

Definition at line 1246 of file MainConfigSchema.php.

◆ SharedUploadDBprefix

const MediaWiki\MainConfigSchema::SharedUploadDBprefix
Initial value:
= [
'default' => '',
'type' => 'string',
]

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

Only used if $wgUseSharedUploads is enabled.

Since
1.5

Definition at line 1258 of file MainConfigSchema.php.

◆ SharedUploadDirectory

const MediaWiki\MainConfigSchema::SharedUploadDirectory
Initial value:
= [
'default' => null,
'type' => '?string',
]

Shortcut for the 'directory' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.3

Definition at line 1186 of file MainConfigSchema.php.

◆ SharedUploadPath

const MediaWiki\MainConfigSchema::SharedUploadPath
Initial value:
= [
'default' => null,
'type' => '?string',
]

Shortcut for the 'url' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since
1.3

Definition at line 1198 of file MainConfigSchema.php.

◆ SharpenParameter

const MediaWiki\MainConfigSchema::SharpenParameter
Initial value:
= [
'default' => '0x0.4',
]

Sharpening parameter to ImageMagick.

Definition at line 1792 of file MainConfigSchema.php.

◆ SharpenReductionThreshold

const MediaWiki\MainConfigSchema::SharpenReductionThreshold
Initial value:
= [
'default' => 0.85,
]

Reduction in linear dimensions below which sharpening will be enabled.

Definition at line 1799 of file MainConfigSchema.php.

◆ ShowArchiveThumbnails

const MediaWiki\MainConfigSchema::ShowArchiveThumbnails
Initial value:
= [
'default' => true,
]

Show thumbnails for old images on the image description page.

Definition at line 2073 of file MainConfigSchema.php.

◆ ShowEXIF

const MediaWiki\MainConfigSchema::ShowEXIF
Initial value:
= [
'dynamicDefault' => [ 'callback' => [ self::class, 'getDefaultShowEXIF' ] ],
]

Whether to show Exif data.

The effective default value is determined at runtime: enabled if PHP's EXIF extension module is loaded.

Requires PHP's Exif extension: https://www.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 1402 of file MainConfigSchema.php.

◆ ShowRollbackEditCount

const MediaWiki\MainConfigSchema::ShowRollbackEditCount
Initial value:
= [
'default' => 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 5257 of file MainConfigSchema.php.

◆ SidebarCacheExpiry

const MediaWiki\MainConfigSchema::SidebarCacheExpiry
Initial value:
= [
'default' => 86400,
]

Expiry time for the sidebar cache, in seconds.

Definition at line 4249 of file MainConfigSchema.php.

◆ SignatureAllowedLintErrors

const MediaWiki\MainConfigSchema::SignatureAllowedLintErrors
Initial value:
= [
'default' => [ 'obsolete-tag', ],
'type' => 'list',
]

List of lint error codes which don't cause signature validation to fail.

See also
https://www.mediawiki.org/wiki/Help:Lint_errors
Since
1.35

Definition at line 7206 of file MainConfigSchema.php.

◆ SignatureValidation

const MediaWiki\MainConfigSchema::SignatureValidation
Initial value:
= [
'default' => 'warning',
]

Behavior of signature validation.

Allowed values are:

  • 'warning' - invalid signatures cause a warning to be displayed on the preferences page, but they are still used when signing comments; new invalid signatures can still be saved as normal
  • 'new' - existing invalid signatures behave as above; new invalid signatures can't be saved
  • 'disallow' - existing invalid signatures are no longer used when signing comments; new invalid signatures can't be saved
Since
1.35

Definition at line 7196 of file MainConfigSchema.php.

◆ Sitename

const MediaWiki\MainConfigSchema::Sitename
Initial value:
= [
'default' => 'MediaWiki',
]

Name of the site.

It must be changed in LocalSettings.php

Definition at line 210 of file MainConfigSchema.php.

◆ SiteNotice

const MediaWiki\MainConfigSchema::SiteNotice
Initial value:
= [
'default' => '',
]

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 5045 of file MainConfigSchema.php.

◆ SkinMetaTags

const MediaWiki\MainConfigSchema::SkinMetaTags
Initial value:
= [
'default' => [],
'type' => 'map',
]

An array of open graph tags which should be added by all skins.

Accepted values are "og:title", "og:type" and "twitter:card". Since some of these fields can be provided by extensions it defaults to an empty array.

Since
1.36

Definition at line 5074 of file MainConfigSchema.php.

◆ SkipSkins

const MediaWiki\MainConfigSchema::SkipSkins
Initial value:
= [
'default' => [],
'type' => 'map',
]

Specify the names of skins that should not be presented in the list of available skins in user preferences.

NOTE: This does not uninstall the skin, and it will still be accessible via the useskin query parameter. To uninstall a skin, remove its inclusion from LocalSettings.php.

See also
\SkinFactory::getAllowedSkins

Definition at line 5106 of file MainConfigSchema.php.

◆ SMTP

const MediaWiki\MainConfigSchema::SMTP
Initial value:
= [
'default' => false,
'type' => 'false|map',
]

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],
];
$wgSMTP
Config variable stub for the SMTP setting, for use by phpdoc and IDEs.

Definition at line 2647 of file MainConfigSchema.php.

◆ SoftBlockRanges

const MediaWiki\MainConfigSchema::SoftBlockRanges
Initial value:
= [
'default' => [],
'type' => 'list',
'items' => [ 'type' => 'string', ],
]

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 8282 of file MainConfigSchema.php.

◆ SpamRegex

const MediaWiki\MainConfigSchema::SpamRegex
Initial value:
= [
'default' => [],
'type' => 'list',
]

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 8201 of file MainConfigSchema.php.

◆ SQLiteDataDir

const MediaWiki\MainConfigSchema::SQLiteDataDir
Initial value:
= [
'default' => '',
]

To override default SQLite data directory ($docroot/../data)

Definition at line 2956 of file MainConfigSchema.php.

◆ SQLMode

const MediaWiki\MainConfigSchema::SQLMode
Initial value:
= [
'default' => '',
]

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 2938 of file MainConfigSchema.php.

◆ SquidPurgeUseHostHeader

const MediaWiki\MainConfigSchema::SquidPurgeUseHostHeader
Initial value:
= [
'default' => true,
'deprecated' => 'since 1.33',
]

Whether to use a Host header in purge requests sent to the proxy servers configured in $wgCdnServers.

Set this to false to support a CDN 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
Deprecated:
since 1.33, will always be true in a future release.

Definition at line 4475 of file MainConfigSchema.php.

◆ StatsCacheType

const MediaWiki\MainConfigSchema::StatsCacheType
Initial value:
= [
'default' => CACHE_ANYTHING,
]

The object cache type for stats storage.

\\Wikimedia\\WRStats\\WRStatsFactory

Definition at line 3759 of file MainConfigSchema.php.

◆ StrictFileExtensions

const MediaWiki\MainConfigSchema::StrictFileExtensions
Initial value:
= [
'default' => 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 1662 of file MainConfigSchema.php.

◆ StyleDirectory

const MediaWiki\MainConfigSchema::StyleDirectory
Initial value:
= [
'default' => null,
'type' => '?string',
]

Skins directory in the file system.

Note
Set to "{$IP}/skins" by Setup.php before loading local settings.
this configuration variable is used to locate skins while loading settings.
Since
1.3

Definition at line 496 of file MainConfigSchema.php.

◆ StylePath

const MediaWiki\MainConfigSchema::StylePath
Initial value:
= [
'default' => false,
'dynamicDefault' => [ 'use' => [ 'ResourceBasePath' ] ]
]

The URL path of the skins directory.

Defaults to "{$wgResourceBasePath}/skins".

Since
1.3

Definition at line 423 of file MainConfigSchema.php.

◆ SummarySpamRegex

const MediaWiki\MainConfigSchema::SummarySpamRegex
Initial value:
= [
'default' => [],
'type' => 'list',
]

Same as SpamRegex except for edit summaries.

Definition at line 8209 of file MainConfigSchema.php.

◆ SuspiciousIpExpiry

const MediaWiki\MainConfigSchema::SuspiciousIpExpiry
Initial value:
= [
'default' => false,
'type' => 'integer|false',
]

Time in seconds to remember IPs for, for the purposes of logging IP changes within the same session.

This is meant more for debugging errors in the authentication system than for detecting abuse.

Since
1.36

Definition at line 4071 of file MainConfigSchema.php.

◆ SVGConverter

const MediaWiki\MainConfigSchema::SVGConverter
Initial value:
= [
'default' => 'ImageMagick',
]

Pick a converter defined in $wgSVGConverters.

Definition at line 1913 of file MainConfigSchema.php.

◆ SVGConverterPath

const MediaWiki\MainConfigSchema::SVGConverterPath
Initial value:
= [
'default' => '',
]

If not in the executable PATH, specify the SVG converter path.

Definition at line 1920 of file MainConfigSchema.php.

◆ SVGConverters

const MediaWiki\MainConfigSchema::SVGConverters
Initial value:
= [
'default' => [
'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', ],
],
'type' => 'map',
]

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 1897 of file MainConfigSchema.php.

◆ SVGMaxSize

const MediaWiki\MainConfigSchema::SVGMaxSize
Initial value:
= [
'default' => 5120,
]

Don't scale a SVG larger than this.

Definition at line 1927 of file MainConfigSchema.php.

◆ SVGMetadataCutoff

const MediaWiki\MainConfigSchema::SVGMetadataCutoff
Initial value:
= [
'default' => 262144,
]

Don't read SVG metadata beyond this point.

Default is 1024*256 bytes

Definition at line 1936 of file MainConfigSchema.php.

◆ TemplateLinksSchemaMigrationStage

const MediaWiki\MainConfigSchema::TemplateLinksSchemaMigrationStage
Initial value:
= [
'type' => 'integer',
]
const SCHEMA_COMPAT_READ_NEW
Definition: Defines.php:270
const SCHEMA_COMPAT_WRITE_NEW
Definition: Defines.php:269

Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields.

Use the SCHEMA_COMPAT_XXX flags. Supported values:

  • SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD
  • SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_NEW
  • SCHEMA_COMPAT_NEW

History:

  • 1.38: Added
  • 1.39: Default has changed to SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD and support for SCHEMA_COMPAT_OLD is dropped.

Definition at line 3233 of file MainConfigSchema.php.

◆ TextModelsToParse

const MediaWiki\MainConfigSchema::TextModelsToParse
Initial value:
= [
'default' => [
],
'type' => 'list',
]

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.

Note that table of contents information will be suppressed for all text models in this list other than wikitext.

Todo:
Make the ToC suppression configurable by the content model (T313455), not a side effect of inclusion here.
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 3334 of file MainConfigSchema.php.

◆ ThumbLimits

const MediaWiki\MainConfigSchema::ThumbLimits
Initial value:
= [
'default' => [
120,
150,
180,
200,
250,
300
],
'type' => 'list',
]

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 2269 of file MainConfigSchema.php.

◆ ThumbnailBuckets

const MediaWiki\MainConfigSchema::ThumbnailBuckets
Initial value:
= [
'default' => null,
'type' => '?list',
]

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 2302 of file MainConfigSchema.php.

◆ ThumbnailEpoch

const MediaWiki\MainConfigSchema::ThumbnailEpoch
Initial value:
= [
'default' => '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 2015 of file MainConfigSchema.php.

◆ ThumbnailMinimumBucketDistance

const MediaWiki\MainConfigSchema::ThumbnailMinimumBucketDistance
Initial value:
= [
'default' => 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 2322 of file MainConfigSchema.php.

◆ ThumbnailNamespaces

const MediaWiki\MainConfigSchema::ThumbnailNamespaces
Initial value:
= [
'default' => [ NS_FILE ],
'type' => 'list',
'items' => [ 'type' => 'integer', ],
]
const NS_FILE
Definition: Defines.php:70

Defines what namespaces thumbnails will be displayed for in Special:Search.

This is the list of namespaces for which thumbnails (or a placeholder in the absence of a thumbnail) will be shown:

Definition at line 2286 of file MainConfigSchema.php.

◆ ThumbnailScriptPath

const MediaWiki\MainConfigSchema::ThumbnailScriptPath
Initial value:
= [
'default' => 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";
$wgThumbnailScriptPath
Config variable stub for the ThumbnailScriptPath setting, for use by phpdoc and IDEs.

Definition at line 1560 of file MainConfigSchema.php.

◆ ThumbPath

const MediaWiki\MainConfigSchema::ThumbPath
Initial value:
= [
'default' => false,
]

The base path for thumb_handler.php.

This is used to interpret the request URL for requests to thumb_handler.php that do not match the base upload path.

Since
1.36

Definition at line 578 of file MainConfigSchema.php.

◆ ThumbUpright

const MediaWiki\MainConfigSchema::ThumbUpright
Initial value:
= [
'default' => 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 2411 of file MainConfigSchema.php.

◆ TiffThumbnailType

const MediaWiki\MainConfigSchema::TiffThumbnailType
Initial value:
= [
'default' => [],
'type' => 'list',
'mergeStrategy' => 'replace',
]

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' ];
$wgTiffThumbnailType
Config variable stub for the TiffThumbnailType setting, for use by phpdoc and IDEs.

Definition at line 2002 of file MainConfigSchema.php.

◆ TmpDirectory

const MediaWiki\MainConfigSchema::TmpDirectory
Initial value:
= [
'default' => false,
]

The local filesystem path to a temporary directory.

This must not be web accessible.

When this setting is set to false, its value will automatically be decided through the first call to wfTempDir(). See that method's implementation for the actual detection logic.

To find the temporary path for the current wiki, developers must not use this variable directly. Use the global function wfTempDir() instead.

The temporary directory is expected to be shared with other applications, including other MediaWiki instances (which might not run the same version or configution). When storing files here, take care to avoid conflicts with other instances of MediaWiki. For example, when caching the result of a computation, the file name should incorporate the input of the computation so that it cannot be confused for the result of a similar computation by another MediaWiki instance.

See also
\wfTempDir()
Note
Default changed to false in MediaWiki 1.20.

Definition at line 792 of file MainConfigSchema.php.

◆ TransactionalTimeLimit

const MediaWiki\MainConfigSchema::TransactionalTimeLimit
Initial value:
= [
'default' => 120,
]

The request time limit for "slow" write requests that should not be interrupted due to the risk of data corruption.

The limit will only be raised. If the pre-existing time limit is larger, then this will have no effect.

Since
1.26

Definition at line 3484 of file MainConfigSchema.php.

◆ TranslateNumerals

const MediaWiki\MainConfigSchema::TranslateNumerals
Initial value:
= [
'default' => true,
]

For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface.

Definition at line 4733 of file MainConfigSchema.php.

◆ TrivialMimeDetection

const MediaWiki\MainConfigSchema::TrivialMimeDetection
Initial value:
= [
'default' => 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 2222 of file MainConfigSchema.php.

◆ TrustedMediaFormats

const MediaWiki\MainConfigSchema::TrustedMediaFormats
Initial value:
= [
'default' => [
"image/svg+xml",
"application/pdf",
# "application/x-shockwave-flash",
],
'type' => 'list',
]
const MEDIATYPE_VIDEO
Definition: defines.php:35
const MEDIATYPE_AUDIO
Definition: defines.php:32
const MEDIATYPE_BITMAP
Definition: defines.php:28

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 1694 of file MainConfigSchema.php.

◆ UpdateCompatibleMetadata

const MediaWiki\MainConfigSchema::UpdateCompatibleMetadata
Initial value:
= [
'default' => false,
]

Shortcut for the 'updateCompatibleMetadata' setting of $wgLocalFileRepo.

Definition at line 1416 of file MainConfigSchema.php.

◆ UploadBaseUrl

const MediaWiki\MainConfigSchema::UploadBaseUrl
Initial value:
= [
'default' => '',
]

If set, this URL is added to the start of $wgUploadPath to form a complete upload URL.

Since
1.4

Definition at line 802 of file MainConfigSchema.php.

◆ UploadDialog

const MediaWiki\MainConfigSchema::UploadDialog
Initial value:
= [
'default' =>
[
'fields' =>
[
'description' => true,
'date' => false,
'categories' => false,
],
'licensemessages' =>
[
'local' => 'generic-local',