MediaWiki REL1_39
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.
 
static listDefaultValues (string $prefix='')
 Returns a generator for iterating over all config settings and their default values.
 

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.
 
const Sitename
 Name of the site.
 
DJVU settings
const DjvuDump
 Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';.
 
const DjvuRenderer
 Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';.
 
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';.
 
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.
 
const DjvuOutputExtension
 File extension for the DJVU post processor output.
 
Email settings
const EmergencyContact
 Site admin email address.
 
const PasswordSender
 Sender email address for e-mail notifications.
 
const NoReplyAddress
 Reply-To address for e-mail notifications.
 
const EnableEmail
 Set to true to enable the e-mail basic features: Password reminders, etc.
 
const EnableUserEmail
 Set to true to enable user-to-user e-mail.
 
const EnableSpecialMute
 Set to true to enable the Special Mute page.
 
const EnableUserEmailMuteList
 Set to true to enable user-to-user e-mail mutelist.
 
const UserEmailUseReplyTo
 If true put the sending user's email in a Reply-To header instead of From (false).
 
const PasswordReminderResendTime
 Minimum time, in hours, which must elapse between password reminder emails for a given account.
 
const NewPasswordExpiry
 The time, in seconds, when an emailed temporary password expires.
 
const UserEmailConfirmationTokenExpiry
 The time, in seconds, when an email confirmation email expires.
 
const PasswordExpirationDays
 The number of days that a user's password is good for.
 
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.
 
const SMTP
 SMTP Mode.
 
const AdditionalMailParams
 Additional email parameters, will be passed as the last argument to mail() call.
 
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.
 
const EnotifFromEditor
 Allow sending of e-mail notifications with the editor's address as sender.
 
const EmailAuthentication
 Require email authentication before sending mail to an email address.
 
const EnotifWatchlist
 Allow users to enable email notification ("enotif") on watchlist changes.
 
const EnotifUserTalk
 Allow users to enable email notification ("enotif") when someone edits their user talk page.
 
const EnotifRevealEditorAddress
 Allow sending of e-mail notifications with the editor's address in "Reply-To".
 
const EnotifMinorEdits
 Potentially send notification mails on minor edits to pages.
 
const EnotifImpersonal
 Send a generic mail instead of a personalised mail for each user.
 
const EnotifMaxRecips
 Maximum number of users to mail at once when using impersonal mail.
 
const EnotifUseRealName
 Use real name instead of username in e-mail "from" field.
 
const UsersNotifiedOnAllChanges
 Array of usernames who will be sent a notification email for every change which occurs on a wiki.
 
Content handlers and storage
const ContentHandlers
 Plugins for page content model handling.
 
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).
 
const ContentHandlerTextFallback
 How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText():
 
const TextModelsToParse
 Determines which types of text are parsed as wikitext.
 
const CompressRevisions
 We can also compress text stored in the 'text' table.
 
const ExternalStores
 List of enabled ExternalStore protocols.
 
const ExternalServers
 Shortcut for setting $wgLBFactoryConf["externalClusters"].
 
const DefaultExternalStore
 The place to put new text blobs or false to put them in the text table of the local wiki database.
 
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.
 
const PageLanguageUseDB
 Enable page language feature Allows setting page language in database.
 
const DiffEngine
 Specify the difference engine to use.
 
const ExternalDiffEngine
 Name of the external diff engine to use.
 
Performance hacks and limits
const RequestTimeLimit
 Set a limit on server request wall clock time.
 
const TransactionalTimeLimit
 The request time limit for "slow" write requests that should not be interrupted due to the risk of data corruption.
 
const CriticalSectionTimeLimit
 The maximum time critical sections are allowed to stay open.
 
const MiserMode
 Disable database-intensive features.
 
const DisableQueryPages
 Disable all query pages if miser mode is on, not just some.
 
const QueryCacheLimit
 Number of rows to cache in 'querycache' table when miser mode is on.
 
const WantedPagesThreshold
 Number of links to a page required before it is deemed "wanted".
 
const AllowSlowParserFunctions
 Enable slow parser functions.
 
const AllowSchemaUpdates
 Allow schema updates.
 
const MaxArticleSize
 Maximum article size in kibibytes.
 
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.
 
const PoolCounterConf
 Configuration for processing pool control, for use in high-traffic wikis.
 
const MaxUserDBWriteDuration
 Max time (in seconds) a user-generated transaction can spend in writes.
 
const MaxJobDBWriteDuration
 Max time (in seconds) a job-generated transaction can spend in writes.
 
const LinkHolderBatchSize
 LinkHolderArray batch size For debugging.
 
const MaximumMovedPages
 Maximum number of pages to move at once when moving subpages with a page.
 
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.
 
const MultiShardSiteStats
 Whether site_stats table should have multiple rows.
 
Cache settings
const CacheDirectory
 Directory for caching data in the local filesystem.
 
const MainCacheType
 Main cache type.
 
const MessageCacheType
 The cache type for storing the contents of the MediaWiki namespace.
 
const ParserCacheType
 The cache type for storing article HTML.
 
const SessionCacheType
 The cache backend for storing session data.
 
const LanguageConverterCacheType
 The cache type for storing language conversion tables, which are used when parsing certain text and interface messages.
 
const StatsCacheType
 The object cache type for stats storage.
 
const ObjectCaches
 Advanced object cache configuration.
 
const MainWANCache
 Main Wide-Area-Network cache type.
 
const WANObjectCaches
 Advanced WAN object cache configuration.
 
const EnableWANCacheReaper
 Verify and enforce WAN cache purges using reliable DB sources as streams.
 
const MainStash
 The object store type of the main stash.
 
const ParsoidCacheConfig
 Configuration for the caching related to parsoid output.
 
const ChronologyProtectorStash
 The object store type for the ChronologyProtector store.
 
const ParserCacheExpireTime
 The expiry time for the parser cache, in seconds.
 
const OldRevisionParserCacheExpireTime
 The expiry time for the parser cache for old revisions, in seconds.
 
const ObjectCacheSessionExpiry
 The expiry time to use for session storage, in seconds.
 
const PHPSessionHandling
 Whether to use PHP session handling ($_SESSION and session_*() functions)
 
const SuspiciousIpExpiry
 Time in seconds to remember IPs for, for the purposes of logging IP changes within the same session.
 
const SessionPbkdf2Iterations
 Number of internal PBKDF2 iterations to use when deriving session secrets.
 
const MemCachedServers
 The list of MemCached servers and port numbers.
 
const MemCachedPersistent
 Use persistent connections to MemCached, which are shared across multiple requests.
 
const MemCachedTimeout
 Read/write timeout for MemCached server communication, in microseconds.
 
const UseLocalMessageCache
 Set this to true to maintain a copy of the message cache on the local server.
 
const AdaptiveMessageCache
 Instead of caching everything, only cache those messages which have been customised in the site content language.
 
const LocalisationCacheConf
 Localisation cache configuration.
 
const CachePages
 Allow client-side caching of pages.
 
const CacheEpoch
 Set this to current time to invalidate all prior cached pages.
 
const GitInfoCacheDirectory
 Directory where GitInfo will look for pre-computed cache files.
 
const UseFileCache
 This will cache static pages for non-logged-in users to reduce database traffic on public sites.
 
const FileCacheDepth
 Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory.
 
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.
 
const EnableSidebarCache
 If on, the sidebar navigation links are cached for users with the current language set.
 
const SidebarCacheExpiry
 Expiry time for the sidebar cache, in seconds.
 
const UseGzip
 When using the file cache, we can store the cached HTML gzipped to save disk space.
 
const InvalidateCacheOnLocalSettingsChange
 Invalidate various caches when LocalSettings.php changes.
 
const ExtensionInfoMTime
 When loading extensions through the extension registration system, this can be used to invalidate the cache.
 
const EnableRemoteBagOStuffTests
 If this is set to true, phpunit will run integration tests against remote caches defined in $wgObjectCaches.
 
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.
 
const VaryOnXFP
 Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds.
 
const InternalServer
 Internal server name as known to CDN, if different.
 
const CdnMaxAge
 Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI).
 
const CdnMaxageLagged
 Cache timeout for the CDN when DB replica DB lag is high.
 
const CdnMaxageStale
 Cache timeout when delivering a stale ParserCache response due to PoolCounter contention.
 
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.
 
const CdnMaxageSubstitute
 Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
 
const ForcedRawSMaxage
 Default maximum age for raw CSS/JS accesses.
 
const CdnServers
 List of proxy servers to purge on changes; default port is 80.
 
const CdnServersNoPurge
 As with $wgCdnServers, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc.
 
const SquidPurgeUseHostHeader
 Whether to use a Host header in purge requests sent to the proxy servers configured in $wgCdnServers.
 
const HTCPRouting
 Routing configuration for HTCP multicast purging.
 
const HTCPMulticastTTL
 HTCP multicast TTL.
 
const UsePrivateIPs
 Should forwarded Private IPs be accepted?
 
const CdnMatchParameterOrder
 Set this to false if MediaWiki is behind a CDN that re-orders query parameters on incoming requests.
 
Output format and skin settings
const MimeType
 The default Content-Type header.
 
const Html5Version
 Defines the value of the version attribute in the <html> tag, if any.
 
const HTMLFormAllowTableFormat
 Temporary variable that allows HTMLForms to be rendered as tables.
 
const UseMediaWikiUIEverywhere
 Temporary variable that applies MediaWiki UI wherever it can be supported.
 
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".
 
const XhtmlNamespaces
 Permit other namespaces in addition to the w3.org default.
 
const SiteNotice
 Site notice shown at the top of each page.
 
const BrowserFormatDetection
 Override ability of certains browsers to attempt to autodetect dataformats in pages.
 
const SkinMetaTags
 An array of open graph tags which should be added by all skins.
 
const DefaultSkin
 Default skin, for new users and anonymous visitors.
 
const FallbackSkin
 Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
 
const SkipSkins
 Specify the names of skins that should not be presented in the list of available skins in user preferences.
 
const DisableOutputCompression
 Disable output compression (enabled by default if zlib is available)
 
const FragmentMode
 How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of:
 
const ExternalInterwikiFragmentMode
 Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragmentMode above for details of each mode.
 
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.
 
const UseCombinedLoginLink
 Login / create account link behavior when it's possible for anonymous users to create an account.
 
const Edititis
 Display user edit counts in various prominent places.
 
const Send404Code
 Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output.
 
const ShowRollbackEditCount
 The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
 
