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	DjvuUseBoxedCommand
	Whether to use BoxedCommand or not.

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

const	Wikidiff2Options
	Options for wikidiff2:

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	PoolCountClientConf
	Configuration array for the PoolCounter client.

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 page content HTML (e.g.

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	ObjectCaches
	Advanced object cache configuration.

const	WANObjectCache
	Extra parameters to the WANObjectCache constructor.

const	MicroStashType
	The stash store backend for MicroStash.

const	MainStash
	The object store type of the main stash.

const	ParsoidCacheConfig
	Configuration for the caching related to parsoid output.

const	ParserCacheFilterConfig
	Per-namespace configuration for the ParserCache filter.

const	ChronologyProtectorStash
	The object store type for the `ChronologyProtector` store.

const	ChronologyProtectorSecret
	Secret string for HMAC hashing in ChronologyProtector [optional].

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	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	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 the ability of certain 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.

const	InterwikiLogoOverride
	List of interwiki logos overrides.

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 as an associative array.

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	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
	Enable shipping the styles for the media HTML structure that replaces legacy, when $wgParserEnableLegacyMediaDOM is `false`.

const	UseLegacyMediaStyles
	Disable shipping the styles for the legacy media HTML structure that has been replaced 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	UserRegistrationProviders
	User registration timestamp provider classes.

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	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	ConditionalUserOptions
	Conditional defaults for user options.

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
	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, sitewide blocked users will not be allowed to login.

const	EnablePartialActionBlocks
	Flag to enable partial blocks against performing certain actions.

const	EnableMultiBlocks
	If this is false, the number of blocks of a given target is limited to only 1.

const	BlockTargetMigrationStage
	Ipblocks table schema migration stage, for normalizing ipb_address field and adding the block_target table.

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	ImplicitRights
	A list of implicit 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	TempAccountCreationThrottle
	Number of temporary accounts each IP address may create per specified period(s).

const	TempAccountNameAcquisitionThrottle
	Number of temporary accounts usernames each IP address may acquire 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
	Grant groups are used on some user interfaces to display conceptually similar grants together.

const	GrantRiskGroups
	Group grants by risk level.

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.

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	StatsTarget
	Stats output target URI e.g.

const	StatsFormat
	Stats output format.

const	StatsPrefix
	Stats service name prefix.

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

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	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
	A directory that contains site-specific configuration files.

const	WikiFarmSettingsExtension
	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	TranslationAliasesDirs
	Message directories containing JSON files for localisation of special page aliases.

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

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
	Obsolete switch that controlled 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	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 class names or ObjectFactory specifications, 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	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	ShellboxUrls
	Shell commands can be run on a remote server using Shellbox.

const	ShellboxSecretKey
	The secret key for HMAC verification of Shellbox requests.

const	ShellboxShell
	The POSIX-compatible shell to use when running scripts.

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.

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.

const	SpecialContributeSkinsEnabled
	List of skins to not show the Special:Contribute page.

const	EnableEditRecovery
	Whether to enable the client-side edit recovery feature.

const	EditRecoveryExpiry
	Number of seconds to keep edit recovery data after the edit is stored.

const	UseCodexSpecialBlock
	Whether to use Codex in Special:Block form.

const	ShowLogoutConfirmation
	Whether to display a confirmation screen during user log out.

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	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
	When enabled, the domain root will show the wiki's main page, instead of redirecting to the main page.

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	EnableAsyncUploadsByURL
	Enable the async processing of upload by url in Special:Upload.

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	SVGNativeRendering
	Whether native rendering by the browser agent is allowed.

const	SVGNativeRenderingSizeLimit
	Filesize limit for allowing SVGs to render natively by the browser agent.

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	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	ThumbnailNamespaces
	Defines what namespaces thumbnails will be displayed for in Special:Search.

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 chmod-ing 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	DBStrictWarnings
	Check for warnings after DB queries and throw an exception if an unacceptable warning is detected.

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
	Configuration for the ILBFactory service.

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	VirtualDomainsMapping
	Mapping of virtual domain to external cluster db.

const	TemplateLinksSchemaMigrationStage
	Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields.

const	PageLinksSchemaMigrationStage
	Pagelinks table schema migration stage, for normalizing pl_namespace and pl_title fields.

const	ExternalLinksDomainGaps
	Gaps in the externallinks table for certain domains.

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.

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	UseXssLanguage
	Whether to enable the 'x-xss' language code, used for development.

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
	Validate JavaScript code loaded from wiki pages.

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	ResourceLoaderEnableSourceMapLinks
	Whether to include a SourceMap header in ResourceLoader responses for JavaScript modules.

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	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	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:

mergeStrategy: see the \\MediaWiki\\Settings\\Config\\MergeStrategy.
dynamicDefault: Specified a callback that computes the effective default at runtime, based on the value of other config variables or on the system environment. See \\MediaWiki\\Settings\\Source\\ReflectionSchemaSource and \\MediaWiki\\Settings\\DynamicDefaultValues for details.

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

Member Function Documentation

◆ getDefaultArticlePath()

static MediaWiki\MainConfigSchema::getDefaultArticlePath	(	string	$script,
			$usePathInfo )

static

Parameters

string	$script	Value of Script
mixed	$usePathInfo	Value of UsePathInfo

Returns: string

Definition at line 536 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 9455 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 9439 of file MainConfigSchema.php.

◆ getDefaultDBerrorLogTZ()

static MediaWiki\MainConfigSchema::getDefaultDBerrorLogTZ ( $localtimezone )

static

Current wiki database name.

This should only contain alphanumeric and underscore characters ([A-Za-z0-9_]+). Spaces, quotes, backticks, dots, and hyphens are likely to be problematic.

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

◆ getDefaultDeletedDirectory()

static MediaWiki\MainConfigSchema::getDefaultDeletedDirectory ( $uploadDirectory )

static

Parameters

mixed $uploadDirectory Value of UploadDirectory

Returns: string

Definition at line 901 of file MainConfigSchema.php.

◆ getDefaultExtensionAssetsPath()

static MediaWiki\MainConfigSchema::getDefaultExtensionAssetsPath ( $resourceBasePath )

static

Parameters

mixed $resourceBasePath Value of ResourceBasePath

Returns: string

Definition at line 478 of file MainConfigSchema.php.

◆ getDefaultFileCacheDirectory()

static MediaWiki\MainConfigSchema::getDefaultFileCacheDirectory ( $uploadDirectory )

static

Parameters

mixed $uploadDirectory Value of UploadDirectory

Returns: string

Definition at line 617 of file MainConfigSchema.php.

◆ getDefaultLoadScript()

static MediaWiki\MainConfigSchema::getDefaultLoadScript ( $scriptPath )

static

Parameters

mixed $scriptPath Value of ScriptPath

Returns: string

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

◆ getDefaultLocalStylePath()

static MediaWiki\MainConfigSchema::getDefaultLocalStylePath ( $scriptPath )

static

Parameters

mixed $scriptPath Value of ScriptPath

Returns: string

Definition at line 457 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 5058 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 5084 of file MainConfigSchema.php.

◆ getDefaultLogo()

static MediaWiki\MainConfigSchema::getDefaultLogo ( $resourceBasePath )

static

Parameters

mixed $resourceBasePath Value of ResourceBasePath

Returns: string

Definition at line 638 of file MainConfigSchema.php.

◆ getDefaultMetaNamespace()

static MediaWiki\MainConfigSchema::getDefaultMetaNamespace ( $sitename )

static

Parameters

mixed $sitename Value of Sitename

Returns: string

Definition at line 6036 of file MainConfigSchema.php.

◆ getDefaultReadOnlyFile()

static MediaWiki\MainConfigSchema::getDefaultReadOnlyFile ( $uploadDirectory )

static

Parameters

mixed $uploadDirectory Value of UploadDirectory

Returns: string

Definition at line 10310 of file MainConfigSchema.php.

◆ getDefaultResourceBasePath()

static MediaWiki\MainConfigSchema::getDefaultResourceBasePath ( $scriptPath )

static

Parameters

mixed $scriptPath Value of ScriptPath

Returns: string

Definition at line 5877 of file MainConfigSchema.php.

◆ getDefaultRestPath()

static MediaWiki\MainConfigSchema::getDefaultRestPath ( $scriptPath )

static

Parameters

mixed $scriptPath Value of ScriptPath

Returns: string

Definition at line 417 of file MainConfigSchema.php.

◆ getDefaultScript()

static MediaWiki\MainConfigSchema::getDefaultScript ( $scriptPath )

static

Parameters

mixed $scriptPath Value of ScriptPath

Returns: string

Definition at line 378 of file MainConfigSchema.php.

◆ getDefaultSharedPrefix()

static MediaWiki\MainConfigSchema::getDefaultSharedPrefix ( $dbPrefix )

static

Parameters

mixed $dbPrefix Value of DBprefix

Returns: mixed

Definition at line 3032 of file MainConfigSchema.php.

◆ getDefaultSharedSchema()

static MediaWiki\MainConfigSchema::getDefaultSharedSchema ( $dbMwschema )

static

Parameters

mixed $dbMwschema Value of DBmwschema

Returns: mixed

Definition at line 3062 of file MainConfigSchema.php.

◆ getDefaultShowEXIF()

static MediaWiki\MainConfigSchema::getDefaultShowEXIF ( )

static

Returns: bool

Definition at line 1390 of file MainConfigSchema.php.

◆ getDefaultStylePath()

static MediaWiki\MainConfigSchema::getDefaultStylePath ( $resourceBasePath )

static

Parameters

mixed $resourceBasePath Value of ResourceBasePath

Returns: string

Definition at line 437 of file MainConfigSchema.php.

◆ getDefaultUploadDirectory()

static MediaWiki\MainConfigSchema::getDefaultUploadDirectory ( $baseDirectory )

static

Parameters

mixed $baseDirectory Value of BaseDirectory

Returns: string

Definition at line 599 of file MainConfigSchema.php.

◆ getDefaultUploadPath()

static MediaWiki\MainConfigSchema::getDefaultUploadPath ( $scriptPath )

static

Parameters

mixed $scriptPath Value of ScriptPath

Returns: string

Definition at line 557 of file MainConfigSchema.php.

◆ getDefaultUsePathInfo()

static MediaWiki\MainConfigSchema::getDefaultUsePathInfo ( )

static

Returns: bool

Definition at line 354 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 $name The 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 182 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 $prefix A 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 147 of file MainConfigSchema.php.

Referenced by MediaWiki\Installer\Installer\getExistingLocalSettings(), and MediaWiki\Installer\Installer\includeExtensionFiles().

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:

$wgAccountCreationThrottle = [
 // no more than 100 per month
 [
  'count' => 100,
  'seconds' => 30*86400,
 ],
 // no more than 10 per day
 [
  'count' => 10,
  'seconds' => 86400,
 ],
];

Note: For backwards compatibility reasons, this may also be given as a single integer, representing the number of account creations per day.

See also: self::TempAccountCreationThrottle for the temporary accounts version of this throttle

Warning: Requires $wgMainCacheType to be enabled

Definition at line 8464 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 11834 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 805 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 corresponding handler code. See ActionFactory for the syntax. Core defaults are in ActionFactory::CORE_ACTIONS, anything here overrides that.

Definition at line 11980 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 6743 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 4283 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.

Definition config-vars.php:2850

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.

Definition config-vars.php:2856

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 8360 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 2669 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 10011 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 10643 of file MainConfigSchema.php.

◆ AjaxLicensePreview

const MediaWiki\MainConfigSchema::AjaxLicensePreview

Initial value:

= [
        'default' => true,
    ]

Enable previewing licences via AJAX.

Definition at line 12252 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 1407 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 9312 of file MainConfigSchema.php.

◆ AllowDisplayTitle

const MediaWiki\MainConfigSchema::AllowDisplayTitle

Initial value:

= [
        'default' => true,
    ]

Allow DISPLAYTITLE to change title display.

Definition at line 6649 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 12296 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 6461 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 config-vars.php:2326

Definition at line 6479 of file MainConfigSchema.php.

◆ AllowExternalReqID

const MediaWiki\MainConfigSchema::AllowExternalReqID

Initial value:

= [
        'default' => false,
    ]

Whether to respect/honour.

request ID provided by the incoming request via the X-Request-Id
trace context provided by the incoming request via the tracestate and traceparent

Set to true if the entity sitting in front of MediaWiki sanitises external requests.

Default: false.

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

◆ AllowRequiringEmailForResets

const MediaWiki\MainConfigSchema::AllowRequiringEmailForResets

Initial value:

= [
        'default' => false,
    ]

Whether users will see a checkbox allowing them to require providing email during password resets.

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

Definition at line 7606 of file MainConfigSchema.php.

◆ AllowSchemaUpdates

const MediaWiki\MainConfigSchema::AllowSchemaUpdates

Initial value:

= [
        'default' => true,
    ]

Allow schema updates.

Definition at line 3638 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: self::ReauthenticateTime

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

◆ AllowSlowParserFunctions

const MediaWiki\MainConfigSchema::AllowSlowParserFunctions

Initial value:

= [
        'default' => false,
    ]

Enable slow parser functions.

Definition at line 3631 of file MainConfigSchema.php.

◆ AllowSpecialInclusion

const MediaWiki\MainConfigSchema::AllowSpecialInclusion

Initial value:

= [
        'default' => true,
    ]

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

Definition at line 11923 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 9177 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 9187 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 9168 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 4837 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 4859 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 2103 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 2163 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',
    ]

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 2143 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 12233 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 12143 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 9247 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 12182 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 12191 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 12218 of file MainConfigSchema.php.

◆ APIMaxResultSize

const MediaWiki\MainConfigSchema::APIMaxResultSize

Initial value:

= [
        'default' => 8_388_608,
    ]

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

Warning: Do not set this lower than $wgMaxArticleSize*1024

Definition at line 12200 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 12208 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 12156 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' ]
];

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

Definition at line 12130 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 12169 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 12226 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 12241 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 712 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 8650 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

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 6731 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 526 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:

$wgArticleRobotPolicies = [
        'Main Page' => 'noindex,follow',
        'User:Bob' => 'index,follow',
];

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

$wgArticleRobotPolicies = [
  // 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 12050 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 278 of file MainConfigSchema.php.

◆ AsyncHTTPTimeout

const MediaWiki\MainConfigSchema::AsyncHTTPTimeout

Initial value:

= [
        'default' => 25,
    ]

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

Definition at line 12525 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 2037 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 7565 of file MainConfigSchema.php.

◆ AuthManagerAutoConfig

const MediaWiki\MainConfigSchema::AuthManagerAutoConfig

See also: self::AuthManagerConfig

Since: 1.27

Definition at line 7017 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 7008 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 7696 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.

Definition config-vars.php:2820

Set age to one day:

$wgAutoConfirmAge = 3600*24; // one day

Definition at line 8211 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 = 50;

$wgAutoConfirmCount

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

Definition config-vars.php:2826

Definition at line 8226 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' => '~$1' ],
            'matchPattern' => [ 'type' => 'string|array|null', 'default' => null ],
            'reservedPattern' => [ 'type' => 'string|null', 'default' => '~$1' ],
            'serialProvider' => [ 'type' => 'object', 'default' => [ 'type' => 'local', 'useYear' => true ] ],
            'serialMapping' => [ 'type' => 'object', 'default' => [ 'type' => 'plain-numeric' ] ],
            'expireAfterDays' => [ 'type' => 'int|null', 'default' => 365 ],
            'notifyBeforeExpirationDays' => [ 'type' => 'int|null', 'default' => 10 ],
        ],
        '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.

Warning: This is 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|string[]|null) 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. This is ignored if "enabled" is false. If the value is null, the the genPattern value is used as the matchPattern.
reservedPattern: (string) A pattern used to determine whether a username should be denied for explicit creation, in addition to matchPattern. This is used even if "enabled" is false.
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.
- useYear: (bool) Restart at 1 each time the year changes (in UTC). To avoid naming conflicts, the year is included in the name after the prefix, in the form 'YYYY-'.
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.
- offset: (int) With "plain-numeric", a constant to add to the stored index.

expireAfterDays: (int|null, default 365) If not null, how many days should the temporary accounts expire? Requires expireTemporaryAccounts.php to be periodically executed in order to work.

notifyBeforeExpirationDays: (int|null, default 10) If not null, how many days before the expiration of a temporary account should it be notified that their account is to be expired.

Stability: unstable: EXPERIMENTAL

Since: 1.39

Definition at line 7672 of file MainConfigSchema.php.

◆ AutoloadAttemptLowercase

const MediaWiki\MainConfigSchema::AutoloadAttemptLowercase

Initial value:

= [
        'default' => false,
        'obsolete' => 'Since 1.40; no longer has any effect.',
        'description' => 'Has been emitting warnings since 1.39 (LTS). ' .
            'Can be removed completely in 1.44, assuming 1.43 is an LTS release.'
    ]

Obsolete switch that controlled legacy case-insensitive classloading.

Case-insensitive classloading was needed for loading data that had been serialized by PHP 4 with the class names converted to lowercase. It is no longer necessary since 1.31; the lowercase forms in question are now listed in autoload.php (T166759).

Deprecated: since 1.35

Definition at line 11243 of file MainConfigSchema.php.

◆ Autopromote

const MediaWiki\MainConfigSchema::Autopromote

Initial value:

= [
        'default' => [
            'autoconfirmed' => [ '&',
                [ APCOND_EDITCOUNT, null ], 
                [ APCOND_AGE, null ], 
            ],
        ],
        'type' => 'map',
    ]

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 8287 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: self::Autopromote

Since: 1.18

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

◆ AvailableRights

const MediaWiki\MainConfigSchema::AvailableRights

Initial value:

= [
        'default' => [],
        'type' => 'list',
        'items' => [ 'type' => 'string', ],
    ]

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

Rights in this list are denied unless explicitly granted, typically using GroupPermissions.

For extensions only.

See also: self::GroupPermissions; self::ImplicitRights

Definition at line 8383 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 515 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 7707 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 7725 of file MainConfigSchema.php.

◆ BlockDisablesLogin

const MediaWiki\MainConfigSchema::BlockDisablesLogin

Initial value:

= [
        'default' => false,
    ]

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

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

Definition at line 7738 of file MainConfigSchema.php.

◆ BlockTargetMigrationStage

const MediaWiki\MainConfigSchema::BlockTargetMigrationStage

Initial value:

= [
        'default' => SCHEMA_COMPAT_OLD,
        'type' => 'integer',
    ]

Ipblocks table schema migration stage, for normalizing ipb_address field and adding the block_target table.

Use the SCHEMA_COMPAT_XXX flags. Supported values:

SCHEMA_COMPAT_OLD
SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD
SCHEMA_COMPAT_NEW

History:

1.42: Added

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

Deprecated: since 1.42 Use $wgVirtualDomainsMapping instead.

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

Deprecated: since 1.42 Use $wgVirtualDomainsMapping instead.

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

◆ BrowserFormatDetection

const MediaWiki\MainConfigSchema::BrowserFormatDetection

Initial value:

= [
        'default' => 'telephone=no',
        'type' => 'string',
    ]

Override the ability of certain 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 the browser defaults.

Since: 1.37

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

Definition at line 5187 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 3810 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 4347 of file MainConfigSchema.php.

◆ CachePages

const MediaWiki\MainConfigSchema::CachePages

Initial value:

= [
        'default' => true,
    ]

Allow client-side caching of pages.

Definition at line 4334 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 9978 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 1251 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 9490 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 6057 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 258 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:

$wgCapitalLinkOverrides[ NS_FILE ] = false;

NS_FILE

const NS_FILE

Definition Defines.php:70

$wgCapitalLinkOverrides

Config variable stub for the CapitalLinkOverrides setting, for use by phpdoc and IDEs.

Definition config-vars.php:2194

Definition at line 6189 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 6171 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 8140 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 11592 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 11555 of file MainConfigSchema.php.

◆ CategoryPagingLimit

const MediaWiki\MainConfigSchema::CategoryPagingLimit

Initial value:

= [
        'default' => 200,
    ]

Paging limit for categories.

Definition at line 11562 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 4688 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 4518 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: self::CdnMaxAge

Since: 1.27

Definition at line 4528 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 4538 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: self::CdnMaxAge

Since: 1.27

Definition at line 4567 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 4557 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 4590 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 4603 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 6859 of file MainConfigSchema.php.

◆ CentralIdLookupProviders

const MediaWiki\MainConfigSchema::CentralIdLookupProviders

Initial value:

= [
        'default' => [
            'local' => [
                'class' => LocalIdLookup::class,
                'services' => [
                    'MainConfig',
                    'DBLoadBalancerFactory',
                    'HideUserUtils',
                ]
            ]
        ],
        'type' => 'map',
    ]

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

Since: 1.27

Definition at line 6842 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 7175 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 1637 of file MainConfigSchema.php.

◆ ChronologyProtectorSecret

const MediaWiki\MainConfigSchema::ChronologyProtectorSecret

Initial value:

= [
        'default' => '',
        'type' => 'string',
    ]

Secret string for HMAC hashing in ChronologyProtector [optional].

Since: 1.41

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

◆ CleanSignatures

const MediaWiki\MainConfigSchema::CleanSignatures

Initial value:

= [
        'default' => true,
    ]

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

Definition at line 6454 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 10267 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 3413 of file MainConfigSchema.php.

◆ ConditionalUserOptions

const MediaWiki\MainConfigSchema::ConditionalUserOptions

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Conditional defaults for user options.

Map of user options to conditional defaults descriptors, which is an array of conditional cases [ VALUE, CONDITION1, CONDITION2 ], where VALUE is the default value for all users that meet ALL conditions, and each CONDITION is either a: (a) a CUDCOND_* constant (when condition does not take any arguments), or (b) an array [ CUDCOND_*, argument1, argument1, ... ] (when chosen condition takes at least one argument).

When null is used as the VALUE, it is interpreted as "no conditional default for this condition". In other words, null and $wgDefaultUserOptions['user-option'] can be used interchangeably as the VALUE.

All conditions are evaluated in order. When no condition matches. $wgDefaultUserOptions is used instead.

Example of valid configuration: $wgConditionalUserOptions['user-option'] = [ [ 'registered in 2024', [ CUDCOND_AFTER, '20240101000000' ] ] ];

List of valid conditions:

CUDCOND_AFTER: user registered after given timestamp (args: string $timestamp)
CUDCOND_ANON: allows specifying a default for anonymous (logged-out, non-temporary) users
CUDCOND_NAMED: allows specifying a default for named (registered, non-temporary) users

Since: 1.42

See also: self::DefaultUserOptions

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

◆ ContentHandlers

const MediaWiki\MainConfigSchema::ContentHandlers

Initial value:

= [
        'default' =>
            [
                
                CONTENT_MODEL_WIKITEXT => [
                    'class' => WikitextContentHandler::class,
                    'services' => [
                        'TitleFactory',
                        'ParserFactory',
                        'GlobalIdGenerator',
                        'LanguageNameUtils',
                        'LinkRenderer',
                        'MagicWordFactory',
                        'ParsoidParserFactory',
                    ],
                ],
                
                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',
    ]

Plugins for page content model handling.

Each entry in the array maps a model id to an ObjectFactory specification that creates an instance of the appropriate ContentHandler subclass.

Since: 1.21

Definition at line 3337 of file MainConfigSchema.php.

◆ ContentNamespaces

const MediaWiki\MainConfigSchema::ContentNamespaces

Initial value:

= [
        'default' => [ NS_MAIN ],
        'type' => 'list',
    ]

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 6223 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 9412 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 9394 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 9469 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 9420 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 9448 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 9482 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 9434 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 9509 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 9520 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 1458 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 1435 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 1416 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 1426 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 1447 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 11941 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 3595 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 12288 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:

$wgCrossSiteAJAXdomains = [
    'www.mediawiki.org',
    '*.wikipedia.org',
    '*.wikimedia.org',
    '*.wiktionary.org',
];

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

◆ CSPHeader

const MediaWiki\MainConfigSchema::CSPHeader

Initial value:

= [
        'default' => false,
        'type' => 'false|object',
    ]

Controls Content-Security-Policy header.

Warning: May cause slowness on Windows due to slow random number generator.

Stability: unstable: EXPERIMENTAL

Since: 1.32

See also: https://www.w3.org/TR/CSP2/

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

Definition config-vars.php:573

Leave as false to skip this.

Definition at line 1808 of file MainConfigSchema.php.

◆ DatabaseReplicaLagCritical

const MediaWiki\MainConfigSchema::DatabaseReplicaLagCritical

Initial value:

= [
        'default' => 30,
    ]

See also: self::DatabaseReplicaLagWarning

Since: 1.36

Definition at line 3231 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 3223 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 3154 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 2925 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 2918 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 2896 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 2985 of file MainConfigSchema.php.

◆ DBerrorLog

const MediaWiki\MainConfigSchema::DBerrorLog

Initial value:

= [
        'default' => false,
    ]

File to log database errors to.

Definition at line 3161 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 = 'UTC';
$wgDBerrorLogTZ = 'GMT';
$wgDBerrorLogTZ = 'PST8PDT';
$wgDBerrorLogTZ = 'Europe/Sweden';
$wgDBerrorLogTZ = 'CET';

Since: 1.20

Definition at line 3185 of file MainConfigSchema.php.

◆ DBmwschema

const MediaWiki\MainConfigSchema::DBmwschema

Initial value:

= [
        'default' => null,
        'type' => '?string',
    ]

Current wiki database schema name.

This should only contain alphanumeric and underscore characters ([A-Za-z0-9_]+). Spaces, quotes, backticks, dots, and hyphens are likely to be problematic.

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

◆ DBname

const MediaWiki\MainConfigSchema::DBname

Initial value:

= [
        'default' => 'my_wiki',
    ]

Current wiki database name.

This should only contain alphanumeric and underscore characters ([A-Za-z0-9_]+). Spaces, quotes, backticks, dots, and hyphens are likely to be problematic.

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

◆ DBpassword

const MediaWiki\MainConfigSchema::DBpassword

Initial value:

= [
        'default' => '',
    ]

Database user's password.

Definition at line 2866 of file MainConfigSchema.php.

◆ DBport

const MediaWiki\MainConfigSchema::DBport

Initial value:

= [
        'default' => 5432,
    ]

Database port number.

Definition at line 2852 of file MainConfigSchema.php.

◆ DBprefix

const MediaWiki\MainConfigSchema::DBprefix

Initial value:

= [
        'default' => '',
    ]

Current wiki database table name prefix.

This should only contain alphanumeric and underscore characters ([A-Za-z0-9_]+). If it's a non-empty string, then it preferably should end with an underscore. Spaces, quotes, backticks, dots, and hyphens are especially likely to be problematic.

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

◆ DBserver

const MediaWiki\MainConfigSchema::DBserver

Initial value:

= [
        'default' => 'localhost',
    ]

Database host name or IP address.

Definition at line 2845 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: Transactional-ize 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: true if MW_ENTRY_POINT is 'cli', otherwise false]

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