const EnableCanonicalServerLink
 Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e.
 
Interwiki links and sites
const LocalInterwikis
 Array for local interwiki values, for each of the interwiki prefixes that point to the current wiki.
 
const InterwikiExpiry
 Expiry time for cache of interwiki table.
 
const InterwikiCache
 Interwiki cache, either as an associative array or a path to a constant database (.cdb) file.
 
const InterwikiScopes
 Specify number of domains to check for messages.
 
const InterwikiFallbackSite
 Fallback site, if unable to resolve from cache.
 
const RedirectSources
 If local interwikis are set up which allow redirects, set this regexp to restrict URLs which will be displayed as 'redirected from' links.
 
const SiteTypes
 Register handlers for specific types of sites.
 
Parser settings

These settings configure the transformation from wikitext to HTML.

const MaxTocLevel
 Maximum indent level of toc.
 
const MaxPPNodeCount
 A complexity limit on template expansion: the maximum number of nodes visited by PPFrame::expand()
 
const MaxTemplateDepth
 Maximum recursion depth for templates within templates.
 
const MaxPPExpandDepth
 
const UrlProtocols
 URL schemes that should be recognized as valid by wfParseUrl().
 
const CleanSignatures
 If true, removes (by substituting) templates in signatures.
 
const AllowExternalImages
 Whether to allow inline image pointing to other websites.
 
const AllowExternalImagesFrom
 If the above is false, you can specify an exception here.
 
const EnableImageWhitelist
 If $wgAllowExternalImages is false, you can allow an on-wiki allow list of regular expression fragments to match the image URL against.
 
const AllowImageTag
 A different approach to the above: simply allow the "<img>" tag to be used.
 
const TidyConfig
 Configuration for HTML postprocessing tool.
 
const ParsoidSettings
 Default Parsoid configuration.
 
const ParserEnableLegacyMediaDOM
 Enable legacy media HTML structure in the output from the Parser.
 
const UseContentMediaStyles
 Temporary flag to ship the styles for the media HTML structure that replaces legacy, when $wgParserEnableLegacyMediaDOM is false.
 
const RawHtml
 Allow raw, unchecked HTML in "<html>...</html>" sections.
 
const ExternalLinkTarget
 Set a default target for external links, e.g.
 
const NoFollowLinks
 If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to search engines that they should not be followed for ranking purposes as they are user-supplied and thus subject to spamming.
 
const NoFollowNsExceptions
 Namespaces in which $wgNoFollowLinks doesn't apply.
 
const NoFollowDomainExceptions
 If this is set to an array of domains, external links to these domain names (or any subdomains) will not be set to rel="nofollow" regardless of the value of $wgNoFollowLinks.
 
const RegisterInternalExternals
 By default MediaWiki does not register links pointing to same server in externallinks dataset, use this value to override:
 
const AllowDisplayTitle
 Allow DISPLAYTITLE to change title display.
 
const RestrictDisplayTitle
 For consistency, restrict DISPLAYTITLE to text that normalizes to the same canonical DB key.
 
const ExpensiveParserFunctionLimit
 Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY.
 
const PreprocessorCacheThreshold
 Preprocessor caching threshold Setting it to 'false' will disable the preprocessor cache.
 
const EnableScaryTranscluding
 Enable interwiki transcluding.
 
const TranscludeCacheExpiry
 Expiry time for transcluded templates cached in object cache.
 
const EnableMagicLinks
 Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
 
Statistics and content analysis
const ArticleCountMethod
 Method used to determine if a page in a content namespace should be counted as a valid article.
 
const ActiveUserDays
 How many days user must be idle before he is considered inactive.
 
const LearnerEdits
 The following variables define 3 user experience levels:
 
const LearnerMemberSince
 Number of days the user must exist before becoming a learner.
 
const ExperiencedUserEdits
 Number of edits the user must have before becoming "experienced".
 
const ExperiencedUserMemberSince
 Number of days the user must exist before becoming "experienced".
 
const ManualRevertSearchRadius
 Maximum number of revisions of a page that will be checked against every new edit made to determine whether the edit was a manual revert.
 
const RevertedTagMaxDepth
 Maximum depth (revision count) of reverts that will have their reverted edits marked with the mw-reverted change tag.
 
User accounts, authentication
const CentralIdLookupProviders
 Central ID lookup providers Key is the provider ID, value is a specification for ObjectFactory.
 
const CentralIdLookupProvider
 Central ID lookup provider to use by default.
 
const PasswordPolicy
 Password policy for the wiki.
 
const AuthManagerConfig
 Configure AuthManager.
 
const AuthManagerAutoConfig
 
const RememberMe
 Configures RememberMe authentication request added by AuthManager.
 
const ReauthenticateTime
 Time frame for re-authentication.
 
const AllowSecuritySensitiveOperationIfCannotReauthenticate
 Whether to allow security-sensitive operations when re-authentication is not possible.
 
const ChangeCredentialsBlacklist
 List of AuthenticationRequest class names which are not changeable through Special:ChangeCredentials and the changeauthenticationdata API.
 
const RemoveCredentialsBlacklist
 List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata API.
 
const MinimalPasswordLength
 Specifies the minimal length of a user password.
 
const MaximalPasswordLength
 Specifies the maximal length of a user password (T64685).
 
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().
 
const PasswordDefault
 Default password type to use when hashing user passwords.
 
const PasswordConfig
 Configuration for built-in password types.
 
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.
 
const MaxSigChars
 Maximum number of Unicode characters in signature.
 
const SignatureValidation
 Behavior of signature validation.
 
const SignatureAllowedLintErrors
 List of lint error codes which don't cause signature validation to fail.
 
const MaxNameChars
 Maximum number of bytes in username.
 
const ReservedUsernames
 Array of usernames which may not be registered or logged in from Maintenance scripts can still use these.
 
const DefaultUserOptions
 Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts.
 
const HiddenPrefs
 An array of preferences to not show for the user.
 
const InvalidUsernameCharacters
 Characters to prevent during new account creations.
 
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.
 
const SecureLogin
 This is to let user authenticate using https when they come from http.
 
const AuthenticationTokenVersion
 Versioning for authentication tokens.
 
const SessionProviders
 MediaWiki\Session\SessionProvider configuration.
 
const AllowRequiringEmailForResets
 Temporary feature flag that controls whether users will see a checkbox allowing them to require providing email during password resets.
 
const AutoCreateTempUser
 Configuration for automatic creation of temporary accounts on page save.
 
User rights, access control and monitoring
const AutoblockExpiry
 Number of seconds before autoblock entries expire.
 
const BlockAllowsUTEdit
 Set this to true to allow blocked users to edit their own user talk page.
 
const BlockCIDRLimit
 Limits on the possible sizes of range blocks.
 
const BlockDisablesLogin
 If true, blocked users will not be allowed to login.
 
const EnablePartialActionBlocks
 Flag to enable partial blocks against performing certain actions.
 
const WhitelistRead
 Pages anonymous user may see, set as an array of pages titles.
 
const WhitelistReadRegexp
 Pages anonymous user may see, set as an array of regular expressions.
 
const EmailConfirmToEdit
 Should editors be required to have a validated e-mail address before being allowed to edit?
 
const HideIdentifiableRedirects
 Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public.
 
const GroupPermissions
 Permission keys given to users in each group.
 
const PrivilegedGroups
 List of groups which should be considered privileged (user accounts belonging in these groups can be abused in dangerous ways).
 
const RevokePermissions
 Permission keys revoked from users in each group.
 
const GroupInheritsPermissions
 Groups that should inherit permissions from another group.
 
const ImplicitGroups
 Implicit groups, aren't shown on Special:Listusers or somewhere else.
 
const GroupsAddToSelf
 A map of group names that the user is in, to group names that those users are allowed to add or revoke.
 
const GroupsRemoveFromSelf
 
const RestrictionTypes
 Set of available actions that can be restricted via action=protect You probably shouldn't change this.
 
const RestrictionLevels
 Rights which can be required for each protection level (via action=protect)
 
const CascadingRestrictionLevels
 Restriction levels that can be used with cascading protection.
 
const SemiprotectedRestrictionLevels
 Restriction levels that should be considered "semiprotected".
 
const NamespaceProtection
 Set the minimum permissions required to edit pages in each namespace.
 
const NonincludableNamespaces
 Pages in namespaces in this array can not be used as templates.
 
const AutoConfirmAge
 Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group membership.
 
const AutoConfirmCount
 Number of edits an account requires before it is autoconfirmed.
 
const Autopromote
 Array containing the conditions of automatic promotion of a user to specific groups.
 
const AutopromoteOnce
 Automatically add a usergroup to any user who matches certain conditions.
 
const AutopromoteOnceLogInRC
 Put user rights log entries for autopromotion in recent changes?
 
const AddGroups
 $wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups at Special:Userrights.
 
const RemoveGroups
 
const AvailableRights
 A list of available rights, in addition to the ones defined by the core.
 
const DeleteRevisionsLimit
 Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission.
 
const DeleteRevisionsBatchSize
 Page deletions with > this number of revisions will use the job queue.
 
const HideUserContribLimit
 The maximum number of edits a user can have and can still be hidden by users with the hideuser permission.
 
const AccountCreationThrottle
 Number of accounts each IP address may create per specified period(s).
 
const SpamRegex
 Edits matching these regular expressions in body text will be recognised as spam and rejected automatically.
 
const SummarySpamRegex
 Same as SpamRegex except for edit summaries.
 
const EnableDnsBlacklist
 Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies.
 
const DnsBlacklistUrls
 List of DNS blacklists to use, if $wgEnableDnsBlacklist is true.
 
const ProxyList
 List of banned IP addresses.
 
const ProxyWhitelist
 Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say.
 
const SoftBlockRanges
 IP ranges that should be considered soft-blocked (anon-only, account creation allowed).
 
const ApplyIpBlocksToXff
 Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them.
 
const RateLimits
 Simple rate limiter options to brake edit floods.
 
const RateLimitsExcludedIPs
 Array of IPs / CIDR ranges which should be excluded from rate limits.
 
const PutIPinRC
 Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g.
 
const QueryPageDefaultLimit
 Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere.
 
const PasswordAttemptThrottle
 Limit password attempts to X attempts per Y seconds per IP per account.
 
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).
 
const GrantPermissionGroups
 
const EnableBotPasswords
 
const BotPasswordsCluster
 Cluster for the bot_passwords table.
 
const BotPasswordsDatabase
 Database name for the bot_passwords table.
 
Security
const SecretKey
 This should always be customised in LocalSettings.php.
 
const AllowUserJs
 Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load.
 
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.
 
const AllowUserCssPrefs
 Allow style-related user-preferences?
 
const UseSiteJs
 Use the site's Javascript page?
 
const UseSiteCss
 Use the site's Cascading Style Sheets (CSS)?
 
const BreakFrames
 Break out of framesets.
 
const EditPageFrameOptions
 The X-Frame-Options header to send on pages sensitive to clickjacking attacks, such as edit pages.
 
const ApiFrameOptions
 Disallow framing of API pages directly, by setting the X-Frame-Options header.
 
const CSPHeader
 Controls Content-Security-Policy header [Experimental].
 
const CSPReportOnlyHeader
 Controls Content-Security-Policy-Report-Only header.
 
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.
 
const AllowCrossOrigin
 Allow anonymous cross origin requests.
 
const RestAllowCrossOriginCookieAuth
 Allows authenticated cross-origin requests to the REST API with session cookies.
 
const SessionSecret
 Secret for session storage.
 
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.
 
const HKDFSecret
 Secret for hmac-based key derivation function (fast, cryptographically secure random numbers).
 
const HKDFAlgorithm
 Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers).
 
Profiling, testing and debugging
const DebugLogFile
 Enable verbose debug logging for all channels and log levels.
 
const DebugLogPrefix
 Prefix for debug log lines.
 
const DebugRedirects
 If true, instead of redirecting, show a page with a link to the redirect destination.
 
const DebugRawPage
 If true, debug logging is also enabled for load.php and action=raw requests.
 
const DebugComments
 Send debug data to an HTML comment in the output.
 
const DebugDumpSql
 Write SQL queries to the debug log.
 
const TrxProfilerLimits
 Performance expectations for DB usage.
 
const DebugLogGroups
 Map of string log group names to log destinations.
 
const MWLoggerDefaultSpi
 Default service provider for creating Psr\Log\LoggerInterface instances.
 
const ShowDebug
 Display debug data at the bottom of the main content area.
 
const SpecialVersionShowHooks
 Show the contents of $wgHooks in Special:Version.
 
const ShowExceptionDetails
 Show exception message and stack trace when printing details about uncaught exceptions in web response output.
 
const LogExceptionBacktrace
 If true, send the exception backtrace to the error log.
 
const PropagateErrors
 If true, the MediaWiki error handler passes errors/warnings to the default error handler after logging them.
 
const ShowHostnames
 Expose backend server host names through the API and various HTML comments.
 
const OverrideHostname
 Override server hostname detection with a hardcoded value.
 
const DevelopmentWarnings
 If set to true MediaWiki will throw notices for some possible error conditions and for deprecated functions.
 
const DeprecationReleaseLimit
 Release limitation to wfDeprecated warnings, if set to a release number development warnings will not be generated for deprecations added in releases after the limit.
 
const Profiler
 Profiler configuration.
 
const StatsdServer
 Destination of statsd metrics.
 
const StatsdMetricPrefix
 Prefix for metric names sent to $wgStatsdServer.
 
const StatsdSamplingRates
 Sampling rate for statsd metrics as an associative array of patterns and rates.
 
const MetricsTarget
 Metrics output target URI e.g.
 
const MetricsFormat
 Metrics output format.
 
const MetricsPrefix
 Metrics service name prefix.
 
const PageInfoTransclusionLimit
 InfoAction retrieves a list of transclusion links (both to and from).
 
const ParserTestFiles
 Parser test suite files to be run by parserTests.php when no specific filename is passed to it.
 
const EnableJavaScriptTest
 Allow running of QUnit tests via [[Special:JavaScriptTest]].
 
const CachePrefix
 Overwrite the caching key prefix with custom value.
 
const DebugToolbar
 Display the new debugging toolbar.
 
Search
const DisableTextSearch
 Set this to true to disable the full text search feature.
 
const AdvancedSearchHighlighting
 Set to true to have nicer highlighted text in search results, by default off due to execution overhead.
 
const SearchHighlightBoundaries
 Regexp to match word boundaries, defaults for non-CJK languages should be empty for CJK since the words are not separate.
 
const OpenSearchTemplate
 Template for OpenSearch suggestions, defaults to API action=opensearch.
 
const OpenSearchTemplates
 Templates for OpenSearch suggestions, defaults to API action=opensearch.
 
const EnableOpenSearchSuggest
 This was previously a used to force empty responses from ApiOpenSearch with the 'suggest' parameter set.
 
const OpenSearchDefaultLimit
 Integer defining default number of entries to show on OpenSearch call.
 
const OpenSearchDescriptionLength
 Minimum length of extract in .
 
const SearchSuggestCacheExpiry
 Expiry time for search suggestion responses.
 
const DisableSearchUpdate
 If you've disabled search semi-permanently, this also disables updates to the table.
 
const NamespacesToBeSearchedDefault
 List of namespaces which are searched by default.
 
const DisableInternalSearch
 Disable the internal MySQL-based search, to allow it to be implemented by an extension instead.
 
const SearchForwardUrl
 Set this to a URL to forward search requests to some external location.
 
const SitemapNamespaces
 Array of namespaces to generate a Google sitemap for when the maintenance/generateSitemap.php script is run, or false if one is to be generated for all namespaces.
 
const SitemapNamespacesPriorities
 Custom namespace priorities for sitemaps.
 
const EnableSearchContributorsByIP
 If true, searches for IP addresses will be redirected to that IP's contributions page.
 
const SpecialSearchFormOptions
 Options for Special:Search completion widget form created by SearchFormWidget class.
 
const SearchMatchRedirectPreference
 Set true to allow logged-in users to set a preference whether or not matches in search results should force redirection to that page.
 
const SearchRunSuggestedQuery
 Controls whether zero-result search queries with suggestions should display results for these suggestions.
 
Edit user interface
const Diff3
 Path to the GNU diff3 utility.
 
const Diff
 Path to the GNU diff utility.
 