◆ DBStrictWarnings

const MediaWiki\MainConfigSchema::DBStrictWarnings

Initial value:

= [
        'default' => false,
    ]

Check for warnings after DB queries and throw an exception if an unacceptable warning is detected.

This setting is only used if $wgLBFactoryConf['class'] is set to '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array. Otherwise, the 'strictWarnings' parameter of the server array must be set to achieve the same functionality.

Since: 1.42

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

◆ DBtype

const MediaWiki\MainConfigSchema::DBtype

Initial value:

= [
        'default' => 'mysql',
    ]

Database type.

Definition at line 2873 of file MainConfigSchema.php.

◆ DBuser

const MediaWiki\MainConfigSchema::DBuser

Initial value:

= [
        'default' => 'wikiuser',
    ]

Database username.

Definition at line 2859 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 12091 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 9588 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 9599 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 9542 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.

Definition config-vars.php:3246

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

◆ DebugLogPrefix

const MediaWiki\MainConfigSchema::DebugLogPrefix

Initial value:

= [
        'default' => '',
    ]

Prefix for debug log lines.

Definition at line 9549 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 9576 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 9558 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 9990 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 config-vars.php:1299

Definition at line 3467 of file MainConfigSchema.php.

◆ DefaultLanguageVariant

const MediaWiki\MainConfigSchema::DefaultLanguageVariant

Initial value:

= [
        'default' => false,
    ]

Default variant code.

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

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

◆ DefaultSkin

const MediaWiki\MainConfigSchema::DefaultSkin

Initial value:

= [
        'default' => 'vector-2022',
    ]

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 5209 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;

To save storage space, no user_properties row will be stored for users with the default setting for a given option, even if the user manually selects that option. This means that a change to the defaults will change the setting for all users who have been using the default setting; there is no way for users to opt out of this. $wgConditionalUserOptions can be used to change the default value for future users only.

See also: self::ConditionalUserOptions

Definition at line 7403 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 892 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 8421 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 8412 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 9801 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 9792 of file MainConfigSchema.php.

◆ Diff

const MediaWiki\MainConfigSchema::Diff

Initial value:

= [
        'default' => '/usr/bin/diff',
    ]

Path to the GNU diff utility.

Definition at line 10223 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 10216 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 3506 of file MainConfigSchema.php.

◆ DirectoryMode

const MediaWiki\MainConfigSchema::DirectoryMode

Initial value:

= [
        'default' => 0777, 
    ]

Default value for chmod-ing of new directories.

Definition at line 2416 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 10683 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 config-vars.php:1881

Definition at line 4928 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 6278 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 10102 of file MainConfigSchema.php.

◆ DisableLangConversion

const MediaWiki\MainConfigSchema::DisableLangConversion

Initial value:

= [
        'default' => false,
    ]

Whether to enable language variant conversion.

Definition at line 4890 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 5240 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 3610 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 a run mode like 'periodical' if a cronjob is set up.

Definition at line 11933 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 10079 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 10003 of file MainConfigSchema.php.

◆ DisableTitleConversion

const MediaWiki\MainConfigSchema::DisableTitleConversion

Initial value:

= [
        'default' => false,
    ]

Whether to enable language variant conversion for links.

Note that this option is slightly misnamed.

Definition at line 4898 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 1657 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';.

If this is set, self::ShellboxShell must be set to the correct shell path.

Definition at line 2472 of file MainConfigSchema.php.

◆ DjvuOutputExtension

const MediaWiki\MainConfigSchema::DjvuOutputExtension

Initial value:

= [
        'default' => 'jpg',
    ]

File extension for the DJVU post processor output.

Definition at line 2513 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 2505 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 2482 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';.

If this is set, self::ShellboxShell must be set to the correct shell path.

Definition at line 2495 of file MainConfigSchema.php.

◆ DjvuUseBoxedCommand

const MediaWiki\MainConfigSchema::DjvuUseBoxedCommand

Initial value:

= [
        'default' => false,
    ]

Whether to use BoxedCommand or not.

Stability: unstable: Temporary feature flag for T352515

Since: 1.42

Definition at line 2460 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:

$wgDnsBlacklistUrls = [
  // String containing URL
  'http.dnsbl.sorbs.net.',
  // Array with URL and key, for services that require a key
  [ 'dnsbl.httpbl.net.', 'mykey' ],
  // Array with just the URL. While this works, it is recommended that you
  // just use a string as shown above
  [ 'opm.tornevall.org.' ]
];

Note: You should end the domain name with a . to avoid searching your eventual domain search suffixes.

Since: 1.16

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

◆ Edititis

const MediaWiki\MainConfigSchema::Edititis

Initial value:

= [
        'default' => false,
    ]

Display user edit counts in various prominent places.

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

◆ EditRecoveryExpiry

const MediaWiki\MainConfigSchema::EditRecoveryExpiry

Initial value:

= [
        'default' => 30 * 24 * 3600,
        'type' => 'integer',
    ]

Number of seconds to keep edit recovery data after the edit is stored.

Definition at line 12834 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 5140 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 2701 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 7839 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 2530 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','PublishStashedFile' and 'UploadFromUrl' job types.

Definition at line 853 of file MainConfigSchema.php.

◆ EnableAsyncUploadsByURL

const MediaWiki\MainConfigSchema::EnableAsyncUploadsByURL

Initial value:

= [
        'default' => false,
    ]

Enable the async processing of upload by url in Special:Upload.

Only works if EnableAsyncUploads is also enabled

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

◆ EnableBotPasswords

const MediaWiki\MainConfigSchema::EnableBotPasswords

Initial value:

= [
        'default' => true,
        'type' => 'boolean',
    ]

Since: 1.27

Definition at line 9120 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 5393 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 8577 of file MainConfigSchema.php.

◆ EnableEditRecovery

const MediaWiki\MainConfigSchema::EnableEditRecovery

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Whether to enable the client-side edit recovery feature.

Stability: unstable: Temporary feature flag, T341844

Since: 1.41

Definition at line 12826 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 2560 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 6494 of file MainConfigSchema.php.

◆ EnableJavaScriptTest

const MediaWiki\MainConfigSchema::EnableJavaScriptTest

Initial value:

= [
        'default' => false,
    ]

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

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

◆ EnableMultiBlocks

const MediaWiki\MainConfigSchema::EnableMultiBlocks

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

If this is false, the number of blocks of a given target is limited to only 1.

Since: 1.42

Definition at line 7758 of file MainConfigSchema.php.

◆ EnableOpenSearchSuggest

const MediaWiki\MainConfigSchema::EnableOpenSearchSuggest

Initial value:

= [
        'default' => true,
        'obsolete' => 'Since 1.35, no longer used',
        'description' => 'Has been emitting warnings since 1.39 (LTS). ' .
            'Can be removed completely in 1.44, assuming 1.43 is an LTS release.'
    ]

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 10045 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 11189 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, T280532

Since: 1.37

Definition at line 7748 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 4454 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 6681 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 10163 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 4395 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 2580 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 836 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 2569 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 2589 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 2690 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 2764 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 2772 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 2753 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 2735 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 2779 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 2719 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 2708 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 listeners 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 systems 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 12726 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:

$wgExemptFromUserRobotsControl = [ NS_MAIN, NS_TALK, NS_PROJECT ];

NS_TALK

const NS_TALK

Definition Defines.php:65

NS_PROJECT

const NS_PROJECT

Definition Defines.php:68

$wgExemptFromUserRobotsControl

Config variable stub for the ExemptFromUserRobotsControl setting, for use by phpdoc and IDEs.

Definition config-vars.php:4112

Definition at line 12066 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 1868 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 1859 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 6666 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: self::LearnerEdits

Definition at line 6777 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: self::LearnerEdits

Definition at line 6786 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 11012 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 10967 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 10983 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 11005 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 10976 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 10998 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 11022 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 9404 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 469 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',
];

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: \MediaWiki\Specials\SpecialVersion::getCredits

Definition at line 11308 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 489 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 11181 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 11074 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.

Definition config-vars.php:1665

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 4443 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 config-vars.php:3864

Definition at line 11106 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 3514 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 5286 of file MainConfigSchema.php.

◆ ExternalLinksDomainGaps

const MediaWiki\MainConfigSchema::ExternalLinksDomainGaps

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Gaps in the externallinks table for certain domains.

If you have identified certain domains for which externallinks searches are slow, you can use this setting to make MediaWiki skip large el_id ranges, rather than having the database scan through them fruitlessly.

Each key in the array is a domain name in el_to_domain_index form, e.g. 'https://com.example.'. The value is an array with integer keys and values, where each entry is a range (from => to, both inclusive) of el_id values where this domain is known to have no entries. (Subdomains are included, i.e., configuring an entry here guarantees to MediaWiki that there are no rows where the el_to_domain_index starts with this value.)

History:

1.41: Added

Definition at line 3318 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 6596 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':

$wgExternalServers = [
    'blobs_cluster1' => <array in the same format as $wgDBservers>
];

Definition at line 3450 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 config-vars.php:1287

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

◆ ExtraInterlanguageLinkPrefixes

const MediaWiki\MainConfigSchema::ExtraInterlanguageLinkPrefixes

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

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.
This should be a list of "interwiki prefixes" (ie, what appears in wikitext), and you probably want to add an entry to InterlanguageLinkCodeMap as well to specify which mediawiki internal (or custom) language code this prefix corresponds to, and perhaps then map that custom language code to a language name in ExtraLanguageNames.

Definition at line 4769 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 4808 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 4789 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:

$wgExtraNamespaces = [
   100 => "Hilfe",
   101 => "Hilfe_Diskussion",
   102 => "Aide",
   103 => "Discussion_Aide"
];

Todo: Add a note about maintenance/namespaceDupes.php

Definition at line 6088 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 6249 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 5218 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 701 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.

Stability: unstable: EXPERIMENTAL

Since: 1.34

Definition at line 12795 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 10572 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 10593 of file MainConfigSchema.php.

◆ FeedClasses

const MediaWiki\MainConfigSchema::FeedClasses

Initial value:

= [
        'default' => [
            'rss' => \MediaWiki\Feed\RSSFeed::class,
            'atom' => \MediaWiki\Feed\AtomFeed::class,
        ],
        'type' => 'map',
    ]

Available feeds objects.

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

Definition at line 10631 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 10601 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 10580 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 1214 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 1347 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 4374 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 608 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 1575 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 11699 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 6287 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 5321 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 3778 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 4576 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 314 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 config-vars.php:1905

Definition at line 5003 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: self::LocalFileRepo

Definition at line 1110 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 1266 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 5273 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 2399 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.

Definition config-vars.php:279

Since: 1.7.0

Definition at line 2076 of file MainConfigSchema.php.

◆ GitBin

const MediaWiki\MainConfigSchema::GitBin

Initial value:

= [
        'default' => '/usr/bin/git',
    ]

Fully specified path to git binary.

Definition at line 10330 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 4355 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 10347 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 config-vars.php:1773

Definition at line 4730 of file MainConfigSchema.php.

◆ GrantPermissionGroups

const MediaWiki\MainConfigSchema::GrantPermissionGroups

Grant groups are used on some user interfaces to display conceptually similar grants together.

This configuration value should usually be set by extensions, not site administrators.

See also: self::GrantPermissions

Since: 1.27

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

◆ GrantRiskGroups

const MediaWiki\MainConfigSchema::GrantRiskGroups

Group grants by risk level.

Keys are grant names (i.e. keys from GrantPermissions), values are GrantsInfo::RISK_* constants.

Note that this classification is only informative; merely applying 'security' or 'internal' to a grant won't prevent it from being available. It's used to give guidance to users in various interfaces about the riskiness of the various grants.

Since: 1.42

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

Definition config-vars.php:2760

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 8051 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 7875 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.

Definition config-vars.php:2772

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

$wgGroupsRemoveFromSelf = [ '*' => true ];

$wgGroupsRemoveFromSelf

Config variable stub for the GroupsRemoveFromSelf setting, for use by phpdoc and IDEs.

Definition config-vars.php:2778

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

◆ GroupsRemoveFromSelf

const MediaWiki\MainConfigSchema::GroupsRemoveFromSelf

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

See also: self::GroupsAddToSelf

Definition at line 8097 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 1191 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 1562 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 7516 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 7847 of file MainConfigSchema.php.

◆ HideInterlanguageLinks

const MediaWiki\MainConfigSchema::HideInterlanguageLinks

Initial value:

= [
        'default' => false,
    ]

Hide interlanguage links from the sidebar.

Definition at line 4745 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 8434 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).

◆ 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 9369 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
$wgHooks
Config variable stub for the Hooks setting, for use by phpdoc and IDEs.
Definition config-vars.php:3912

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

◆ HTCPMulticastTTL

const MediaWiki\MainConfigSchema::HTCPMulticastTTL

Initial value:

= [
        'default' => 1,
    ]

HTCP multicast TTL.

See also: self::HTCPRouting

Definition at line 4666 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:

$wgHTCPRouting = [
        '|^https?://upload\\.wikimedia\\.org|' => [
                'host' => '239.128.0.113',
                'port' => 4827,
        ],
        '' => [
                'host' => '239.128.0.112',
                'port' => 4827,
        ],
];

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

Example of sending purges to multiple hosts:

$wgHTCPRouting = [
    '' => [
        // 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: self::HTCPMulticastTTL

Definition at line 4656 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 5129 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 12484 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 12518 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 12508 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 12496 of file MainConfigSchema.php.

◆ HTTPProxy

const MediaWiki\MainConfigSchema::HTTPProxy

Initial value:

= [
        'default' => '',
    ]

Proxy to use for CURL requests.

Definition at line 12532 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 293 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 12472 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 2052 of file MainConfigSchema.php.

◆ IllegalFileChars

const MediaWiki\MainConfigSchema::IllegalFileChars

Initial value:

= [
        'default' => ':\\/\\\\',
        'deprecated' => 'since 1.41; no longer customizable',
    ]

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.

Deprecated: since 1.41; no longer customizable

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

◆ ImageMagickConvertCommand

const MediaWiki\MainConfigSchema::ImageMagickConvertCommand

Initial value:

= [
        'default' => '/usr/bin/convert',
    ]

The convert command shipped with ImageMagick.

Definition at line 1760 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 1792 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 2446 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 908 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 573 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: self::FileBackends

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

◆ ImplicitRights

const MediaWiki\MainConfigSchema::ImplicitRights

Initial value:

= [
        'default' => [],
        'type' => 'list',
        'items' => [ 'type' => 'string', ]
    ]

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

Rights in this list are granted implicitly to all users, but rate limits may apply to them.

Extensions that define rate limits should add the corresponding right to either ImplicitRights or AvailableRights, depending on whether the right should be granted to everyone.

Since: 1.41

See also: self::RateLimits; self::AvailableRights

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

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

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

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

Definition at line 10944 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 10957 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 4781 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 config-vars.php:1689

Definition at line 4505 of file MainConfigSchema.php.

◆ InterwikiCache

const MediaWiki\MainConfigSchema::InterwikiCache

Initial value:

= [
        'default' => false,
        'type' => 'false|map',
        'mergeStrategy' => 'replace',
    ]

Interwiki cache as an associative array.

When set, the InterwikiLookup service will not use the built-in interwiki database table, but instead use this static array as its source.

This cache data structure can be generated by the dumpInterwiki.php 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.

See also: \MediaWiki\Interwiki\ClassicInterwikiLookup

Definition at line 6335 of file MainConfigSchema.php.

◆ InterwikiExpiry

const MediaWiki\MainConfigSchema::InterwikiExpiry

Initial value:

= [
        'default' => 10800,
    ]

Expiry time for cache of interwiki table.

Definition at line 6311 of file MainConfigSchema.php.

◆ InterwikiFallbackSite

const MediaWiki\MainConfigSchema::InterwikiFallbackSite

Initial value:

= [
        'default' => 'wiki',
    ]

Fallback site, if unable to resolve from cache.

Definition at line 6355 of file MainConfigSchema.php.

◆ InterwikiLogoOverride

const MediaWiki\MainConfigSchema::InterwikiLogoOverride

Initial value:

= [
        'default' => [],
        'type' => 'list',
        'items' => [ 'type' => 'string', ],
    ]

List of interwiki logos overrides.

This is used by the sister project sidebar. This list accept a key equal to the interwiki ID (as defined in the interwiki links), and accept a Codex icon name (https://doc.wikimedia.org/codex/latest/icons/all-icons.html) or a base URL for the given interwiki.

Example : $wgInterwikiLogoOverride = [ 'c' => 'logoWikimediaCommons', 'wikit' => 'https://mySpecialWiki.com' ];

Definition at line 5410 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 4738 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 6348 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 4425 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 7207 of file MainConfigSchema.php.

◆ InvalidRedirectTargets

const MediaWiki\MainConfigSchema::InvalidRedirectTargets

Initial value:

= [
        'default' => [ 'Filepath', 'Mypage', 'Mytalk', 'Redirect', 'Mylog' ],
        '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 6265 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 7527 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 11472 of file MainConfigSchema.php.

◆ JobClasses

const MediaWiki\MainConfigSchema::JobClasses

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

Since 1.40, job handlers can be specified as object specs for use with ObjectFactory, using an array, a plain class name, or a callback.

Note: The constructor signature of job classes has to follow one of two patterns: Either it takes a parameter array as the first argument, followed by any services it needs to have injected: ( array $params, ... ). Or it takes a PageReference as the first parameter, followed by the parameter array, followed by any services: ( PageReference $page, array $params, ... ). In order to signal to the JobFactory that the $page parameter should be omitted from the constructor arguments, the job class has to be a subclass of GenericParameterJob, or the object specification for the job has to set the 'needsPage' key to false. If a callback is used, its signature follows the same rules.

Definition at line 11385 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 11516 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 in loop every few seconds via a service or cron job. If using a cron job, be sure to handle the case where the script is already running (e.g. via /usr/bin/flock -n <lock_file>).

If this is set to a non-zero number, then it is highly recommended that PHP run in fastcgi mode (php_fpm). When using a standard Apache PHP handler (mod_php), it is recommended that output_buffering and zlib.output_compression both be set to "Off", allowing MediaWiki to install an unlimited size output buffer on the fly. Setting output_buffering to an integer (e.g. 4096) or enabling zlib.output_compression can cause user-visible slowness as background tasks execute during web requests.

Regardless of the web server engine in use, be sure to configure a sufficient number processes/threads in order to avoid exhaustion (which will cause user-visible slowness).

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

◆ JobTypesExcludedFromDefaultQueue

const MediaWiki\MainConfigSchema::JobTypesExcludedFromDefaultQueue

Initial value:

= [
        'default' => [ 'AssembleUploadChunks', 'PublishStashedFile', 'UploadFromUrl' ],
        '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 11458 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 1840 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 1851 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 1817 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 4715 of file MainConfigSchema.php.

◆ LanguageConverterCacheType

const MediaWiki\MainConfigSchema::LanguageConverterCacheType

Initial value:

= [
        'default' => CACHE_ANYTHING,
    ]

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

For available types see $wgMainCacheType.

Since: 1.20

Definition at line 3900 of file MainConfigSchema.php.

◆ LBFactoryConf

const MediaWiki\MainConfigSchema::LBFactoryConf

Initial value:

= [
        'default' => [
            'class' => 'Wikimedia\\Rdbms\\LBFactorySimple',
        ],
        'type' => 'map',
        'mergeStrategy' => 'replace',
    ]

Configuration for the ILBFactory service.

The "class" setting must point to a LBFactory subclass, which is also responsible for reading $wgDBservers, $wgDBserver, etc.

To set up a wiki farm with multiple database clusters, set the "class" to LBFactoryMulti. See LBFactoryMulti docs for information on how to configure the rest of the $wgLBFactoryConf array.

Definition at line 3135 of file MainConfigSchema.php.

◆ LearnerEdits

const MediaWiki\MainConfigSchema::LearnerEdits

Initial value:

= [
        'default' => 10,
    ]

The following variables define 3 user experience levels:

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

Definition at line 6759 of file MainConfigSchema.php.

◆ LearnerMemberSince

const MediaWiki\MainConfigSchema::LearnerMemberSince

Initial value:

= [
        'default' => 4,
    ]

Number of days the user must exist before becoming a learner.

See also: self::LearnerEdits

Definition at line 6768 of file MainConfigSchema.php.

◆ LegacyEncoding

const MediaWiki\MainConfigSchema::LegacyEncoding

Initial value:

= [
        'default' => false,
    ]

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

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

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

Definition at line 4851 of file MainConfigSchema.php.

◆ LegalTitleChars

const MediaWiki\MainConfigSchema::LegalTitleChars

Initial value:

= [
        'default' => ' %!"$&\'()*,\\-.\\/0-9:;=?@A-Z\\\\^_`a-z~\\x80-\\xFF+',
        'deprecated' => 'since 1.41; use Extension:TitleBlacklist to customize',
    ]

Allowed title characters – regex character class Don't change this unless you know what you're doing.

Problematic punctuation:

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

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

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

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

Deprecated: since 1.41; use Extension:TitleBlacklist or (soon) Extension:AbuseFilter to customize this set.

Definition at line 6159 of file MainConfigSchema.php.

◆ LinkHolderBatchSize

const MediaWiki\MainConfigSchema::LinkHolderBatchSize

Initial value:

= [
        'default' => 1000,
    ]

LinkHolderArray batch size For debugging.

Definition at line 3755 of file MainConfigSchema.php.

◆ LoadScript

const MediaWiki\MainConfigSchema::LoadScript

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
    ]

The URL path to load.php.

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

Since: 1.17

Definition at line 389 of file MainConfigSchema.php.

◆ LocalDatabases

const MediaWiki\MainConfigSchema::LocalDatabases

Initial value:

= [
        'default' => [],
        'type' => 'list',
        'items' => [ 'type' => 'string', ],
    ]

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

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

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

Definition at line 3210 of file MainConfigSchema.php.

◆ LocalFileRepo

const MediaWiki\MainConfigSchema::LocalFileRepo

Initial value:

= [
        'default' => false,
        'type' => 'map|false',
        'dynamicDefault' => [ 'use' => [ 'UploadDirectory', 'ScriptPath', 'Favicon', 'UploadBaseUrl',
            'UploadPath', 'HashedUploadDirectory', 'ThumbnailScriptPath',
            'GenerateThumbnailOnParse', 'DeletedDirectory', 'UpdateCompatibleMetadata' ] ],
    ]

File repository structures.

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

Properties required for all repos:

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

Optional common properties:

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

For most core repos:

zones Associative array of zone names that each map to an array with: container : backend container name the zone is in directory : root path within container for the zone url : base URL to the root of the zone urlsByExt : map of file extension types to base URLs (useful for using a different cache for videos) Zones default to using "<repo name>-<zone name>" as the container name and default to using the container root as the zone's root directory. Nesting of zone locations within other zones should be avoided.
url Public zone URL. The 'zones' settings take precedence.

hashLevels The number of directory levels for hash-based division of files.

             Set this to 0 if you do not want MediaWiki to divide your images
             directory into many subdirectories.

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

             Default: 2.

deletedHashLevels Optional 'hashLevels' override for the 'deleted' zone.
thumbScriptUrl The URL for thumb.php (optional, not recommended)
transformVia404 Whether to skip media file transformation on parse and rely on a 404 handler instead.
thumbProxyUrl Optional. URL of where to proxy thumb.php requests to. This is also used internally for remote thumbnailing of upload stash files. Example: http://127.0.0.1:8888/wiki/dev/thumb/
thumbProxySecret Optional value of the X-Swift-Secret header to use in requests to thumbProxyUrl
disableLocalTransform If present and true, local image scaling will be disabled. If attempted, it will show an error to the user and log an error message. To avoid an error, thumbProxyUrl must be set, as well as either transformVia404 (preferred) or thumbScriptUrl.
initialCapital Equivalent to $wgCapitalLinks (or $wgCapitalLinkOverrides[NS_FILE], determines whether filenames implicitly start with a capital letter. The current implementation may give incorrect description page links when the local $wgCapitalLinks and initialCapital are mismatched.
pathDisclosureProtection May be 'paranoid' to remove all parameters from error messages, 'none' to leave the paths in unchanged, or 'simple' to replace paths with placeholders. Default for LocalRepo is 'simple'.
fileMode This allows wikis to set the file mode when uploading/moving files. Default is 0644.
directory The local filesystem directory where public files are stored. Not used for some remote repos.
thumbDir The base thumbnail directory. Defaults to "<directory>/thumb".
thumbUrl The base thumbnail URL. Defaults to "<url>/thumb".
isPrivate Set this if measures should always be taken to keep the files private. One should not trust this to assure that the files are not web readable; the server configuration should be done manually depending on the backend.
useJsonMetadata Whether handler metadata should be stored in JSON format. Default: true.
useSplitMetadata Whether handler metadata should be split up and stored in the text table. Default: false.
splitMetadataThreshold If the media handler opts in, large metadata items will be split into a separate blob in the database if the item is larger than this threshold. Default: 1000
updateCompatibleMetadata When true, image metadata will be upgraded by reloading it from the original file, if the handler indicates that it is out of date.

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

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

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

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

ForeignDBRepo:

dbType, dbServer, dbUser, dbPassword, dbName, dbFlags equivalent to the corresponding member of $wgDBservers
tablePrefix Table prefix, the foreign wiki's $wgDBprefix
hasSharedCache Set to true if the foreign wiki's $wgMainCacheType is identical to, and accessible from, this wiki.

ForeignAPIRepo:

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

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

See also: \FileRepo::__construct for the default options.; Setup.php for an example usage and default initialization.

Definition at line 1067 of file MainConfigSchema.php.

◆ LocalHTTPProxy

const MediaWiki\MainConfigSchema::LocalHTTPProxy

Initial value:

= [
        'default' => false,
        'type' => 'string|false',
    ]

Reverse proxy to use for requests to domains in $wgLocalVirtualHosts.

When used, any port in the request URL will be dropped. The behavior of redirects and cookies is dependent upon the reverse proxy actually in use, as MediaWiki doesn't implement any special handling for them.

If set to false, no reverse proxy will be used for local requests.

Since: 1.38

Definition at line 12567 of file MainConfigSchema.php.

◆ LocalInterwikis

const MediaWiki\MainConfigSchema::LocalInterwikis

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

Array for local interwiki values, for each of the interwiki prefixes that point to the current wiki.

Note, recent changes feeds use only the first entry in this array. See $wgRCFeeds.

Definition at line 6303 of file MainConfigSchema.php.

◆ LocalisationCacheConf

const MediaWiki\MainConfigSchema::LocalisationCacheConf

Initial value:

= [
        'properties' => [
            'class' => [ 'type' => 'string', 'default' => LocalisationCache::class ],
            'store' => [ 'type' => 'string', 'default' => 'detect' ],
            'storeClass' => [ 'type' => 'false|string', 'default' => false ],
            'storeDirectory' => [ 'type' => 'false|string', 'default' => false ],
            'storeServer' => [ 'type' => 'object', 'default' => [] ],
            'forceRecache' => [ 'type' => 'bool', 'default' => false ],
            'manualRecache' => [ 'type' => 'bool', 'default' => false ],
        ],
        'type' => 'object',
    ]

Localisation cache configuration.

Used by service wiring to decide how to construct the LocalisationCache instance. Associative array with keys:

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

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

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

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

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

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

Definition at line 4318 of file MainConfigSchema.php.

◆ LocalStylePath

const MediaWiki\MainConfigSchema::LocalStylePath

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
    ]

The URL path of the skins directory.

Should not point to an external domain.

Defaults to "{$wgScriptPath}/skins".

Since: 1.17

Definition at line 448 of file MainConfigSchema.php.

◆ Localtimezone

const MediaWiki\MainConfigSchema::Localtimezone

Initial value:

= [
        'dynamicDefault' => true,
    ]

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

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

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

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

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

Examples:

$wgLocaltimezone = 'UTC';
$wgLocaltimezone = 'GMT';
$wgLocaltimezone = 'PST8PDT';
$wgLocaltimezone = 'Europe/Sweden';
$wgLocaltimezone = 'CET';

Definition at line 5054 of file MainConfigSchema.php.

◆ LocalTZoffset

const MediaWiki\MainConfigSchema::LocalTZoffset

Initial value:

= [
        'dynamicDefault' => [ 'use' => [ 'Localtimezone' ] ]
    ]

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

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

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

Definition at line 5080 of file MainConfigSchema.php.

◆ LocalVirtualHosts

const MediaWiki\MainConfigSchema::LocalVirtualHosts

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Local virtual hosts.

This lists domains that are configured as virtual hosts on the same machine. It is expected that each domain can be identified by its hostname alone, without any ports.

This affects the following:

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

Since: 1.25

Definition at line 12551 of file MainConfigSchema.php.

◆ LockManagers

const MediaWiki\MainConfigSchema::LockManagers

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

List of lock manager backend configurations.

Each backend configuration has the following parameters:

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

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

Definition at line 1363 of file MainConfigSchema.php.

◆ LogActions

const MediaWiki\MainConfigSchema::LogActions

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Maps log actions to message keys, for formatting log entries of each type and action when displaying logs to the user.

The array keys are composed as "$type/$action".

Extensions with custom log types may add to this array.

Definition at line 11767 of file MainConfigSchema.php.

◆ LogActionsHandlers

const MediaWiki\MainConfigSchema::LogActionsHandlers

The same as above, but here values are class names or ObjectFactory specifications, not messages.

The specification must resolve to a LogFormatter subclass, and will receive the LogEntry object as its first constructor argument. The type can be specified as '*' (e.g. 'block/*') to handle all types.

See also: \LogPage::actionText; \LogFormatter

Definition at line 11781 of file MainConfigSchema.php.

◆ LogExceptionBacktrace

const MediaWiki\MainConfigSchema::LogExceptionBacktrace

Initial value:

= [
        'default' => true,
    ]

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

Definition at line 9758 of file MainConfigSchema.php.

◆ LogHeaders

const MediaWiki\MainConfigSchema::LogHeaders

Initial value:

= [
        'default' => [
            '' => 'alllogstext',
            'block' => 'blocklogtext',
            'delete' => 'dellogpagetext',
            'import' => 'importlogpagetext',
            'merge' => 'mergelogpagetext',
            'move' => 'movelogpagetext',
            'patrol' => 'patrol-log-header',
            'protect' => 'protectlogtext',
            'rights' => 'rightslogtext',
            'suppress' => 'suppressionlogtext',
            'upload' => 'uploadlogpagetext',
        ],
        'type' => 'map',
    ]

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

Extensions with custom log types may add to this array.

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

Definition at line 11743 of file MainConfigSchema.php.

◆ LoginLanguageSelector

const MediaWiki\MainConfigSchema::LoginLanguageSelector

Initial value:

= [
        'default' => false,
    ]

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

Definition at line 4979 of file MainConfigSchema.php.

◆ LogNames

const MediaWiki\MainConfigSchema::LogNames

Initial value:

= [
        'default' => [
            '' => 'all-logs-page',
            'block' => 'blocklogpage',
            'protect' => 'protectlogpage',
            'rights' => 'rightslog',
            'delete' => 'dellogpage',
            'upload' => 'uploadlogpage',
            'move' => 'movelogpage',
            'import' => 'importlogpage',
            'patrol' => 'patrol-log-page',
            'merge' => 'mergelog',
            'suppress' => 'suppressionlog',
        ],
        'type' => 'map',
    ]

Lists the message key string for each log type.

The localized messages will be listed in the user interface.

Extensions with custom log types may add to this array.

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

Definition at line 11717 of file MainConfigSchema.php.

◆ Logo

const MediaWiki\MainConfigSchema::Logo

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'ResourceBasePath' ] ]
    ]

The URL path of the wiki logo.

The logo size should be 135x135 pixels.

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

Definition at line 629 of file MainConfigSchema.php.

◆ Logos

const MediaWiki\MainConfigSchema::Logos

Initial value:

= [
        'default' => false,
        'type' => 'map|false',
    ]

Specification for different versions of the wiki logo.

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

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

src path to wordmark version
1x path to svg wordmark version (if you want to support browsers with SVG support with an SVG logo)
width width of the logo in pixels
height height of the logo in pixels The tagline key may be null or array with the following fields
src path to tagline image
width width of the tagline in pixels
height height of the tagline in pixels

Example:: $wgLogos = [

'1x' => 'path/to/1x_version.png',

'1.5x' => 'path/to/1.5x_version.png',

'2x' => 'path/to/2x_version.png',

'svg' => 'path/to/svg_version.svg',

'icon' => 'path/to/icon.png',

'wordmark' => [

'src' => 'path/to/wordmark_version.png',

'1x' => 'path/to/wordmark_version.svg',

'width' => 135,

'height' => 20,

],

'tagline' => [

'src' => 'path/to/tagline_version.png',

'width' => 135,

'height' => 15,

]

];

$wgLogos
$wgLogos
Config variable stub for the Logos setting, for use by phpdoc and IDEs.
Definition config-vars.php:169

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

Since: 1.35

Definition at line 691 of file MainConfigSchema.php.

◆ LogRestrictions

const MediaWiki\MainConfigSchema::LogRestrictions

Initial value:

= [
        'default' => [ 'suppress' => 'suppressionlog', ],
        'type' => 'map',
    ]

This restricts log access to those who have a certain right Users without this will not see it in the option menu and can not view it Restricted logs are not added to recent changes Logs should remain non-transcludable Format: logtype => permissiontype.

Definition at line 11676 of file MainConfigSchema.php.

◆ LogTypes

const MediaWiki\MainConfigSchema::LogTypes

Initial value:

= [
        'default' => [
            '',
            'block',
            'protect',
            'rights',
            'delete',
            'upload',
            'move',
            'import',
            'patrol',
            'merge',
            'suppress',
            'tag',
            'managetags',
            'contentmodel',
            'renameuser',
        ],
        'type' => 'list',
    ]

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.

Note that code should call LogPage::validTypes() to get a list of valid log types instead of checking the global variable.

Definition at line 11648 of file MainConfigSchema.php.

◆ MainCacheType

const MediaWiki\MainConfigSchema::MainCacheType

Initial value:

= [
        'default' => CACHE_NONE,
    ]

Main cache type.

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

The options are:

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

For a multi-datacenter setup, the underlying service should be configured to broadcast operations by WANObjectCache using Mcrouter or Dynomite. See Deploying WANObjectCache. To configure the broadcastRoutingPrefix WANObjectCache parameter, use $wgWANObjectCache.

See also: self::MessageCacheType; self::ParserCacheType

Definition at line 3838 of file MainConfigSchema.php.

◆ MainPageIsDomainRoot

const MediaWiki\MainConfigSchema::MainPageIsDomainRoot

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

When enabled, the domain root will show the wiki's main page, instead of redirecting to the main page.

Since: 1.34

Definition at line 816 of file MainConfigSchema.php.

◆ MainStash

const MediaWiki\MainConfigSchema::MainStash

Initial value:

= [
        'default' => CACHE_DB,
    ]

The object store type of the main stash.

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

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

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

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

See also: \BagOStuff

Since: 1.26

Definition at line 4058 of file MainConfigSchema.php.

◆ MangleFlashPolicy

const MediaWiki\MainConfigSchema::MangleFlashPolicy

Initial value:

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

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

Since: 1.25

Deprecated: since 1.39

Definition at line 5429 of file MainConfigSchema.php.

◆ ManualRevertSearchRadius

const MediaWiki\MainConfigSchema::ManualRevertSearchRadius

Initial value:

= [
        'default' => 15,
        'type' => 'integer',
    ]

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.

Computational time required increases roughly linearly with this configuration variable.

Larger values will let you detect very deep reverts, but at the same time can give unexpected results (such as marking large amounts of edits as reverts) and may slow down the wiki slightly when saving new edits.

Setting this to 0 will disable the manual revert detection feature entirely.

See this document for a discussion on this topic: https://meta.wikimedia.org/wiki/Research:Revert

Since: 1.36

Definition at line 6808 of file MainConfigSchema.php.

◆ MaxAnimatedGifArea

const MediaWiki\MainConfigSchema::MaxAnimatedGifArea

Initial value:

= [
        'default' => 12_500_000,
    ]

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

As of MW 1.17 this limit is checked against the total size of all frames in the animation.

It probably makes sense to keep this equal to $wgMaxImageArea.

Definition at line 1994 of file MainConfigSchema.php.

◆ MaxArticleSize

const MediaWiki\MainConfigSchema::MaxArticleSize

Initial value:

= [
        'default' => 2048,
    ]

Maximum article size in kibibytes.

Definition at line 3645 of file MainConfigSchema.php.

◆ MaxCredits

const MediaWiki\MainConfigSchema::MaxCredits

Initial value:

= [
        'default' => 0,
    ]

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

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

Definition at line 10902 of file MainConfigSchema.php.

◆ MaxExecutionTimeForExpensiveQueries

const MediaWiki\MainConfigSchema::MaxExecutionTimeForExpensiveQueries

Initial value:

= [
        'default' => 0,
    ]

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

Since: 1.38

Definition at line 3241 of file MainConfigSchema.php.

◆ MaxImageArea

const MediaWiki\MainConfigSchema::MaxImageArea

Initial value:

= [
        'default' => 12_500_000,
        'type' => 'string|integer|false',
    ]

The maximum number of pixels a source image can have if it is to be scaled down by a scaler that requires the full source image to be decompressed and stored in decompressed form, before the thumbnail is generated.

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

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

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

Definition at line 1981 of file MainConfigSchema.php.

◆ MaximumMovedPages

const MediaWiki\MainConfigSchema::MaximumMovedPages

Initial value:

= [
        'default' => 100,
    ]

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

Definition at line 3762 of file MainConfigSchema.php.

◆ MaxInterlacingAreas

const MediaWiki\MainConfigSchema::MaxInterlacingAreas

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Array of max pixel areas for interlacing per MIME type.

Since: 1.27

Definition at line 1769 of file MainConfigSchema.php.

◆ MaxJobDBWriteDuration

const MediaWiki\MainConfigSchema::MaxJobDBWriteDuration

Initial value:

= [
        'default' => false,
        'type' => 'integer|false',
    ]

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

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

Since: 1.30

Definition at line 3746 of file MainConfigSchema.php.

◆ MaxMsgCacheEntrySize

const MediaWiki\MainConfigSchema::MaxMsgCacheEntrySize

Initial value:

= [
        'default' => 10000,
    ]

Maximum entry size in the message cache, in bytes.

Definition at line 4883 of file MainConfigSchema.php.

◆ MaxNameChars

const MediaWiki\MainConfigSchema::MaxNameChars

Initial value:

= [
        'default' => 255,
    ]

Maximum number of bytes in username.

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

Definition at line 7356 of file MainConfigSchema.php.

◆ MaxPPExpandDepth

const MediaWiki\MainConfigSchema::MaxPPExpandDepth

Initial value:

= [
        'default' => 100,
    ]

See also: self::MaxTemplateDepth

Definition at line 6426 of file MainConfigSchema.php.

◆ MaxPPNodeCount

const MediaWiki\MainConfigSchema::MaxPPNodeCount

Initial value:

= [
        'default' => 1_000_000,
    ]

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

Definition at line 6408 of file MainConfigSchema.php.

◆ MaxRedirectLinksRetrieved

const MediaWiki\MainConfigSchema::MaxRedirectLinksRetrieved

Initial value:

= [
        'default' => 500,
    ]

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

Definition at line 11949 of file MainConfigSchema.php.

◆ MaxShellFileSize

const MediaWiki\MainConfigSchema::MaxShellFileSize

Initial value:

= [
        'default' => 102_400,
    ]

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

Definition at line 12345 of file MainConfigSchema.php.

◆ MaxShellMemory

const MediaWiki\MainConfigSchema::MaxShellMemory

Initial value:

= [
        'default' => 307_200,
    ]

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

Definition at line 12337 of file MainConfigSchema.php.

◆ MaxShellTime

const MediaWiki\MainConfigSchema::MaxShellTime

Initial value:

= [
        'default' => 180,
    ]

Maximum CPU time in seconds for shell processes under Linux.

Definition at line 12352 of file MainConfigSchema.php.

◆ MaxShellWallClockTime

const MediaWiki\MainConfigSchema::MaxShellWallClockTime

Initial value:

= [
        'default' => 180,
    ]

Maximum wall clock time (i.e.

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

Definition at line 12360 of file MainConfigSchema.php.

◆ MaxSigChars

const MediaWiki\MainConfigSchema::MaxSigChars

Initial value:

= [
        'default' => 255,
    ]

Maximum number of Unicode characters in signature.

Definition at line 7321 of file MainConfigSchema.php.

◆ MaxTemplateDepth

const MediaWiki\MainConfigSchema::MaxTemplateDepth

Initial value:

= [
        'default' => 100,
    ]

Maximum recursion depth for templates within templates.

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

Definition at line 6419 of file MainConfigSchema.php.

◆ MaxTocLevel

const MediaWiki\MainConfigSchema::MaxTocLevel

Initial value:

= [
        'default' => 999,
    ]

Maximum indent level of toc.

Definition at line 6400 of file MainConfigSchema.php.

◆ MaxUploadSize

const MediaWiki\MainConfigSchema::MaxUploadSize

Initial value:

= [
        'default' => 1024 * 1024 * 100,
    ]

Max size for uploads, in bytes.

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

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

Example:

$wgMaxUploadSize = [
    '*' => 250 * 1024,
    'url' => 500 * 1024,
];

Default: 100 MiB.

Definition at line 1482 of file MainConfigSchema.php.

◆ MaxUserDBWriteDuration

const MediaWiki\MainConfigSchema::MaxUserDBWriteDuration

Initial value:

= [
        'default' => false,
        'type' => 'integer|false',
    ]

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

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

Since: 1.27

Definition at line 3734 of file MainConfigSchema.php.

◆ MediaHandlers

const MediaWiki\MainConfigSchema::MediaHandlers

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Plugins for media file type handling.

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

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

Definition at line 1699 of file MainConfigSchema.php.

◆ MediaInTargetLanguage

const MediaWiki\MainConfigSchema::MediaInTargetLanguage

Initial value:

= [
        'default' => true,
    ]

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

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

Since: 1.33

Definition at line 1960 of file MainConfigSchema.php.

◆ MemCachedPersistent

const MediaWiki\MainConfigSchema::MemCachedPersistent

Initial value:

= [
        'default' => false,
    ]

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

Definition at line 4250 of file MainConfigSchema.php.

◆ MemCachedServers

const MediaWiki\MainConfigSchema::MemCachedServers

Initial value:

= [
        'default' => [ '127.0.0.1:11211', ],
        'type' => 'list',
    ]

The list of MemCached servers and port numbers.

Definition at line 4241 of file MainConfigSchema.php.

◆ MemCachedTimeout

const MediaWiki\MainConfigSchema::MemCachedTimeout

Initial value:

= [
        'default' => 500_000,
    ]

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

Definition at line 4257 of file MainConfigSchema.php.

◆ MemoryLimit

const MediaWiki\MainConfigSchema::MemoryLimit

Initial value:

= [
        'default' => '50M',
    ]

The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount.

Definition at line 3653 of file MainConfigSchema.php.

◆ MessageCacheType

const MediaWiki\MainConfigSchema::MessageCacheType

Initial value:

= [
        'default' => CACHE_ANYTHING,
    ]

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

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

For available types see $wgMainCacheType.

Definition at line 3848 of file MainConfigSchema.php.

◆ MessagesDirs

const MediaWiki\MainConfigSchema::MessagesDirs

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Extension messages directories.

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

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

Simple example:

$wgMessagesDirs['Example'] = __DIR__ . '/i18n';

$wgMessagesDirs

Config variable stub for the MessagesDirs setting, for use by phpdoc and IDEs.

Definition config-vars.php:3870

Complex example:

$wgMessagesDirs['Example'] = [
    __DIR__ . '/lib/ve/i18n',
    __DIR__ . '/lib/ooui/i18n',
    __DIR__ . '/i18n',
]

Since: 1.23

Definition at line 11139 of file MainConfigSchema.php.

◆ MetaNamespace

const MediaWiki\MainConfigSchema::MetaNamespace

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'Sitename' ] ]
    ]

Name of the project namespace.

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

Definition at line 6027 of file MainConfigSchema.php.

◆ MetaNamespaceTalk

const MediaWiki\MainConfigSchema::MetaNamespaceTalk

Initial value:

= [
        'default' => false,
    ]

Name of the project talk namespace.

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

Definition at line 6047 of file MainConfigSchema.php.

◆ MicroStashType

const MediaWiki\MainConfigSchema::MicroStashType

Initial value:

= [
        'default' => CACHE_ANYTHING,
        'type' => 'string|int',
    ]

The stash store backend for MicroStash.

This store should be optimized for ephemeral data, and should be able to handle a high volume of writes and reads. The dataset access scope should be across all servers that serve the application.

Note that the TTL of the data written to the store must be respected completely before the data gets evicted from the store (whether the data is used or not). Thus, the store should not evict data before the TTL expires.

Properties of the backend should be: 1.) the data written to the store should be short-lived, 2.) it should be evicted ONLY after the TTL elapses (reliably persist), 3.) should be accessed by all servers that serve the application, 4.) should be able to handle a high volume of writes and reads.

See also: \BagOStuff

Since: 1.42

Definition at line 4026 of file MainConfigSchema.php.

◆ MimeDetectorCommand

const MediaWiki\MainConfigSchema::MimeDetectorCommand

Initial value:

= [
        'default' => null,
        'type' => '?string',
    ]

Sets an external MIME detector program.

The command must print only the MIME type to standard output.

The name of the file to process will be appended to the command given here. If not set or NULL, PHP's mime_content_type function will be used.

Example:

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

Definition at line 2210 of file MainConfigSchema.php.

◆ MimeInfoFile

const MediaWiki\MainConfigSchema::MimeInfoFile

Initial value:

= [
        'default' => 'internal',
    ]

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

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

Definition at line 2193 of file MainConfigSchema.php.

◆ MimeType

const MediaWiki\MainConfigSchema::MimeType

Initial value:

= [
        'default' => 'text/html',
    ]

The default Content-Type header.

Definition at line 5116 of file MainConfigSchema.php.

◆ MimeTypeExclusions

const MediaWiki\MainConfigSchema::MimeTypeExclusions

Initial value:

= [
        'default' => [
            # HTML may contain cookie-stealing JavaScript and web bugs
            'text/html',
            # Similarly with JavaScript itself
            'application/javascript', 'text/javascript', 'text/x-javascript', 'application/x-shellscript',
            # PHP scripts may execute arbitrary code on the server
            'application/x-php', 'text/x-php',
            # Other types that may be interpreted by some servers
            'text/x-python', 'text/x-perl', 'text/x-bash', 'text/x-sh', 'text/x-csh',
            # Client-side hazards on Internet Explorer
            'text/scriptlet', 'application/x-msdownload',
            # Windows metafile, client-side vulnerability on some systems
            'application/x-msmetafile',
            # Files that look like java files
            'application/java',
            # XML files generally - T341565
            'application/xml', 'text/xml',
        ],
        'type' => 'list',
    ]

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

Since: 1.37; previously $wgMimeTypeBlacklist

Definition at line 1610 of file MainConfigSchema.php.

◆ MimeTypeFile

const MediaWiki\MainConfigSchema::MimeTypeFile

Initial value:

= [
        'default' => 'internal',
    ]

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

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

Definition at line 2184 of file MainConfigSchema.php.

◆ MinUploadChunkSize

const MediaWiki\MainConfigSchema::MinUploadChunkSize

Initial value:

= [
        'default' => 1024,
    ]

Minimum upload chunk size, in bytes.

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

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

Default: 1 KiB.

Since: 1.26

See also: \ApiUpload::getMinUploadChunkSize

Definition at line 1500 of file MainConfigSchema.php.

◆ MiserMode

const MediaWiki\MainConfigSchema::MiserMode

Initial value:

= [
        'default' => false,
    ]

Disable database-intensive features.

Definition at line 3603 of file MainConfigSchema.php.

◆ MultiShardSiteStats

const MediaWiki\MainConfigSchema::MultiShardSiteStats

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Whether site_stats table should have multiple rows.

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

Since: 1.39

Definition at line 3791 of file MainConfigSchema.php.

◆ MWLoggerDefaultSpi

const MediaWiki\MainConfigSchema::MWLoggerDefaultSpi

Initial value:

= [
        'default' => [ 'class' => 'MediaWiki\\Logger\\LegacySpi', ],
        'mergeStrategy' => 'replace',
        'type' => 'map',
    ]

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

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

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

To completely disable logging:

$wgMWLoggerDefaultSpi = [ 'class' => \\MediaWiki\\Logger\\NullSpi::class ];

$wgMWLoggerDefaultSpi

Config variable stub for the MWLoggerDefaultSpi setting, for use by phpdoc and IDEs.

Definition config-vars.php:3252

MediaWiki

A helper class for throttling authentication attempts.

Since: 1.25

See also: \MwLogger

Definition at line 9722 of file MainConfigSchema.php.

◆ NamespaceAliases

const MediaWiki\MainConfigSchema::NamespaceAliases

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Define extra namespace aliases.

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

Set this to a map from namespace names to IDs.

Example:

$wgNamespaceAliases = [
    'Wikipedian' => NS_USER,
    'Help' => 100,
];

See also: \Language::getNamespaceAliases for accessing the full list of aliases, including those defined by other means.

Definition at line 6128 of file MainConfigSchema.php.

◆ NamespaceContentModels

const MediaWiki\MainConfigSchema::NamespaceContentModels

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by default (use the CONTENT_MODEL_XXX constants).

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

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

Since: 1.21

Definition at line 3378 of file MainConfigSchema.php.

◆ NamespaceProtection

const MediaWiki\MainConfigSchema::NamespaceProtection

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

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

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

Note: NS_MEDIAWIKI is implicitly restricted to 'editinterface'.

Definition at line 8169 of file MainConfigSchema.php.

◆ NamespaceRobotPolicies

const MediaWiki\MainConfigSchema::NamespaceRobotPolicies

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Robot policies per namespaces.

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

Example:

$wgNamespaceRobotPolicies = [ NS_TALK => 'noindex' ];

$wgNamespaceRobotPolicies

Config variable stub for the NamespaceRobotPolicies setting, for use by phpdoc and IDEs.

Definition config-vars.php:4100

Definition at line 12016 of file MainConfigSchema.php.

◆ NamespacesToBeSearchedDefault

const MediaWiki\MainConfigSchema::NamespacesToBeSearchedDefault

Initial value:

= [
        'default' => [ NS_MAIN => true, ],
        'type' => 'map',
    ]

List of namespaces which are searched by default.

Example:

$wgNamespacesToBeSearchedDefault[NS_MAIN] = true;

$wgNamespacesToBeSearchedDefault[NS_PROJECT] = true;

$wgNamespacesToBeSearchedDefault

Config variable stub for the NamespacesToBeSearchedDefault setting, for use by phpdoc and IDEs.

Definition config-vars.php:3426

Definition at line 10093 of file MainConfigSchema.php.

◆ NamespacesWithSubpages

const MediaWiki\MainConfigSchema::NamespacesWithSubpages

Initial value:

= [
        'default' => [
            NS_TALK => true,
            NS_USER => true,
            NS_USER_TALK => true,
            NS_PROJECT => true,
            NS_PROJECT_TALK => true,
            NS_FILE_TALK => true,
            NS_MEDIAWIKI => true,
            NS_MEDIAWIKI_TALK => true,
            NS_TEMPLATE => true,
            NS_TEMPLATE_TALK => true,
            NS_HELP => true,
            NS_HELP_TALK => true,
            NS_CATEGORY_TALK => true
        ],
        'type' => 'map',
    ]

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

Definition at line 6198 of file MainConfigSchema.php.

◆ NativeImageLazyLoading

const MediaWiki\MainConfigSchema::NativeImageLazyLoading

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

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

Stability: unstable: EXPERIMENTAL

Since: 1.34

Definition at line 1710 of file MainConfigSchema.php.

◆ NewPasswordExpiry

const MediaWiki\MainConfigSchema::NewPasswordExpiry

Initial value:

= [
        'default' => 3600 * 24 * 7,
    ]

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

Definition at line 2617 of file MainConfigSchema.php.

◆ NewUserLog

const MediaWiki\MainConfigSchema::NewUserLog

Initial value:

= [
        'default' => true,
    ]

Maintain a log of newusers at Special:Log/newusers?

Definition at line 11901 of file MainConfigSchema.php.

◆ NoFollowDomainExceptions

const MediaWiki\MainConfigSchema::NoFollowDomainExceptions

Initial value:

= [
        'default' => [ 'mediawiki.org', ],
        'type' => 'list',
    ]

If this is set to an array of domains, external links to these domain names (or any subdomains) will not be set to rel="nofollow" regardless of the value of $wgNoFollowLinks.

For instance:

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

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

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

Definition at line 6633 of file MainConfigSchema.php.

◆ NoFollowLinks