const PreviewOnOpenNamespaces
 Which namespaces have special treatment where they should be preview-on-open Internally only Category: pages apply, but using this extensions (e.g.
 
const UniversalEditButton
 Enable the UniversalEditButton for browsers that support it (currently only Firefox with an extension) See http://universaleditbutton.org for more background information.
 
const UseAutomaticEditSummaries
 If user doesn't specify any edit summary when making a an edit, MediaWiki will try to automatically create one.
 
Recent changes, new pages, watchlist and history
const RCMaxAge
 Recentchanges items are periodically purged; entries older than this many seconds will go.
 
const WatchersMaxAge
 Page watchers inactive for more than this many seconds are considered inactive.
 
const UnwatchedPageSecret
 If active watchers (per above) are this number or less, do not disclose it.
 
const RCFilterByAge
 Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers higher than what will be stored.
 
const RCLinkLimits
 List of Limits options to list in the Special:Recentchanges and Special:Recentchangeslinked pages.
 
const RCLinkDays
 List of Days options to list in the Special:Recentchanges and Special:Recentchangeslinked pages.
 
const RCFeeds
 Configuration for feeds to which notifications about recent changes will be sent.
 
const RCEngines
 Used by RecentChange::getEngine to find the correct engine for a given URI scheme.
 
const RCWatchCategoryMembership
 Treat category membership changes as a RecentChange.
 
const UseRCPatrol
 Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files are included.
 
const StructuredChangeFiltersLiveUpdatePollingRate
 Polling rate, in seconds, used by the 'live update' and 'view newest' features of the RCFilters app on SpecialRecentChanges and Special:Watchlist.
 
const UseNPPatrol
 Use new page patrolling to check new pages on Special:Newpages.
 
const UseFilePatrol
 Use file patrolling to check new files on Special:Newfiles.
 
const Feed
 Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages.
 
const FeedLimit
 Set maximum number of results to return in syndication feeds (RSS, Atom) for eg Recentchanges, Newpages.
 
const FeedCacheTimeout
 Minimum timeout for cached Recentchanges feed, in seconds.
 
const FeedDiffCutoff
 When generating Recentchanges RSS/Atom feed, diffs will not be generated for pages larger than this size.
 
const OverrideSiteFeed
 Override the site's default RSS/ATOM feed for recentchanges that appears on every page.
 
const FeedClasses
 Available feeds objects.
 
const AdvertisedFeedTypes
 Which feed types should we provide by default? This can include 'rss', 'atom', neither, or both.
 
const RCShowWatchingUsers
 Show watching users in recent changes, watchlist and page history views.
 
const RCShowChangedSize
 Show the amount of changed characters in recent changes.
 
const RCChangedSizeThreshold
 If the difference between the character counts of the text before and after the edit is below that value, the value will be highlighted on the RC page.
 
const ShowUpdatedMarker
 Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes.
 
const DisableAnonTalk
 Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history, Special:Recentchanges, etc.
 
const UseTagFilter
 Allow filtering by change tag in recentchanges, history, etc Has no effect if no tags are defined.
 
const SoftwareTags
 List of core tags to enable.
 
const UnwatchedPageThreshold
 If set to an integer, pages that are watched by this many users or more will not require the unwatchedpages permission to view the number of watchers.
 
const RecentChangesFlags
 Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits.
 
const WatchlistExpiry
 Whether to enable the watchlist expiry feature.
 
const WatchlistPurgeRate
 Chance of expired watchlist items being purged on any page edit.
 
const WatchlistExpiryMaxDuration
 Relative maximum duration for watchlist expiries, as accepted by strtotime().
 
Copyright and credits settings
const RightsPage
 Override for copyright metadata.
 
const RightsUrl
 Set this to specify an external URL containing details about the content license used on your wiki.
 
const RightsText
 If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link.
 
const RightsIcon
 Override for copyright metadata.
 
const UseCopyrightUpload
 Set this to true if you want detailed copyright information forms on Upload.
 
const MaxCredits
 Set this to the number of authors that you want to be credited below an article text.
 
const ShowCreditsIfMax
 If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
 
Import / Export
const ImportSources
 List of interwiki prefixes for wikis we'll accept as sources for Special:Import and API action=import.
 
const ImportTargetNamespace
 Optional default target namespace for interwiki imports.
 
const ExportAllowHistory
 If set to false, disables the full-history option on Special:Export.
 
const ExportMaxHistory
 If set nonzero, Special:Export requests for history of pages with more revisions than this will be rejected.
 
const ExportAllowListContributors
 Return distinct author list (when not returning full history)
 
const ExportMaxLinkDepth
 If non-zero, Special:Export accepts a "pagelink-depth" parameter up to this specified level, which will cause it to include all pages linked to from the pages you specify.
 
const ExportFromNamespaces
 Whether to allow the "export all pages in namespace" option.
 
const ExportAllowAll
 Whether to allow exporting the entire wiki into a single file.
 
const ExportPagelistLimit
 Maximum number of pages returned by the GetPagesFromCategory and GetPagesFromNamespace functions.
 
const XmlDumpSchemaVersion
 The schema to use per default when generating XML dumps.
 
Wiki Farm
const WikiFarmSettingsDirectory
 EXPERIMENTAL: A directory that contains site-specific configuration files.
 
const WikiFarmSettingsExtension
 EXPERIMENTAL: The file extension to be used when looking up site-specific settings files in $wgWikiFarmSettingsDirectory, such as 'json' or 'yaml'.
 
Extensions
const ExtensionFunctions
 A list of callback functions which are called once MediaWiki is fully initialised.
 
const ExtensionMessagesFiles
 Extension messages files.
 
const MessagesDirs
 Extension messages directories.
 
const ExtensionEntryPointListFiles
 Array of files with list(s) of extension entry points to be used in maintenance/mergeMessageFileList.php.
 
const ParserOutputHooks
 Parser output hooks.
 
const EnableParserLimitReporting
 Whether to include the NewPP limit report as a HTML comment.
 
const ValidSkinNames
 List of valid skin names.
 
const SpecialPages
 Special page list.
 
const AutoloadAttemptLowercase
 Switch controlling legacy case-insensitive classloading.
 
const ExtensionCredits
 Add information about an installed extension, keyed by its type.
 
const Hooks
 Global list of hooks.
 
const ServiceWiringFiles
 List of service wiring files to be loaded by the default instance of MediaWikiServices.
 
const JobClasses
 Maps jobs to their handlers; extensions can add to this to provide custom jobs.
 
const JobTypesExcludedFromDefaultQueue
 Jobs that must be explicitly requested, i.e.
 
const JobBackoffThrottling
 Map of job types to how many job "work items" should be run per second on each job runner process.
 
const JobSerialCommitThreshold
 Make job runners commit changes for replica DB-lag prone jobs one job at a time.
 
const JobTypeConf
 Map of job types to configuration arrays.
 
const JobQueueIncludeInMaxLagFactor
 Whether to include the number of jobs that are queued for the API's maxlag parameter.
 
const SpecialPageCacheUpdates
 Additional functions to be performed with updateSpecialPages.
 
const PagePropLinkInvalidations
 Page property link table invalidation lists.
 
Categories
const CategoryMagicGallery
 On category pages, show thumbnail gallery for images belonging to that category instead of listing them as articles.
 
const CategoryPagingLimit
 Paging limit for categories.
 
const CategoryCollation
 Specify how category names should be sorted, when listed on a category page.
 
const TempCategoryCollations
 Additional category collations to store during LinksUpdate.
 
const TrackingCategories
 Array holding default tracking category names.
 
Logging
const LogTypes
 The logging system has two levels: an event type, which describes the general category and can be viewed as a named subset of all logs; and an action, which is a specific kind of event that can exist in that log type.
 
const LogRestrictions
 This restricts log access to those who have a certain right Users without this will not see it in the option menu and can not view it Restricted logs are not added to recent changes Logs should remain non-transcludable Format: logtype => permissiontype.
 
const FilterLogTypes
 Show/hide links on Special:Log will be shown for these log types.
 
const LogNames
 Lists the message key string for each log type.
 
const LogHeaders
 Lists the message key string for descriptive text to be shown at the top of each log type.
 
const LogActions
 Maps log actions to message keys, for formatting log entries of each type and action when displaying logs to the user.
 
const LogActionsHandlers
 The same as above, but here values are names of classes, not messages.
 
const ActionFilteredLogs
 List of log types that can be filtered by action types.
 
const NewUserLog
 Maintain a log of newusers at Special:Log/newusers?
 
const PageCreationLog
 Maintain a log of page creations at Special:Log/create?
 
Special pages (general and miscellaneous)
const AllowSpecialInclusion
 Allow special page inclusions such as {{Special:Allpages}}.
 
const DisableQueryPageUpdate
 Set this to an array of special page names to prevent maintenance/updateSpecialPages.php from updating those pages.
 
const CountCategorizedImagesAsUsed
 On Special:Unusedimages, consider images "used", if they are put into a category.
 
const MaxRedirectLinksRetrieved
 Maximum number of links to a redirect page listed on Special:Whatlinkshere/RedirectDestination.
 
const RangeContributionsCIDRLimit
 Shortest CIDR limits that can be checked in any individual range check at Special:Contributions.
 
Actions
const Actions
 Map of allowed values for the "title=foo&action=<action>" parameter.
 
Robot (search engine crawler) policy
const DefaultRobotPolicy
 Default robot policy.
 
const NamespaceRobotPolicies
 Robot policies per namespaces.
 
const ArticleRobotPolicies
 Robot policies per article.
 
const ExemptFromUserRobotsControl
 An array of namespace keys in which the INDEX/__NOINDEX__ magic words will not function, so users can't decide whether pages in that namespace are indexed by search engines.
 
Action API and REST API
const DebugAPI
 WARNING: SECURITY THREAT - debug use only.
 
const APIModules
 API module extensions.
 
const APIFormatModules
 API format module extensions.
 
const APIMetaModules
 API Query meta module extensions.
 
const APIPropModules
 API Query prop module extensions.
 
const APIListModules
 API Query list module extensions.
 
const APIMaxDBRows
 Maximum amount of rows to scan in a DB query in the API The default value is generally fine.
 
const APIMaxResultSize
 The maximum size (in bytes) of an API result.
 
const APIMaxUncachedDiffs
 The maximum number of uncached diffs that can be retrieved in one API request.
 
const APIMaxLagThreshold
 Maximum amount of DB lag on a majority of DB replica DBs to tolerate before forcing bots to retry any write requests via API errors.
 
const APIRequestLog
 Log file or URL (TCP or UDP) to log API requests to, or false to disable API request logging.
 
const APICacheHelpTimeout
 Set the timeout for the API help text cache.
 
const APIUselessQueryPages
 The ApiQueryQueryPages module should skip pages that are redundant to true API queries.
 
const AjaxUploadDestCheck
 Enable AJAX check for file overwrite, pre-upload.
 
const AjaxLicensePreview
 Enable previewing licences via AJAX.
 
const CrossSiteAJAXdomains
 Settings for incoming cross-site AJAX requests: Newer browsers support cross-site AJAX when the target resource allows requests from the origin domain by the Access-Control-Allow-Origin header.
 
const CrossSiteAJAXdomainExceptions
 Domains that should not be allowed to make AJAX requests, even if they match one of the domains allowed by $wgCrossSiteAJAXdomains Uses the same syntax as $wgCrossSiteAJAXdomains.
 
const AllowedCorsHeaders
 List of allowed headers for cross-origin API requests.
 
const RestAPIAdditionalRouteFiles
 Additional REST API Route files.
 
Shell and process control
const MaxShellMemory
 Maximum amount of virtual memory available to shell processes under linux, in KiB.
 
const MaxShellFileSize
 Maximum file size created by shell processes under linux, in KiB ImageMagick convert for example can be fairly hungry for scratch space.
 
const MaxShellTime
 Maximum CPU time in seconds for shell processes under Linux.
 
const MaxShellWallClockTime
 Maximum wall clock time (i.e.
 
const ShellCgroup
 Under Linux: a cgroup directory used to constrain memory usage of shell commands.
 
const PhpCli
 Executable path of the PHP cli binary.
 
const ShellRestrictionMethod
 Method to use to restrict shell commands.
 
const ShellboxUrl
 
const ShellboxUrls
 Shell commands can be run on a remote server using Shellbox.
 
const ShellboxSecretKey
 The secret key for HMAC verification of Shellbox requests.
 
HTTP client
const HTTPTimeout
 Timeout for HTTP requests done internally, in seconds.
 
const HTTPConnectTimeout
 Timeout for connections done internally (in seconds).
 
const HTTPMaxTimeout
 The maximum HTTP request timeout in seconds.
 
const HTTPMaxConnectTimeout
 The maximum HTTP connect timeout in seconds.
 
const HTTPImportTimeout
 Timeout for HTTP requests done internally for transwiki imports, in seconds.
 
const AsyncHTTPTimeout
 Timeout for Asynchronous (background) HTTP requests, in seconds.
 
const HTTPProxy
 Proxy to use for CURL requests.
 
const LocalVirtualHosts
 Local virtual hosts.
 
const LocalHTTPProxy
 Reverse proxy to use for requests to domains in $wgLocalVirtualHosts.
 
const AllowExternalReqID
 Whether to respect/honour the request ID provided by the incoming request via the X-Request-Id header.
 
Job queue
const JobRunRate
 Number of jobs to perform per request.
 
const RunJobsAsync
 When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process to handle the job execution, instead of blocking the request until the job execution finishes.
 
const UpdateRowsPerJob
 Number of rows to update per job.
 
const UpdateRowsPerQuery
 Number of rows to update per query.
 
Miscellaneous
const RedirectOnLogin
 Allow redirection to another page when a user logs in.
 
const VirtualRestConfig
 Global configuration variable for Virtual REST Services.
 
const EventRelayerConfig
 Mapping of event channels (or channel categories) to EventRelayer configuration.
 
const Pingback
 Share data about this installation with MediaWiki developers.
 
const OriginTrials
 Origin Trials tokens.
 
const ReportToExpiry
 Expiry of the endpoint definition for the Reporting API.
 
const ReportToEndpoints
 List of endpoints for the Reporting API.
 
const FeaturePolicyReportOnly
 List of Feature Policy Reporting types to enable.
 
const SkinsPreferred
 List of preferred skins to be listed higher in Special:Preferences.
 

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

Database settings

const DBname
 Current wiki database name.
 
const DBmwschema
 Current wiki database schema name.
 
const DBprefix
 Current wiki database table name prefix.
 
const DBserver
 Database host name or IP address.
 
const DBport
 Database port number.
 
const DBuser
 Database username.
 
const DBpassword
 Database user's password.
 
const DBtype
 Database type.
 
const DBssl
 Whether to use SSL in DB connection.
 
const DBcompress
 Whether to use compression in DB connection.
 
const DBadminuser
 Separate username for maintenance tasks.
 
const DBadminpassword
 Separate password for maintenance tasks.
 
const SearchType
 Search type.
 
const SearchTypeAlternatives
 Alternative search types.
 
const DBTableOptions
 MySQL table options to use during installation or update.
 
const SQLMode
 SQL Mode - default is turning off all modes, including strict, if set.
 
const DBDefaultGroup
 Default group to use when getting database connections.
 
const SQLiteDataDir
 To override default SQLite data directory ($docroot/../data)
 
const SharedDB
 Shared database for multiple wikis.
 
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:
 
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().
 
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.
 
const DBerrorLog
 File to log database errors to.
 
const DBerrorLogTZ
 Timezone to use in the error log.
 
const LocalDatabases
 Other wikis on this site, can be administered from a single developer account.
 
const DatabaseReplicaLagWarning
 If lag is higher than $wgDatabaseReplicaLagWarning, show a warning in some special pages (like watchlist).
 
const DatabaseReplicaLagCritical
 
const MaxExecutionTimeForExpensiveQueries
 Max execution time for queries of several expensive special pages such as RecentChanges in milliseconds.
 
const TemplateLinksSchemaMigrationStage
 Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields.
 
static getDefaultSharedPrefix ( $dbPrefix)
 
static getDefaultSharedSchema ( $dbMwschema)
 
static getDefaultDBerrorLogTZ ( $localtimezone)
 Current wiki database name.
 

Language, regional and character encoding settings

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

ResourceLoader settings

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

Page titles and redirects

const MetaNamespace
 Name of the project namespace.
 
const MetaNamespaceTalk
 Name of the project talk namespace.
 
const CanonicalNamespaceNames
 Canonical namespace names.
 
const ExtraNamespaces
 Additional namespaces.
 
const ExtraGenderNamespaces
 Same as above, but for namespaces with gender distinction.
 
const NamespaceAliases
 Define extra namespace aliases.
 
const LegalTitleChars
 Allowed title characters – regex character class Don't change this unless you know what you're doing.
 
const CapitalLinks
 Set this to false to avoid forcing the first letter of links to capitals.
 
const CapitalLinkOverrides
 
const NamespacesWithSubpages
 Which namespaces should support subpages? See Language.php for a list of namespaces.
 
const ContentNamespaces
 Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are concerned.
 
const ShortPagesNamespaceExclusions
 Optional array of namespaces which should be excluded from Special:ShortPages.
 
const ExtraSignatureNamespaces
 Array of namespaces, in addition to the talk namespaces, where signatures (~~~~) are likely to be used.
 
const InvalidRedirectTargets
 Array of invalid page redirect targets.
 
const DisableHardRedirects
 Disable redirects to special pages and interwiki redirects, which use a 302 and have no "redirected from" link.
 
const FixDoubleRedirects
 Fix double redirects after a page move.
 
static getDefaultMetaNamespace ( $sitename)
 

Cookie settings

const CookieExpiration
 Default cookie lifetime, in seconds.
 
const ExtendedLoginCookieExpiration
 Default login cookie lifetime, in seconds.
 
const CookieDomain
 Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net".
 
const CookiePath
 Set this variable if you want to restrict cookies to a certain path within the domain specified by $wgCookieDomain.
 
const CookieSecure
 Whether the "secure" flag should be set on the cookie.
 
const DisableCookieCheck
 By default, MediaWiki checks if the client supports cookies during the login process, so that it can display an informative error message if cookies are disabled.
 
const CookiePrefix
 Cookies generated by MediaWiki have names starting with this prefix.
 
const CookieHttpOnly
 Set authentication cookies to HttpOnly to prevent access by JavaScript, in browsers that support this feature.
 
const CookieSameSite
 The SameSite cookie attribute used for login cookies.
 
const UseSameSiteLegacyCookies
 If true, when a cross-site cookie with SameSite=None is sent, a legacy cookie with an "ss0" prefix will also be sent, without SameSite=None.
 
const CacheVaryCookies
 A list of cookies that vary the cache (for use by extensions)
 
const SessionName
 Override to customise the session name.
 
const CookieSetOnAutoblock
 Whether to set a cookie when a user is autoblocked.
 
const CookieSetOnIpBlock
 Whether to set a cookie when a logged-out user is blocked.
 
static getDefaultCookieSecure ( $forceHTTPS)
 Default cookie lifetime, in seconds.
 
static getDefaultCookiePrefix ( $sharedDB, $sharedPrefix, $sharedTables, $dbName, $dbPrefix)
 Default cookie lifetime, in seconds.
 

Maintenance

const CommandLineDarkBg
 For colorized maintenance script output, is your terminal background dark ?
 
const ReadOnly
 Set this to a string to put the wiki into read-only mode.
 
const ReadOnlyWatchedItemStore
 Set this to true to put the wiki watchlists into read-only mode.
 
const ReadOnlyFile
 If this lock file exists (size > 0), the wiki will be forced into read-only mode.
 
const UpgradeKey
 When you run the web-based upgrade utility, it will tell you what to set this to in order to authorize the upgrade process.
 
const GitBin
 Fully specified path to git binary.
 
const GitRepositoryViewers
 Map GIT repository URLs to viewer URLs to provide links in Special:Version.
 
static getDefaultReadOnlyFile ( $uploadDirectory)
 

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

◆ getDefaultCookiePrefix()

static MediaWiki\MainConfigSchema::getDefaultCookiePrefix ( $sharedDB,
$sharedPrefix,
$sharedTables,
$dbName,
$dbPrefix )
static

Default cookie lifetime, in seconds.

Setting to 0 makes all cookies session-only.

Definition at line 9048 of file MainConfigSchema.php.

◆ getDefaultCookieSecure()

static MediaWiki\MainConfigSchema::getDefaultCookieSecure ( $forceHTTPS)
static

Default cookie lifetime, in seconds.

Setting to 0 makes all cookies session-only.

Definition at line 9022 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 3148 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 470 of file MainConfigSchema.php.

◆ getDefaultFileCacheDirectory()

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

Definition at line 609 of file MainConfigSchema.php.

◆ getDefaultLoadScript()

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

Definition at line 390 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 449 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 4888 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 4914 of file MainConfigSchema.php.

◆ getDefaultLogo()

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

Definition at line 630 of file MainConfigSchema.php.

◆ getDefaultMetaNamespace()

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

Definition at line 5872 of file MainConfigSchema.php.

◆ getDefaultReadOnlyFile()

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

Definition at line 9948 of file MainConfigSchema.php.

◆ getDefaultResourceBasePath()

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

Definition at line 5726 of file MainConfigSchema.php.

◆ getDefaultRestPath()

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

Definition at line 409 of file MainConfigSchema.php.

◆ getDefaultScript()

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

Definition at line 370 of file MainConfigSchema.php.

◆ getDefaultSharedPrefix()

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

Definition at line 2989 of file MainConfigSchema.php.

◆ getDefaultSharedSchema()

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

Definition at line 3019 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 429 of file MainConfigSchema.php.

◆ getDefaultUploadDirectory()

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

Definition at line 591 of file MainConfigSchema.php.

◆ getDefaultUploadPath()

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

Definition at line 549 of file MainConfigSchema.php.

◆ getDefaultUsePathInfo()

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

Definition at line 346 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 174 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;
}

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

◆ ActionFilteredLogs

const MediaWiki\MainConfigSchema::ActionFilteredLogs

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

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

Since
1.27

Definition at line 11431 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 834 of file MainConfigSchema.php.

◆ Actions

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

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

to the corrspeonding handler code. See ActionFactory for the syntax. Core defaults are in ActionFactory::CORE_ACTIONS, anything here overrides that.

Definition at line 11577 of file MainConfigSchema.php.

◆ ActiveUserDays

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

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

Will affect the number shown on Special:Statistics, Special:ActiveUsers, and the {{NUMBEROFACTIVEUSERS}} magic word in wikitext.

You might want to leave this as the default value, to provide comparable numbers between different wikis.

Definition at line 6570 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 4113 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 8098 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 2648 of file MainConfigSchema.php.

◆ AdvancedSearchHighlighting

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

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

Definition at line 9635 of file MainConfigSchema.php.

◆ AdvertisedFeedTypes

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

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

Definition at line 10281 of file MainConfigSchema.php.

◆ AjaxLicensePreview

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

Enable previewing licences via AJAX.

Definition at line 11856 of file MainConfigSchema.php.

◆ AjaxUploadDestCheck

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

Enable AJAX check for file overwrite, pre-upload.

Definition at line 11849 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 8895 of file MainConfigSchema.php.

◆ AllowDisplayTitle

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

Allow DISPLAYTITLE to change title display.

Definition at line 6476 of file MainConfigSchema.php.

◆ AllowedCorsHeaders

const MediaWiki\MainConfigSchema::AllowedCorsHeaders
Initial value:
= [
'default' => [
'Accept',
'Accept-Language',
'Content-Language',
'Content-Type',
'Accept-Encoding',
'DNT',
'Origin',
'User-Agent',
'Api-User-Agent',
'Access-Control-Max-Age',
'Authorization',
],
'type' => 'list',
]

List of allowed headers for cross-origin API requests.

Definition at line 11900 of file MainConfigSchema.php.

◆ AllowExternalImages

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

Whether to allow inline image pointing to other websites.

Definition at line 6290 of file MainConfigSchema.php.

◆ AllowExternalImagesFrom

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

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

Image URLs that start with this string are then rendered, while all others are not.

You can use this to set up a trusted, simple repository of images. You may also specify an array of strings to allow multiple sites

Examples:

$wgAllowExternalImagesFrom = 'http://127.0.0.1/';
$wgAllowExternalImagesFrom = [ 'http://127.0.0.1/', 'http://example.com' ];
$wgAllowExternalImagesFrom
Config variable stub for the AllowExternalImagesFrom setting, for use by phpdoc and IDEs.

Definition at line 6308 of file MainConfigSchema.php.

◆ AllowExternalReqID

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

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

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

Definition at line 12175 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 2656 of file MainConfigSchema.php.

◆ AllowImageTag

const MediaWiki\MainConfigSchema::AllowImageTag
Initial value:
= [
'default' => false,
'deprecated' => 'since 1.35; register an extension tag named <img> instead.',
]

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

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

Deprecated
since 1.35; register an extension tag named

instead.

Definition at line 6338 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 7389 of file MainConfigSchema.php.

◆ AllowSchemaUpdates

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

Allow schema updates.

Definition at line 3513 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 6969 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 5835 of file MainConfigSchema.php.

◆ AllowSlowParserFunctions

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

Enable slow parser functions.

Definition at line 3506 of file MainConfigSchema.php.

◆ AllowSpecialInclusion

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

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

Definition at line 11520 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 8762 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 8772 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 8753 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 4686 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 4708 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 2096 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 2156 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 2136 of file MainConfigSchema.php.

◆ APICacheHelpTimeout

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

Set the timeout for the API help text cache.

If set to 0, caching disabled

Definition at line 11830 of file MainConfigSchema.php.

◆ APIFormatModules

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

API format module extensions.

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

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

Definition at line 11740 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 8832 of file MainConfigSchema.php.

◆ APIListModules

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

API Query list module extensions.

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

See ApiQuery::QUERY_LIST_MODULES for a list of the core list modules.

Definition at line 11779 of file MainConfigSchema.php.

◆ APIMaxDBRows

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

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

Definition at line 11788 of file MainConfigSchema.php.

◆ APIMaxLagThreshold

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

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

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

Definition at line 11815 of file MainConfigSchema.php.

◆ APIMaxResultSize

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

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

Warning
Do not set this lower than $wgMaxArticleSize*1024

Definition at line 11797 of file MainConfigSchema.php.

◆ APIMaxUncachedDiffs

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

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

Set this to 0 to disable API diffs altogether

Definition at line 11805 of file MainConfigSchema.php.

◆ APIMetaModules

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

API Query meta module extensions.

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

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

Definition at line 11753 of file MainConfigSchema.php.

◆ APIModules

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

API module extensions.

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

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

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

Examples for registering API modules:

$wgAPIModules['foo'] = 'ApiFoo';
$wgAPIModules['bar'] = [
'class' => ApiBar::class,
'factory' => function( $main, $name ) { ... }
];
$wgAPIModules['xyzzy'] = [
'class' => ApiXyzzy::class,
'factory' => [ XyzzyFactory::class, 'newApiModule' ]
];
$wgAPIModules
Config variable stub for the APIModules setting, for use by phpdoc and IDEs.

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

Definition at line 11727 of file MainConfigSchema.php.

◆ APIPropModules

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

API Query prop module extensions.

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

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

Definition at line 11766 of file MainConfigSchema.php.

◆ APIRequestLog

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

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

Definition at line 11823 of file MainConfigSchema.php.

◆ APIUselessQueryPages

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

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

Definition at line 11838 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 741 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 8286 of file MainConfigSchema.php.

◆ ArticleCountMethod

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

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

Redirect pages will never be counted as valid articles.

This variable can have the following values:

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

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

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

Definition at line 6558 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 518 of file MainConfigSchema.php.

◆ ArticleRobotPolicies

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

Robot policies per article.

These override the per-namespace robot policies.

Must be in the form of an array where the key part is a properly canonicalised text form title and the value is a robot policy.

Example:

'Main Page' => 'noindex,follow',
'User:Bob' => 'index,follow',
];
$wgArticleRobotPolicies
Config variable stub for the ArticleRobotPolicies setting, for use by phpdoc and IDEs.

Example that DOES NOT WORK because the names are not canonical text forms:

// Underscore, not space!
'Main_Page' => 'noindex,follow',
// "Project", not the actual project name!
'Project:X' => 'index,follow',
// Needs to be "Abc", not "abc" (unless $wgCapitalLinks is false for that namespace)!
'abc' => 'noindex,nofollow'
];

Definition at line 11647 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 270 of file MainConfigSchema.php.

◆ AsyncHTTPTimeout

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

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

Definition at line 12123 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 2030 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 7346 of file MainConfigSchema.php.

◆ AuthManagerAutoConfig

const MediaWiki\MainConfigSchema::AuthManagerAutoConfig
See also
$wgAuthManagerConfig
Since
1.27

Definition at line 6827 of file MainConfigSchema.php.

◆ AuthManagerConfig

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

Configure AuthManager.

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

Elements are:

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

Definition at line 6818 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 7461 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 7949 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 7964 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 7440 of file MainConfigSchema.php.

◆ AutoloadAttemptLowercase

const MediaWiki\MainConfigSchema::AutoloadAttemptLowercase
Initial value:
= [
'default' => false,
'deprecated' => 'since 1.35',
]

Switch controlling legacy case-insensitive classloading.

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

Deprecated
since 1.35

Definition at line 10871 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 8025 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 8055 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 8065 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 8116 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 507 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 7472 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 7490 of file MainConfigSchema.php.