const MediaWiki\MainConfigSchema::NoFollowLinks

Initial value:

= [
        'default' => true,
    ]

If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to search engines that they should not be followed for ranking purposes as they are user-supplied and thus subject to spamming.

Definition at line 6606 of file MainConfigSchema.php.

◆ NoFollowNsExceptions

const MediaWiki\MainConfigSchema::NoFollowNsExceptions

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

Namespaces in which $wgNoFollowLinks doesn't apply.

See Language.php for a list of namespaces.

Definition at line 6615 of file MainConfigSchema.php.

◆ NonincludableNamespaces

const MediaWiki\MainConfigSchema::NonincludableNamespaces

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

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

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

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

Definition at line 8183 of file MainConfigSchema.php.

◆ NoReplyAddress

const MediaWiki\MainConfigSchema::NoReplyAddress

Initial value:

= [
        'default' => false,
    ]

Reply-To address for e-mail notifications.

Defaults to $wgPasswordSender (in Setup.php).

Definition at line 2551 of file MainConfigSchema.php.

◆ ObjectCaches

const MediaWiki\MainConfigSchema::ObjectCaches

Initial value:

= [
        'default' => [
            CACHE_NONE => [ 'class' => EmptyBagOStuff::class, 'reportDupes' => false ],
            CACHE_DB => [ 'class' => SqlBagOStuff::class, 'loggroup' => 'SQLBagOStuff' ],
 
            'memcached-php' => [ 'class' => MemcachedPhpBagOStuff::class, 'loggroup' => 'memcached' ],
            'memcached-pecl' => [ 'class' => MemcachedPeclBagOStuff::class, 'loggroup' => 'memcached' ],
            'hash' => [ 'class' => HashBagOStuff::class, 'reportDupes' => false ],
 
            'apc' => [ 'class' => APCUBagOStuff::class, 'reportDupes' => false ],
            'apcu' => [ 'class' => APCUBagOStuff::class, 'reportDupes' => false ],
            'wincache' => [ 'class' => WinCacheBagOStuff::class, 'reportDupes' => false ],
        ],
        'type' => 'map',
    ]

Advanced object cache configuration.

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

The format is an associative array where the key is a cache identifier, and the value is an associative array of parameters. One of the following parameters specifying the class must be given:

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

The following parameters are shared and understood by most classes:

loggroup: The log channel to use.

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

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

SqlBagOStuff also accepts the following optional parameters:

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

For MemcachedPhpBagOStuff parameters see MemcachedPhpBagOStuff::__construct

For MemcachedPeclBagOStuff parameters see MemcachedPeclBagOStuff::__construct

For RedisBagOStuff parameters see RedisBagOStuff::__construct

Definition at line 3968 of file MainConfigSchema.php.

◆ ObjectCacheSessionExpiry

const MediaWiki\MainConfigSchema::ObjectCacheSessionExpiry

Initial value:

= [
        'default' => 60 * 60,
    ]

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

Definition at line 4196 of file MainConfigSchema.php.

◆ OldRevisionParserCacheExpireTime

const MediaWiki\MainConfigSchema::OldRevisionParserCacheExpireTime

Initial value:

= [
        'default' => 60 * 60,
    ]

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

The default is 3600 (cache disabled).

Definition at line 4189 of file MainConfigSchema.php.

◆ OpenSearchDefaultLimit

const MediaWiki\MainConfigSchema::OpenSearchDefaultLimit

Initial value:

= [
        'default' => 10,
    ]

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

Definition at line 10056 of file MainConfigSchema.php.

◆ OpenSearchDescriptionLength

const MediaWiki\MainConfigSchema::OpenSearchDescriptionLength

Initial value:

= [
        'default' => 100,
    ]

Minimum length of extract in .

Actual extracts will last until the end of sentence.

Definition at line 10064 of file MainConfigSchema.php.

◆ OpenSearchTemplates

const MediaWiki\MainConfigSchema::OpenSearchTemplates

Initial value:

= [
        'default' => [
            'application/x-suggestions+json' => false,
            'application/x-suggestions+xml' => false,
        ],
        'type' => 'map',
    ]

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

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

Placeholders: {searchTerms}

Definition at line 10031 of file MainConfigSchema.php.

◆ OriginTrials

const MediaWiki\MainConfigSchema::OriginTrials

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

Origin Trials tokens.

Since: 1.33

Definition at line 12760 of file MainConfigSchema.php.

◆ OverrideHostname

const MediaWiki\MainConfigSchema::OverrideHostname

Initial value:

= [
        'default' => false,
    ]

Override server hostname detection with a hardcoded value.

Should be a string, default false.

Since: 1.20

Definition at line 9784 of file MainConfigSchema.php.

◆ OverrideSiteFeed

const MediaWiki\MainConfigSchema::OverrideSiteFeed

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

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

Some sites might have a different feed they'd like to promote instead of the RC feed (maybe like a "Recent New Articles" or "Breaking news" one).

Should be a format as key (either 'rss' or 'atom') and an URL to the feed as value.

Example: Configure the 'atom' feed to https://example.com/somefeed.xml

$wgSiteFeed['atom'] = "https://example.com/somefeed.xml";

Definition at line 10620 of file MainConfigSchema.php.

◆ OverrideUcfirstCharacters

const MediaWiki\MainConfigSchema::OverrideUcfirstCharacters

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

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

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

Since: 1.34

Definition at line 5102 of file MainConfigSchema.php.

◆ PageCreationLog

const MediaWiki\MainConfigSchema::PageCreationLog

Initial value:

= [
        'default' => true,
    ]

Maintain a log of page creations at Special:Log/create?

Since: 1.32

Definition at line 11910 of file MainConfigSchema.php.

◆ PageInfoTransclusionLimit

const MediaWiki\MainConfigSchema::PageInfoTransclusionLimit

Initial value:

= [
        'default' => 50,
    ]

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

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

Definition at line 9962 of file MainConfigSchema.php.

◆ PageLanguageUseDB

const MediaWiki\MainConfigSchema::PageLanguageUseDB

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Enable page language feature Allows setting page language in database.

Since: 1.24

Definition at line 3489 of file MainConfigSchema.php.

◆ PageLinksSchemaMigrationStage

const MediaWiki\MainConfigSchema::PageLinksSchemaMigrationStage

Initial value:

= [
        'default' => SCHEMA_COMPAT_WRITE_OLD | SCHEMA_COMPAT_READ_OLD,
        'type' => 'integer',
    ]

Pagelinks table schema migration stage, for normalizing pl_namespace and pl_title fields.

Use the SCHEMA_COMPAT_XXX flags. Supported values:

SCHEMA_COMPAT_WRITE_OLD | SCHEMA_COMPAT_READ_OLD
SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD

History:

1.41: Added

Definition at line 3295 of file MainConfigSchema.php.

◆ PagePropLinkInvalidations

const MediaWiki\MainConfigSchema::PagePropLinkInvalidations

Initial value:

= [
        'default' => [ 'hiddencat' => 'categorylinks', ],
        'type' => 'map',
    ]

Page property link table invalidation lists.

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

This array can be added to by extensions.

Definition at line 11540 of file MainConfigSchema.php.

◆ ParserCacheExpireTime

const MediaWiki\MainConfigSchema::ParserCacheExpireTime

Initial value:

= [
        'default' => 60 * 60 * 24,
    ]

The expiry time for the parser cache, in seconds.

The default is 86400 (one day).

Definition at line 4180 of file MainConfigSchema.php.

◆ ParserCacheFilterConfig

const MediaWiki\MainConfigSchema::ParserCacheFilterConfig

Initial value:

= [
        'type' => 'map',
        'default' => [ 
            'pcache' => [ 
                'default' => [ 
                    
                    
                    'minCpuTime' => 0
                ],
            ],
            'parsoid-pcache' => [ 
                'default' => [ 
                    
                    
                    'minCpuTime' => 0
                ],
            ],
        ],
        'additionalProperties' => [ 
            'type' => 'map',
            'description' => 'A map of namespace IDs to filter definitions.',
            'additionalProperties' => [ 
                'type' => 'map',
                'description' => 'A map of filter names to values.',
                'properties' => [ 
                    'minCpuTime' => [ 'type' => 'float' ]
                ]
            ],
        ],
    ]

Per-namespace configuration for the ParserCache filter.

There is one top level key for each cache name supported in ParserCacheFactory. The per-namespace configuration is given separately for each cache.

For each namespace, this defines a set of filter options, which are represented as an associative array. The following keys are supported in this array:

minCpuTime: causes the parser cache to not save any output that took fewer than the given number of seconds of CPU time to generate, according to ParserOutput::getTimeProfile(). Set to 0 to always cache, or to PHP_INT_MAX to disable caching for this namespace.

If no filter options are defined for a given namespace, the filter options under the "default" key will be used for pages in that namespace.

Since: 1.42

Definition at line 4114 of file MainConfigSchema.php.

◆ ParserCacheType

const MediaWiki\MainConfigSchema::ParserCacheType

Initial value:

= [
        'default' => CACHE_ANYTHING,
    ]

The cache type for storing page content HTML (e.g.

parsed from wikitext).

Parsing wikitext is considered an expensive operation. It is recommended to give your parser cache plenty of storage space, such that long tail cache hits are possible.

The default parser cache backend (when MainCacheType is left to CACHE_NONE) is effectively CACHE_DB (SqlBagOStuff). If you set up a main cache type such as memcached, it is recommended to set this explicitly to CACHE_DB.

Advice for large wiki farms:

Consider allocating a dedicated database to ParserCache. Register it in $wgObjectCaches and point $wgParserCacheType to it.
Consider using MultiWriteBagOStuff to add a higher tier with Memcached in front of the lower database tier.
Consider setting ‘'purgePeriod’ => 0` in the dedicated SqlBagOStuff entry in $wgObjectCaches. This disables the automatic purging of expired rows (which would normally happen in the background of write requests). You can then schedule the purgeParserCache.php script to e.g. once a day prune expired rows from the a dedicated maintenance server.

For available types see $wgMainCacheType.

Definition at line 3877 of file MainConfigSchema.php.

◆ ParserEnableLegacyMediaDOM

const MediaWiki\MainConfigSchema::ParserEnableLegacyMediaDOM

Initial value:

= [
        'default' => false,
        'deprecated' => 'since 1.41',
    ]

Enable legacy media HTML structure in the output from the Parser.

The alternative modern HTML structure that replaces it is described at https://www.mediawiki.org/wiki/Parsing/Media_structure

Deprecated: since 1.41

Since: 1.36

Definition at line 6544 of file MainConfigSchema.php.

◆ ParserTestMediaHandlers

const MediaWiki\MainConfigSchema::ParserTestMediaHandlers

Initial value:

= [
        'default' => [
            'image/jpeg' => 'MockBitmapHandler',
            'image/png' => 'MockBitmapHandler',
            'image/gif' => 'MockBitmapHandler',
            'image/tiff' => 'MockBitmapHandler',
            'image/webp' => 'MockBitmapHandler',
            'image/x-ms-bmp' => 'MockBitmapHandler',
            'image/x-bmp' => 'MockBitmapHandler',
            'image/x-xcf' => 'MockBitmapHandler',
            'image/svg+xml' => 'MockSvgHandler',
            'image/vnd.djvu' => 'MockDjVuHandler',
        ],
        'type' => 'map',
    ]

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

Definition at line 1719 of file MainConfigSchema.php.

◆ ParsoidCacheConfig

const MediaWiki\MainConfigSchema::ParsoidCacheConfig

Initial value:

= [
        'type' => 'object',
        'properties' => [
            'StashType' => [ 'type' => 'int|string|null', 'default' => null ],
            'StashDuration' => [ 'type' => 'int', 'default' => 24 * 60 * 60 ],
            'WarmParsoidParserCache' => [ 'type' => 'bool', 'default' => false ],
        ]
    ]

Configuration for the caching related to parsoid output.

The configuration contains the following keys:

StashType: The type of object store to be used by the ParsoidOutputStash service, which stores the base state of HTML based edits. Valid options are the keys of $wgObjectCaches, e.g. CACHE_* constants. Per default, the value of the MainStash setting will be used. This should be an object store that provides fairly solid persistence guarantees, since losing an entry from the stash may mean that the user can't save their edit. If null, the value of the MainStash configuration setting will be used.
StashDuration: The number of seconds for which an entry in the stash should be kept. Should be long enough for users to finish editing, since losing an entry from the stash may mean that the user can't save their edit. This is set to one day per default.
WarmParsoidParserCache: Setting this to true will pre-populate the parsoid parser cache with parsoid outputs on page edits. This speeds up loading HTML into Visual Editor.

Since: 1.39

Stability: unstable: Per MediaWiki 1.39, the structure of this configuration is still subject to change.

Definition at line 4086 of file MainConfigSchema.php.

◆ ParsoidSettings

const MediaWiki\MainConfigSchema::ParsoidSettings

Initial value:

= [
        'default' => [
            'useSelser' => true,
        ],
        'type' => 'map',
    ]

Default Parsoid configuration.

Overriding the default configuration is strongly discouraged in production.

Since: 1.39

Definition at line 6529 of file MainConfigSchema.php.

◆ PasswordAttemptThrottle

const MediaWiki\MainConfigSchema::PasswordAttemptThrottle

Initial value:

= [
        'default' => [
            
            [ 'count' => 5, 'seconds' => 300 ],
            
            
            
            [ 'count' => 150, 'seconds' => 60 * 60 * 48 ],
        ],
        'type' => 'list',
    ]

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

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

Since: 1.27 allIps support and multiple limits added in 1.27. Prior to 1.27 this only supported having a single throttle.

Warning: Requires $wgMainCacheType to be enabled

Definition at line 8822 of file MainConfigSchema.php.

◆ PasswordConfig

const MediaWiki\MainConfigSchema::PasswordConfig

Configuration for built-in password types.

Maps the password type to an array of options:

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

All other options are class-dependent.

An advanced example:

$wgPasswordConfig['bcrypt-peppered'] = [
    'class' => EncryptedPassword::class,
    'underlying' => 'bcrypt',
    'secrets' => [
        hash( 'sha256', 'secret', true ),
    ],
    'cipher' => 'aes-256-cbc',
];

Since: 1.24

Definition at line 7250 of file MainConfigSchema.php.

◆ PasswordDefault

const MediaWiki\MainConfigSchema::PasswordDefault

Initial value:

= [
        'default' => 'pbkdf2',
    ]

Default password type to use when hashing user passwords.

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

Since: 1.24

Definition at line 7219 of file MainConfigSchema.php.

◆ PasswordExpirationDays

const MediaWiki\MainConfigSchema::PasswordExpirationDays

Initial value:

= [
        'default' => false,
    ]

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

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

Definition at line 2632 of file MainConfigSchema.php.

◆ PasswordExpireGrace

const MediaWiki\MainConfigSchema::PasswordExpireGrace

Initial value:

= [
        'default' => 3600 * 24 * 7,
    ]

If a user's password is expired, the number of seconds when they can still login, and cancel their password change, but are sent to the password change form on each login.

Definition at line 2640 of file MainConfigSchema.php.

◆ PasswordPolicy

const MediaWiki\MainConfigSchema::PasswordPolicy

Password policy for the wiki.

Structured as

[
    'policies' => [ <group> => [ <policy> => <settings>, ... ], ... ],
    'checks' => [ <policy> => <callback>, ... ],
]

where <group> is a user group, <policy> is a password policy name (arbitrary string) defined in the 'checks' part, <callback> is the PHP callable implementing the policy check, <settings> is an array of options with the following keys:

value: (number, boolean or null) the value to pass to the callback
forceChange: (boolean, default false) if the password is invalid, do not let the user log in without changing the password
suggestChangeOnLogin: (boolean, default false) if true and the password is invalid, suggest a password change if logging in. If all the failing policies that apply to the user have this set to false, the password change screen will not be shown. 'forceChange' takes precedence over 'suggestChangeOnLogin' if they are both present. As a shorthand for [ 'value' =>

], simply

can be written. When multiple password policies are defined for a user, the settings arrays are merged, and for fields which are set in both arrays, the larger value (as understood by PHP's 'max' method) is taken.

A user's effective policy is the superset of all policy statements from the policies for the groups where the user is a member. If more than one group policy include the same policy statement, the value is the max() of the values. Note true > false. The 'default' policy group is required, and serves as the minimum policy for all users.

Callbacks receive three arguments: the policy value, the User object and the password; and must return a StatusValue. A non-good status means the password will not be accepted for new accounts, and existing accounts will be prompted for password change or barred from logging in (depending on whether the status is a fatal or merely error/warning).

The checks supported by core are:

MinimalPasswordLength - Minimum length a user can set.
MinimumPasswordLengthToLogin - Passwords shorter than this will not be allowed to login, or offered a chance to reset their password as part of the login workflow, regardless if it is correct.
MaximalPasswordLength - maximum length password a user is allowed to attempt. Prevents DoS attacks with pbkdf2.
PasswordCannotBeSubstringInUsername - Password cannot be a substring (contained within) the username.
PasswordCannotMatchDefaults - Username/password combination cannot match a list of default passwords used by MediaWiki in the past.
PasswordNotInCommonList - Password not in best practices list of 100,000 commonly used passwords. Due to the size of the list this is a probabilistic test.

If you add custom checks, for Special:PasswordPolicies to display them correctly, every check should have a corresponding passwordpolicies-policy-<check> message, and every settings field other than 'value' should have a corresponding passwordpolicies-policyflag-<flag> message (<check> and <flag> are in lowercase). The check message receives the policy value as a parameter, the flag message receives the flag value (or values if it's an array).

Since: 1.26

See also: \PasswordPolicyChecks; \MediaWiki\User\User::checkPasswordValidity()

Definition at line 6945 of file MainConfigSchema.php.

◆ PasswordReminderResendTime

const MediaWiki\MainConfigSchema::PasswordReminderResendTime

Initial value:

= [
        'default' => 24,
    ]

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

This is to prevent abuse by mail flooding.

Definition at line 2610 of file MainConfigSchema.php.

◆ PasswordResetRoutes

const MediaWiki\MainConfigSchema::PasswordResetRoutes

Initial value:

= [
        'default' => [
            'username' => true,
            'email' => true,
        ],
        'type' => 'map',
    ]

Whether to allow password resets ("enter some identifying data, and we'll send an email with a temporary password you can use to get back into the account") identified by various bits of data.

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

Definition at line 7310 of file MainConfigSchema.php.

◆ PasswordSender

const MediaWiki\MainConfigSchema::PasswordSender

Initial value:

= [
        'default' => false,
    ]

Sender email address for e-mail notifications.

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

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

Definition at line 2542 of file MainConfigSchema.php.

◆ PhpCli

const MediaWiki\MainConfigSchema::PhpCli

Initial value:

= [
        'default' => '/usr/bin/php',
    ]

Executable path of the PHP cli binary.

Should be set up on install.

Definition at line 12394 of file MainConfigSchema.php.

◆ PHPSessionHandling

const MediaWiki\MainConfigSchema::PHPSessionHandling

Initial value:

= [
        'default' => 'enable',
        'type' => 'string',
    ]

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

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

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

Since: 1.27

Definition at line 4212 of file MainConfigSchema.php.

◆ Pingback

const MediaWiki\MainConfigSchema::Pingback

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Share data about this installation with MediaWiki developers.

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

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

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

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

Since: 1.28

Definition at line 12750 of file MainConfigSchema.php.

◆ PoolCountClientConf

const MediaWiki\MainConfigSchema::PoolCountClientConf

Initial value:

= [
        'default' => [
            'servers' => [
                '127.0.0.1'
            ],
            'timeout' => 0.1,
        ],
        'type' => 'map',
    ]

Configuration array for the PoolCounter client.

servers: Array of hostnames, or hostname:port. The default port is 7531.
timeout: Connection timeout.
connect_timeout: [Since 1.28] Alternative connection timeout. If set, it is used instead of timeout and will be retried once if a connection fails to be established. Background: https://phabricator.wikimedia.org/T105378.

See also: \MediaWiki\PoolCounter\PoolCounterClient

Since: 1.16

Definition at line 3717 of file MainConfigSchema.php.

◆ PoolCounterConf

const MediaWiki\MainConfigSchema::PoolCounterConf

Initial value:

= [
        'default' => null,
        'type' => '?map',
    ]

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

An implementation is provided in the PoolCounter extension.

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

Example using local redis instance:

$wgPoolCounterConf = [ 'ArticleView' => [
  'class' => PoolCounterRedis::class,
  'timeout' => 15, // wait timeout in seconds
  'workers' => 1, // maximum number of active threads in each pool
  'maxqueue' => 5, // maximum number of total threads in each pool
  'servers' => [ '127.0.0.1' ],
  'redisConfig' => []
] ];

Example using C daemon from https://gerrit.wikimedia.org/g/mediawiki/services/poolcounter

$wgPoolCountClientConf = [
  'servers' => [ '127.0.0.1' ],
  'timeout' => 0.5,
  'connect_timeout' => 0.01,
];
 
$wgPoolCounterConf = [ 'ArticleView' => [
  'class' => 'PoolCounter_Client',
  'timeout' => 15, // wait timeout in seconds
  'workers' => 5, // maximum number of active threads in each pool
  'maxqueue' => 50, // maximum number of total threads in each pool
  ... any extension-specific options...
] ];

Since: 1.16

Definition at line 3700 of file MainConfigSchema.php.

◆ PreprocessorCacheThreshold

const MediaWiki\MainConfigSchema::PreprocessorCacheThreshold

Initial value:

= [
        'default' => 1000,
    ]

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

Definition at line 6674 of file MainConfigSchema.php.

◆ PreviewOnOpenNamespaces

const MediaWiki\MainConfigSchema::PreviewOnOpenNamespaces

Initial value:

= [
        'default' => [
            NS_CATEGORY => true
        ],
        'type' => 'map',
    ]

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

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

Definition at line 10232 of file MainConfigSchema.php.

◆ PrivilegedGroups

const MediaWiki\MainConfigSchema::PrivilegedGroups

Initial value:

= [
        'default' => [
            'bureaucrat',
            'interface-admin',
            'suppress',
            'sysop',
        ],
        'type' => 'list',
    ]

List of groups which should be considered privileged (user accounts belonging in these groups can be abused in dangerous ways).

This is used for some security checks, mainly logging.

Since: 1.41

See also: \MediaWiki\User\UserGroupManager::getUserPrivilegedGroups()

Definition at line 8007 of file MainConfigSchema.php.

◆ Profiler

const MediaWiki\MainConfigSchema::Profiler

Initial value:

= [
        'default' => [],
        'type' => 'map',
        'mergeStrategy' => 'replace',
    ]

Profiler configuration.

To use a profiler, set $wgProfiler in LocalSettings.php.

Options:

'class' (string): The Profiler subclass to use. Default: ProfilerStub.
'sampling' (integer): Only enable the profiler on one in this many requests. For requests that are not in the sampling, the 'class' option will be replaced with ProfilerStub. Default: 1.
'threshold' (float): Only process the recorded data if the total elapsed time for a request is more than this number of seconds. Default: 0.0.
'output' (string|string[]): ProfilerOutput subclass or subclasess to use. Default: [].

The options array is passed in its entirety to the specified Profiler class. Check individual Profiler subclasses for additional options that may be available.

Profiler subclasses available in MediaWiki core:

ProfilerXhprof: Based on XHProf or Tideways-XHProf.
ProfilerExcimer: Based on Excimer.
ProfilerSectionOnly

Profiler output classes available in MediaWiki:

ProfilerOutputText: outputs profiling data in the web page body as a comment. You can make the profiling data in HTML render visibly instead by setting the 'visible' configuration flag.
ProfilerOutputStats: outputs profiling data as StatsD metrics. It expects that $wgStatsdServer is set to the host (or host:port) of a statsd server.
ProfilerOutputDump: outputs dump files that are compatible with the XHProf gui. It expects that ‘$wgProfiler['outputDir’]` is set as well.

Examples:

$wgProfiler = [
  'class' => ProfilerXhprof::class,
  'output' => ProfilerOutputText::class,
];

$wgProfiler = [
  'class' => ProfilerXhprof::class,
  'output' => [ ProfilerOutputText::class ],
  'sampling' => 50, // one in every 50 requests
];

For performance, the profiler is always disabled for CLI scripts as they could be long running and the data would accumulate. Use the --profiler parameter of maintenance scripts to override this.

Since: 1.17.0

Definition at line 9871 of file MainConfigSchema.php.

◆ ProhibitedFileExtensions

const MediaWiki\MainConfigSchema::ProhibitedFileExtensions

Initial value:

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

Files with these extensions will never be allowed as uploads.

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

Since: 1.37; previously $wgFileBlacklist

Definition at line 1588 of file MainConfigSchema.php.

◆ PropagateErrors

const MediaWiki\MainConfigSchema::PropagateErrors

Initial value:

= [
        'default' => true,
    ]

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

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

Definition at line 9766 of file MainConfigSchema.php.

◆ ProxyList

const MediaWiki\MainConfigSchema::ProxyList

Initial value:

= [
        'default' => [],
        'type' => 'string|list',
    ]

List of banned IP addresses.

This can have the following formats:

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

Definition at line 8618 of file MainConfigSchema.php.

◆ ProxyWhitelist

const MediaWiki\MainConfigSchema::ProxyWhitelist

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

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

Definition at line 8627 of file MainConfigSchema.php.

◆ PutIPinRC

const MediaWiki\MainConfigSchema::PutIPinRC

Initial value:

= [
        'default' => true,
    ]

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

CheckUser) or a DB admin Used for retroactive autoblocks

Definition at line 8798 of file MainConfigSchema.php.

◆ QueryCacheLimit

const MediaWiki\MainConfigSchema::QueryCacheLimit

Initial value:

= [
        'default' => 1000,
    ]

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

Definition at line 3617 of file MainConfigSchema.php.

◆ QueryPageDefaultLimit

const MediaWiki\MainConfigSchema::QueryPageDefaultLimit

Initial value:

= [
        'default' => 50,
    ]

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

Definition at line 8806 of file MainConfigSchema.php.

◆ RangeContributionsCIDRLimit

const MediaWiki\MainConfigSchema::RangeContributionsCIDRLimit

Initial value:

= [
        'default' => [
            'IPv4' => 16,
            'IPv6' => 32,
        ],
        'type' => 'map',
        'additionalProperties' => [ 'type' => 'integer', ],
    ]

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

Since: 1.30

Definition at line 11959 of file MainConfigSchema.php.

◆ RateLimits

const MediaWiki\MainConfigSchema::RateLimits

Simple rate limiter options to brake edit floods.

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

Example: Limits per configured per action and then type of users.

$wgRateLimits = [
    'edit' => [
        'anon' => [ x, y ], // any and all anonymous edits (aggregate)
        'user' => [ x, y ], // each logged-in user
        'user-global' => [ x, y ], // per username, across all sites (assumes names are
global)
        'newbie' => [ x, y ], // each new autoconfirmed accounts; overrides 'user'
        'ip' => [ x, y ], // each anon and recent account, across all sites
        'subnet' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
        'ip-all' => [ x, y ], // per ip, across all sites
        'subnet-all' => [ x, y ], // ... within a /24 subnet in IPv4 or /64 in IPv6
        'groupName' => [ x, y ], // by group membership
    ]
];

Normally, the 'noratelimit' right allows a user to bypass any rate limit checks. This can be disabled on a per-action basis by setting the special '&can-bypass' key to false in that action's configuration.

$wgRateLimits = [
    'some-action' => [
        '&can-bypass' => false,
        'user' => [ x, y ],
];

See also: self::ImplicitRights

Warning: Requires that $wgMainCacheType is set to something persistent

Definition at line 8696 of file MainConfigSchema.php.

◆ RateLimitsExcludedIPs

const MediaWiki\MainConfigSchema::RateLimitsExcludedIPs

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

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

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

Definition at line 8788 of file MainConfigSchema.php.

◆ RawHtml

const MediaWiki\MainConfigSchema::RawHtml

Initial value:

= [
        'default' => false,
    ]

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

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

Definition at line 6583 of file MainConfigSchema.php.

◆ RawHtmlMessages

const MediaWiki\MainConfigSchema::RawHtmlMessages

Initial value:

= [
        'default' => [
            'copyright',
            'history_copyright',
            'googlesearch',
        ],
        'type' => 'list',
        'items' => [ 'type' => 'string', ],
    ]

List of messages which might contain raw HTML.

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

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

Since: 1.32

Definition at line 5020 of file MainConfigSchema.php.

◆ RCChangedSizeThreshold

const MediaWiki\MainConfigSchema::RCChangedSizeThreshold

Initial value:

= [
        'default' => 500,
    ]

If the difference between the character counts of the text before and after the edit is below that value, the value will be highlighted on the RC page.

Definition at line 10667 of file MainConfigSchema.php.

◆ RCEngines

const MediaWiki\MainConfigSchema::RCEngines

Initial value:

= [
        'default' => [
            'redis' => RedisPubSubFeedEngine::class,
            'udp' => UDPRCFeedEngine::class,
        ],
        'type' => 'map',
    ]

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

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

Since: 1.22

Definition at line 10500 of file MainConfigSchema.php.

◆ RCFeeds

const MediaWiki\MainConfigSchema::RCFeeds

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Configuration for feeds to which notifications about recent changes will be sent.

The following feed classes are available by default:

'UDPRCFeedEngine' - sends recent changes over UDP to the specified server.
'RedisPubSubFeedEngine' - send recent changes to Redis.

Only 'class' or 'uri' is required. If 'uri' is set instead of 'class', then RecentChange::getEngine() is used to determine the class. All options are passed to the constructor.

Common options:

'class' – The class to use for this feed (must implement RCFeed).
'omit_bots' – Exclude bot edits from the feed. (default: false)
'omit_anon' – Exclude anonymous edits from the feed. (default: false)
'omit_user' – Exclude edits by registered users from the feed. (default: false)
'omit_minor' – Exclude minor edits from the feed. (default: false)
'omit_patrolled' – Exclude patrolled edits from the feed. (default: false)

FormattedRCFeed-specific options:

'uri' – [required] The address to which the messages are sent. The uri scheme of this string will be looked up in $wgRCEngines to determine which FormattedRCFeed class to use.
'formatter' – [required] The class (implementing RCFeedFormatter) which will produce the text to send. This can also be an object of the class. Formatters available by default: JSONRCFeedFormatter, XMLRCFeedFormatter, IRCColourfulRCFeedFormatter.

IRCColourfulRCFeedFormatter-specific options:

'add_interwiki_prefix' – whether the titles should be prefixed with the first entry in the $wgLocalInterwikis array

JSONRCFeedFormatter-specific options:

'channel' – if set, the 'channel' parameter is also set in JSON values.

Examples:

$wgRCFeeds['example'] = [
    'uri' => 'udp://localhost:1336',
    'formatter' => 'JSONRCFeedFormatter',
    'add_interwiki_prefix' => false,
    'omit_bots' => true,
];

$wgRCFeeds['example'] = [
    'uri' => 'udp://localhost:1338',
    'formatter' => 'IRCColourfulRCFeedFormatter',
    'add_interwiki_prefix' => false,
    'omit_bots' => true,
];

$wgRCFeeds['example'] = [
    'class' => ExampleRCFeed::class,
];

Since: 1.22

Definition at line 10488 of file MainConfigSchema.php.

◆ RCFilterByAge

const MediaWiki\MainConfigSchema::RCFilterByAge

Initial value:

= [
        'default' => false,
    ]

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

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

Definition at line 10401 of file MainConfigSchema.php.

◆ RCLinkDays

const MediaWiki\MainConfigSchema::RCLinkDays

Initial value:

= [
        'default' => [ 1, 3, 7, 14, 30 ],
        'type' => 'list',
    ]

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

See also: \MediaWiki\SpecialPage\ChangesListSpecialPage::getLinkDays

Definition at line 10420 of file MainConfigSchema.php.

◆ RCLinkLimits

const MediaWiki\MainConfigSchema::RCLinkLimits

Initial value:

= [
        'default' => [ 50, 100, 250, 500 ],
        'type' => 'list',
    ]

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

Definition at line 10409 of file MainConfigSchema.php.

◆ RCMaxAge

const MediaWiki\MainConfigSchema::RCMaxAge

Initial value:

= [
        'default' => 90 * 24 * 3600,
    ]

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

Default: 90 days = about three months

Definition at line 10367 of file MainConfigSchema.php.

◆ RCShowChangedSize

const MediaWiki\MainConfigSchema::RCShowChangedSize

Initial value:

= [
        'default' => true,
    ]

Show the amount of changed characters in recent changes.

Definition at line 10658 of file MainConfigSchema.php.

◆ RCShowWatchingUsers

const MediaWiki\MainConfigSchema::RCShowWatchingUsers

Initial value:

= [
        'default' => false,
    ]

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

Definition at line 10651 of file MainConfigSchema.php.

◆ RCWatchCategoryMembership

const MediaWiki\MainConfigSchema::RCWatchCategoryMembership

Initial value:

= [
        'default' => false,
    ]

Treat category membership changes as a RecentChange.

Changes are mentioned in RC for page actions as follows:

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

Since: 1.27

Definition at line 10520 of file MainConfigSchema.php.

◆ ReadOnly

const MediaWiki\MainConfigSchema::ReadOnly

Initial value:

= [
        'default' => null,
    ]

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

The text will be used as an explanation to users.

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

Definition at line 10279 of file MainConfigSchema.php.

◆ ReadOnlyFile

const MediaWiki\MainConfigSchema::ReadOnlyFile

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'UploadDirectory' ] ]
    ]

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

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

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

Definition at line 10301 of file MainConfigSchema.php.

◆ ReadOnlyWatchedItemStore

const MediaWiki\MainConfigSchema::ReadOnlyWatchedItemStore

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

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

Since: 1.31

Definition at line 10288 of file MainConfigSchema.php.

◆ ReauthenticateTime

const MediaWiki\MainConfigSchema::ReauthenticateTime

Initial value:

= [
        'default' => [ 'default' => 300, ],
        'type' => 'map',
        'additionalProperties' => [ 'type' => 'integer', ],
    ]

Time frame for re-authentication.

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

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

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

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

LinkAccounts
UnlinkAccount
ChangeCredentials
RemoveCredentials
ChangeEmail

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

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

Since: 1.27

Definition at line 7139 of file MainConfigSchema.php.

◆ RecentChangesFlags

const MediaWiki\MainConfigSchema::RecentChangesFlags

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

To register a new one:

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

Since: 1.22

Definition at line 10766 of file MainConfigSchema.php.

◆ RedirectOnLogin

const MediaWiki\MainConfigSchema::RedirectOnLogin

Initial value:

= [
        'default' => null,
    ]

Allow redirection to another page when a user logs in.

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

Definition at line 12648 of file MainConfigSchema.php.

◆ RedirectSources

const MediaWiki\MainConfigSchema::RedirectSources

Initial value:

= [
        'default' => false,
    ]

If local interwikis are set up which allow redirects, set this regexp to restrict URLs which will be displayed as 'redirected from' links.

Example: It might look something like this:

$wgRedirectSources = '!^https?://[a-z-]+\\.wikipedia\\.org/!';

$wgRedirectSources

Config variable stub for the RedirectSources setting, for use by phpdoc and IDEs.

Definition config-vars.php:2272

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

Definition at line 6375 of file MainConfigSchema.php.

◆ ReferrerPolicy

const MediaWiki\MainConfigSchema::ReferrerPolicy

Initial value:

= [
        'default' => false,
        'type' => 'list|string|false',
    ]

Value for the referrer policy meta tag.

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

Since: 1.25

Definition at line 734 of file MainConfigSchema.php.

◆ RegisterInternalExternals

const MediaWiki\MainConfigSchema::RegisterInternalExternals

Initial value:

= [
        'default' => false,
    ]

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

Definition at line 6642 of file MainConfigSchema.php.

◆ RememberMe

const MediaWiki\MainConfigSchema::RememberMe

Initial value:

= [
        'default' => 'choose',
        'type' => 'string',
    ]

Configures RememberMe authentication request added by AuthManager.

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

Valid values are listed in RememberMeAuthenticationRequest::ALLOWED_FLAGS.

Since: 1.36

Definition at line 7097 of file MainConfigSchema.php.

◆ RemoveCredentialsBlacklist

const MediaWiki\MainConfigSchema::RemoveCredentialsBlacklist

Initial value:

= [
        'default' => [
            \MediaWiki\Auth\PasswordAuthenticationRequest::class,
        ],
        'type' => 'list',
        'items' => [ 'type' => 'string', ],
    ]

List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata API.

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

Since: 1.27

Definition at line 7193 of file MainConfigSchema.php.

◆ RemoveGroups

const MediaWiki\MainConfigSchema::RemoveGroups

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

See also: self::AddGroups

Definition at line 8368 of file MainConfigSchema.php.

◆ RenderHashAppend

const MediaWiki\MainConfigSchema::RenderHashAppend

Initial value:

= [
        'default' => '',
    ]

Append a configured value to the parser cache and the sitenotice key so that they can be kept separate for some class of activity.

Definition at line 4382 of file MainConfigSchema.php.

◆ ReportToEndpoints

const MediaWiki\MainConfigSchema::ReportToEndpoints

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

List of endpoints for the Reporting API.

Stability: unstable: EXPERIMENTAL

Since: 1.34

Definition at line 12782 of file MainConfigSchema.php.

◆ ReportToExpiry

const MediaWiki\MainConfigSchema::ReportToExpiry

Initial value:

= [
        'default' => 86400,
        'type' => 'integer',
    ]

Expiry of the endpoint definition for the Reporting API.

Stability: unstable: EXPERIMENTAL

Since: 1.34

Definition at line 12771 of file MainConfigSchema.php.

◆ RepositoryBaseUrl

const MediaWiki\MainConfigSchema::RepositoryBaseUrl

Initial value:

= [
        'default' => 'https://commons.wikimedia.org/wiki/File:',
    ]

Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since: 1.5

Definition at line 1203 of file MainConfigSchema.php.

◆ RequestTimeLimit

const MediaWiki\MainConfigSchema::RequestTimeLimit

Initial value:

= [
        'default' => null,
        'type' => '?integer',
    ]

Set a limit on server request wall clock time.

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

Since: 1.36

Definition at line 3563 of file MainConfigSchema.php.

◆ ReservedUsernames

const MediaWiki\MainConfigSchema::ReservedUsernames

Initial value:

= [
        'default' => [
            'MediaWiki default', 
            'Conversion script', 
            'Maintenance script', 
            'Template namespace initialisation script', 
            'ScriptImporter', 
            'Delete page script', 
            'Move page script', 
            'Command line script', 
            'Unknown user', 
            'msg:double-redirect-fixer', 
            'msg:usermessage-editor', 
            'msg:proxyblocker', 
            'msg:sorbs', 
            'msg:spambot_username', 
            'msg:autochange-username', 
        ],
        'type' => 'list',
    ]

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

See also: \MediaWiki\User\User::MAINTENANCE_SCRIPT_USER

Definition at line 7366 of file MainConfigSchema.php.

◆ ResourceBasePath

const MediaWiki\MainConfigSchema::ResourceBasePath

Initial value:

= [
        'default' => null,
        'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
    ]

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

Defaults to $wgScriptPath.

Definition at line 5868 of file MainConfigSchema.php.

◆ ResourceLoaderDebug

const MediaWiki\MainConfigSchema::ResourceLoaderDebug

Initial value:

= [
        'default' => false,
    ]

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

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

Definition at line 5913 of file MainConfigSchema.php.

◆ ResourceLoaderEnableJSProfiler

const MediaWiki\MainConfigSchema::ResourceLoaderEnableJSProfiler

Initial value:

= [
        'default' => false,
    ]

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

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

Since: 1.32

Definition at line 5956 of file MainConfigSchema.php.

◆ ResourceLoaderEnableSourceMapLinks

const MediaWiki\MainConfigSchema::ResourceLoaderEnableSourceMapLinks

Initial value:

= [
        'default' => true,
    ]

Whether to include a SourceMap header in ResourceLoader responses for JavaScript modules.

Since: 1.41

Definition at line 5984 of file MainConfigSchema.php.

◆ ResourceLoaderMaxage

const MediaWiki\MainConfigSchema::ResourceLoaderMaxage

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

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

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

Valid keys:

versioned
unversioned

See also: \MediaWiki\ResourceLoader\ResourceLoader::__construct

Since: 1.35

Definition at line 5893 of file MainConfigSchema.php.

◆ ResourceLoaderMaxQueryLength

const MediaWiki\MainConfigSchema::ResourceLoaderMaxQueryLength

Initial value:

= [
        'default' => false,
        'type' => 'integer|false',
    ]

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

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

Default: 2000.

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

Since: 1.17

Definition at line 5929 of file MainConfigSchema.php.

◆ ResourceLoaderSources

const MediaWiki\MainConfigSchema::ResourceLoaderSources

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Extensions should register foreign module sources here.

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

Example:

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

$wgResourceLoaderSources

Config variable stub for the ResourceLoaderSources setting, for use by phpdoc and IDEs.

Definition config-vars.php:2067

Definition at line 5858 of file MainConfigSchema.php.

◆ ResourceLoaderStorageEnabled

const MediaWiki\MainConfigSchema::ResourceLoaderStorageEnabled

Initial value:

= [
        'default' => true,
    ]

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

Definition at line 5964 of file MainConfigSchema.php.

◆ ResourceLoaderStorageVersion

const MediaWiki\MainConfigSchema::ResourceLoaderStorageVersion

Initial value:

= [
        'default' => 1,
    ]

Cache version for client-side ResourceLoader module storage.

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

Since: 1.23

Definition at line 5974 of file MainConfigSchema.php.

◆ ResourceLoaderUseObjectCacheForDeps

const MediaWiki\MainConfigSchema::ResourceLoaderUseObjectCacheForDeps

Initial value:

= [
        'default' => false,
    ]

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

Stability: unstable: EXPERIMENTAL

Since: 1.35

Definition at line 5904 of file MainConfigSchema.php.

◆ ResourceLoaderValidateJS

const MediaWiki\MainConfigSchema::ResourceLoaderValidateJS

Initial value:

= [
        'default' => true,
    ]

Validate JavaScript code loaded from wiki pages.

If a syntax error is found, the script is replaced with a warning logged to the browser console. This ensures errors are found early and consistently (independent of the editor's own browser), and prevents breaking other modules loaded in the same batch from load.php.

See also: \MediaWiki\ResourceLoader\Module::validateScriptFile

Definition at line 5944 of file MainConfigSchema.php.

◆ ResourceModules

const MediaWiki\MainConfigSchema::ResourceModules

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

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

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

Registration is internally handled by ResourceLoader::register.

Available modules

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

Options

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

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

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

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

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

Use this option with caution. The default behaviour is well-tuned already, and setting this often does more harm than good. For more about request balancing optimisations, see ResourceLoader/Architecture#Balance.
skipFunction {string}: Allow this module to be satisfied as dependency without actually loading or executing scripts from the server, if the specified JavaScript function returns true.

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

FileModule options

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

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

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

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

See Stylesheet examples below.

See also $wgResourceModuleSkinStyles.

Extended options:
- skinStyles {string[]|string}: Styles to include in specific skin contexts. Array keyed is by skin name with file path or list of file paths as value, relative to localBasePath.
Default: []
noflip {boolean}: By default, CSSJanus will be used automatically to perform LTR-to-RTL flipping when loaded in a right-to-left (RTL) interface language context. Use this option to skip CSSJanus LTR-to-RTL flipping for this module, for example when registering an external library that already handles RTL styles.

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

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

See examples at ResourceLoader/Package_files on mediawiki.org.

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

Since: MW 1.33

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

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

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

Since MW 1.41, an element of scripts may be an array in the same format as packageFiles, giving a callback to call for content generation.

Default: []

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

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

Default: []
es6 {boolean}: Since: MW 1.36; ignored since MW 1.41.

Default: true
- skipStructureTest {boolean}: Whether to skip ResourcesTest::testRespond(). Since MW 1.42.
  
  Default: false.

Examples

Example: Using an alternate subclass

$wgResourceModules['ext.myExtension'] = [
  'class' => \\MediaWiki\\ResourceLoader\\WikiModule::class,
];

Example: Deprecated module

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

Example: Base paths in extension.json

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

Example: Base paths in core with PHP

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

Example: Define a skip function

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

Example: Contents of skip function file

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

Example: Stylesheets

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

Example: Package files

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

Example: Legacy scripts

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

Example: Template files

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

Since: 1.17

Definition at line 5743 of file MainConfigSchema.php.

◆ ResourceModuleSkinStyles

const MediaWiki\MainConfigSchema::ResourceModuleSkinStyles

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Add extra skin-specific styles to a resource module.

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

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

Example:

$wgResourceModules['bar'] = [
  'scripts' => 'resources/bar/bar.js',
  'styles' => 'resources/bar/main.css',
];
 
$wgResourceModuleSkinStyles['foo'] = [
  'bar' => 'skins/Foo/bar.css',
];

This is effectively equivalent to:

Equivalent:

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

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

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

Example:

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

This is effectively equivalent to:

Equivalent:

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

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

As with $wgResourceModules, always set the localBasePath and remoteBasePath keys (or one of remoteExtPath/remoteSkinPath).

Example:

$wgResourceModuleSkinStyles['foo'] = [
  'bar' => 'bar.css',
  'quux' => 'quux.css',
  'remoteSkinPath' => 'Foo',
  'localBasePath' => __DIR__,
];

Definition at line 5842 of file MainConfigSchema.php.

◆ ResponsiveImages

const MediaWiki\MainConfigSchema::ResponsiveImages

Initial value:

= [
        'default' => true,
    ]

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

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

Definition at line 2426 of file MainConfigSchema.php.

◆ RestAllowCrossOriginCookieAuth

const MediaWiki\MainConfigSchema::RestAllowCrossOriginCookieAuth

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

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

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

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

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

Since: 1.36

Definition at line 9330 of file MainConfigSchema.php.

◆ RestAPIAdditionalRouteFiles

const MediaWiki\MainConfigSchema::RestAPIAdditionalRouteFiles

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

Additional REST API Route files.

A common usage is to enable development/experimental endpoints only on test wikis.

Definition at line 12323 of file MainConfigSchema.php.

◆ RestPath

const MediaWiki\MainConfigSchema::RestPath

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
    ]

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

Since: 1.34

Definition at line 408 of file MainConfigSchema.php.

◆ RestrictDisplayTitle

const MediaWiki\MainConfigSchema::RestrictDisplayTitle

Initial value:

= [
        'default' => true,
    ]

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

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

Definition at line 6658 of file MainConfigSchema.php.

◆ RestrictionLevels

const MediaWiki\MainConfigSchema::RestrictionLevels

Initial value:

= [
        'default' => [ '', 'autoconfirmed', 'sysop' ],
        'type' => 'list',
    ]

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

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

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

Definition at line 8126 of file MainConfigSchema.php.

◆ RestrictionTypes

const MediaWiki\MainConfigSchema::RestrictionTypes

Initial value:

= [
        'default' => [ 'create', 'edit', 'move', 'upload' ],
        'type' => 'list',
    ]

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

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

Definition at line 8110 of file MainConfigSchema.php.

◆ RevertedTagMaxDepth

const MediaWiki\MainConfigSchema::RevertedTagMaxDepth

Initial value:

= [
        'default' => 15,
        'type' => 'integer',
    ]

Maximum depth (revision count) of reverts that will have their reverted edits marked with the mw-reverted change tag.

Reverts deeper than that will not have any edits marked as reverted at all.

Large values can lead to lots of revisions being marked as "reverted", which may appear confusing to users.

Setting this to 0 will disable the reverted tag entirely.

Since: 1.36

Definition at line 6825 of file MainConfigSchema.php.

◆ RevisionCacheExpiry

const MediaWiki\MainConfigSchema::RevisionCacheExpiry

Initial value:

= [
        'default' => SqlBlobStore::DEFAULT_TTL,
        'type' => 'integer',
    ]

Revision text may be cached in the main WAN cache to reduce load on external storage servers and object extraction overhead for frequently-loaded revisions.

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

Definition at line 3478 of file MainConfigSchema.php.

◆ RevokePermissions

const MediaWiki\MainConfigSchema::RevokePermissions

Initial value:

= [
        'default' => [],
        'type' => 'map',
        'mergeStrategy' => 'array_plus_2d',
    ]

Permission keys revoked from users in each group.

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

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

Definition at line 8026 of file MainConfigSchema.php.

◆ RightsIcon

const MediaWiki\MainConfigSchema::RightsIcon

Initial value:

= [
        'default' => null,
    ]

Override for copyright metadata.

Definition at line 10884 of file MainConfigSchema.php.

◆ RightsPage

const MediaWiki\MainConfigSchema::RightsPage

Initial value:

= [
        'default' => null,
    ]

Override for copyright metadata.

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

Definition at line 10855 of file MainConfigSchema.php.

◆ RightsText

const MediaWiki\MainConfigSchema::RightsText

Initial value:

= [
        'default' => null,
    ]

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

Otherwise, it will be treated as raw HTML.

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

Definition at line 10877 of file MainConfigSchema.php.

◆ RightsUrl

const MediaWiki\MainConfigSchema::RightsUrl

Initial value:

= [
        'default' => null,
    ]

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

If $wgRightsPage is set then this setting is ignored.

Definition at line 10865 of file MainConfigSchema.php.

◆ RunJobsAsync

const MediaWiki\MainConfigSchema::RunJobsAsync

Initial value:

= [
        'default' => false,
    ]

When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process to handle the job execution, instead of blocking the request until the job execution finishes.

Since: 1.23

Definition at line 12619 of file MainConfigSchema.php.

◆ Script

const MediaWiki\MainConfigSchema::Script

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
    ]

The URL path to index.php.

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

Definition at line 369 of file MainConfigSchema.php.

◆ ScriptPath

const MediaWiki\MainConfigSchema::ScriptPath

Initial value:

= [
        'default' => '/wiki',
    ]

The path we should point to.

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

This needs to be set correctly.

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

Definition at line 329 of file MainConfigSchema.php.

◆ SearchForwardUrl

const MediaWiki\MainConfigSchema::SearchForwardUrl

Initial value:

= [
        'default' => null,
    ]

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

If the URL includes '$1', this will be replaced with the URL-encoded search term. Before using this, $wgDisableTextSearch must be set to true.

Example: To forward to Google you'd have something like:

$wgSearchForwardUrl =
'https://www.google.com/search?q=$1' .
'&domains=https://example.com' .
'&sitesearch=https://example.com' .
'&ie=utf-8&oe=utf-8';

Definition at line 10123 of file MainConfigSchema.php.

◆ SearchHighlightBoundaries

const MediaWiki\MainConfigSchema::SearchHighlightBoundaries

Initial value:

= [
        'default' => '[\\p{Z}\\p{P}\\p{C}]',
    ]

Regexp to match word boundaries, defaults for non-CJK languages should be empty for CJK since the words are not separate.

Definition at line 10019 of file MainConfigSchema.php.

◆ SearchMatchRedirectPreference

const MediaWiki\MainConfigSchema::SearchMatchRedirectPreference

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Set true to allow logged-in users to set a preference whether or not matches in search results should force redirection to that page.

If false, the preference is not exposed and cannot be altered from site default. To change your site's default preference, set via $wgDefaultUserOptions['search-match-redirect'].

Since: 1.35

Definition at line 10190 of file MainConfigSchema.php.

◆ SearchRunSuggestedQuery

const MediaWiki\MainConfigSchema::SearchRunSuggestedQuery

Initial value:

= [
        'default' => true,
        'type' => 'boolean',
    ]

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

Since: 1.26

Definition at line 10201 of file MainConfigSchema.php.

◆ SearchSuggestCacheExpiry

const MediaWiki\MainConfigSchema::SearchSuggestCacheExpiry

Initial value:

= [
        'default' => 1200,
    ]

Expiry time for search suggestion responses.

Definition at line 10071 of file MainConfigSchema.php.

◆ SearchType

const MediaWiki\MainConfigSchema::SearchType

Initial value:

= [
        'default' => null,
    ]

Search type.

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

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

Definition at line 2940 of file MainConfigSchema.php.

◆ SearchTypeAlternatives

const MediaWiki\MainConfigSchema::SearchTypeAlternatives

Initial value:

= [
        'default' => null,
    ]

Alternative search types.

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

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

Definition at line 2956 of file MainConfigSchema.php.

◆ SecretKey

const MediaWiki\MainConfigSchema::SecretKey

Initial value:

= [
        'default' => false,
    ]

This should always be customised in LocalSettings.php.

Definition at line 9159 of file MainConfigSchema.php.

◆ SecureLogin

const MediaWiki\MainConfigSchema::SecureLogin

Initial value:

= [
        'default' => false,
    ]

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

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

Since: 1.17

Definition at line 7552 of file MainConfigSchema.php.

◆ SemiprotectedRestrictionLevels

const MediaWiki\MainConfigSchema::SemiprotectedRestrictionLevels

Initial value:

= [
        'default' => [ 'autoconfirmed', ],
        'type' => 'list',
    ]

Restriction levels that should be considered "semiprotected".

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

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

Definition at line 8157 of file MainConfigSchema.php.

◆ Send404Code

const MediaWiki\MainConfigSchema::Send404Code

Initial value:

= [
        'default' => true,
    ]

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

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

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

Definition at line 5369 of file MainConfigSchema.php.

◆ Server

const MediaWiki\MainConfigSchema::Server

Initial value:

= [
        'default' => false,
    ]

URL of the server.

Example:

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

$wgServer

Config variable stub for the Server setting, for use by phpdoc and IDEs.

Definition config-vars.php:25

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

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

Definition at line 245 of file MainConfigSchema.php.

◆ ServerName

const MediaWiki\MainConfigSchema::ServerName

Initial value:

= [
        'default' => false,
    ]

Server name.

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

Since: 1.24

Definition at line 268 of file MainConfigSchema.php.

◆ ServiceWiringFiles

const MediaWiki\MainConfigSchema::ServiceWiringFiles

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

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

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

Note: the default wiring file will be added automatically by Setup.php

See also: \MediaWiki\MediaWikiServices; \Wikimedia\Services\ServiceContainer::loadWiringFiles() for details on loading service instantiator functions.; docs/Injection.md for an overview of dependency injection in MediaWiki.

Definition at line 11362 of file MainConfigSchema.php.

◆ SessionCacheType

const MediaWiki\MainConfigSchema::SessionCacheType

Initial value:

= [
        'default' => CACHE_ANYTHING,
    ]

The cache backend for storing session data.

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

See SessionManager Storage expectations.

Definition at line 3888 of file MainConfigSchema.php.

◆ SessionInsecureSecrets

const MediaWiki\MainConfigSchema::SessionInsecureSecrets

Initial value:

= [
        'default' => false,
    ]

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

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

Since: 1.27

Definition at line 9355 of file MainConfigSchema.php.

◆ SessionName

const MediaWiki\MainConfigSchema::SessionName

Initial value:

= [
        'default' => false,
    ]

Override to customise the session name.

Definition at line 9498 of file MainConfigSchema.php.

◆ SessionPbkdf2Iterations

const MediaWiki\MainConfigSchema::SessionPbkdf2Iterations

Initial value:

= [
        'default' => 10001,
    ]

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

Since: 1.28

Definition at line 4234 of file MainConfigSchema.php.

◆ SessionProviders

const MediaWiki\MainConfigSchema::SessionProviders

Initial value:

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

MediaWiki\Session\SessionProvider configuration.

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

Since: 1.27

Definition at line 7579 of file MainConfigSchema.php.

◆ SessionSecret

const MediaWiki\MainConfigSchema::SessionSecret

Initial value:

= [
        'default' => false,
    ]

Secret for session storage.

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

Since: 1.27

Definition at line 9343 of file MainConfigSchema.php.

◆ SharedDB

const MediaWiki\MainConfigSchema::SharedDB

Initial value:

= [
        'default' => null,
    ]

Shared database for multiple wikis.

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

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

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

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

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

Definition at line 3016 of file MainConfigSchema.php.

◆ SharedPrefix

const MediaWiki\MainConfigSchema::SharedPrefix

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'DBprefix' ] ]
    ]

See also: self::SharedDB

Definition at line 3023 of file MainConfigSchema.php.

◆ SharedSchema

const MediaWiki\MainConfigSchema::SharedSchema

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'DBmwschema' ] ]
    ]

See also: self::SharedDB

Since: 1.23

Definition at line 3053 of file MainConfigSchema.php.

◆ SharedTables

const MediaWiki\MainConfigSchema::SharedTables

Initial value:

= [
        'default' => [
            'user',
            'user_properties',
            'user_autocreate_serial',
        ],
        'type' => 'list',
    ]

See also: self::SharedDB The installer will add 'actor' to this list for all new wikis.

Definition at line 3040 of file MainConfigSchema.php.

◆ SharedThumbnailScriptPath

const MediaWiki\MainConfigSchema::SharedThumbnailScriptPath

Initial value:

= [
        'default' => false,
        'type' => 'string|false',
    ]

Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since: 1.3

Definition at line 1552 of file MainConfigSchema.php.

◆ SharedUploadDBname

const MediaWiki\MainConfigSchema::SharedUploadDBname

Initial value:

= [
        'default' => false,
        'type' => 'false|string',
    ]

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

Set this to false if the uploads do not come from a wiki. Only used if $wgUseSharedUploads is enabled.

Since: 1.4

Definition at line 1227 of file MainConfigSchema.php.

◆ SharedUploadDBprefix

const MediaWiki\MainConfigSchema::SharedUploadDBprefix

Initial value:

= [
        'default' => '',
        'type' => 'string',
    ]

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

Only used if $wgUseSharedUploads is enabled.

Since: 1.5

Definition at line 1239 of file MainConfigSchema.php.

◆ SharedUploadDirectory

const MediaWiki\MainConfigSchema::SharedUploadDirectory

Initial value:

= [
        'default' => null,
        'type' => '?string',
    ]

Shortcut for the 'directory' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since: 1.3

Definition at line 1167 of file MainConfigSchema.php.

◆ SharedUploadPath

const MediaWiki\MainConfigSchema::SharedUploadPath

Initial value:

= [
        'default' => null,
        'type' => '?string',
    ]

Shortcut for the 'url' setting of $wgForeignFileRepos.

Only used if $wgUseSharedUploads is enabled.

Since: 1.3

Definition at line 1179 of file MainConfigSchema.php.

◆ SharpenParameter

const MediaWiki\MainConfigSchema::SharpenParameter

Initial value:

= [
        'default' => '0x0.4',
    ]

Sharpening parameter to ImageMagick.

Definition at line 1777 of file MainConfigSchema.php.

◆ SharpenReductionThreshold

const MediaWiki\MainConfigSchema::SharpenReductionThreshold

Initial value:

= [
        'default' => 0.85,
    ]

Reduction in linear dimensions below which sharpening will be enabled.

Definition at line 1784 of file MainConfigSchema.php.

◆ ShellboxSecretKey

const MediaWiki\MainConfigSchema::ShellboxSecretKey

Initial value:

= [
        'default' => null,
        'type' => '?string',
    ]

The secret key for HMAC verification of Shellbox requests.

Set this to a long random string.

Since: 1.36

Definition at line 12442 of file MainConfigSchema.php.

◆ ShellboxShell

const MediaWiki\MainConfigSchema::ShellboxShell

Initial value:

= [
        'default' => '/bin/sh',
        'type' => '?string',
    ]

The POSIX-compatible shell to use when running scripts.

This is used by some media handling shell commands.

If ShellboxUrls is configured, this path should exist on the remote side. On Windows this should be the full path to bash.exe, not git-bash.exe.

Since: 1.42

Definition at line 12456 of file MainConfigSchema.php.

◆ ShellboxUrls

const MediaWiki\MainConfigSchema::ShellboxUrls

Initial value:

= [
        'default' => [ 'default' => null, ],
        'type' => 'map',
        'additionalProperties' => [
            'type' => 'string|false|null',
        ],
    ]

Shell commands can be run on a remote server using Shellbox.

To use this feature, set this to the URLs mapped by the service, and also configure $wgShellboxSecretKey.

You can also disable a certain service by setting it to false or null.

'default' would be the default URL if no URL is defined for that service.

For more information about installing Shellbox, see https://www.mediawiki.org/wiki/Shellbox

Since: 1.37

Definition at line 12428 of file MainConfigSchema.php.

◆ ShellCgroup

const MediaWiki\MainConfigSchema::ShellCgroup

Initial value:

= [
        'default' => false,
    ]

Under Linux: a cgroup directory used to constrain memory usage of shell commands.

The directory must be writable by the user which runs MediaWiki.

If specified, this is used instead of ulimit, which is inaccurate, and causes malloc() to return NULL, which exposes bugs in C applications, making them segfault or deadlock.

A wrapper script will create a cgroup for each shell command that runs, as a subgroup of the specified cgroup. If the memory limit is exceeded, the kernel will send a SIGKILL signal to a process in the subgroup.

Example:

mkdir -p /sys/fs/cgroup/memory/mediawiki
mkdir -m 0777 /sys/fs/cgroup/memory/mediawiki/job
echo '$wgShellCgroup = "/sys/fs/cgroup/memory/mediawiki/job";' >> LocalSettings.php

The reliability of cgroup cleanup can be improved by installing a notify_on_release script in the root cgroup, see e.g. https://gerrit.wikimedia.org/r/#/c/40784

Definition at line 12387 of file MainConfigSchema.php.

◆ ShellRestrictionMethod

const MediaWiki\MainConfigSchema::ShellRestrictionMethod

Initial value:

= [
        'default' => 'autodetect',
        'type' => 'string|false',
    ]

Method to use to restrict shell commands.

Supported options:

'autodetect': Autodetect if any restriction methods are available
'firejail': Use firejail https://firejail.wordpress.com/
false: Don't use any restrictions

Note: If using firejail with MediaWiki running in a home directory different from the webserver user, firejail 0.9.44+ is required.

Since: 1.31

Definition at line 12410 of file MainConfigSchema.php.

◆ ShortPagesNamespaceExclusions

const MediaWiki\MainConfigSchema::ShortPagesNamespaceExclusions

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

Optional array of namespaces which should be excluded from Special:ShortPages.

Only pages inside $wgContentNamespaces but not $wgShortPagesNamespaceExclusions will be shown on that page.

Since: 1.37; previously $wgShortPagesNamespaceBlacklist

Definition at line 6236 of file MainConfigSchema.php.

◆ ShowArchiveThumbnails

const MediaWiki\MainConfigSchema::ShowArchiveThumbnails

Initial value:

= [
        'default' => true,
    ]

Show thumbnails for old images on the image description page.

Definition at line 2084 of file MainConfigSchema.php.

◆ ShowCreditsIfMax

const MediaWiki\MainConfigSchema::ShowCreditsIfMax

Initial value:

= [
        'default' => true,
    ]

If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.

Otherwise, link to a separate credits page.

Definition at line 10911 of file MainConfigSchema.php.

◆ ShowDebug

const MediaWiki\MainConfigSchema::ShowDebug

Initial value:

= [
        'default' => false,
    ]

Display debug data at the bottom of the main content area.

Useful for developers and technical users trying to working on a closed wiki.

Definition at line 9733 of file MainConfigSchema.php.

◆ ShowExceptionDetails

const MediaWiki\MainConfigSchema::ShowExceptionDetails

Initial value:

= [
        'default' => false,
    ]

Show exception message and stack trace when printing details about uncaught exceptions in web response output.

This may reveal private information in error messages or function parameters. If set to false, only the exception type or class name will be exposed.

Definition at line 9751 of file MainConfigSchema.php.

◆ ShowEXIF

const MediaWiki\MainConfigSchema::ShowEXIF

Initial value:

= [
        'dynamicDefault' => [ 'callback' => [ self::class, 'getDefaultShowEXIF' ] ],
    ]

Whether to show Exif data.

The effective default value is determined at runtime: enabled if PHP's EXIF extension module is loaded.

Requires PHP's Exif extension: https://www.php.net/manual/en/ref.exif.php

Note: FOR WINDOWS USERS: To enable Exif functions, add the following line to the "Windows extensions" section of php.ini:

extension=extensions/php_exif.dll

Definition at line 1383 of file MainConfigSchema.php.

◆ ShowHostnames

const MediaWiki\MainConfigSchema::ShowHostnames

Initial value:

= [
        'default' => false,
    ]

Expose backend server host names through the API and various HTML comments.

Definition at line 9773 of file MainConfigSchema.php.

◆ ShowLogoutConfirmation

const MediaWiki\MainConfigSchema::ShowLogoutConfirmation

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Whether to display a confirmation screen during user log out.

Stability: unstable: Temporary feature flag, T357484

Since: 1.42

Definition at line 12856 of file MainConfigSchema.php.

◆ ShowRollbackEditCount

const MediaWiki\MainConfigSchema::ShowRollbackEditCount

Initial value:

= [
        'default' => 10,
    ]

The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.

The numeric value of the variable controls how many edits MediaWiki will look back to determine whether a rollback is allowed (by checking that they are all from the same author). If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki from hiding some useless rollback links.

Since: 1.20

Definition at line 5383 of file MainConfigSchema.php.

◆ ShowUpdatedMarker

const MediaWiki\MainConfigSchema::ShowUpdatedMarker

Initial value:

= [
        'default' => true,
    ]

Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes.

Definition at line 10675 of file MainConfigSchema.php.

◆ SidebarCacheExpiry

const MediaWiki\MainConfigSchema::SidebarCacheExpiry

Initial value:

= [
        'default' => 86400,
    ]

Expiry time for the sidebar cache, in seconds.

Definition at line 4402 of file MainConfigSchema.php.

◆ SignatureAllowedLintErrors

const MediaWiki\MainConfigSchema::SignatureAllowedLintErrors

Initial value:

= [
        'default' => [ 'obsolete-tag', ],
        'type' => 'list',
    ]

List of lint error codes which don't cause signature validation to fail.

See also: https://www.mediawiki.org/wiki/Help:Lint_errors

Since: 1.35

Definition at line 7347 of file MainConfigSchema.php.

◆ SignatureValidation

const MediaWiki\MainConfigSchema::SignatureValidation

Initial value:

= [
        'default' => 'warning',
    ]

Behavior of signature validation.

Allowed values are:

'warning' - invalid signatures cause a warning to be displayed on the preferences page, but they are still used when signing comments; new invalid signatures can still be saved as normal
'new' - existing invalid signatures behave as above; new invalid signatures can't be saved
'disallow' - existing invalid signatures are no longer used when signing comments; new invalid signatures can't be saved

Since: 1.35

Definition at line 7337 of file MainConfigSchema.php.

◆ SitemapNamespaces

const MediaWiki\MainConfigSchema::SitemapNamespaces

Initial value:

= [
        'default' => false,
        'type' => 'false|list',
    ]

Array of namespaces to generate a Google sitemap for when the maintenance/generateSitemap.php script is run, or false if one is to be generated for all namespaces.

Definition at line 10132 of file MainConfigSchema.php.

◆ SitemapNamespacesPriorities

const MediaWiki\MainConfigSchema::SitemapNamespacesPriorities

Initial value:

= [
        'default' => false,
        'type' => 'false|map',
    ]

Custom namespace priorities for sitemaps.

Setting this will allow you to set custom priorities to namespaces when sitemaps are generated using the maintenance/generateSitemap.php script.

This should be a map of namespace IDs to priority

Example:

$wgSitemapNamespacesPriorities = [
    NS_USER => '0.9',
    NS_HELP => '0.0',
];

Definition at line 10153 of file MainConfigSchema.php.

◆ Sitename

const MediaWiki\MainConfigSchema::Sitename

Initial value:

= [
        'default' => 'MediaWiki',
    ]

Name of the site.

It must be changed in LocalSettings.php

Definition at line 215 of file MainConfigSchema.php.

◆ SiteNotice

const MediaWiki\MainConfigSchema::SiteNotice

Initial value:

= [
        'default' => '',
    ]

Site notice shown at the top of each page.

MediaWiki:Sitenotice page, which will override this. You can also provide a separate message for logged-out users using the MediaWiki:Anonnotice page.

Definition at line 5172 of file MainConfigSchema.php.

◆ SiteTypes

const MediaWiki\MainConfigSchema::SiteTypes

Initial value:

= [
        'default' => [ 'mediawiki' => MediaWikiSite::class, ],
        'type' => 'map',
    ]

Register handlers for specific types of sites.

Since: 1.21

Definition at line 6384 of file MainConfigSchema.php.

◆ SkinMetaTags

const MediaWiki\MainConfigSchema::SkinMetaTags

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

An array of open graph tags which should be added by all skins.

Accepted values are "og:site_name", "og:title", "og:type" and "twitter:card". Since some of these fields can be provided by extensions it defaults to an empty array.

Since: 1.36

Definition at line 5200 of file MainConfigSchema.php.

◆ SkinsPreferred

const MediaWiki\MainConfigSchema::SkinsPreferred

Initial value:

= [
        'default' => [ 'vector-2022', 'vector' ],
        'type' => 'list',
    ]

List of preferred skins to be listed higher in Special:Preferences.

Since: 1.38

Definition at line 12805 of file MainConfigSchema.php.

◆ SkipSkins

const MediaWiki\MainConfigSchema::SkipSkins

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Specify the names of skins that should not be presented in the list of available skins in user preferences.

NOTE: This does not uninstall the skin, and it will still be accessible via the useskin query parameter. To uninstall a skin, remove its inclusion from LocalSettings.php.

See also: \SkinFactory::getAllowedSkins

Definition at line 5232 of file MainConfigSchema.php.

◆ SMTP

const MediaWiki\MainConfigSchema::SMTP

Initial value:

= [
        'default' => false,
        'type' => 'false|map',
    ]

SMTP Mode.

For using a direct (authenticated) SMTP server connection. Default to false or fill an array :

$wgSMTP = [
    'host'     => 'SMTP domain',
    'IDHost'   => 'domain for MessageID',
    'port'     => '25',
    'auth'     => [true|false],
    'username' => [SMTP username],
    'password' => [SMTP password],
];

Definition at line 2661 of file MainConfigSchema.php.

◆ SoftBlockRanges

const MediaWiki\MainConfigSchema::SoftBlockRanges

Initial value:

= [
        'default' => [],
        'type' => 'list',
        'items' => [ 'type' => 'string', ],
    ]

IP ranges that should be considered soft-blocked (anon-only, account creation allowed).

The intent is to use this to prevent anonymous edits from shared resources such as Wikimedia Labs.

Since: 1.29

Definition at line 8639 of file MainConfigSchema.php.

◆ SoftwareTags

const MediaWiki\MainConfigSchema::SoftwareTags

Initial value:

= [
        'default' => [
            'mw-contentmodelchange' => true,
            'mw-new-redirect' => true,
            'mw-removed-redirect' => true,
            'mw-changed-redirect-target' => true,
            'mw-blank' => true,
            'mw-replace' => true,
            'mw-rollback' => true,
            'mw-undo' => true,
            'mw-manual-revert' => true,
            'mw-reverted' => true,
            'mw-server-side-upload' => true,
        ],
        'type' => 'map',
        'additionalProperties' => [ 'type' => 'boolean', ],
    ]

List of core tags to enable.

Since: 1.31; 1.36 Added 'mw-manual-revert' and 'mw-reverted'

See also: \ChangeTags::TAG_CONTENT_MODEL_CHANGE; \ChangeTags::TAG_NEW_REDIRECT; \ChangeTags::TAG_REMOVED_REDIRECT; \ChangeTags::TAG_CHANGED_REDIRECT_TARGET; \ChangeTags::TAG_BLANK; \ChangeTags::TAG_REPLACE; \ChangeTags::TAG_ROLLBACK; \ChangeTags::TAG_UNDO; \ChangeTags::TAG_MANUAL_REVERT; \ChangeTags::TAG_REVERTED; \ChangeTags::TAG_SERVER_SIDE_UPLOAD

Definition at line 10712 of file MainConfigSchema.php.

◆ SpamRegex

const MediaWiki\MainConfigSchema::SpamRegex

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

Edits matching these regular expressions in body text will be recognised as spam and rejected automatically.

There's no administrator override on-wiki, so be careful what you set. :) May be an array of regexes or a single string for backwards compatibility.

See also: https://en.wikipedia.org/wiki/Regular_expression

Note: Each regex needs a beginning/end delimiter, eg: # or /

Definition at line 8558 of file MainConfigSchema.php.

◆ SpecialContributeSkinsEnabled

const MediaWiki\MainConfigSchema::SpecialContributeSkinsEnabled

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

List of skins to not show the Special:Contribute page.

Since: 1.40

Definition at line 12815 of file MainConfigSchema.php.

◆ SpecialPageCacheUpdates

const MediaWiki\MainConfigSchema::SpecialPageCacheUpdates

Initial value:

= [
        'default' => [
            'Statistics' => [ SiteStatsUpdate::class, 'cacheUpdate' ]
        ],
        'type' => 'map',
    ]

Additional functions to be performed with updateSpecialPages.

Expensive Querypages are already updated.

Definition at line 11525 of file MainConfigSchema.php.

◆ SpecialPages

const MediaWiki\MainConfigSchema::SpecialPages

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Special page list.

This is an associative array mapping the (canonical) names of special pages to either a class name or a ObjectFactory spec to be instantiated, or a callback to use for creating the special page object. In all cases, the result must be an instance of SpecialPage.

Definition at line 11228 of file MainConfigSchema.php.

◆ SpecialSearchFormOptions

const MediaWiki\MainConfigSchema::SpecialSearchFormOptions

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Options for Special:Search completion widget form created by SearchFormWidget class.

Settings that can be used:

showDescriptions: true/false - whether to show opensearch description results
performSearchOnClick: true/false - whether to perform search on click See also TitleWidget.js UI widget.

Since: 1.34

Definition at line 10177 of file MainConfigSchema.php.

◆ SpecialVersionShowHooks

const MediaWiki\MainConfigSchema::SpecialVersionShowHooks

Initial value:

= [
        'default' => false,
    ]

Show the contents of $wgHooks in Special:Version.

Definition at line 9740 of file MainConfigSchema.php.

◆ SQLiteDataDir

const MediaWiki\MainConfigSchema::SQLiteDataDir

Initial value:

= [
        'default' => '',
    ]

To override default SQLite data directory ($docroot/../data)

Definition at line 2992 of file MainConfigSchema.php.

◆ SQLMode

const MediaWiki\MainConfigSchema::SQLMode

Initial value:

= [
        'default' => '',
    ]

SQL Mode - default is turning off all modes, including strict, if set.

null can be used to skip the setting for performance reasons and assume DBA has done his best job. String override can be used for some additional fun :-)

Definition at line 2974 of file MainConfigSchema.php.

◆ StatsdMetricPrefix

const MediaWiki\MainConfigSchema::StatsdMetricPrefix

Initial value:

= [
        'default' => 'MediaWiki',
    ]

Prefix for metric names sent to $wgStatsdServer.

See also: \MediaWiki\MediaWikiServices::getInstance()->getStatsdDataFactory; \BufferingStatsdDataFactory

Since: 1.25

Definition at line 9898 of file MainConfigSchema.php.

◆ StatsdSamplingRates

const MediaWiki\MainConfigSchema::StatsdSamplingRates

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Sampling rate for statsd metrics as an associative array of patterns and rates.

Patterns are Unix shell patterns (e.g. 'MediaWiki.api.*'). Rates are sampling probabilities (e.g. 0.1 means 1 in 10 events are sampled).

Since: 1.28

Definition at line 9910 of file MainConfigSchema.php.

◆ StatsdServer

const MediaWiki\MainConfigSchema::StatsdServer

Initial value:

= [
        'default' => false,
    ]

Destination of statsd metrics.

A host or host:port of a statsd server. Port defaults to 8125.

If not set, statsd metrics will not be collected.

See also: MediaWiki::emitBufferedStatsdData()

Since: 1.25

Definition at line 9887 of file MainConfigSchema.php.

◆ StatsFormat

const MediaWiki\MainConfigSchema::StatsFormat

Initial value:

= [
        'default' => null,
        'type' => '?string',
    ]

Stats output format.

If null, metrics will not be rendered nor sent. Note: this only affects metrics instantiated by the StatsFactory service

See also: \Wikimedia\Stats\OutputFormats::SUPPORTED_FORMATS

Since: 1.41

Definition at line 9937 of file MainConfigSchema.php.

◆ StatsPrefix

const MediaWiki\MainConfigSchema::StatsPrefix

Initial value:

= [
        'default' => 'mediawiki',
        'type' => 'string',
    ]

Stats service name prefix.

Required. Must not be zero-length. Defaults to: 'mediawiki' Note: this only affects metrics instantiated by the StatsFactory service

Since: 1.41

Definition at line 9951 of file MainConfigSchema.php.

◆ StatsTarget

const MediaWiki\MainConfigSchema::StatsTarget

Initial value:

= [
        'default' => null,
        'type' => '?string',
    ]

Stats output target URI e.g.

udp://127.0.0.1:8125

If null, metrics will not be sent. Note: this only affects metrics instantiated by the StatsFactory service

Since: 1.38

Definition at line 9923 of file MainConfigSchema.php.

◆ StrictFileExtensions

const MediaWiki\MainConfigSchema::StrictFileExtensions

Initial value:

= [
        'default' => true,
    ]

If this is turned off, users may override the warning for files not covered by $wgFileExtensions.

Warning: Setting this to false is insecure for public wikis.

Definition at line 1647 of file MainConfigSchema.php.

◆ StructuredChangeFiltersLiveUpdatePollingRate

const MediaWiki\MainConfigSchema::StructuredChangeFiltersLiveUpdatePollingRate

Initial value:

= [
        'default' => 3,
    ]

Polling rate, in seconds, used by the 'live update' and 'view newest' features of the RCFilters app on SpecialRecentChanges and Special:Watchlist.

0 to disable completely.

Definition at line 10542 of file MainConfigSchema.php.

◆ StyleDirectory

const MediaWiki\MainConfigSchema::StyleDirectory

Initial value:

= [
        'default' => null,
        'type' => '?string',
    ]

Skins directory in the file system.

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

Since: 1.3

Definition at line 501 of file MainConfigSchema.php.

◆ StylePath

const MediaWiki\MainConfigSchema::StylePath

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'ResourceBasePath' ] ]
    ]

The URL path of the skins directory.

Defaults to "{$wgResourceBasePath}/skins".

Since: 1.3

Definition at line 428 of file MainConfigSchema.php.

◆ SummarySpamRegex

const MediaWiki\MainConfigSchema::SummarySpamRegex

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

Same as SpamRegex except for edit summaries.

Definition at line 8566 of file MainConfigSchema.php.

◆ SuspiciousIpExpiry

const MediaWiki\MainConfigSchema::SuspiciousIpExpiry

Initial value:

= [
        'default' => false,
        'type' => 'integer|false',
    ]

Time in seconds to remember IPs for, for the purposes of logging IP changes within the same session.

This is meant more for debugging errors in the authentication system than for detecting abuse.

Since: 1.36

Definition at line 4224 of file MainConfigSchema.php.

◆ SVGConverter

const MediaWiki\MainConfigSchema::SVGConverter

Initial value:

= [
        'default' => 'ImageMagick',
    ]

Pick a converter defined in $wgSVGConverters.

Definition at line 1898 of file MainConfigSchema.php.

◆ SVGConverterPath

const MediaWiki\MainConfigSchema::SVGConverterPath

Initial value:

= [
        'default' => '',
    ]

If not in the executable PATH, specify the SVG converter path.

Definition at line 1905 of file MainConfigSchema.php.

◆ SVGConverters

const MediaWiki\MainConfigSchema::SVGConverters

Initial value:

= [
        'default' => [
            'ImageMagick' => '$path/convert -background "#ffffff00" -thumbnail $widthx$height\\! $input PNG:$output',
            'sodipodi' => '$path/sodipodi -z -w $width -f $input -e $output',
            'inkscape' => '$path/inkscape -z -w $width -f $input -e $output',
            'batik' => 'java -Djava.awt.headless=true -jar $path/batik-rasterizer.jar -w $width -d $output $input',
            'rsvg' => '$path/rsvg-convert -w $width -h $height -o $output $input',
            'imgserv' => '$path/imgserv-wrapper -i svg -o png -w$width $input $output',
            'ImagickExt' => [ 'SvgHandler::rasterizeImagickExt', ],
        ],
        'type' => 'map',
    ]

Scalable Vector Graphics (SVG) may be uploaded as images.

Since SVG support is not yet standard in browsers, it is necessary to rasterize SVGs to PNG as a fallback format.

An external program is required to perform this conversion. If set to an array, the first item is a PHP callable and any further items are passed as parameters after $srcPath, $dstPath, $width, $height

Definition at line 1882 of file MainConfigSchema.php.

◆ SVGMaxSize

const MediaWiki\MainConfigSchema::SVGMaxSize

Initial value:

= [
        'default' => 5120,
    ]

Don't scale a SVG larger than this.

Definition at line 1912 of file MainConfigSchema.php.

◆ SVGMetadataCutoff

const MediaWiki\MainConfigSchema::SVGMetadataCutoff

Initial value:

= [
        'default' => 1024 * 1024 * 5,
    ]

Don't read SVG metadata beyond this point.

Default is 5 MiB

Definition at line 1921 of file MainConfigSchema.php.

◆ SVGNativeRendering

const MediaWiki\MainConfigSchema::SVGNativeRendering

Initial value:

= [
        'default' => false,
        'type' => 'string|boolean',
    ]

Whether native rendering by the browser agent is allowed.

Default is false. Setting it to true disables all SVG conversion. Setting to the string 'partial' will only allow native rendering when the filesize is below SVGNativeRenderingSizeLimit and if the file contains at most 1 language.

Since: 1.41

Definition at line 1935 of file MainConfigSchema.php.

◆ SVGNativeRenderingSizeLimit

const MediaWiki\MainConfigSchema::SVGNativeRenderingSizeLimit

Initial value:

= [
        'default' => 50 * 1024,
    ]

Filesize limit for allowing SVGs to render natively by the browser agent.

Default is 50kB.

Since: 1.41

Definition at line 1947 of file MainConfigSchema.php.

◆ TempAccountCreationThrottle

const MediaWiki\MainConfigSchema::TempAccountCreationThrottle

Initial value:

= [
        'default' => [ [
            'count' => 6,
            'seconds' => 86400,
        ] ],
        'type' => 'list',
    ]

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

Example:

$wgTempAccountCreationThrottle = [
 // no more than 100 per month
 [
  'count' => 100,
  'seconds' => 30*86400,
 ],
 // no more than 6 per day
 [
  'count' => 6,
  'seconds' => 86400,
 ],
];

See also: self::AccountCreationThrottle for the regular account version of this throttle.

Warning: Requires $wgMainCacheType to be enabled

Since: 1.42

Definition at line 8497 of file MainConfigSchema.php.

◆ TempAccountNameAcquisitionThrottle

const MediaWiki\MainConfigSchema::TempAccountNameAcquisitionThrottle

Initial value:

= [
        'default' => [ [
            'count' => 60,
            'seconds' => 86400,
        ] ],
        'type' => 'list',
    ]

Number of temporary accounts usernames each IP address may acquire per specified period(s).

This should be set to a higher value than TempAccountCreationThrottle.

On editing, we first attempt to acquire a temp username before proceeding with saving an edit and potentially creating a temp account if the edit save is successful.

Some edits may fail (due to core or extensions denying an edit); this throttle ensures that there are limits to the number of temporary account names that can be acquired and stored in the database.

Example:

$wgTempAccountNameAcquisitionThrottle = [
 // no more than 100 per month
 [
  'count' => 100,
  'seconds' => 30*86400,
 ],
 // no more than 60 per day
 [
  'count' => 60,
  'seconds' => 86400,
 ],
];

See also: self::TempAccountCreationThrottle Make sure that TempAccountNameAcquisitionThrottle is greater than or equal to TempAccountCreationThrottle

Warning: Requires $wgMainCacheType to be enabled

Since: 1.42

Definition at line 8540 of file MainConfigSchema.php.

◆ TempCategoryCollations

const MediaWiki\MainConfigSchema::TempCategoryCollations

Initial value:

= [
        'default' => [],
        'type' => 'list',
    ]

Additional category collations to store during LinksUpdate.

This can be used to perform online migration of categories from one collation to another. An array of associative arrays each having the following keys:

table: (string) The table name
collation: (string) The collation to use for cl_sortkey
fakeCollation: (string) The collation name to insert into cl_collation

Since: 1.38

Definition at line 11607 of file MainConfigSchema.php.

◆ TemplateLinksSchemaMigrationStage

const MediaWiki\MainConfigSchema::TemplateLinksSchemaMigrationStage

Initial value:

= [
        'default' => SCHEMA_COMPAT_WRITE_NEW | SCHEMA_COMPAT_READ_NEW,
        'type' => 'integer',
    ]

Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields.

Use the SCHEMA_COMPAT_XXX flags. Supported values:

SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD
SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_NEW
SCHEMA_COMPAT_NEW

History:

1.38: Added
1.39: Default has changed to SCHEMA_COMPAT_WRITE_BOTH | SCHEMA_COMPAT_READ_OLD and support for SCHEMA_COMPAT_OLD is dropped.

Definition at line 3279 of file MainConfigSchema.php.

◆ TextModelsToParse

const MediaWiki\MainConfigSchema::TextModelsToParse

Initial value:

= [
        'default' => [
            CONTENT_MODEL_WIKITEXT, 
            CONTENT_MODEL_JAVASCRIPT, 
            CONTENT_MODEL_CSS, 
        ],
        'type' => 'list',
    ]

Determines which types of text are parsed as wikitext.

This does not imply that these kinds of texts are also rendered as wikitext, it only means that links, magic words, etc will have the effect on the database they would have on a wikitext page.

Note that table of contents information will be suppressed for all text models in this list other than wikitext.

Todo: Make the ToC suppression configurable by the content model (T313455), not a side effect of inclusion here.

Todo: On the long run, it would be nice to put categories etc into a separate structure, or at least parse only the contents of comments in the scripts.

Since: 1.21

Definition at line 3398 of file MainConfigSchema.php.

◆ ThumbLimits

const MediaWiki\MainConfigSchema::ThumbLimits

Initial value:

= [
        'default' => [
            120,
            150,
            180,
            200,
            250,
            300
        ],
        'type' => 'list',
    ]

Adjust thumbnails on image pages according to a user setting.

In order to reduce disk usage, the values can only be selected from a list. This is the list of settings the user can choose from:

Definition at line 2267 of file MainConfigSchema.php.

◆ ThumbnailBuckets

const MediaWiki\MainConfigSchema::ThumbnailBuckets

Initial value:

= [
        'default' => null,
        'type' => '?list',
    ]

When defined, is an array of image widths used as buckets for thumbnail generation.

The goal is to save resources by generating thumbnails based on reference buckets instead of always using the original. This will incur a speed gain but cause a quality loss.

The buckets generation is chained, with each bucket generated based on the above bucket when possible. File handlers have to opt into using that feature. For now only BitmapHandler supports it.

Definition at line 2300 of file MainConfigSchema.php.

◆ ThumbnailEpoch

const MediaWiki\MainConfigSchema::ThumbnailEpoch

Initial value:

= [
        'default' => '20030516000000',
    ]

If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if the file didn't already exist.

Update if there is some need to force thumbs and SVG rasterizations to rerender, such as fixes to rendering bugs.

Definition at line 2026 of file MainConfigSchema.php.

◆ ThumbnailMinimumBucketDistance

const MediaWiki\MainConfigSchema::ThumbnailMinimumBucketDistance

Initial value:

= [
        'default' => 50,
    ]

When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size.

The distance represents how many extra pixels of width the bucket needs in order to be used as the reference for a given thumbnail. For example, with the following buckets:

$wgThumbnailBuckets = [ 128, 256, 512 ];

and a distance of 50:

$wgThumbnailMinimumBucketDistance = 50;

If we want to render a thumbnail of width 220px, the 512px bucket will be used, because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.

Definition at line 2320 of file MainConfigSchema.php.

◆ ThumbnailNamespaces

const MediaWiki\MainConfigSchema::ThumbnailNamespaces

Initial value:

= [
        'default' => [ NS_FILE ],
        'type' => 'list',
        'items' => [ 'type' => 'integer', ],
    ]

Defines what namespaces thumbnails will be displayed for in Special:Search.

This is the list of namespaces for which thumbnails (or a placeholder in the absence of a thumbnail) will be shown:

Definition at line 2284 of file MainConfigSchema.php.

◆ ThumbnailScriptPath

const MediaWiki\MainConfigSchema::ThumbnailScriptPath

Initial value:

= [
        'default' => false,
    ]

Give a path here to use thumb.php for thumbnail generation on client request, instead of generating them on render and outputting a static URL.

This is necessary if some of your apache servers don't have read/write access to the thumbnail path.

Example:

$wgThumbnailScriptPath = "{$wgScriptPath}/thumb.php";

$wgThumbnailScriptPath

Config variable stub for the ThumbnailScriptPath setting, for use by phpdoc and IDEs.

Definition config-vars.php:447

Definition at line 1541 of file MainConfigSchema.php.

◆ ThumbPath

const MediaWiki\MainConfigSchema::ThumbPath

Initial value:

= [
        'default' => false,
    ]

The base path for thumb_handler.php.

This is used to interpret the request URL for requests to thumb_handler.php that do not match the base upload path.

Since: 1.36

Definition at line 583 of file MainConfigSchema.php.

◆ ThumbUpright

const MediaWiki\MainConfigSchema::ThumbUpright

Initial value:

= [
        'default' => 0.75,
    ]

Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright images without the need to fix the width by hardcoded px in wiki sourcecode.

Definition at line 2409 of file MainConfigSchema.php.

◆ TidyConfig

const MediaWiki\MainConfigSchema::TidyConfig

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Configuration for HTML postprocessing tool.

Set this to a configuration array to enable an external tool. By default, we now use the RemexHtml library; historically, other postprocessors were used.

Setting this to null will use default settings.

Keys include:

treeMutationTrace: a boolean to turn on Remex tracing
serializerTrace: a boolean to turn on Remex tracing
mungerTrace: a boolean to turn on Remex tracing
pwrap: whether

wrapping should be done (default true)

See includes/tidy/RemexDriver.php for detail on configuration.

Overriding the default configuration is strongly discouraged in production.

Definition at line 6516 of file MainConfigSchema.php.

◆ TiffThumbnailType

const MediaWiki\MainConfigSchema::TiffThumbnailType

Initial value:

= [
        'default' => [],
        'type' => 'list',
        'mergeStrategy' => 'replace',
    ]

Browsers don't support TIFF inline generally... For inline display, we need to convert to PNG or JPEG.

Note scaling should work with ImageMagick, but may not with GD scaling.

Example:

// PNG is lossless, but inefficient for photos
$wgTiffThumbnailType = [ 'png', 'image/png' ];
// JPEG is good for photos, but has no transparency support. Bad for diagrams.
$wgTiffThumbnailType = [ 'jpg', 'image/jpeg' ];

Definition at line 2013 of file MainConfigSchema.php.

◆ TmpDirectory

const MediaWiki\MainConfigSchema::TmpDirectory

Initial value:

= [
        'default' => false,
    ]

The local filesystem path to a temporary directory.

This must not be web-accessible.

When this setting is set to false, its value will automatically be decided through the first call to wfTempDir(). See that method's implementation for the actual detection logic.

To find the temporary path for the current wiki, developers must not use this variable directly. Use the global function wfTempDir() instead.

The temporary directory is expected to be shared with other applications, including other MediaWiki instances (which might not run the same version or configuration). When storing files here, take care to avoid conflicts with other instances of MediaWiki. For example, when caching the result of a computation, the file name should incorporate the input of the computation so that it cannot be confused for the result of a similar computation by another MediaWiki instance.

See also: \wfTempDir()

Note: Default changed to false in MediaWiki 1.20.

Definition at line 760 of file MainConfigSchema.php.

◆ TrackingCategories

const MediaWiki\MainConfigSchema::TrackingCategories

Initial value:

= [
        'default' => [],
        'type' => 'list',
        'deprecated' => 'since 1.25 Extensions should now register tracking categories using ' .
            'the new extension registration system.',
    ]

Array holding default tracking category names.

Array contains the system messages for each tracking category. Tracking categories allow pages with certain characteristics to be tracked. It works by adding any such page to a category automatically.

A message with the suffix '-desc' should be added as a description message to have extra information on Special:TrackingCategories.

Deprecated: since 1.25 Extensions should now register tracking categories using the new extension registration system.

Since: 1.23

Definition at line 11626 of file MainConfigSchema.php.

◆ TransactionalTimeLimit

const MediaWiki\MainConfigSchema::TransactionalTimeLimit

Initial value:

= [
        'default' => 120,
    ]

The request time limit for "slow" write requests that should not be interrupted due to the risk of data corruption.

The limit will only be raised. If the pre-existing time limit is larger, then this will have no effect.

Since: 1.26

Definition at line 3577 of file MainConfigSchema.php.

◆ TranscludeCacheExpiry

const MediaWiki\MainConfigSchema::TranscludeCacheExpiry

Initial value:

= [
        'default' => 3600,
    ]

Expiry time for transcluded templates cached in object cache.

Only used $wgEnableInterwikiTranscluding is set to true.

Definition at line 6690 of file MainConfigSchema.php.

◆ TranslateNumerals

const MediaWiki\MainConfigSchema::TranslateNumerals

Initial value:

= [
        'default' => true,
    ]

For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface.

Definition at line 4867 of file MainConfigSchema.php.

◆ TranslationAliasesDirs

const MediaWiki\MainConfigSchema::TranslationAliasesDirs

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Message directories containing JSON files for localisation of special page aliases.

Associative array mapping extension name to the directory where configurations can be found. The directory is expected to contain JSON files corresponding to each language code.

Variables defined in extensions will override conflicting variables defined in the core. We recommend using this configuration to set variables that require localisation: special page aliases, and in the future namespace aliases and magic words.

Simple example: extension.json

"TranslationAliasesDirs": {
  "TranslationNotificationsAlias": "i18n/aliases/"
}

Complex example: extension.json

"TranslationAliasesDirs": {
  "TranslationNotificationsAlias": [ "i18n/special-page-aliases", "i18n/magic-words", "i18n/namespaces" ]
}

Stability: unstable: EXPERIMENTAL

Since: 1.42

Definition at line 11170 of file MainConfigSchema.php.

◆ TrivialMimeDetection

const MediaWiki\MainConfigSchema::TrivialMimeDetection

Initial value:

= [
        'default' => false,
    ]

Switch for trivial MIME detection.

Used by thumb.php to disable all fancy things, because only a few types of images are needed and file extensions can be trusted.

Definition at line 2220 of file MainConfigSchema.php.

◆ TrustedMediaFormats

const MediaWiki\MainConfigSchema::TrustedMediaFormats

Initial value:

= [
        'default' => [
            MEDIATYPE_BITMAP, 
            MEDIATYPE_AUDIO, 
            MEDIATYPE_VIDEO, 
            "image/svg+xml", 
            "application/pdf", 
            # "application/x-shockwave-flash", 
        ],
        'type' => 'list',
    ]

list of trusted media-types and MIME types.

Use the MEDIATYPE_xxx constants to represent media types. This list is used by File::isSafeFile

Types not listed here will have a warning about unsafe content displayed on the images description page. It would also be possible to use this for further restrictions, like disabling direct [[media:...]] links for non-trusted formats.

Definition at line 1679 of file MainConfigSchema.php.

◆ TrxProfilerLimits

const MediaWiki\MainConfigSchema::TrxProfilerLimits

Performance expectations for DB usage.

Since: 1.26

Definition at line 9608 of file MainConfigSchema.php.

◆ UniversalEditButton

const MediaWiki\MainConfigSchema::UniversalEditButton

Initial value:

= [
        'default' => true,
    ]

Enable the UniversalEditButton for browsers that support it (currently only Firefox with an extension) See http://universaleditbutton.org for more background information.

Definition at line 10244 of file MainConfigSchema.php.

◆ UnwatchedPageSecret

const MediaWiki\MainConfigSchema::UnwatchedPageSecret

Initial value:

= [
        'default' => 1,
    ]

If active watchers (per above) are this number or less, do not disclose it.

Left to 1, prevents unprivileged users from knowing for sure that there are 0. Set to -1 if you want to always complement watchers count with this info.

Since: 1.26

Definition at line 10390 of file MainConfigSchema.php.

◆ UnwatchedPageThreshold

const MediaWiki\MainConfigSchema::UnwatchedPageThreshold

Initial value:

= [
        'default' => false,
    ]

If set to an integer, pages that are watched by this many users or more will not require the unwatchedpages permission to view the number of watchers.

Since: 1.21

Definition at line 10737 of file MainConfigSchema.php.

◆ UpdateCompatibleMetadata

const MediaWiki\MainConfigSchema::UpdateCompatibleMetadata

Initial value:

= [
        'default' => false,
    ]

Shortcut for the 'updateCompatibleMetadata' setting of $wgLocalFileRepo.

Definition at line 1397 of file MainConfigSchema.php.

◆ UpdateRowsPerJob

const MediaWiki\MainConfigSchema::UpdateRowsPerJob

Initial value:

= [
        'default' => 300,
    ]

Number of rows to update per job.

Definition at line 12626 of file MainConfigSchema.php.

◆ UpdateRowsPerQuery

const MediaWiki\MainConfigSchema::UpdateRowsPerQuery

Initial value:

= [
        'default' => 100,
    ]

Number of rows to update per query.

Definition at line 12633 of file MainConfigSchema.php.

◆ UpgradeKey

const MediaWiki\MainConfigSchema::UpgradeKey

Initial value:

= [
        'default' => false,
    ]

When you run the web-based upgrade utility, it will tell you what to set this to in order to authorize the upgrade process.

It will subsequently be used as a password, to authorize further upgrades.

For security, do not set this to a guessable string. Use the value supplied by the install/upgrade process. To cause the upgrader to generate a new key, delete the old key from LocalSettings.php.

Definition at line 10323 of file MainConfigSchema.php.

◆ UploadBaseUrl

const MediaWiki\MainConfigSchema::UploadBaseUrl

Initial value:

= [
        'default' => '',
    ]

If set, this URL is added to the start of $wgUploadPath to form a complete upload URL.

Since: 1.4

Definition at line 770 of file MainConfigSchema.php.

◆ UploadDialog

const MediaWiki\MainConfigSchema::UploadDialog

Initial value:

= [
        'default' =>
            [
                'fields' =>
                    [
                        'description' => true,
                        'date' => false,
                        'categories' => false,
                    ],
                'licensemessages' =>
                    [
                        'local' => 'generic-local',
                        'foreign' => 'generic-foreign',
                    ],
                'comment' =>
                    [
                        'local' => '',
                        'foreign' => '',
                    ],
                'format' =>
                    [
                        'filepage' => '$DESCRIPTION',
                        'description' => '$TEXT',
                        'ownwork' => '',
                        'license' => '',
                        'uncategorized' => '',
                    ],
            ],
        'type' => 'map',
    ]

Configuration for file uploads using the embeddable upload dialog (https://www.mediawiki.org/wiki/Upload_dialog).

This applies also to foreign uploads to this wiki (the configuration is loaded by remote wikis using the action=query&meta=siteinfo API).

See below for documentation of each property. None of the properties may be omitted.

Definition at line 1280 of file MainConfigSchema.php.

◆ UploadDirectory

const MediaWiki\MainConfigSchema::UploadDirectory

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'BaseDirectory' ] ]
    ]

The filesystem path of the images directory.

Defaults to "{$IP}/images".

Definition at line 590 of file MainConfigSchema.php.

◆ UploadMaintenance

const MediaWiki\MainConfigSchema::UploadMaintenance

Initial value:

= [
        'default' => false,
    ]

To disable file delete/restore temporarily.

Definition at line 869 of file MainConfigSchema.php.

◆ UploadMissingFileUrl

const MediaWiki\MainConfigSchema::UploadMissingFileUrl

Initial value:

= [
        'default' => false,
    ]

Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl.

The URL will get "(?|&)wpDestFile=<filename>" appended to it as appropriate.

Definition at line 1524 of file MainConfigSchema.php.

◆ UploadNavigationUrl

const MediaWiki\MainConfigSchema::UploadNavigationUrl

Initial value:

= [
        'default' => false,
    ]

Point the upload navigation link to an external URL Useful if you want to use a shared repository by default without disabling local uploads (use $wgEnableUploads = false for that).

Example:

$wgUploadNavigationUrl = 'https://commons.wikimedia.org/wiki/Special:Upload';

$wgUploadNavigationUrl

Config variable stub for the UploadNavigationUrl setting, for use by phpdoc and IDEs.

Definition config-vars.php:435

Definition at line 1515 of file MainConfigSchema.php.

◆ UploadPath

const MediaWiki\MainConfigSchema::UploadPath

Initial value:

= [
        'default' => false,
        'dynamicDefault' => [ 'use' => [ 'ScriptPath' ] ]
    ]

The URL path for the images directory.

Defaults to "{$wgScriptPath}/images".

Definition at line 548 of file MainConfigSchema.php.

◆ UploadSizeWarning

const MediaWiki\MainConfigSchema::UploadSizeWarning

Initial value:

= [
        'default' => false,
    ]

Warn if uploaded files are larger than this (in bytes), or false to disable.

Definition at line 1664 of file MainConfigSchema.php.

◆ UploadStashMaxAge

const MediaWiki\MainConfigSchema::UploadStashMaxAge

Initial value:

= [
        'default' => 6 * 3600, 
    ]

The maximum age of temporary (incomplete) uploaded files.

Definition at line 843 of file MainConfigSchema.php.

◆ UploadStashScalerBaseUrl

const MediaWiki\MainConfigSchema::UploadStashScalerBaseUrl

Initial value:

= [
        'default' => false,
        'deprecated' => 'since 1.36 Use thumbProxyUrl in $wgLocalFileRepo',
    ]

To enable remote on-demand scaling, set this to the thumbnail base URL.

Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg where 'e6' are the first two characters of the MD5 hash of the file name.

Deprecated: since 1.36 Use thumbProxyUrl in $wgLocalFileRepo

If $wgUploadStashScalerBaseUrl and thumbProxyUrl are both false, thumbs are rendered locally as needed.

Since: 1.17

Definition at line 786 of file MainConfigSchema.php.

◆ UploadThumbnailRenderHttpCustomDomain

const MediaWiki\MainConfigSchema::UploadThumbnailRenderHttpCustomDomain

Initial value:

= [
        'default' => false,
    ]

When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to.

Since: 1.25

Definition at line 2369 of file MainConfigSchema.php.

◆ UploadThumbnailRenderHttpCustomHost

const MediaWiki\MainConfigSchema::UploadThumbnailRenderHttpCustomHost

Initial value:

= [
        'default' => false,
    ]

When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.

Since: 1.25

Definition at line 2359 of file MainConfigSchema.php.

◆ UploadThumbnailRenderMap

const MediaWiki\MainConfigSchema::UploadThumbnailRenderMap

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

When defined, is an array of thumbnail widths to be rendered at upload time.

The idea is to prerender common thumbnail sizes, in order to avoid the necessity to render them on demand, which has a performance impact for the first client to view a certain size.

This obviously means that more disk space is needed per upload upfront.

Since: 1.25

Definition at line 2333 of file MainConfigSchema.php.

◆ UploadThumbnailRenderMethod

const MediaWiki\MainConfigSchema::UploadThumbnailRenderMethod

Initial value:

= [
        'default' => 'jobqueue',
    ]

The method through which the thumbnails will be prerendered for the entries in $wgUploadThumbnailRenderMap.

The method can be either "http" or "jobqueue". The former uses an http request to hit the thumbnail's URL. This method only works if thumbnails are configured to be rendered by a 404 handler. The latter option uses the job queue to render the thumbnail.

Since: 1.25

Definition at line 2349 of file MainConfigSchema.php.

◆ UrlProtocols

const MediaWiki\MainConfigSchema::UrlProtocols

Initial value:

= [
        'default' => [
            'bitcoin:', 'ftp://', 'ftps://', 'geo:', 'git://', 'gopher://', 'http://',
            'https://', 'irc://', 'ircs://', 'magnet:', 'mailto:', 'matrix:', 'mms://',
            'news:', 'nntp://', 'redis://', 'sftp://', 'sip:', 'sips:', 'sms:',
            'ssh://', 'svn://', 'tel:', 'telnet://', 'urn:', 'worldwind://', 'xmpp:',
            '//',
        ],
        'type' => 'list',
    ]

URL schemes that should be recognized as valid by wfParseUrl().

WARNING: Do not add 'file:' to this or internal file links will be broken. Instead, if you want to support file links, add 'file://'. The same applies to any other protocols with the same name as a namespace. See task T46011 for more information.

See also: \wfParseUrl

Definition at line 6440 of file MainConfigSchema.php.

◆ UseAutomaticEditSummaries

const MediaWiki\MainConfigSchema::UseAutomaticEditSummaries

Initial value:

= [
        'default' => true,
    ]

If user doesn't specify any edit summary when making a an edit, MediaWiki will try to automatically create one.

This feature can be disabled by set- ting this variable false.

Definition at line 10253 of file MainConfigSchema.php.

◆ UseCdn

const MediaWiki\MainConfigSchema::UseCdn

Initial value:

= [
        'default' => false,
    ]

Enable/disable CDN.

See https://www.mediawiki.org/wiki/Manual:Performance_tuning#Page_view_caching

Since: 1.34 Renamed from $wgUseSquid.

Definition at line 4480 of file MainConfigSchema.php.

◆ UseCodexSpecialBlock

const MediaWiki\MainConfigSchema::UseCodexSpecialBlock

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Whether to use Codex in Special:Block form.

Stability: unstable: Temporary feature flag, T358153

Since: 1.42

Definition at line 12845 of file MainConfigSchema.php.

◆ UseCombinedLoginLink

const MediaWiki\MainConfigSchema::UseCombinedLoginLink

Initial value:

= [
        'default' => false,
    ]

Login / create account link behavior when it's possible for anonymous users to create an account.

true = use a combined login / create account link
false = split login and create account into two separate links

Definition at line 5347 of file MainConfigSchema.php.

◆ UseContentMediaStyles

const MediaWiki\MainConfigSchema::UseContentMediaStyles

Initial value:

= [
        'default' => false,
        'deprecated' => 'since 1.41',
    ]

Enable shipping the styles for the media HTML structure that replaces legacy, when $wgParserEnableLegacyMediaDOM is false.

This is configured separately so that it can continue to be served after the latter is disabled but still in the cache.

Deprecated: since 1.41

Access: internal: Temporary flag, T51097.

Since: 1.38

Definition at line 6559 of file MainConfigSchema.php.

◆ UseCopyrightUpload

const MediaWiki\MainConfigSchema::UseCopyrightUpload

Initial value:

= [
        'default' => false,
    ]

Set this to true if you want detailed copyright information forms on Upload.

Definition at line 10891 of file MainConfigSchema.php.

◆ UseDatabaseMessages

const MediaWiki\MainConfigSchema::UseDatabaseMessages

Initial value:

= [
        'default' => true,
    ]

Translation using MediaWiki: namespace.

Interface messages will be loaded from the database.

Definition at line 4876 of file MainConfigSchema.php.

◆ UseFileCache

const MediaWiki\MainConfigSchema::UseFileCache

Initial value:

= [
        'default' => false,
    ]

This will cache static pages for non-logged-in users to reduce database traffic on public sites.

ResourceLoader requests to default language and skins are cached as well as single module requests.

Definition at line 4364 of file MainConfigSchema.php.

◆ UseFilePatrol

const MediaWiki\MainConfigSchema::UseFilePatrol

Initial value:

= [
        'default' => true,
    ]

Use file patrolling to check new files on Special:Newfiles.

Note: If you disable all patrolling features, you probably also want to remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on Special:Log.

Since: 1.27

Definition at line 10565 of file MainConfigSchema.php.

◆ UseGzip

const MediaWiki\MainConfigSchema::UseGzip

Initial value:

= [
        'default' => false,
    ]

When using the file cache, we can store the cached HTML gzipped to save disk space.

Pages will then also be served compressed to clients that support it.

Requires zlib support enabled in PHP.

Definition at line 4412 of file MainConfigSchema.php.

◆ UseImageMagick

const MediaWiki\MainConfigSchema::UseImageMagick

Initial value:

= [
        'default' => false,
    ]

Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party converter, e.g.

GraphicMagick.

These support more file formats than PHP, which only supports PNG, GIF, JPG, XBM and WBMP.

Use Image Magick instead of PHP builtin functions.

Definition at line 1753 of file MainConfigSchema.php.

◆ UseImageResize

const MediaWiki\MainConfigSchema::UseImageResize

Initial value:

= [
        'default' => true,
    ]

Whether to enable server-side image thumbnailing.

If false, images will always be sent to the client in full resolution, with appropriate width= and height= attributes on the tag for the client to do its own scaling.

Definition at line 1740 of file MainConfigSchema.php.

◆ UseInstantCommons

const MediaWiki\MainConfigSchema::UseInstantCommons

Initial value:

= [
        'default' => false,
    ]

Use Wikimedia Commons as a foreign file repository.

This is a shortcut for adding an entry to $wgForeignFileRepos for https://commons.wikimedia.org, using ForeignAPIRepo with the default settings.

Since: 1.16

Definition at line 1124 of file MainConfigSchema.php.

◆ UseLegacyMediaStyles

const MediaWiki\MainConfigSchema::UseLegacyMediaStyles

Initial value:

= [
        'default' => false,
    ]

Disable shipping the styles for the legacy media HTML structure that has been replaced when $wgParserEnableLegacyMediaDOM is false.

This is configured separately to give time for templates and extensions that mimic the parser output to be migrated away.

Access: internal: Temporary feature flag for T318433.

Since: 1.41

Definition at line 6573 of file MainConfigSchema.php.

◆ UseLocalMessageCache

const MediaWiki\MainConfigSchema::UseLocalMessageCache

Initial value:

= [
        'default' => false,
    ]

Set this to true to maintain a copy of the message cache on the local server.

This layer of message cache is in addition to the one configured by $wgMessageCacheType.

The local copy is put in APC. If APC is not installed, this setting does nothing.

Note that this is about the message cache, which stores interface messages maintained as wiki pages. This is separate from the localisation cache for interface messages provided by the software, which is configured by $wgLocalisationCacheConf.

Definition at line 4272 of file MainConfigSchema.php.

◆ UseNPPatrol

const MediaWiki\MainConfigSchema::UseNPPatrol

Initial value:

= [
        'default' => true,
    ]

Use new page patrolling to check new pages on Special:Newpages.

Note: If you disable all patrolling features, you probably also want to remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on Special:Log.

Definition at line 10553 of file MainConfigSchema.php.

◆ UsePathInfo

const MediaWiki\MainConfigSchema::UsePathInfo

Initial value:

= [
        'dynamicDefault' => true,
    ]

Whether to support URLs like index.php/Page_title.

The effective default value is determined at runtime: it will be enabled in environments where it is expected to be safe.

Override this to false if $_SERVER['PATH_INFO'] contains unexpectedly incorrect garbage, or to true if it is really correct.

The default $wgArticlePath will be set based on this value at runtime, but if you have customized it, having this incorrectly set to true can cause redirect loops when "pretty URLs" are used.

Since: 1.2.1

Definition at line 347 of file MainConfigSchema.php.

◆ UsePigLatinVariant

const MediaWiki\MainConfigSchema::UsePigLatinVariant

Initial value:

= [
        'default' => false,
    ]

Whether to enable the pig Latin variant of English (en-x-piglatin), used to ease variant development work.

Definition at line 4914 of file MainConfigSchema.php.

◆ UsePrivateIPs

const MediaWiki\MainConfigSchema::UsePrivateIPs

Initial value:

= [
        'default' => false,
    ]

Should forwarded Private IPs be accepted?

Definition at line 4673 of file MainConfigSchema.php.

◆ UseRCPatrol

const MediaWiki\MainConfigSchema::UseRCPatrol

Initial value:

= [
        'default' => true,
    ]

Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files are included.

Note: If you disable all patrolling features, you probably also want to remove 'patrol' from $wgFilterLogTypes so a show/hide link isn't shown on Special:Log.

Definition at line 10532 of file MainConfigSchema.php.

◆ UserEmailConfirmationTokenExpiry

const MediaWiki\MainConfigSchema::UserEmailConfirmationTokenExpiry

Initial value:

= [
        'default' => 7 * 24 * 60 * 60,
    ]

The time, in seconds, when an email confirmation email expires.

Definition at line 2624 of file MainConfigSchema.php.

◆ UserEmailUseReplyTo

const MediaWiki\MainConfigSchema::UserEmailUseReplyTo

Initial value:

= [
        'default' => true,
    ]

If true put the sending user's email in a Reply-To header instead of From (false).

($wgPasswordSender will be used as From.)

Some mailers (eg SMTP) set the SMTP envelope sender to the From value, which can cause problems with SPF validation and leak recipient addresses when bounces are sent to the sender. In addition, DMARC restrictions can cause emails to fail to be received when false.

Definition at line 2602 of file MainConfigSchema.php.

◆ UserRegistrationProviders

const MediaWiki\MainConfigSchema::UserRegistrationProviders

Initial value:

= [
        'default' => [
            LocalUserRegistrationProvider::TYPE => [
                'class' => LocalUserRegistrationProvider::class,
                'services' => [
                    'UserFactory'
                ]
            ]
        ],
        'type' => 'map',
    ]

User registration timestamp provider classes.

Since: 1.41

Definition at line 6868 of file MainConfigSchema.php.

◆ UserrightsInterwikiDelimiter

const MediaWiki\MainConfigSchema::UserrightsInterwikiDelimiter

Initial value:

= [
        'default' => '@',
    ]

Character used as a delimiter when testing for interwiki userrights (In Special:UserRights, it is possible to modify users on different databases if the delimiter is used, e.g.

"Someuser@enwiki").

It is recommended that you have this delimiter in $wgInvalidUsernameCharacters above, or you will not be able to modify the user rights of those users via Special:UserRights

Definition at line 7540 of file MainConfigSchema.php.

◆ UsersNotifiedOnAllChanges

const MediaWiki\MainConfigSchema::UsersNotifiedOnAllChanges

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Array of usernames who will be sent a notification email for every change which occurs on a wiki.

Users will not be notified of their own changes.

Definition at line 2787 of file MainConfigSchema.php.

◆ UseSharedUploads

const MediaWiki\MainConfigSchema::UseSharedUploads

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Shortcut for adding an entry to $wgForeignFileRepos.

Uses the following variables:

directory: $wgSharedUploadDirectory.
url: $wgSharedUploadPath.
hashLevels: Based on $wgHashedSharedUploadDirectory.
thumbScriptUrl: $wgSharedThumbnailScriptPath.
transformVia404: Based on $wgGenerateThumbnailOnParse.
descBaseUrl: $wgRepositoryBaseUrl.
fetchDescription: $wgFetchCommonsDescriptions.

If $wgSharedUploadDBname is set, it uses the ForeignDBRepo class, with also the following variables:

dbName: $wgSharedUploadDBname.
dbType: $wgDBtype.
dbServer: $wgDBserver.
dbUser: $wgDBuser.
dbPassword: $wgDBpassword.
dbFlags: Based on $wgDebugDumpSql.
tablePrefix: $wgSharedUploadDBprefix,
hasSharedCache: $wgCacheSharedUploads.

Since: 1.3

Definition at line 1155 of file MainConfigSchema.php.

◆ UseSiteCss

const MediaWiki\MainConfigSchema::UseSiteCss

Initial value:

= [
        'default' => true,
    ]

Use the site's Cascading Style Sheets (CSS)?

Definition at line 9201 of file MainConfigSchema.php.

◆ UseSiteJs

const MediaWiki\MainConfigSchema::UseSiteJs

Initial value:

= [
        'default' => true,
    ]

Use the site's Javascript page?

Definition at line 9194 of file MainConfigSchema.php.

◆ UseTagFilter

const MediaWiki\MainConfigSchema::UseTagFilter

Initial value:

= [
        'default' => true,
    ]

Allow filtering by change tag in recentchanges, history, etc Has no effect if no tags are defined.

Definition at line 10691 of file MainConfigSchema.php.

◆ UseTinyRGBForJPGThumbnails

const MediaWiki\MainConfigSchema::UseTinyRGBForJPGThumbnails

Initial value:

= [
        'default' => false,
    ]

When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight (and free) TinyRGB profile when generating thumbnails.

Since: 1.26

Definition at line 2380 of file MainConfigSchema.php.

◆ UseXssLanguage

const MediaWiki\MainConfigSchema::UseXssLanguage

Initial value:

= [
        'default' => false,
    ]

Whether to enable the 'x-xss' language code, used for development.

When enabled, the language code 'x-xss' (e.g. via ?uselang=x-xss) can be used to test correct message escaping at scale, to prevent cross-site scripting. In this "language", every message becomes an HTML snippet which attempts to alert the message key. Well-written code will correctly escape all of these messages. If any alerts are actually fired in the browser, the message is not being escaped correctly; either the offending code should be fixed, or the message should be added to self::RawHtmlMessages.

See also: https://www.mediawiki.org/wiki/Special:MyLanguage/Cross-site_scripting

Since: 1.41

Definition at line 4970 of file MainConfigSchema.php.

◆ ValidSkinNames

const MediaWiki\MainConfigSchema::ValidSkinNames

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

List of valid skin names.

The key should be the name in all lower case.

As of 1.35, the value should be a an array in the form of the ObjectFactory specification.

For example for 'foobarskin' where the PHP class is 'MediaWiki\Skins\FooBar\FooBarSkin' set:

skin.json Example:

"ValidSkinNames": {
   "foobarskin": {
       "displayname": "FooBarSkin",
       "class": "MediaWiki\\\\Skins\\\\FooBar\\\\FooBarSkin"
   }
}

Historically, the value was a properly cased name for the skin (and is still currently supported). This value will be prefixed with "Skin" to create the class name of the skin to load. Use Skin::getSkinNames() as an accessor if you wish to have access to the full list.

Definition at line 11218 of file MainConfigSchema.php.

◆ VariantArticlePath

const MediaWiki\MainConfigSchema::VariantArticlePath

Initial value:

= [
        'default' => false,
    ]

Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which parts of the URL contain the language variant.

Example:

$wgLanguageCode = 'sr';
$wgVariantArticlePath = '/$2/$1';
$wgArticlePath = '/wiki/$1';

A link to /wiki/ would be redirected to /sr/Главна_страна

It is important that $wgArticlePath not overlap with possible values of $wgVariantArticlePath.

Definition at line 4951 of file MainConfigSchema.php.

◆ VaryOnXFP

const MediaWiki\MainConfigSchema::VaryOnXFP

Initial value:

= [
        'default' => false,
    ]

Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds.

Use this if you have an SSL termination setup and need to split the cache between HTTP and HTTPS for API requests, feed requests and HTTP redirect responses in order to prevent cache pollution. This does not affect 'normal' requests to index.php other than HTTP redirects.

Definition at line 4492 of file MainConfigSchema.php.

◆ VerifyMimeType

const MediaWiki\MainConfigSchema::VerifyMimeType

Initial value:

= [
        'default' => true,
    ]

Determines if the MIME type of uploaded files should be checked.

Definition at line 2170 of file MainConfigSchema.php.

◆ VirtualDomainsMapping

const MediaWiki\MainConfigSchema::VirtualDomainsMapping

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Mapping of virtual domain to external cluster db.

If no entry is set, the code assumes local database. For example, for routing queries of virtual domain 'vdomain' to 'wikishared' database in 'extension1' cluster. The config should be like this: [ 'vdomain' => [ 'cluster' => 'extension1', 'db' => 'wikishared' ] ]

If the database needs to be the local domain, just set the 'db' to false.

If you want to get another db in the main cluster, just omit 'cluster'. For example: [ 'centralauth' => [ 'db' => 'centralauth' ] ]

Since: 1.41

Definition at line 3260 of file MainConfigSchema.php.

◆ VirtualRestConfig

const MediaWiki\MainConfigSchema::VirtualRestConfig

Initial value:

= [
        'default' => [
            'paths' => [],
            'modules' => [],
            'global' => [
                # Timeout in seconds
                'timeout' => 360,
                # 'domain' is set to $wgCanonicalServer in Setup.php
                'forwardCookies' => false,
                'HTTPProxy' => null
            ]
        ],
        'mergeStrategy' => 'array_plus_2d',
        'type' => 'map',
    ]

Global configuration variable for Virtual REST Services.

Use the 'path' key to define automatically mounted services. The value for this key is a map of path prefixes to service configuration. The latter is an array of:

class : the fully qualified class name
options : map of arguments to the class constructor Such services will be available to handle queries under their path from the VRS singleton, e.g. MediaWikiServices::getInstance()->getVirtualRESTServiceClient();

Auto-mounting example for Parsoid:

$wgVirtualRestConfig['paths']['/parsoid/'] = [ 'class' => ParsoidVirtualRESTService::class, 'options' => [ 'url' => 'http://localhost:8000', 'prefix' => 'enwiki', 'domain' => 'en.wikipedia.org' ] ];

Parameters for different services can also be declared inside the 'modules' value, which is to be treated as an associative array. The parameters in 'global' will be merged with service-specific ones. The result will then be passed to VirtualRESTService::__construct() in the module.

Example config for Parsoid:

$wgVirtualRestConfig['modules']['parsoid'] = [ 'url' => 'http://localhost:8000', 'prefix' => 'enwiki', 'domain' => 'en.wikipedia.org', ];

Since: 1.25

Definition at line 12688 of file MainConfigSchema.php.

◆ VueDevelopmentMode

const MediaWiki\MainConfigSchema::VueDevelopmentMode

Initial value:

= [
        'default' => false,
    ]

Whether to use the development version of Vue.js.

This should be disabled for production installations. For development installations, enabling this provides useful additional warnings and checks.

Even when this is disabled, using ResourceLoader's debug mode (?debug=true) will cause the development version to be loaded.

Since: 1.35

Definition at line 6013 of file MainConfigSchema.php.

◆ WANObjectCache

const MediaWiki\MainConfigSchema::WANObjectCache

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Extra parameters to the WANObjectCache constructor.

See Deploying WANObjectCache.

Since: 1.40

Definition at line 4001 of file MainConfigSchema.php.

◆ WantedPagesThreshold

const MediaWiki\MainConfigSchema::WantedPagesThreshold

Initial value:

= [
        'default' => 1,
    ]

Number of links to a page required before it is deemed "wanted".

Definition at line 3624 of file MainConfigSchema.php.

◆ WatchersMaxAge

const MediaWiki\MainConfigSchema::WatchersMaxAge

Initial value:

= [
        'default' => 180 * 24 * 3600,
    ]

Page watchers inactive for more than this many seconds are considered inactive.

Used mainly by action=info. Default: 180 days = about six months.

Since: 1.26

Definition at line 10378 of file MainConfigSchema.php.

◆ WatchlistExpiry

const MediaWiki\MainConfigSchema::WatchlistExpiry

Initial value:

= [
        'default' => false,
        'type' => 'boolean',
    ]

Whether to enable the watchlist expiry feature.

Since: 1.35

Definition at line 10803 of file MainConfigSchema.php.

◆ WatchlistExpiryMaxDuration

const MediaWiki\MainConfigSchema::WatchlistExpiryMaxDuration

Initial value:

= [
        'default' => '1 year',
        'type' => '?string',
    ]

Relative maximum duration for watchlist expiries, as accepted by strtotime().

This relates to finite watchlist expiries only. Pages can be watched indefinitely regardless of what this is set to.

This is used to ensure the watchlist_expiry table doesn't grow to be too big.

Only has effect if $wgWatchlistExpiry is true.

Set to null to allow expiries of any duration.

Since: 1.35

Definition at line 10837 of file MainConfigSchema.php.

◆ WatchlistPurgeRate

const MediaWiki\MainConfigSchema::WatchlistPurgeRate

Initial value:

= [
        'default' => 0.1,
        'type' => 'float',
    ]

Chance of expired watchlist items being purged on any page edit.

Only has effect if $wgWatchlistExpiry is true.

If this is zero, expired watchlist items will not be removed and the purgeExpiredWatchlistItems.php maintenance script should be run periodically.

Since: 1.35

Definition at line 10818 of file MainConfigSchema.php.

◆ WhitelistRead

const MediaWiki\MainConfigSchema::WhitelistRead

Initial value:

= [
        'default' => false,
    ]

Pages anonymous user may see, set as an array of pages titles.

Example:

$wgWhitelistRead = [ "Main Page", "Wikipedia:Help" ];

$wgWhitelistRead

Config variable stub for the WhitelistRead setting, for use by phpdoc and IDEs.

Definition config-vars.php:2718

Special:Userlogin and Special:ChangePassword are always allowed.

Note: This will only work if $wgGroupPermissions['*']['read'] is false – see below. Otherwise, ALL pages are accessible, regardless of this setting.; Also that this will only protect pages in the wiki. Uploaded files will remain readable. You can use img_auth.php to protect uploaded files, see https://www.mediawiki.org/wiki/Manual:Image_Authorization; Extensions should not modify this, but use the TitleReadWhitelist hook instead.

Definition at line 7800 of file MainConfigSchema.php.

◆ WhitelistReadRegexp

const MediaWiki\MainConfigSchema::WhitelistReadRegexp

Initial value:

= [
        'default' => false,
    ]

Pages anonymous user may see, set as an array of regular expressions.

This function will match the regexp against the title name, which is without underscore.

Example: To whitelist [[Main Page]]:

$wgWhitelistReadRegexp = [ "/Main Page/" ];

$wgWhitelistReadRegexp

Config variable stub for the WhitelistReadRegexp setting, for use by phpdoc and IDEs.

Definition config-vars.php:2724

Note: Unless ^ and/or $ is specified, a regular expression might match pages not intended to be allowed. The above example will also allow a page named 'Security Main Page'.

Example: To allow reading any page starting with 'User' regardless of the case:

$wgWhitelistReadRegexp = [ "@^UsEr.*@i" ];

Will allow both [[User is banned]] and [[User:JohnDoe]]

Note: This will only work if $wgGroupPermissions['*']['read'] is false – see below. Otherwise, ALL pages are accessible, regardless of this setting.

Definition at line 7831 of file MainConfigSchema.php.

◆ Wikidiff2Options

const MediaWiki\MainConfigSchema::Wikidiff2Options

Initial value:

= [
        'default' => [],
        'type' => 'map'
    ]

Options for wikidiff2:

useMultiFormat: (bool) Whether to use wikidiff2_multi_format_diff() if it is available. This temporarily defaults to false, during migration to the new code. It is available in wikidiff2 1.14.0+.

The following options are only effective if wikidiff2_multi_format_diff() is enabled. See README.md in wikidiff2 for details:

numContextLines
changeThreshold
movedLineThreshold
maxMovedLines
maxWordLevelDiffComplexity
maxSplitSize
initialSplitThreshold
finalSplitThreshold

Also:

formatOptions: An array of format-specific overrides. The key may be "inline" or "table" and the value is an array with keys numContextLines, changeThreshold, etc.
Since
1.41

Definition at line 3543 of file MainConfigSchema.php.

◆ WikiFarmSettingsDirectory

const MediaWiki\MainConfigSchema::WikiFarmSettingsDirectory

Initial value:

= [
        'default' => null
    ]

A directory that contains site-specific configuration files.

Setting this will enable multi-tenant ("wiki farm") mode, causing site-specific settings to be loaded based on information from the web request.

Stability: unstable: EXPERIMENTAL

Since: 1.38

Definition at line 11049 of file MainConfigSchema.php.

◆ WikiFarmSettingsExtension

const MediaWiki\MainConfigSchema::WikiFarmSettingsExtension

Initial value:

= [
        'default' => 'yaml'
    ]

The file extension to be used when looking up site-specific settings files in $wgWikiFarmSettingsDirectory, such as 'json' or 'yaml'.

Stability: unstable: EXPERIMENTAL

Since: 1.38

Definition at line 11060 of file MainConfigSchema.php.

◆ XhtmlNamespaces

const MediaWiki\MainConfigSchema::XhtmlNamespaces

Initial value:

= [
        'default' => [],
        'type' => 'map',
    ]

Permit other namespaces in addition to the w3.org default.

Use the prefix for the key and the namespace for the value.

Example:

$wgXhtmlNamespaces['svg'] = 'http://www.w3.org/2000/svg';

$wgXhtmlNamespaces

Config variable stub for the XhtmlNamespaces setting, for use by phpdoc and IDEs.

Definition config-vars.php:1953

Normally we wouldn't have to define this in the root "<html>" element, but IE needs it there in some circumstances.

This is ignored if $wgMimeType is set to a non-XML MIME type.

Definition at line 5160 of file MainConfigSchema.php.

◆ XmlDumpSchemaVersion

const MediaWiki\MainConfigSchema::XmlDumpSchemaVersion

Initial value:

= [
        'default' => XML_DUMP_SCHEMA_VERSION_11,
    ]

The schema to use per default when generating XML dumps.

This allows sites to control explicitly when to make breaking changes to their export and dump format.

Definition at line 11030 of file MainConfigSchema.php.

◆ XMLMimeTypes

const MediaWiki\MainConfigSchema::XMLMimeTypes

Initial value:

= [
        'default' => [
            'http://www.w3.org/2000/svg:svg' => 'image/svg+xml',
            'svg' => 'image/svg+xml',
            'http://www.lysator.liu.se/~alla/dia/:diagram' => 'application/x-dia-diagram',
            'http://www.w3.org/1999/xhtml:html' => 'text/html',
            'html' => 'text/html',
        ],
        'type' => 'map',
    ]

Additional XML types we can allow via MIME-detection.

array = [ 'rootElement' => 'associatedMimeType' ]

Definition at line 2229 of file MainConfigSchema.php.

The documentation for this class was generated from the following file:

includes/MainConfigSchema.php

Static Public Member Functions

Public Attributes

Server URLs and file paths

Files and file uploads

Database settings

Language, regional and character encoding settings

ResourceLoader settings

Page titles and redirects

Cookie settings

Maintenance

Detailed Description

Member Function Documentation

◆ getDefaultArticlePath()

◆ getDefaultCookiePrefix()

◆ getDefaultCookieSecure()

◆ getDefaultDBerrorLogTZ()

◆ getDefaultDeletedDirectory()

◆ getDefaultExtensionAssetsPath()

◆ getDefaultFileCacheDirectory()

◆ getDefaultLoadScript()

◆ getDefaultLocalFileRepo()

◆ getDefaultLocalStylePath()

◆ getDefaultLocaltimezone()

◆ getDefaultLocalTZoffset()

◆ getDefaultLogo()

◆ getDefaultMetaNamespace()

◆ getDefaultReadOnlyFile()

◆ getDefaultResourceBasePath()

◆ getDefaultRestPath()

◆ getDefaultScript()

◆ getDefaultSharedPrefix()

◆ getDefaultSharedSchema()

◆ getDefaultShowEXIF()

◆ getDefaultStylePath()

◆ getDefaultUploadDirectory()

◆ getDefaultUploadPath()

◆ getDefaultUsePathInfo()

◆ getDefaultValue()

◆ listDefaultValues()

Member Data Documentation

◆ AccountCreationThrottle

◆ ActionFilteredLogs

◆ ActionPaths

◆ Actions

◆ ActiveUserDays

◆ AdaptiveMessageCache

◆ AddGroups

◆ AdditionalMailParams

◆ AdvancedSearchHighlighting

◆ AdvertisedFeedTypes

◆ AjaxLicensePreview

◆ AllowCopyUploads

◆ AllowCrossOrigin

◆ AllowDisplayTitle

◆ AllowedCorsHeaders

◆ AllowExternalImages

◆ AllowExternalImagesFrom

◆ AllowExternalReqID

◆ AllowHTMLEmail

◆ AllowRequiringEmailForResets

◆ AllowSchemaUpdates

◆ AllowSecuritySensitiveOperationIfCannotReauthenticate

◆ AllowSiteCSSOnRestrictedPages

◆ AllowSlowParserFunctions

◆ AllowSpecialInclusion

◆ AllowUserCss

◆ AllowUserCssPrefs

◆ AllowUserJs

◆ AllUnicodeFixes

◆ AmericanDates

◆ Antivirus

◆ AntivirusRequired

◆ AntivirusSetup

◆ APICacheHelpTimeout

◆ APIFormatModules

◆ ApiFrameOptions

◆ APIListModules

◆ APIMaxDBRows

◆ APIMaxLagThreshold

◆ APIMaxResultSize