◆ BlockDisablesLogin

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

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

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

Definition at line 7505 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 8717 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 8730 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 8794 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 5044 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 3655 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 4177 of file MainConfigSchema.php.

◆ CachePages

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

Allow client-side caching of pages.

Definition at line 4164 of file MainConfigSchema.php.

◆ CachePrefix

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

Overwrite the caching key prefix with custom value.

Since
1.19

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

◆ CacheVaryCookies

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

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

Definition at line 9095 of file MainConfigSchema.php.

◆ CanonicalNamespaceNames

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

Canonical namespace names.

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

Definition at line 5893 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 250 of file MainConfigSchema.php.

◆ CapitalLinkOverrides

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

Example:

const NS_FILE
Definition Defines.php:70
$wgCapitalLinkOverrides
Config variable stub for the CapitalLinkOverrides setting, for use by phpdoc and IDEs.

Definition at line 6022 of file MainConfigSchema.php.

◆ CapitalLinks

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

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

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

Definition at line 6004 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 7878 of file MainConfigSchema.php.

◆ CategoryCollation

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

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

A sorting scheme is also known as a collation.

Available values are:

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

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

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

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

Definition at line 11193 of file MainConfigSchema.php.

◆ CategoryMagicGallery

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

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

Definition at line 11156 of file MainConfigSchema.php.

◆ CategoryPagingLimit

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

Paging limit for categories.

Definition at line 11163 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 4543 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 4348 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 4358 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 4368 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 4397 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 4387 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 4420 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 4433 of file MainConfigSchema.php.

◆ CentralIdLookupProvider

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

Central ID lookup provider to use by default.

Definition at line 6685 of file MainConfigSchema.php.

◆ CentralIdLookupProviders

const MediaWiki\MainConfigSchema::CentralIdLookupProviders
Initial value:
= [
'default' => [
'local' => [
'class' => LocalIdLookup::class,
'services' => [
'MainConfig',
'DBLoadBalancer',
]
]
],
'type' => 'map',
]

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

Since
1.27

Definition at line 6669 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 6985 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 1656 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 4000 of file MainConfigSchema.php.

◆ CleanSignatures

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

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

Definition at line 6283 of file MainConfigSchema.php.

◆ CommandLineDarkBg

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

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

Definition at line 9905 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 3317 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 197 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 3236 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 3282 of file MainConfigSchema.php.

◆ ContentNamespaces

const MediaWiki\MainConfigSchema::ContentNamespaces
Initial value:
= [
'default' => [ NS_MAIN ],
'type' => 'list',
]
const NS_MAIN
Definition Defines.php:64

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

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

Definition at line 6056 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 8995 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 8977 of file MainConfigSchema.php.

◆ CookieHttpOnly

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

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

This can mitigates some classes of XSS attack.

Definition at line 9062 of file MainConfigSchema.php.

◆ CookiePath

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

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

Definition at line 9003 of file MainConfigSchema.php.

◆ CookiePrefix

const MediaWiki\MainConfigSchema::CookiePrefix
Initial value:
= [
'default' => false,
'dynamicDefault' => [
'use' => [ 'SharedDB', 'SharedPrefix', 'SharedTables', 'DBname', 'DBprefix' ]
],
]

Cookies generated by MediaWiki have names starting with this prefix.

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

Definition at line 9041 of file MainConfigSchema.php.

◆ CookieSameSite

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

The SameSite cookie attribute used for login cookies.

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

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

Since
1.35

Definition at line 9075 of file MainConfigSchema.php.

◆ CookieSecure

const MediaWiki\MainConfigSchema::CookieSecure
Initial value:
= [
'default' => 'detect',
'dynamicDefault' => [ 'use' => [ 'ForceHTTPS' ] ]
]

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

This can be:

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

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

Definition at line 9017 of file MainConfigSchema.php.

◆ CookieSetOnAutoblock

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

Whether to set a cookie when a user is autoblocked.

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

Definition at line 9114 of file MainConfigSchema.php.

◆ CookieSetOnIpBlock

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

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

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

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

◆ CountCategorizedImagesAsUsed

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

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

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

Definition at line 11538 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 3470 of file MainConfigSchema.php.

◆ CrossSiteAJAXdomainExceptions

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

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

Definition at line 11892 of file MainConfigSchema.php.

◆ CrossSiteAJAXdomains

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

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

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

  • '*' matches any number of characters
  • '?' matches any 1 character

Example:

'www.mediawiki.org',
'*.wikipedia.org',
'*.wikimedia.org',
'*.wiktionary.org',
];
$wgCrossSiteAJAXdomains
Config variable stub for the CrossSiteAJAXdomains setting, for use by phpdoc and IDEs.

Definition at line 11882 of file MainConfigSchema.php.

◆ CSPFalsePositiveUrls

const MediaWiki\MainConfigSchema::CSPFalsePositiveUrls
Initial value:
= [
'default' => [
'https://3hub.co' => true,
'https://morepro.info' => true,
'https://p.ato.mx' => true,
'https://s.ato.mx' => true,
'https://adserver.adtech.de' => true,
'https://ums.adtechus.com' => true,
'https://cas.criteo.com' => true,
'https://cat.nl.eu.criteo.com' => true,
'https://atpixel.alephd.com' => true,
'https://rtb.metrigo.com' => true,
'https://d5p.de17a.com' => true,
'https://ad.lkqd.net/vpaid/vpaid.js' => true,
'https://ad.lkqd.net/vpaid/vpaid.js?fusion=1.0' => true,
'https://t.lkqd.net/t' => true,
'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 8867 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 8843 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 8853 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 1827 of file MainConfigSchema.php.

◆ DatabaseReplicaLagCritical

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

Definition at line 3189 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 3181 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 3112 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 2882 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 2875 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 2868 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 2942 of file MainConfigSchema.php.

◆ DBerrorLog

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

File to log database errors to.

Definition at line 3119 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 3143 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 2797 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 2785 of file MainConfigSchema.php.

◆ DBpassword

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

Database user's password.

Definition at line 2838 of file MainConfigSchema.php.

◆ DBport

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

Database port number.

Definition at line 2824 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 2810 of file MainConfigSchema.php.

◆ DBserver

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

Database host name or IP address.

Definition at line 2817 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 3077 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 2856 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 2920 of file MainConfigSchema.php.

◆ DBtype

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

Database type.

Definition at line 2845 of file MainConfigSchema.php.

◆ DBuser

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

Database username.

Definition at line 2831 of file MainConfigSchema.php.

◆ DebugAPI

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

WARNING: SECURITY THREAT - debug use only.

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

Since
1.21

Definition at line 11688 of file MainConfigSchema.php.

◆ DebugComments

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

Send debug data to an HTML comment in the output.

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

Definition at line 9193 of file MainConfigSchema.php.

◆ DebugDumpSql

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

Write SQL queries to the debug log.

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

Definition at line 9204 of file MainConfigSchema.php.

◆ DebugLogFile

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

Enable verbose debug logging for all channels and log levels.

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

For static requests, this enables all channels and warning-level and above only. Use $wgDebugRawPage to make those verbose as well.

The debug log file should be not be web-accessible if it is used in a production environment, as may contain private data.

Definition at line 9147 of file MainConfigSchema.php.

◆ DebugLogGroups

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

Map of string log group names to log destinations.

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

Log destinations may be one of the following:

  • false to completely remove from the output, including from $wgDebugLogFile.
  • string values specifying a filename or URI.
  • associative array with keys:
    • 'destination' desired filename or URI.
    • 'sample' an integer value, specifying a sampling factor (optional)
    • 'level' A \Psr\Log\LogLevel constant, indicating the minimum level to log (optional, since 1.25)

Example:

$wgDebugLogGroups['redis'] = '/var/log/mediawiki/redis.log';
$wgDebugLogGroups
Config variable stub for the DebugLogGroups setting, for use by phpdoc and IDEs.

Advanced example:

$wgDebugLogGroups['memcached'] = [
'destination' => '/var/log/mediawiki/memcached.log',
'sample' => 1000, // log 1 message out of every 1,000.
'level' => \\Psr\\Log\\LogLevel::WARNING
];

Definition at line 9301 of file MainConfigSchema.php.

◆ DebugLogPrefix

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

Prefix for debug log lines.

Definition at line 9154 of file MainConfigSchema.php.

◆ DebugRawPage

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

If true, debug logging is also enabled for load.php and action=raw requests.

By default, $wgDebugLogFile enables all channels and warning-level and above for static requests.

This ensures that the debug log is likely a chronological record of of specific web request you are debugging, instead of overlapping with messages from static requests, which would make it unclear which message originated from what request.

Also, during development this can make browsing and JavaScript testing considerably slower (T85805).

Definition at line 9181 of file MainConfigSchema.php.

◆ DebugRedirects

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

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

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

Definition at line 9163 of file MainConfigSchema.php.

◆ DebugToolbar

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

Display the new debugging toolbar.

This also enables profiling on database queries and other useful output.

Will be ignored if $wgUseFileCache or $wgUseCdn is enabled.

Since
1.19

Definition at line 9614 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 3371 of file MainConfigSchema.php.

◆ DefaultLanguageVariant

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

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

Definition at line 4753 of file MainConfigSchema.php.

◆ DefaultRobotPolicy

const MediaWiki\MainConfigSchema::DefaultRobotPolicy
Initial value:
= [
'default' => 'index,follow',
]

Default robot policy.

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

Definition at line 11594 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 5066 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 7224 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 8134 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 8125 of file MainConfigSchema.php.

◆ DeprecationReleaseLimit

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

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

Definition at line 9406 of file MainConfigSchema.php.

◆ DevelopmentWarnings

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

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

Definition at line 9397 of file MainConfigSchema.php.

◆ Diff

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

Path to the GNU diff utility.

Definition at line 9861 of file MainConfigSchema.php.

◆ Diff3

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

Path to the GNU diff3 utility.

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

Definition at line 9854 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 3410 of file MainConfigSchema.php.

◆ DirectoryMode

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

Default value for chmoding of new directories.

Definition at line 2411 of file MainConfigSchema.php.

◆ DisableAnonTalk

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

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

Definition at line 10321 of file MainConfigSchema.php.

◆ DisableCookieCheck

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

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

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

Definition at line 9032 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 4775 of file MainConfigSchema.php.

◆ DisableHardRedirects

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

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

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

Definition at line 6111 of file MainConfigSchema.php.

◆ DisableInternalSearch

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

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

Definition at line 9740 of file MainConfigSchema.php.

◆ DisableLangConversion

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

Whether to enable language variant conversion.

Definition at line 4739 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 5097 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 3485 of file MainConfigSchema.php.

◆ DisableQueryPageUpdate

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

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

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

Definition at line 11530 of file MainConfigSchema.php.

◆ DisableSearchUpdate

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

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

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

Definition at line 9717 of file MainConfigSchema.php.

◆ DisableTextSearch

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

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

Definition at line 9627 of file MainConfigSchema.php.

◆ DisableTitleConversion

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

Whether to enable language variant conversion for links.

Definition at line 4746 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 1676 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 2454 of file MainConfigSchema.php.

◆ DjvuOutputExtension

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

File extension for the DJVU post processor output.

Definition at line 2492 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 2484 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 2464 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 2474 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 8241 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 4674 of file MainConfigSchema.php.

◆ Edititis

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

Display user edit counts in various prominent places.

Definition at line 5211 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 8817 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 4996 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 2680 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 7577 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 2509 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.

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

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

◆ EnableBotPasswords

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

Definition at line 8707 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 5250 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 8213 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 2539 of file MainConfigSchema.php.

◆ EnableImageWhitelist

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

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

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

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

Since
1.14

Definition at line 6323 of file MainConfigSchema.php.

◆ EnableJavaScriptTest

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

Allow running of QUnit tests via [[Special:JavaScriptTest]].

Definition at line 9593 of file MainConfigSchema.php.

◆ EnableMagicLinks

const MediaWiki\MainConfigSchema::EnableMagicLinks
Initial value:
= [
'default' => [
'ISBN' => false,
'PMID' => false,
'RFC' => false,
],
'type' => 'map',
]

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

Since
1.28

Definition at line 6527 of file MainConfigSchema.php.

◆ EnableOpenSearchSuggest

const MediaWiki\MainConfigSchema::EnableOpenSearchSuggest
Initial value:
= [
'default' => true,
'deprecated' => 'since 1.35 No longer used',
]

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

Deprecated
since 1.35 No longer used

Definition at line 9685 of file MainConfigSchema.php.

◆ EnableParserLimitReporting

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

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

Definition at line 10818 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 7514 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 4284 of file MainConfigSchema.php.

◆ EnableScaryTranscluding

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

Enable interwiki transcluding.

Only when iw_trans=1 in the interwiki table.

Definition at line 6508 of file MainConfigSchema.php.

◆ EnableSearchContributorsByIP

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

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

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

Definition at line 9801 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 4225 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 2559 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 865 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 2548 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 2568 of file MainConfigSchema.php.

◆ EnableWANCacheReaper

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

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

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

Since
1.29

Definition at line 3910 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 2669 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 2743 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 2751 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 2732 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 2714 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 2758 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 2698 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 2687 of file MainConfigSchema.php.

◆ EventRelayerConfig

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

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

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

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

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

Since
1.27

Definition at line 12309 of file MainConfigSchema.php.

◆ ExemptFromUserRobotsControl

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

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

If set to null, default to $wgContentNamespaces.

Example:

const NS_TALK
Definition Defines.php:65
const NS_PROJECT
Definition Defines.php:68
$wgExemptFromUserRobotsControl
Config variable stub for the ExemptFromUserRobotsControl setting, for use by phpdoc and IDEs.

Definition at line 11663 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 1887 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 1878 of file MainConfigSchema.php.

◆ ExpensiveParserFunctionLimit

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

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

Definition at line 6493 of file MainConfigSchema.php.

◆ ExperiencedUserEdits

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

Number of edits the user must have before becoming "experienced".

See also
$wgLearnerEdits

Definition at line 6604 of file MainConfigSchema.php.

◆ ExperiencedUserMemberSince

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

Number of days the user must exist before becoming "experienced".

See also
$wgLearnerEdits

Definition at line 6613 of file MainConfigSchema.php.

◆ ExportAllowAll

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

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

Definition at line 10650 of file MainConfigSchema.php.

◆ ExportAllowHistory

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

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

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

Definition at line 10605 of file MainConfigSchema.php.

◆ ExportAllowListContributors

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

Return distinct author list (when not returning full history)

Definition at line 10621 of file MainConfigSchema.php.

◆ ExportFromNamespaces

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

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

Definition at line 10643 of file MainConfigSchema.php.

◆ ExportMaxHistory

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

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

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

Definition at line 10614 of file MainConfigSchema.php.

◆ ExportMaxLinkDepth

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

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

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

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

Definition at line 10636 of file MainConfigSchema.php.

◆ ExportPagelistLimit

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

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

Since
1.27

Definition at line 10660 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 8987 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 461 of file MainConfigSchema.php.

◆ ExtensionCredits

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

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

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

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

$wgExtensionCredits['other'][] = [
'path' => __FILE__,
'name' => 'Example extension',
'namemsg' => 'exampleextension-name',
'author' => [
'Foo Barstein',
],
'version' => '0.0.1',
'url' => 'https://example.org/example-extension/',
'descriptionmsg' => 'exampleextension-desc',
'license-name' => 'GPL-2.0-or-later',
];
$wgExtensionCredits
Config variable stub for the ExtensionCredits setting, for use by phpdoc and IDEs.

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

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

Definition at line 10934 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 481 of file MainConfigSchema.php.

◆ ExtensionEntryPointListFiles

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

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

Since
1.22

Definition at line 10789 of file MainConfigSchema.php.

◆ ExtensionFunctions

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

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

Definition at line 10713 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 4273 of file MainConfigSchema.php.

◆ ExtensionMessagesFiles

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

Extension messages files.

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

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

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

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

Example:

$wgExtensionMessagesFiles['ConfirmEdit'] = __DIR__.'/ConfirmEdit.i18n.php';
$wgExtensionMessagesFiles
Config variable stub for the ExtensionMessagesFiles setting, for use by phpdoc and IDEs.

Definition at line 10745 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 3418 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 5143 of file MainConfigSchema.php.

◆ ExternalLinkTarget

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

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

_blank to pop up a new window.

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

Definition at line 6423 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 3354 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 3330 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 5937 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 4618 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 4657 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 4638 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 5924 of file MainConfigSchema.php.

◆ ExtraSignatureNamespaces

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

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

This determines whether to display the Signature button on the edit toolbar, and may also be used by extensions.

For example, "traditional" style wikis, where content and discussion are intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.

Definition at line 6082 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 5075 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 730 of file MainConfigSchema.php.

◆ FeaturePolicyReportOnly

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

List of Feature Policy Reporting types to enable.

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

Warning
EXPERIMENTAL!
Since
1.34

Definition at line 12378 of file MainConfigSchema.php.

◆ Feed

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

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

Definition at line 10210 of file MainConfigSchema.php.

◆ FeedCacheTimeout

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

Minimum timeout for cached Recentchanges feed, in seconds.

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

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

Definition at line 10231 of file MainConfigSchema.php.

◆ FeedClasses

const MediaWiki\MainConfigSchema::FeedClasses
Initial value:
= [
'default' => [
'rss' => 'RSSFeed',
'atom' => 'AtomFeed',
],
'type' => 'map',
]

Available feeds objects.

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

Definition at line 10269 of file MainConfigSchema.php.

◆ FeedDiffCutoff

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

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

Definition at line 10239 of file MainConfigSchema.php.

◆ FeedLimit

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

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

Definition at line 10218 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 4204 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 600 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.

◆ FilterLogTypes

const MediaWiki\MainConfigSchema::FilterLogTypes
Initial value:
= [
'default' => [
'patrol' => true,
'tag' => true,
'newusers' => false,
],
'type' => 'map',
]

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

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

See $wgLogTypes for a list of available log types.

Example:

‘$wgFilterLogTypes = [ 'move’ => true, 'import' => false ];`

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

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

Definition at line 11299 of file MainConfigSchema.php.

◆ FixDoubleRedirects

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

Fix double redirects after a page move.

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

Definition at line 6120 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 5178 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 3623 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 4406 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 306 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 4831 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 5130 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 2394 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 2069 of file MainConfigSchema.php.

◆ GitBin

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

Fully specified path to git binary.

Definition at line 9968 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 4185 of file MainConfigSchema.php.

◆ GitRepositoryViewers

const MediaWiki\MainConfigSchema::GitRepositoryViewers
Initial value:
= [
'default' => [
'https://(?:[a-z0-9_]+@)?gerrit.wikimedia.org/r/(?:p/)?(.*)' => 'https://gerrit.wikimedia.org/g/%R/+/%H',
'ssh://(?:[a-z0-9_]+@)?gerrit.wikimedia.org:29418/(.*)' => 'https://gerrit.wikimedia.org/g/%R/+/%H',
],
'type' => 'map',
]

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

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

Since
1.20

Definition at line 9985 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 4585 of file MainConfigSchema.php.

◆ GrantPermissionGroups

const MediaWiki\MainConfigSchema::GrantPermissionGroups
Since
1.27

Definition at line 8661 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 8479 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 7789 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 7613 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:92

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

◆ GroupsRemoveFromSelf

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

Definition at line 7835 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 7297 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 7585 of file MainConfigSchema.php.

◆ HideInterlanguageLinks

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

Hide interlanguage links from the sidebar.

Definition at line 4600 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 8147 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 8964 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 8952 of file MainConfigSchema.php.

◆ Hooks

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

Global list of hooks.

The key is one of the events made available by MediaWiki, you can find a description for most of them in their respective hook interfaces. For overview of the hook system see docs/Hooks.md. The array is used internally by HookContainer::run().

The value can be one of:

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

Definition at line 10968 of file MainConfigSchema.php.

◆ HTCPMulticastTTL

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

HTCP multicast TTL.

See also
$wgHTCPRouting

Definition at line 4521 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 4511 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 4960 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 4973 of file MainConfigSchema.php.

◆ HTTPConnectTimeout

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

Timeout for connections done internally (in seconds).

Only supported if cURL is installed, ignored otherwise.

Since
1.22

Definition at line 12082 of file MainConfigSchema.php.

◆ HTTPImportTimeout

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

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

Since
1.29

Definition at line 12116 of file MainConfigSchema.php.

◆ HTTPMaxConnectTimeout

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

The maximum HTTP connect timeout in seconds.

If any specified or configured connect timeout is larger than this, then this value will be used instead. Zero is interpreted as "no limit".

Since
1.35

Definition at line 12106 of file MainConfigSchema.php.

◆ HTTPMaxTimeout

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

The maximum HTTP request timeout in seconds.

If any specified or configured request timeout is larger than this, then this value will be used instead. Zero is interpreted as "no limit".

Since
1.35

Definition at line 12094 of file MainConfigSchema.php.

◆ HTTPProxy

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

Proxy to use for CURL requests.

Definition at line 12130 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 285 of file MainConfigSchema.php.

◆ HTTPTimeout

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

Timeout for HTTP requests done internally, in seconds.

Since
1.5

Definition at line 12070 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 2045 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 2256 of file MainConfigSchema.php.

◆ ImageMagickConvertCommand

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

The convert command shipped with ImageMagick.

Definition at line 1779 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 1811 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 2441 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 565 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 7798 of file MainConfigSchema.php.

◆ ImportSources

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

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

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

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

'wikipedia' => [ 'cs', 'en', 'fr', 'zh' ],
'wikispecies',
'wikia' => [ 'animanga', 'brickipedia', 'desserts' ],
];
$wgImportSources
Config variable stub for the ImportSources setting, for use by phpdoc and IDEs.

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

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

Definition at line 10582 of file MainConfigSchema.php.

◆ ImportTargetNamespace

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

Optional default target namespace for interwiki imports.

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

Users may override this in the Special:Import dialog.

Definition at line 10595 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 4630 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 4335 of file MainConfigSchema.php.

◆ InterwikiCache

const MediaWiki\MainConfigSchema::InterwikiCache
Initial value:
= [
'default' => false,
'type' => 'false|map|string',
'mergeStrategy' => 'replace',
]

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

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

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

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

Definition at line 6164 of file MainConfigSchema.php.

◆ InterwikiExpiry

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

Expiry time for cache of interwiki table.

Definition at line 6144 of file MainConfigSchema.php.

◆ InterwikiFallbackSite

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

Fallback site, if unable to resolve from cache.

Definition at line 6184 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 4593 of file MainConfigSchema.php.

◆ InterwikiScopes

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

Specify number of domains to check for messages.

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

Definition at line 6177 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 4255 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 7044 of file MainConfigSchema.php.

◆ InvalidRedirectTargets

const MediaWiki\MainConfigSchema::InvalidRedirectTargets
Initial value:
= [
'default' => [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect' ],
'type' => 'list',
]

Array of invalid page redirect targets.

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

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

Definition at line 6098 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 7308 of file MainConfigSchema.php.

◆ JobBackoffThrottling

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

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

The meaning of "work items" varies per job, but typically would be something like "pages to update". A single job may have a variable number of work items, as is the case with batch jobs.

This is used by runJobs.php and not jobs run via $wgJobRunRate. These settings should be global to all wikis.

Definition at line 11055 of file MainConfigSchema.php.

◆ JobClasses

const MediaWiki\MainConfigSchema::JobClasses
Initial value:
= [
'default' => [
'deletePage' => DeletePageJob::class,
'refreshLinks' => RefreshLinksJob::class,
'deleteLinks' => DeleteLinksJob::class,
'htmlCacheUpdate' => HTMLCacheUpdateJob::class,
'sendMail' => EmaillingJob::class,
'enotifNotify' => EnotifNotifyJob::class,
'fixDoubleRedirect' => DoubleRedirectJob::class,
'AssembleUploadChunks' => AssembleUploadChunksJob::class,
'PublishStashedFile' => PublishStashedFileJob::class,
'ThumbnailRender' => ThumbnailRenderJob::class,
'recentChangesUpdate' => RecentChangesUpdateJob::class,
'refreshLinksPrioritized' => RefreshLinksJob::class,
'refreshLinksDynamic' => RefreshLinksJob::class,
'activityUpdateJob' => ActivityUpdateJob::class,
'categoryMembershipChange' => CategoryMembershipChangeJob::class,
'clearUserWatchlist' => ClearUserWatchlistJob::class,
'watchlistExpiry' => WatchlistExpiryJob::class,
'cdnPurge' => CdnPurgeJob::class,
'userGroupExpiry' => UserGroupExpiryJob::class,
'clearWatchlistNotifications' => ClearWatchlistNotificationsJob::class,
'userOptionsUpdate' => UserOptionsUpdateJob::class,
'revertedTagUpdate' => RevertedTagUpdateJob::class,
'enqueue' => EnqueueJob::class,
'null' => NullJob::class,
'userEditCountInit' => UserEditCountInitJob::class,
],
'type' => 'map',
]

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

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

Definition at line 10999 of file MainConfigSchema.php.

◆ JobQueueIncludeInMaxLagFactor

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

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

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

Since
1.29

Definition at line 11117 of file MainConfigSchema.php.

◆ JobRunRate

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

Number of jobs to perform per request.

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

Definition at line 12191 of file MainConfigSchema.php.

◆ JobSerialCommitThreshold

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

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

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

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

Since
1.26

Definition at line 11074 of file MainConfigSchema.php.

◆ JobTypeConf

const MediaWiki\MainConfigSchema::JobTypeConf
Initial value:
= [
'default' => [
'default' => [
'class' => JobQueueDB::class,
'order' => 'random',
'claimTTL' => 3600
],
],
'additionalProperties' => [
'type' => 'object',
'properties' => [
'class' => [ 'type' => 'string' ],
'order' => [ 'type' => 'string' ],
'claimTTL' => [ 'type' => 'int' ]
],
],
'type' => 'map',
]

Map of job types to configuration arrays.

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

Definition at line 11086 of file MainConfigSchema.php.

◆ JobTypesExcludedFromDefaultQueue

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

Jobs that must be explicitly requested, i.e.

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

These can be:

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

Definition at line 11041 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 1859 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 1870 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 1836 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 4570 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 3719 of file MainConfigSchema.php.

◆ LBFactoryConf

const MediaWiki\MainConfigSchema::LBFactoryConf
Initial value: