MediaWiki REL1_39
|
This class contains schema declarations for all configuration variables known to MediaWiki core. More...
Static Public Member Functions | |
static | getDefaultValue (string $name) |
Returns the default value of the given config setting. | |
static | listDefaultValues (string $prefix='') |
Returns a generator for iterating over all config settings and their default values. | |
Public Attributes | |
const | ConfigRegistry |
Registry of factory functions to create config objects: The 'main' key must be set, and the value should be a valid callable. | |
const | Sitename |
Name of the site. | |
DJVU settings | |
const | DjvuDump |
Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';. | |
const | DjvuRenderer |
Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';. | |
const | DjvuTxt |
Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';. | |
const | DjvuPostProcessor |
Shell command for the DJVU post processor Default: pnmtojpeg, since ddjvu generates ppm output Set this to false to output the ppm file directly. | |
const | DjvuOutputExtension |
File extension for the DJVU post processor output. | |
Email settings | |
const | EmergencyContact |
Site admin email address. | |
const | PasswordSender |
Sender email address for e-mail notifications. | |
const | NoReplyAddress |
Reply-To address for e-mail notifications. | |
const | EnableEmail |
Set to true to enable the e-mail basic features: Password reminders, etc. | |
const | EnableUserEmail |
Set to true to enable user-to-user e-mail. | |
const | EnableSpecialMute |
Set to true to enable the Special Mute page. | |
const | EnableUserEmailMuteList |
Set to true to enable user-to-user e-mail mutelist. | |
const | UserEmailUseReplyTo |
If true put the sending user's email in a Reply-To header instead of From (false). | |
const | PasswordReminderResendTime |
Minimum time, in hours, which must elapse between password reminder emails for a given account. | |
const | NewPasswordExpiry |
The time, in seconds, when an emailed temporary password expires. | |
const | UserEmailConfirmationTokenExpiry |
The time, in seconds, when an email confirmation email expires. | |
const | PasswordExpirationDays |
The number of days that a user's password is good for. | |
const | PasswordExpireGrace |
If a user's password is expired, the number of seconds when they can still login, and cancel their password change, but are sent to the password change form on each login. | |
const | SMTP |
SMTP Mode. | |
const | AdditionalMailParams |
Additional email parameters, will be passed as the last argument to mail() call. | |
const | AllowHTMLEmail |
For parts of the system that have been updated to provide HTML email content, send both text and HTML parts as the body of the email. | |
const | EnotifFromEditor |
Allow sending of e-mail notifications with the editor's address as sender. | |
const | EmailAuthentication |
Require email authentication before sending mail to an email address. | |
const | EnotifWatchlist |
Allow users to enable email notification ("enotif") on watchlist changes. | |
const | EnotifUserTalk |
Allow users to enable email notification ("enotif") when someone edits their user talk page. | |
const | EnotifRevealEditorAddress |
Allow sending of e-mail notifications with the editor's address in "Reply-To". | |
const | EnotifMinorEdits |
Potentially send notification mails on minor edits to pages. | |
const | EnotifImpersonal |
Send a generic mail instead of a personalised mail for each user. | |
const | EnotifMaxRecips |
Maximum number of users to mail at once when using impersonal mail. | |
const | EnotifUseRealName |
Use real name instead of username in e-mail "from" field. | |
const | UsersNotifiedOnAllChanges |
Array of usernames who will be sent a notification email for every change which occurs on a wiki. | |
Content handlers and storage | |
const | ContentHandlers |
Plugins for page content model handling. | |
const | NamespaceContentModels |
Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by default (use the CONTENT_MODEL_XXX constants). | |
const | ContentHandlerTextFallback |
How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText(): | |
const | TextModelsToParse |
Determines which types of text are parsed as wikitext. | |
const | CompressRevisions |
We can also compress text stored in the 'text' table. | |
const | ExternalStores |
List of enabled ExternalStore protocols. | |
const | ExternalServers |
Shortcut for setting $wgLBFactoryConf["externalClusters"] . | |
const | DefaultExternalStore |
The place to put new text blobs or false to put them in the text table of the local wiki database. | |
const | RevisionCacheExpiry |
Revision text may be cached in the main WAN cache to reduce load on external storage servers and object extraction overhead for frequently-loaded revisions. | |
const | PageLanguageUseDB |
Enable page language feature Allows setting page language in database. | |
const | DiffEngine |
Specify the difference engine to use. | |
const | ExternalDiffEngine |
Name of the external diff engine to use. | |
Performance hacks and limits | |
const | RequestTimeLimit |
Set a limit on server request wall clock time. | |
const | TransactionalTimeLimit |
The request time limit for "slow" write requests that should not be interrupted due to the risk of data corruption. | |
const | CriticalSectionTimeLimit |
The maximum time critical sections are allowed to stay open. | |
const | MiserMode |
Disable database-intensive features. | |
const | DisableQueryPages |
Disable all query pages if miser mode is on, not just some. | |
const | QueryCacheLimit |
Number of rows to cache in 'querycache' table when miser mode is on. | |
const | WantedPagesThreshold |
Number of links to a page required before it is deemed "wanted". | |
const | AllowSlowParserFunctions |
Enable slow parser functions. | |
const | AllowSchemaUpdates |
Allow schema updates. | |
const | MaxArticleSize |
Maximum article size in kibibytes. | |
const | MemoryLimit |
The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount. | |
const | PoolCounterConf |
Configuration for processing pool control, for use in high-traffic wikis. | |
const | MaxUserDBWriteDuration |
Max time (in seconds) a user-generated transaction can spend in writes. | |
const | MaxJobDBWriteDuration |
Max time (in seconds) a job-generated transaction can spend in writes. | |
const | LinkHolderBatchSize |
LinkHolderArray batch size For debugging. | |
const | MaximumMovedPages |
Maximum number of pages to move at once when moving subpages with a page. | |
const | ForceDeferredUpdatesPreSend |
Force deferred updates to be run before sending a response to the client, instead of attempting to run them after sending the response. | |
const | MultiShardSiteStats |
Whether site_stats table should have multiple rows. | |
Cache settings | |
const | CacheDirectory |
Directory for caching data in the local filesystem. | |
const | MainCacheType |
Main cache type. | |
const | MessageCacheType |
The cache type for storing the contents of the MediaWiki namespace. | |
const | ParserCacheType |
The cache type for storing article HTML. | |
const | SessionCacheType |
The cache backend for storing session data. | |
const | LanguageConverterCacheType |
The cache type for storing language conversion tables, which are used when parsing certain text and interface messages. | |
const | StatsCacheType |
The object cache type for stats storage. | |
const | ObjectCaches |
Advanced object cache configuration. | |
const | MainWANCache |
Main Wide-Area-Network cache type. | |
const | WANObjectCaches |
Advanced WAN object cache configuration. | |
const | EnableWANCacheReaper |
Verify and enforce WAN cache purges using reliable DB sources as streams. | |
const | MainStash |
The object store type of the main stash. | |
const | ParsoidCacheConfig |
Configuration for the caching related to parsoid output. | |
const | ChronologyProtectorStash |
The object store type for the ChronologyProtector store. | |
const | ParserCacheExpireTime |
The expiry time for the parser cache, in seconds. | |
const | OldRevisionParserCacheExpireTime |
The expiry time for the parser cache for old revisions, in seconds. | |
const | ObjectCacheSessionExpiry |
The expiry time to use for session storage, in seconds. | |
const | PHPSessionHandling |
Whether to use PHP session handling ($_SESSION and session_*() functions) | |
const | SuspiciousIpExpiry |
Time in seconds to remember IPs for, for the purposes of logging IP changes within the same session. | |
const | SessionPbkdf2Iterations |
Number of internal PBKDF2 iterations to use when deriving session secrets. | |
const | MemCachedServers |
The list of MemCached servers and port numbers. | |
const | MemCachedPersistent |
Use persistent connections to MemCached, which are shared across multiple requests. | |
const | MemCachedTimeout |
Read/write timeout for MemCached server communication, in microseconds. | |
const | UseLocalMessageCache |
Set this to true to maintain a copy of the message cache on the local server. | |
const | AdaptiveMessageCache |
Instead of caching everything, only cache those messages which have been customised in the site content language. | |
const | LocalisationCacheConf |
Localisation cache configuration. | |
const | CachePages |
Allow client-side caching of pages. | |
const | CacheEpoch |
Set this to current time to invalidate all prior cached pages. | |
const | GitInfoCacheDirectory |
Directory where GitInfo will look for pre-computed cache files. | |
const | UseFileCache |
This will cache static pages for non-logged-in users to reduce database traffic on public sites. | |
const | FileCacheDepth |
Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory. | |
const | RenderHashAppend |
Append a configured value to the parser cache and the sitenotice key so that they can be kept separate for some class of activity. | |
const | EnableSidebarCache |
If on, the sidebar navigation links are cached for users with the current language set. | |
const | SidebarCacheExpiry |
Expiry time for the sidebar cache, in seconds. | |
const | UseGzip |
When using the file cache, we can store the cached HTML gzipped to save disk space. | |
const | InvalidateCacheOnLocalSettingsChange |
Invalidate various caches when LocalSettings.php changes. | |
const | ExtensionInfoMTime |
When loading extensions through the extension registration system, this can be used to invalidate the cache. | |
const | EnableRemoteBagOStuffTests |
If this is set to true, phpunit will run integration tests against remote caches defined in $wgObjectCaches. | |
HTTP proxy (CDN) settings | |
Many of these settings apply to any HTTP proxy used in front of MediaWiki, although they are sometimes still referred to as Squid settings for historical reasons. Achieving a high hit ratio with an HTTP proxy requires special configuration. See https://www.mediawiki.org/wiki/Manual:Performance_tuning#Page_view_caching for more details. | |
const | UseCdn |
Enable/disable CDN. | |
const | VaryOnXFP |
Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds. | |
const | InternalServer |
Internal server name as known to CDN, if different. | |
const | CdnMaxAge |
Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI). | |
const | CdnMaxageLagged |
Cache timeout for the CDN when DB replica DB lag is high. | |
const | CdnMaxageStale |
Cache timeout when delivering a stale ParserCache response due to PoolCounter contention. | |
const | CdnReboundPurgeDelay |
If set, any SquidPurge call on a URL or URLs will send a second purge no less than this many seconds later via the job queue. | |
const | CdnMaxageSubstitute |
Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load) | |
const | ForcedRawSMaxage |
Default maximum age for raw CSS/JS accesses. | |
const | CdnServers |
List of proxy servers to purge on changes; default port is 80. | |
const | CdnServersNoPurge |
As with $wgCdnServers, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc. | |
const | SquidPurgeUseHostHeader |
Whether to use a Host header in purge requests sent to the proxy servers configured in $wgCdnServers. | |
const | HTCPRouting |
Routing configuration for HTCP multicast purging. | |
const | HTCPMulticastTTL |
HTCP multicast TTL. | |
const | UsePrivateIPs |
Should forwarded Private IPs be accepted? | |
const | CdnMatchParameterOrder |
Set this to false if MediaWiki is behind a CDN that re-orders query parameters on incoming requests. | |
Output format and skin settings | |
const | MimeType |
The default Content-Type header. | |
const | Html5Version |
Defines the value of the version attribute in the <html> tag, if any. | |
const | HTMLFormAllowTableFormat |
Temporary variable that allows HTMLForms to be rendered as tables. | |
const | UseMediaWikiUIEverywhere |
Temporary variable that applies MediaWiki UI wherever it can be supported. | |
const | EditSubmitButtonLabelPublish |
Whether to label the store-to-database-and-show-to-others button in the editor as "Save page"/"Save changes" if false (the default) or, if true, instead as "Publish page"/"Publish changes". | |
const | XhtmlNamespaces |
Permit other namespaces in addition to the w3.org default. | |
const | SiteNotice |
Site notice shown at the top of each page. | |
const | BrowserFormatDetection |
Override ability of certains browsers to attempt to autodetect dataformats in pages. | |
const | SkinMetaTags |
An array of open graph tags which should be added by all skins. | |
const | DefaultSkin |
Default skin, for new users and anonymous visitors. | |
const | FallbackSkin |
Fallback skin used when the skin defined by $wgDefaultSkin can't be found. | |
const | SkipSkins |
Specify the names of skins that should not be presented in the list of available skins in user preferences. | |
const | DisableOutputCompression |
Disable output compression (enabled by default if zlib is available) | |
const | FragmentMode |
How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of: | |
const | ExternalInterwikiFragmentMode |
Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragmentMode above for details of each mode. | |
const | FooterIcons |
Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can add new icons to the built in copyright or poweredby, or you can create a new block. | |
const | UseCombinedLoginLink |
Login / create account link behavior when it's possible for anonymous users to create an account. | |
const | Edititis |
Display user edit counts in various prominent places. | |
const | Send404Code |
Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output. | |
const | ShowRollbackEditCount |
The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back. | |
const | EnableCanonicalServerLink |
Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e. | |
Interwiki links and sites | |
const | LocalInterwikis |
Array for local interwiki values, for each of the interwiki prefixes that point to the current wiki. | |
const | InterwikiExpiry |
Expiry time for cache of interwiki table. | |
const | InterwikiCache |
Interwiki cache, either as an associative array or a path to a constant database (.cdb) file. | |
const | InterwikiScopes |
Specify number of domains to check for messages. | |
const | InterwikiFallbackSite |
Fallback site, if unable to resolve from cache. | |
const | RedirectSources |
If local interwikis are set up which allow redirects, set this regexp to restrict URLs which will be displayed as 'redirected from' links. | |
const | SiteTypes |
Register handlers for specific types of sites. | |
Parser settings | |
These settings configure the transformation from wikitext to HTML. | |
const | MaxTocLevel |
Maximum indent level of toc. | |
const | MaxPPNodeCount |
A complexity limit on template expansion: the maximum number of nodes visited by PPFrame::expand() | |
const | MaxTemplateDepth |
Maximum recursion depth for templates within templates. | |
const | MaxPPExpandDepth |
const | UrlProtocols |
URL schemes that should be recognized as valid by wfParseUrl(). | |
const | CleanSignatures |
If true, removes (by substituting) templates in signatures. | |
const | AllowExternalImages |
Whether to allow inline image pointing to other websites. | |
const | AllowExternalImagesFrom |
If the above is false, you can specify an exception here. | |
const | EnableImageWhitelist |
If $wgAllowExternalImages is false, you can allow an on-wiki allow list of regular expression fragments to match the image URL against. | |
const | AllowImageTag |
A different approach to the above: simply allow the "<img>" tag to be used. | |
const | TidyConfig |
Configuration for HTML postprocessing tool. | |
const | ParsoidSettings |
Default Parsoid configuration. | |
const | ParserEnableLegacyMediaDOM |
Enable legacy media HTML structure in the output from the Parser. | |
const | UseContentMediaStyles |
Temporary flag to ship the styles for the media HTML structure that replaces legacy, when $wgParserEnableLegacyMediaDOM is false . | |
const | RawHtml |
Allow raw, unchecked HTML in "<html>...</html>" sections. | |
const | ExternalLinkTarget |
Set a default target for external links, e.g. | |
const | NoFollowLinks |
If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to search engines that they should not be followed for ranking purposes as they are user-supplied and thus subject to spamming. | |
const | NoFollowNsExceptions |
Namespaces in which $wgNoFollowLinks doesn't apply. | |
const | NoFollowDomainExceptions |
If this is set to an array of domains, external links to these domain names (or any subdomains) will not be set to rel="nofollow" regardless of the value of $wgNoFollowLinks. | |
const | RegisterInternalExternals |
By default MediaWiki does not register links pointing to same server in externallinks dataset, use this value to override: | |
const | AllowDisplayTitle |
Allow DISPLAYTITLE to change title display. | |
const | RestrictDisplayTitle |
For consistency, restrict DISPLAYTITLE to text that normalizes to the same canonical DB key. | |
const | ExpensiveParserFunctionLimit |
Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY. | |
const | PreprocessorCacheThreshold |
Preprocessor caching threshold Setting it to 'false' will disable the preprocessor cache. | |
const | EnableScaryTranscluding |
Enable interwiki transcluding. | |
const | TranscludeCacheExpiry |
Expiry time for transcluded templates cached in object cache. | |
const | EnableMagicLinks |
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links. | |
Statistics and content analysis | |
const | ArticleCountMethod |
Method used to determine if a page in a content namespace should be counted as a valid article. | |
const | ActiveUserDays |
How many days user must be idle before he is considered inactive. | |
const | LearnerEdits |
The following variables define 3 user experience levels: | |
const | LearnerMemberSince |
Number of days the user must exist before becoming a learner. | |
const | ExperiencedUserEdits |
Number of edits the user must have before becoming "experienced". | |
const | ExperiencedUserMemberSince |
Number of days the user must exist before becoming "experienced". | |
const | ManualRevertSearchRadius |
Maximum number of revisions of a page that will be checked against every new edit made to determine whether the edit was a manual revert. | |
const | RevertedTagMaxDepth |
Maximum depth (revision count) of reverts that will have their reverted edits marked with the mw-reverted change tag. | |
User accounts, authentication | |
const | CentralIdLookupProviders |
Central ID lookup providers Key is the provider ID, value is a specification for ObjectFactory. | |
const | CentralIdLookupProvider |
Central ID lookup provider to use by default. | |
const | PasswordPolicy |
Password policy for the wiki. | |
const | AuthManagerConfig |
Configure AuthManager. | |
const | AuthManagerAutoConfig |
const | RememberMe |
Configures RememberMe authentication request added by AuthManager. | |
const | ReauthenticateTime |
Time frame for re-authentication. | |
const | AllowSecuritySensitiveOperationIfCannotReauthenticate |
Whether to allow security-sensitive operations when re-authentication is not possible. | |
const | ChangeCredentialsBlacklist |
List of AuthenticationRequest class names which are not changeable through Special:ChangeCredentials and the changeauthenticationdata API. | |
const | RemoveCredentialsBlacklist |
List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata API. | |
const | MinimalPasswordLength |
Specifies the minimal length of a user password. | |
const | MaximalPasswordLength |
Specifies the maximal length of a user password (T64685). | |
const | InvalidPasswordReset |
Specifies if users should be sent to a password-reset form on login, if their password doesn't meet the requirements of User::isValidPassword(). | |
const | PasswordDefault |
Default password type to use when hashing user passwords. | |
const | PasswordConfig |
Configuration for built-in password types. | |
const | PasswordResetRoutes |
Whether to allow password resets ("enter some identifying data, and we'll send an email
with a temporary password you can use to get back into the account") identified by various bits of data. | |
const | MaxSigChars |
Maximum number of Unicode characters in signature. | |
const | SignatureValidation |
Behavior of signature validation. | |
const | SignatureAllowedLintErrors |
List of lint error codes which don't cause signature validation to fail. | |
const | MaxNameChars |
Maximum number of bytes in username. | |
const | ReservedUsernames |
Array of usernames which may not be registered or logged in from Maintenance scripts can still use these. | |
const | DefaultUserOptions |
Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts. | |
const | HiddenPrefs |
An array of preferences to not show for the user. | |
const | InvalidUsernameCharacters |
Characters to prevent during new account creations. | |
const | UserrightsInterwikiDelimiter |
Character used as a delimiter when testing for interwiki userrights (In Special:UserRights, it is possible to modify users on different databases if the delimiter is used, e.g. | |
const | SecureLogin |
This is to let user authenticate using https when they come from http. | |
const | AuthenticationTokenVersion |
Versioning for authentication tokens. | |
const | SessionProviders |
MediaWiki\Session\SessionProvider configuration. | |
const | AllowRequiringEmailForResets |
Temporary feature flag that controls whether users will see a checkbox allowing them to require providing email during password resets. | |
const | AutoCreateTempUser |
Configuration for automatic creation of temporary accounts on page save. | |
User rights, access control and monitoring | |
const | AutoblockExpiry |
Number of seconds before autoblock entries expire. | |
const | BlockAllowsUTEdit |
Set this to true to allow blocked users to edit their own user talk page. | |
const | BlockCIDRLimit |
Limits on the possible sizes of range blocks. | |
const | BlockDisablesLogin |
If true, blocked users will not be allowed to login. | |
const | EnablePartialActionBlocks |
Flag to enable partial blocks against performing certain actions. | |
const | WhitelistRead |
Pages anonymous user may see, set as an array of pages titles. | |
const | WhitelistReadRegexp |
Pages anonymous user may see, set as an array of regular expressions. | |
const | EmailConfirmToEdit |
Should editors be required to have a validated e-mail address before being allowed to edit? | |
const | HideIdentifiableRedirects |
Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public. | |
const | GroupPermissions |
Permission keys given to users in each group. | |
const | PrivilegedGroups |
List of groups which should be considered privileged (user accounts belonging in these groups can be abused in dangerous ways). | |
const | RevokePermissions |
Permission keys revoked from users in each group. | |
const | GroupInheritsPermissions |
Groups that should inherit permissions from another group. | |
const | ImplicitGroups |
Implicit groups, aren't shown on Special:Listusers or somewhere else. | |
const | GroupsAddToSelf |
A map of group names that the user is in, to group names that those users are allowed to add or revoke. | |
const | GroupsRemoveFromSelf |
const | RestrictionTypes |
Set of available actions that can be restricted via action=protect You probably shouldn't change this. | |
const | RestrictionLevels |
Rights which can be required for each protection level (via action=protect) | |
const | CascadingRestrictionLevels |
Restriction levels that can be used with cascading protection. | |
const | SemiprotectedRestrictionLevels |
Restriction levels that should be considered "semiprotected". | |
const | NamespaceProtection |
Set the minimum permissions required to edit pages in each namespace. | |
const | NonincludableNamespaces |
Pages in namespaces in this array can not be used as templates. | |
const | AutoConfirmAge |
Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group membership. | |
const | AutoConfirmCount |
Number of edits an account requires before it is autoconfirmed. | |
const | Autopromote |
Array containing the conditions of automatic promotion of a user to specific groups. | |
const | AutopromoteOnce |
Automatically add a usergroup to any user who matches certain conditions. | |
const | AutopromoteOnceLogInRC |
Put user rights log entries for autopromotion in recent changes? | |
const | AddGroups |
$wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups at Special:Userrights. | |
const | RemoveGroups |
const | AvailableRights |
A list of available rights, in addition to the ones defined by the core. | |
const | DeleteRevisionsLimit |
Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission. | |
const | DeleteRevisionsBatchSize |
Page deletions with > this number of revisions will use the job queue. | |
const | HideUserContribLimit |
The maximum number of edits a user can have and can still be hidden by users with the hideuser permission. | |
const | AccountCreationThrottle |
Number of accounts each IP address may create per specified period(s). | |
const | SpamRegex |
Edits matching these regular expressions in body text will be recognised as spam and rejected automatically. | |
const | SummarySpamRegex |
Same as SpamRegex except for edit summaries. | |
const | EnableDnsBlacklist |
Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies. | |
const | DnsBlacklistUrls |
List of DNS blacklists to use, if $wgEnableDnsBlacklist is true. | |
const | ProxyList |
List of banned IP addresses. | |
const | ProxyWhitelist |
Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say. | |
const | SoftBlockRanges |
IP ranges that should be considered soft-blocked (anon-only, account creation allowed). | |
const | ApplyIpBlocksToXff |
Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them. | |
const | RateLimits |
Simple rate limiter options to brake edit floods. | |
const | RateLimitsExcludedIPs |
Array of IPs / CIDR ranges which should be excluded from rate limits. | |
const | PutIPinRC |
Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g. | |
const | QueryPageDefaultLimit |
Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere. | |
const | PasswordAttemptThrottle |
Limit password attempts to X attempts per Y seconds per IP per account. | |
const | GrantPermissions |
Users authorize consumers (like Apps) to act on their behalf but only with a subset of the user's normal account rights (signed off on by the user). | |
const | GrantPermissionGroups |
const | EnableBotPasswords |
const | BotPasswordsCluster |
Cluster for the bot_passwords table. | |
const | BotPasswordsDatabase |
Database name for the bot_passwords table. | |
Security | |
const | SecretKey |
This should always be customised in LocalSettings.php. | |
const | AllowUserJs |
Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load. | |
const | AllowUserCss |
Allow user Cascading Style Sheets (CSS)? This enables a lot of neat customizations, but may increase security risk to users and server load. | |
const | AllowUserCssPrefs |
Allow style-related user-preferences? | |
const | UseSiteJs |
Use the site's Javascript page? | |
const | UseSiteCss |
Use the site's Cascading Style Sheets (CSS)? | |
const | BreakFrames |
Break out of framesets. | |
const | EditPageFrameOptions |
The X-Frame-Options header to send on pages sensitive to clickjacking attacks, such as edit pages. | |
const | ApiFrameOptions |
Disallow framing of API pages directly, by setting the X-Frame-Options header. | |
const | CSPHeader |
Controls Content-Security-Policy header [Experimental]. | |
const | CSPReportOnlyHeader |
Controls Content-Security-Policy-Report-Only header. | |
const | CSPFalsePositiveUrls |
List of urls which appear often to be triggering CSP reports but do not appear to be caused by actual content, but by client software inserting scripts (i.e. | |
const | AllowCrossOrigin |
Allow anonymous cross origin requests to the REST API. | |
const | RestAllowCrossOriginCookieAuth |
Allows authenticated cross-origin requests to the REST API with session cookies. | |
const | SessionSecret |
Secret for session storage. | |
const | SessionInsecureSecrets |
If for some reason you can't install the PHP OpenSSL extension, you can set this to true to make MediaWiki work again at the cost of storing sensitive session data insecurely. | |
const | HKDFSecret |
Secret for hmac-based key derivation function (fast, cryptographically secure random numbers). | |
const | HKDFAlgorithm |
Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers). | |
Profiling, testing and debugging | |
const | DebugLogFile |
Enable verbose debug logging for all channels and log levels. | |
const | DebugLogPrefix |
Prefix for debug log lines. | |
const | DebugRedirects |
If true, instead of redirecting, show a page with a link to the redirect destination. | |
const | DebugRawPage |
If true, debug logging is also enabled for load.php and action=raw requests. | |
const | DebugComments |
Send debug data to an HTML comment in the output. | |
const | DebugDumpSql |
Write SQL queries to the debug log. | |
const | TrxProfilerLimits |
Performance expectations for DB usage. | |
const | DebugLogGroups |
Map of string log group names to log destinations. | |
const | MWLoggerDefaultSpi |
Default service provider for creating Psr\Log\LoggerInterface instances. | |
const | ShowDebug |
Display debug data at the bottom of the main content area. | |
const | SpecialVersionShowHooks |
Show the contents of $wgHooks in Special:Version. | |
const | ShowExceptionDetails |
Show exception message and stack trace when printing details about uncaught exceptions in web response output. | |
const | LogExceptionBacktrace |
If true, send the exception backtrace to the error log. | |
const | PropagateErrors |
If true, the MediaWiki error handler passes errors/warnings to the default error handler after logging them. | |
const | ShowHostnames |
Expose backend server host names through the API and various HTML comments. | |
const | OverrideHostname |
Override server hostname detection with a hardcoded value. | |
const | DevelopmentWarnings |
If set to true MediaWiki will throw notices for some possible error conditions and for deprecated functions. | |
const | DeprecationReleaseLimit |
Release limitation to wfDeprecated warnings, if set to a release number development warnings will not be generated for deprecations added in releases after the limit. | |
const | Profiler |
Profiler configuration. | |
const | StatsdServer |
Destination of statsd metrics. | |
const | StatsdMetricPrefix |
Prefix for metric names sent to $wgStatsdServer. | |
const | StatsdSamplingRates |
Sampling rate for statsd metrics as an associative array of patterns and rates. | |
const | MetricsTarget |
Metrics output target URI e.g. | |
const | MetricsFormat |
Metrics output format. | |
const | MetricsPrefix |
Metrics service name prefix. | |
const | PageInfoTransclusionLimit |
InfoAction retrieves a list of transclusion links (both to and from). | |
const | ParserTestFiles |
Parser test suite files to be run by parserTests.php when no specific filename is passed to it. | |
const | EnableJavaScriptTest |
Allow running of QUnit tests via [[Special:JavaScriptTest]]. | |
const | CachePrefix |
Overwrite the caching key prefix with custom value. | |
const | DebugToolbar |
Display the new debugging toolbar. | |
Search | |
const | DisableTextSearch |
Set this to true to disable the full text search feature. | |
const | AdvancedSearchHighlighting |
Set to true to have nicer highlighted text in search results, by default off due to execution overhead. | |
const | SearchHighlightBoundaries |
Regexp to match word boundaries, defaults for non-CJK languages should be empty for CJK since the words are not separate. | |
const | OpenSearchTemplate |
Template for OpenSearch suggestions, defaults to API action=opensearch. | |
const | OpenSearchTemplates |
Templates for OpenSearch suggestions, defaults to API action=opensearch. | |
const | EnableOpenSearchSuggest |
This was previously a used to force empty responses from ApiOpenSearch with the 'suggest' parameter set. | |
const | OpenSearchDefaultLimit |
Integer defining default number of entries to show on OpenSearch call. | |
const | OpenSearchDescriptionLength |
Minimum length of extract in . | |
const | SearchSuggestCacheExpiry |
Expiry time for search suggestion responses. | |
const | DisableSearchUpdate |
If you've disabled search semi-permanently, this also disables updates to the table. | |
const | NamespacesToBeSearchedDefault |
List of namespaces which are searched by default. | |
const | DisableInternalSearch |
Disable the internal MySQL-based search, to allow it to be implemented by an extension instead. | |
const | SearchForwardUrl |
Set this to a URL to forward search requests to some external location. | |
const | SitemapNamespaces |
Array of namespaces to generate a Google sitemap for when the maintenance/generateSitemap.php script is run, or false if one is to be generated for all namespaces. | |
const | SitemapNamespacesPriorities |
Custom namespace priorities for sitemaps. | |
const | EnableSearchContributorsByIP |
If true, searches for IP addresses will be redirected to that IP's contributions page. | |
const | SpecialSearchFormOptions |
Options for Special:Search completion widget form created by SearchFormWidget class. | |
const | SearchMatchRedirectPreference |
Set true to allow logged-in users to set a preference whether or not matches in search results should force redirection to that page. | |
const | SearchRunSuggestedQuery |
Controls whether zero-result search queries with suggestions should display results for these suggestions. | |
Edit user interface | |
const | Diff3 |
Path to the GNU diff3 utility. | |
const | Diff |
Path to the GNU diff utility. | |
const | PreviewOnOpenNamespaces |
Which namespaces have special treatment where they should be preview-on-open Internally only Category: pages apply, but using this extensions (e.g. | |
const | UniversalEditButton |
Enable the UniversalEditButton for browsers that support it (currently only Firefox with an extension) See http://universaleditbutton.org for more background information. | |
const | UseAutomaticEditSummaries |
If user doesn't specify any edit summary when making a an edit, MediaWiki will try to automatically create one. | |
Recent changes, new pages, watchlist and history | |
const | RCMaxAge |
Recentchanges items are periodically purged; entries older than this many seconds will go. | |
const | WatchersMaxAge |
Page watchers inactive for more than this many seconds are considered inactive. | |
const | UnwatchedPageSecret |
If active watchers (per above) are this number or less, do not disclose it. | |
const | RCFilterByAge |
Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers higher than what will be stored. | |
const | RCLinkLimits |
List of Limits options to list in the Special:Recentchanges and Special:Recentchangeslinked pages. | |
const | RCLinkDays |
List of Days options to list in the Special:Recentchanges and Special:Recentchangeslinked pages. | |
const | RCFeeds |
Configuration for feeds to which notifications about recent changes will be sent. | |
const | RCEngines |
Used by RecentChange::getEngine to find the correct engine for a given URI scheme. | |
const | RCWatchCategoryMembership |
Treat category membership changes as a RecentChange. | |
const | UseRCPatrol |
Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files are included. | |
const | StructuredChangeFiltersLiveUpdatePollingRate |
Polling rate, in seconds, used by the 'live update' and 'view newest' features of the RCFilters app on SpecialRecentChanges and Special:Watchlist. | |
const | UseNPPatrol |
Use new page patrolling to check new pages on Special:Newpages. | |
const | UseFilePatrol |
Use file patrolling to check new files on Special:Newfiles. | |
const | Feed |
Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages. | |
const | FeedLimit |
Set maximum number of results to return in syndication feeds (RSS, Atom) for eg Recentchanges, Newpages. | |
const | FeedCacheTimeout |
Minimum timeout for cached Recentchanges feed, in seconds. | |
const | FeedDiffCutoff |
When generating Recentchanges RSS/Atom feed, diffs will not be generated for pages larger than this size. | |
const | OverrideSiteFeed |
Override the site's default RSS/ATOM feed for recentchanges that appears on every page. | |
const | FeedClasses |
Available feeds objects. | |
const | AdvertisedFeedTypes |
Which feed types should we provide by default? This can include 'rss', 'atom', neither, or both. | |
const | RCShowWatchingUsers |
Show watching users in recent changes, watchlist and page history views. | |
const | RCShowChangedSize |
Show the amount of changed characters in recent changes. | |
const | RCChangedSizeThreshold |
If the difference between the character counts of the text before and after the edit is below that value, the value will be highlighted on the RC page. | |
const | ShowUpdatedMarker |
Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes. | |
const | DisableAnonTalk |
Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history, Special:Recentchanges, etc. | |
const | UseTagFilter |
Allow filtering by change tag in recentchanges, history, etc Has no effect if no tags are defined. | |
const | SoftwareTags |
List of core tags to enable. | |
const | UnwatchedPageThreshold |
If set to an integer, pages that are watched by this many users or more will not require the unwatchedpages permission to view the number of watchers. | |
const | RecentChangesFlags |
Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits. | |
const | WatchlistExpiry |
Whether to enable the watchlist expiry feature. | |
const | WatchlistPurgeRate |
Chance of expired watchlist items being purged on any page edit. | |
const | WatchlistExpiryMaxDuration |
Relative maximum duration for watchlist expiries, as accepted by strtotime(). | |
Copyright and credits settings | |
const | RightsPage |
Override for copyright metadata. | |
const | RightsUrl |
Set this to specify an external URL containing details about the content license used on your wiki. | |
const | RightsText |
If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link. | |
const | RightsIcon |
Override for copyright metadata. | |
const | UseCopyrightUpload |
Set this to true if you want detailed copyright information forms on Upload. | |
const | MaxCredits |
Set this to the number of authors that you want to be credited below an article text. | |
const | ShowCreditsIfMax |
If there are more than $wgMaxCredits authors, show $wgMaxCredits of them. | |
Import / Export | |
const | ImportSources |
List of interwiki prefixes for wikis we'll accept as sources for Special:Import and API action=import. | |
const | ImportTargetNamespace |
Optional default target namespace for interwiki imports. | |
const | ExportAllowHistory |
If set to false, disables the full-history option on Special:Export. | |
const | ExportMaxHistory |
If set nonzero, Special:Export requests for history of pages with more revisions than this will be rejected. | |
const | ExportAllowListContributors |
Return distinct author list (when not returning full history) | |
const | ExportMaxLinkDepth |
If non-zero, Special:Export accepts a "pagelink-depth" parameter up to this specified level, which will cause it to include all pages linked to from the pages you specify. | |
const | ExportFromNamespaces |
Whether to allow the "export all pages in namespace" option. | |
const | ExportAllowAll |
Whether to allow exporting the entire wiki into a single file. | |
const | ExportPagelistLimit |
Maximum number of pages returned by the GetPagesFromCategory and GetPagesFromNamespace functions. | |
const | XmlDumpSchemaVersion |
The schema to use per default when generating XML dumps. | |
Wiki Farm | |
const | WikiFarmSettingsDirectory |
EXPERIMENTAL: A directory that contains site-specific configuration files. | |
const | WikiFarmSettingsExtension |
EXPERIMENTAL: The file extension to be used when looking up site-specific settings files in $wgWikiFarmSettingsDirectory, such as 'json' or 'yaml'. | |
Extensions | |
const | ExtensionFunctions |
A list of callback functions which are called once MediaWiki is fully initialised. | |
const | ExtensionMessagesFiles |
Extension messages files. | |
const | MessagesDirs |
Extension messages directories. | |
const | ExtensionEntryPointListFiles |
Array of files with list(s) of extension entry points to be used in maintenance/mergeMessageFileList.php. | |
const | ParserOutputHooks |
Parser output hooks. | |
const | EnableParserLimitReporting |
Whether to include the NewPP limit report as a HTML comment. | |
const | ValidSkinNames |
List of valid skin names. | |
const | SpecialPages |
Special page list. | |
const | AutoloadAttemptLowercase |
Switch controlling legacy case-insensitive classloading. | |
const | ExtensionCredits |
Add information about an installed extension, keyed by its type. | |
const | Hooks |
Global list of hooks. | |
const | ServiceWiringFiles |
List of service wiring files to be loaded by the default instance of MediaWikiServices. | |
const | JobClasses |
Maps jobs to their handlers; extensions can add to this to provide custom jobs. | |
const | JobTypesExcludedFromDefaultQueue |
Jobs that must be explicitly requested, i.e. | |
const | JobBackoffThrottling |
Map of job types to how many job "work items" should be run per second on each job runner process. | |
const | JobSerialCommitThreshold |
Make job runners commit changes for replica DB-lag prone jobs one job at a time. | |
const | JobTypeConf |
Map of job types to configuration arrays. | |
const | JobQueueIncludeInMaxLagFactor |
Whether to include the number of jobs that are queued for the API's maxlag parameter. | |
const | SpecialPageCacheUpdates |
Additional functions to be performed with updateSpecialPages. | |
const | PagePropLinkInvalidations |
Page property link table invalidation lists. | |
Categories | |
const | CategoryMagicGallery |
On category pages, show thumbnail gallery for images belonging to that category instead of listing them as articles. | |
const | CategoryPagingLimit |
Paging limit for categories. | |
const | CategoryCollation |
Specify how category names should be sorted, when listed on a category page. | |
const | TempCategoryCollations |
Additional category collations to store during LinksUpdate. | |
const | TrackingCategories |
Array holding default tracking category names. | |
Logging | |
const | LogTypes |
The logging system has two levels: an event type, which describes the general category and can be viewed as a named subset of all logs; and an action, which is a specific kind of event that can exist in that log type. | |
const | LogRestrictions |
This restricts log access to those who have a certain right Users without this will not see it in the option menu and can not view it Restricted logs are not added to recent changes Logs should remain non-transcludable Format: logtype => permissiontype. | |
const | FilterLogTypes |
Show/hide links on Special:Log will be shown for these log types. | |
const | LogNames |
Lists the message key string for each log type. | |
const | LogHeaders |
Lists the message key string for descriptive text to be shown at the top of each log type. | |
const | LogActions |
Maps log actions to message keys, for formatting log entries of each type and action when displaying logs to the user. | |
const | LogActionsHandlers |
The same as above, but here values are names of classes, not messages. | |
const | ActionFilteredLogs |
List of log types that can be filtered by action types. | |
const | NewUserLog |
Maintain a log of newusers at Special:Log/newusers? | |
const | PageCreationLog |
Maintain a log of page creations at Special:Log/create? | |
Special pages (general and miscellaneous) | |
const | AllowSpecialInclusion |
Allow special page inclusions such as {{Special:Allpages}}. | |
const | DisableQueryPageUpdate |
Set this to an array of special page names to prevent maintenance/updateSpecialPages.php from updating those pages. | |
const | CountCategorizedImagesAsUsed |
On Special:Unusedimages, consider images "used", if they are put into a category. | |
const | MaxRedirectLinksRetrieved |
Maximum number of links to a redirect page listed on Special:Whatlinkshere/RedirectDestination. | |
const | RangeContributionsCIDRLimit |
Shortest CIDR limits that can be checked in any individual range check at Special:Contributions. | |
Actions | |
const | Actions |
Map of allowed values for the "title=foo&action=<action>" parameter. | |
Robot (search engine crawler) policy | |
const | DefaultRobotPolicy |
Default robot policy. | |
const | NamespaceRobotPolicies |
Robot policies per namespaces. | |
const | ArticleRobotPolicies |
Robot policies per article. | |
const | ExemptFromUserRobotsControl |
An array of namespace keys in which the INDEX/__NOINDEX__ magic words will not function, so users can't decide whether pages in that namespace are indexed by search engines. | |
Action API and REST API | |
const | DebugAPI |
WARNING: SECURITY THREAT - debug use only. | |
const | APIModules |
API module extensions. | |
const | APIFormatModules |
API format module extensions. | |
const | APIMetaModules |
API Query meta module extensions. | |
const | APIPropModules |
API Query prop module extensions. | |
const | APIListModules |
API Query list module extensions. | |
const | APIMaxDBRows |
Maximum amount of rows to scan in a DB query in the API The default value is generally fine. | |
const | APIMaxResultSize |
The maximum size (in bytes) of an API result. | |
const | APIMaxUncachedDiffs |
The maximum number of uncached diffs that can be retrieved in one API request. | |
const | APIMaxLagThreshold |
Maximum amount of DB lag on a majority of DB replica DBs to tolerate before forcing bots to retry any write requests via API errors. | |
const | APIRequestLog |
Log file or URL (TCP or UDP) to log API requests to, or false to disable API request logging. | |
const | APICacheHelpTimeout |
Set the timeout for the API help text cache. | |
const | APIUselessQueryPages |
The ApiQueryQueryPages module should skip pages that are redundant to true API queries. | |
const | AjaxUploadDestCheck |
Enable AJAX check for file overwrite, pre-upload. | |
const | AjaxLicensePreview |
Enable previewing licences via AJAX. | |
const | CrossSiteAJAXdomains |
Settings for incoming cross-site AJAX requests: Newer browsers support cross-site AJAX when the target resource allows requests from the origin domain by the Access-Control-Allow-Origin header. | |
const | CrossSiteAJAXdomainExceptions |
Domains that should not be allowed to make AJAX requests, even if they match one of the domains allowed by $wgCrossSiteAJAXdomains Uses the same syntax as $wgCrossSiteAJAXdomains. | |
const | AllowedCorsHeaders |
List of allowed headers for cross-origin API requests. | |
const | RestAPIAdditionalRouteFiles |
Additional REST API Route files. | |
Shell and process control | |
const | MaxShellMemory |
Maximum amount of virtual memory available to shell processes under linux, in KiB. | |
const | MaxShellFileSize |
Maximum file size created by shell processes under linux, in KiB ImageMagick convert for example can be fairly hungry for scratch space. | |
const | MaxShellTime |
Maximum CPU time in seconds for shell processes under Linux. | |
const | MaxShellWallClockTime |
Maximum wall clock time (i.e. | |
const | ShellCgroup |
Under Linux: a cgroup directory used to constrain memory usage of shell commands. | |
const | PhpCli |
Executable path of the PHP cli binary. | |
const | ShellRestrictionMethod |
Method to use to restrict shell commands. | |
const | ShellboxUrl |
const | ShellboxUrls |
Shell commands can be run on a remote server using Shellbox. | |
const | ShellboxSecretKey |
The secret key for HMAC verification of Shellbox requests. | |
HTTP client | |
const | HTTPTimeout |
Timeout for HTTP requests done internally, in seconds. | |
const | HTTPConnectTimeout |
Timeout for connections done internally (in seconds). | |
const | HTTPMaxTimeout |
The maximum HTTP request timeout in seconds. | |
const | HTTPMaxConnectTimeout |
The maximum HTTP connect timeout in seconds. | |
const | HTTPImportTimeout |
Timeout for HTTP requests done internally for transwiki imports, in seconds. | |
const | AsyncHTTPTimeout |
Timeout for Asynchronous (background) HTTP requests, in seconds. | |
const | HTTPProxy |
Proxy to use for CURL requests. | |
const | LocalVirtualHosts |
Local virtual hosts. | |
const | LocalHTTPProxy |
Reverse proxy to use for requests to domains in $wgLocalVirtualHosts. | |
const | AllowExternalReqID |
Whether to respect/honour the request ID provided by the incoming request via the X-Request-Id header. | |
Job queue | |
const | JobRunRate |
Number of jobs to perform per request. | |
const | RunJobsAsync |
When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process to handle the job execution, instead of blocking the request until the job execution finishes. | |
const | UpdateRowsPerJob |
Number of rows to update per job. | |
const | UpdateRowsPerQuery |
Number of rows to update per query. | |
Miscellaneous | |
const | RedirectOnLogin |
Allow redirection to another page when a user logs in. | |
const | VirtualRestConfig |
Global configuration variable for Virtual REST Services. | |
const | EventRelayerConfig |
Mapping of event channels (or channel categories) to EventRelayer configuration. | |
const | Pingback |
Share data about this installation with MediaWiki developers. | |
const | OriginTrials |
Origin Trials tokens. | |
const | ReportToExpiry |
Expiry of the endpoint definition for the Reporting API. | |
const | ReportToEndpoints |
List of endpoints for the Reporting API. | |
const | FeaturePolicyReportOnly |
List of Feature Policy Reporting types to enable. | |
const | SkinsPreferred |
List of preferred skins to be listed higher in Special:Preferences. | |
Server URLs and file paths | |
In this section, a "path" is usually a host-relative URL, i.e. a URL without the host part, that starts with a slash. In most cases a full URL is also acceptable. A "directory" is a local file path. In both paths and directories, trailing slashes should not be included. | |
const | Server |
URL of the server. | |
const | CanonicalServer |
Canonical URL of the server, to use in IRC feeds and notification e-mails. | |
const | ServerName |
Server name. | |
const | AssumeProxiesUseDefaultProtocolPorts |
When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes the wiki on the standard ports (443 for https and 80 for http). | |
const | HttpsPort |
For installations where the canonical server is HTTP but HTTPS is optionally supported, you can specify a non-standard HTTPS port here. | |
const | ForceHTTPS |
If this is true, when an insecure HTTP request is received, always redirect to HTTPS. | |
const | ScriptPath |
The path we should point to. | |
const | UsePathInfo |
Whether to support URLs like index.php/Page_title. | |
const | Script |
The URL path to index.php. | |
const | LoadScript |
The URL path to load.php. | |
const | RestPath |
The URL path to the REST API Defaults to "{$wgScriptPath}/rest.php". | |
const | StylePath |
The URL path of the skins directory. | |
const | LocalStylePath |
The URL path of the skins directory. | |
const | ExtensionAssetsPath |
The URL path of the extensions directory. | |
const | ExtensionDirectory |
Extensions directory in the file system. | |
const | StyleDirectory |
Skins directory in the file system. | |
const | BaseDirectory |
Absolute filesystem path of the root directory of the MediaWiki installation. | |
const | ArticlePath |
The URL path for primary article page views. | |
const | UploadPath |
The URL path for the images directory. | |
const | ImgAuthPath |
The base path for img_auth.php. | |
const | ThumbPath |
The base path for thumb_handler.php. | |
const | UploadDirectory |
The filesystem path of the images directory. | |
const | FileCacheDirectory |
Directory where the cached page will be saved. | |
const | Logo |
The URL path of the wiki logo. | |
const | Logos |
Specification for different versions of the wiki logo. | |
const | LogoHD |
Array with URL paths to HD versions of the wiki logo. | |
const | Favicon |
The URL path of the icon. | |
const | AppleTouchIcon |
The URL path of the icon for iPhone and iPod Touch web app bookmarks. | |
const | ReferrerPolicy |
Value for the referrer policy meta tag. | |
const | TmpDirectory |
The local filesystem path to a temporary directory. | |
const | UploadBaseUrl |
If set, this URL is added to the start of $wgUploadPath to form a complete upload URL. | |
const | UploadStashScalerBaseUrl |
To enable remote on-demand scaling, set this to the thumbnail base URL. | |
const | ActionPaths |
To set 'pretty' URL paths for actions other than plain page views, add to this array. | |
const | MainPageIsDomainRoot |
Option to whether serve the main page as the domain root. | |
static | getDefaultUsePathInfo () |
static | getDefaultScript ( $scriptPath) |
static | getDefaultLoadScript ( $scriptPath) |
static | getDefaultRestPath ( $scriptPath) |
static | getDefaultStylePath ( $resourceBasePath) |
static | getDefaultLocalStylePath ( $scriptPath) |
static | getDefaultExtensionAssetsPath ( $resourceBasePath) |
static | getDefaultArticlePath (string $script, $usePathInfo) |
static | getDefaultUploadPath ( $scriptPath) |
static | getDefaultUploadDirectory ( $baseDirectory) |
static | getDefaultFileCacheDirectory ( $uploadDirectory) |
static | getDefaultLogo ( $resourceBasePath) |
Files and file uploads | |
const | EnableUploads |
Allow users to upload files. | |
const | UploadStashMaxAge |
The maximum age of temporary (incomplete) uploaded files. | |
const | EnableAsyncUploads |
Enable deferred upload tasks that use the job queue. | |
const | UploadMaintenance |
To disable file delete/restore temporarily. | |
const | IllegalFileChars |
Additional characters that are not allowed in filenames. | |
const | DeletedDirectory |
What directory to place deleted uploads in. | |
const | ImgAuthDetails |
Set this to true if you use img_auth and want the user to see details on why access failed. | |
const | ImgAuthUrlPathMap |
Map of relative URL directories to match to internal mwstore:// base storage paths. | |
const | LocalFileRepo |
File repository structures. | |
const | ForeignFileRepos |
Enable the use of files from one or more other wikis. | |
const | UseInstantCommons |
Use Wikimedia Commons as a foreign file repository. | |
const | UseSharedUploads |
Shortcut for adding an entry to $wgForeignFileRepos. | |
const | SharedUploadDirectory |
Shortcut for the 'directory' setting of $wgForeignFileRepos. | |
const | SharedUploadPath |
Shortcut for the 'url' setting of $wgForeignFileRepos. | |
const | HashedSharedUploadDirectory |
Shortcut for the 'hashLevels' setting of $wgForeignFileRepos. | |
const | RepositoryBaseUrl |
Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos. | |
const | FetchCommonsDescriptions |
Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos. | |
const | SharedUploadDBname |
Shortcut for the ForeignDBRepo 'dbName' setting in $wgForeignFileRepos. | |
const | SharedUploadDBprefix |
Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos. | |
const | CacheSharedUploads |
Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos. | |
const | ForeignUploadTargets |
Array of foreign file repo names (set in $wgForeignFileRepos above) that are allowable upload targets. | |
const | UploadDialog |
Configuration for file uploads using the embeddable upload dialog (https://www.mediawiki.org/wiki/Upload_dialog). | |
const | FileBackends |
File backend structure configuration. | |
const | LockManagers |
List of lock manager backend configurations. | |
const | ShowEXIF |
Whether to show Exif data. | |
const | UpdateCompatibleMetadata |
Shortcut for the 'updateCompatibleMetadata' setting of $wgLocalFileRepo. | |
const | AllowCopyUploads |
Allow for upload to be copied from an URL. | |
const | CopyUploadsDomains |
A list of domains copy uploads can come from. | |
const | CopyUploadsFromSpecialUpload |
Enable copy uploads from Special:Upload. | |
const | CopyUploadProxy |
Proxy to use for copy upload requests. | |
const | CopyUploadTimeout |
Different timeout for upload by url This could be useful since when fetching large files, you may want a timeout longer than the default $wgHTTPTimeout. | |
const | CopyUploadAllowOnWikiDomainConfig |
If true, the value of $wgCopyUploadsDomains will be merged with the contents of MediaWiki:Copyupload-allowed-domains. | |
const | MaxUploadSize |
Max size for uploads, in bytes. | |
const | MinUploadChunkSize |
Minimum upload chunk size, in bytes. | |
const | UploadNavigationUrl |
Point the upload navigation link to an external URL Useful if you want to use a shared repository by default without disabling local uploads (use $wgEnableUploads = false for that). | |
const | UploadMissingFileUrl |
Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl. | |
const | ThumbnailScriptPath |
Give a path here to use thumb.php for thumbnail generation on client request, instead of generating them on render and outputting a static URL. | |
const | SharedThumbnailScriptPath |
Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos. | |
const | HashedUploadDirectory |
Shortcut for setting hashLevels=2 in $wgLocalFileRepo. | |
const | FileExtensions |
This is the list of preferred extensions for uploading files. | |
const | ProhibitedFileExtensions |
Files with these extensions will never be allowed as uploads. | |
const | MimeTypeExclusions |
Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled. | |
const | CheckFileExtensions |
This is a flag to determine whether or not to check file extensions on upload. | |
const | StrictFileExtensions |
If this is turned off, users may override the warning for files not covered by $wgFileExtensions. | |
const | DisableUploadScriptChecks |
Setting this to true will disable the upload system's checks for HTML/JavaScript. | |
const | UploadSizeWarning |
Warn if uploaded files are larger than this (in bytes), or false to disable. | |
const | TrustedMediaFormats |
list of trusted media-types and MIME types. | |
const | MediaHandlers |
Plugins for media file type handling. | |
const | NativeImageLazyLoading |
Toggles native image lazy loading, via the "loading" attribute. | |
const | ParserTestMediaHandlers |
Media handler overrides for parser tests (they don't need to generate actual thumbnails, so a mock will do) | |
const | UseImageResize |
Whether to enable server-side image thumbnailing. | |
const | UseImageMagick |
Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party converter, e.g. | |
const | ImageMagickConvertCommand |
The convert command shipped with ImageMagick. | |
const | MaxInterlacingAreas |
Array of max pixel areas for interlacing per MIME type. | |
const | SharpenParameter |
Sharpening parameter to ImageMagick. | |
const | SharpenReductionThreshold |
Reduction in linear dimensions below which sharpening will be enabled. | |
const | ImageMagickTempDir |
Temporary directory used for ImageMagick. | |
const | CustomConvertCommand |
Use another resizing converter, e.g. | |
const | JpegTran |
used for lossless jpeg rotation | |
const | JpegPixelFormat |
At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma subsampling to reduce file size, at the cost of possible color fringing at sharp edges. | |
const | JpegQuality |
When scaling a JPEG thumbnail, this is the quality we request from the backend. | |
const | Exiv2Command |
Some tests and extensions use exiv2 to manipulate the Exif metadata in some image formats. | |
const | Exiftool |
Path to exiftool binary. | |
const | SVGConverters |
Scalable Vector Graphics (SVG) may be uploaded as images. | |
const | SVGConverter |
Pick a converter defined in $wgSVGConverters. | |
const | SVGConverterPath |
If not in the executable PATH, specify the SVG converter path. | |
const | SVGMaxSize |
Don't scale a SVG larger than this. | |
const | SVGMetadataCutoff |
Don't read SVG metadata beyond this point. | |
const | MediaInTargetLanguage |
Whether thumbnails should be generated in target language (usually, same as page language), if available. | |
const | MaxImageArea |
The maximum number of pixels a source image can have if it is to be scaled down by a scaler that requires the full source image to be decompressed and stored in decompressed form, before the thumbnail is generated. | |
const | MaxAnimatedGifArea |
Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnail. | |
const | TiffThumbnailType |
Browsers don't support TIFF inline generally... For inline display, we need to convert to PNG or JPEG. | |
const | ThumbnailEpoch |
If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if the file didn't already exist. | |
const | AttemptFailureEpoch |
Certain operations are avoided if there were too many recent failures, for example, thumbnail generation. | |
const | IgnoreImageErrors |
If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an error message. | |
const | GenerateThumbnailOnParse |
Render thumbnails while parsing wikitext. | |
const | ShowArchiveThumbnails |
Show thumbnails for old images on the image description page. | |
const | EnableAutoRotation |
If set to true, images that contain certain the exif orientation tag will be rotated accordingly. | |
const | Antivirus |
Internal name of virus scanner. | |
const | AntivirusSetup |
Configuration for different virus scanners. | |
const | AntivirusRequired |
Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected. | |
const | VerifyMimeType |
Determines if the MIME type of uploaded files should be checked. | |
const | VerifyMimeTypeIE |
Determines whether extra checks for IE type detection should be applied. | |
const | MimeTypeFile |
Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php. | |
const | MimeInfoFile |
Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php. | |
const | MimeDetectorCommand |
Sets an external MIME detector program. | |
const | TrivialMimeDetection |
Switch for trivial MIME detection. | |
const | XMLMimeTypes |
Additional XML types we can allow via MIME-detection. | |
const | ImageLimits |
Limit images on image description pages to a user-selectable limit. | |
const | ThumbLimits |
Adjust thumbnails on image pages according to a user setting. | |
const | ThumbnailBuckets |
When defined, is an array of image widths used as buckets for thumbnail generation. | |
const | ThumbnailMinimumBucketDistance |
When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size. | |
const | UploadThumbnailRenderMap |
When defined, is an array of thumbnail widths to be rendered at upload time. | |
const | UploadThumbnailRenderMethod |
The method through which the thumbnails will be prerendered for the entries in $wgUploadThumbnailRenderMap. | |
const | UploadThumbnailRenderHttpCustomHost |
When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header. | |
const | UploadThumbnailRenderHttpCustomDomain |
When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to. | |
const | UseTinyRGBForJPGThumbnails |
When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight (and free) TinyRGB profile when generating thumbnails. | |
const | GalleryOptions |
Parameters for the "<gallery>" tag. | |
const | ThumbUpright |
Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright images without the need to fix the width by hardcoded px in wiki sourcecode. | |
const | DirectoryMode |
Default value for chmoding of new directories. | |
const | ResponsiveImages |
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities. | |
const | ImagePreconnect |
Add a preconnect link for browsers to a remote FileRepo host. | |
static | getDefaultDeletedDirectory ( $uploadDirectory) |
static | getDefaultLocalFileRepo ( $uploadDirectory, $scriptPath, $favicon, $uploadBaseUrl, $uploadPath, $hashedUploadDirectory, $thumbnailScriptPath, $generateThumbnailOnParse, $deletedDirectory, $updateCompatibleMetadata) |
Allow users to upload files. | |
static | getDefaultShowEXIF () |
Database settings | |
const | DBname |
Current wiki database name. | |
const | DBmwschema |
Current wiki database schema name. | |
const | DBprefix |
Current wiki database table name prefix. | |
const | DBserver |
Database host name or IP address. | |
const | DBport |
Database port number. | |
const | DBuser |
Database username. | |
const | DBpassword |
Database user's password. | |
const | DBtype |
Database type. | |
const | DBssl |
Whether to use SSL in DB connection. | |
const | DBcompress |
Whether to use compression in DB connection. | |
const | DBadminuser |
Separate username for maintenance tasks. | |
const | DBadminpassword |
Separate password for maintenance tasks. | |
const | SearchType |
Search type. | |
const | SearchTypeAlternatives |
Alternative search types. | |
const | DBTableOptions |
MySQL table options to use during installation or update. | |
const | SQLMode |
SQL Mode - default is turning off all modes, including strict, if set. | |
const | DBDefaultGroup |
Default group to use when getting database connections. | |
const | SQLiteDataDir |
To override default SQLite data directory ($docroot/../data) | |
const | SharedDB |
Shared database for multiple wikis. | |
const | SharedPrefix |
const | SharedTables |
const | SharedSchema |
const | DBservers |
Database load balancer This is a two-dimensional array, a list of server info structures Fields are: | |
const | LBFactoryConf |
Load balancer factory configuration To set up a multi-primary wiki farm, set the class here to something that can return a LoadBalancer with an appropriate primary on a call to getMainLB(). | |
const | DataCenterUpdateStickTTL |
After a state-changing request is done by a client, this determines how many seconds that client should keep using the primary datacenter. | |
const | DBerrorLog |
File to log database errors to. | |
const | DBerrorLogTZ |
Timezone to use in the error log. | |
const | LocalDatabases |
Other wikis on this site, can be administered from a single developer account. | |
const | DatabaseReplicaLagWarning |
If lag is higher than $wgDatabaseReplicaLagWarning, show a warning in some special pages (like watchlist). | |
const | DatabaseReplicaLagCritical |
const | MaxExecutionTimeForExpensiveQueries |
Max execution time for queries of several expensive special pages such as RecentChanges in milliseconds. | |
const | TemplateLinksSchemaMigrationStage |
Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields. | |
static | getDefaultSharedPrefix ( $dbPrefix) |
static | getDefaultSharedSchema ( $dbMwschema) |
static | getDefaultDBerrorLogTZ ( $localtimezone) |
Current wiki database name. | |
Language, regional and character encoding settings | |
const | LanguageCode |
Site language code. | |
const | GrammarForms |
Some languages need different word forms, usually for different cases. | |
const | InterwikiMagic |
Treat language links as magic connectors, not inline links. | |
const | HideInterlanguageLinks |
Hide interlanguage links from the sidebar. | |
const | ExtraInterlanguageLinkPrefixes |
List of additional interwiki prefixes that should be treated as interlanguage links (i.e. | |
const | InterlanguageLinkCodeMap |
Map of interlanguage link codes to language codes. | |
const | ExtraLanguageNames |
List of language names or overrides for default names in Names.php. | |
const | ExtraLanguageCodes |
List of mappings from one language code to another. | |
const | DummyLanguageCodes |
Functionally the same as $wgExtraLanguageCodes, but deprecated. | |
const | AllUnicodeFixes |
Set this to always convert certain Unicode sequences to modern ones regardless of the content language. | |
const | LegacyEncoding |
Set this to eg 'ISO-8859-1' to perform character set conversion when loading old revisions not marked with "utf-8" flag. | |
const | AmericanDates |
Enable dates like 'May 12' instead of '12 May', if the default date format is 'dmy or mdy'. | |
const | TranslateNumerals |
For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface. | |
const | UseDatabaseMessages |
Translation using MediaWiki: namespace. | |
const | MaxMsgCacheEntrySize |
Maximum entry size in the message cache, in bytes. | |
const | DisableLangConversion |
Whether to enable language variant conversion. | |
const | DisableTitleConversion |
Whether to enable language variant conversion for links. | |
const | DefaultLanguageVariant |
Default variant code, if false, the default will be the language code. | |
const | UsePigLatinVariant |
Whether to enable the pig Latin variant of English (en-x-piglatin), used to ease variant development work. | |
const | DisabledVariants |
Disabled variants array of language variant conversion. | |
const | VariantArticlePath |
Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which parts of the URL contain the language variant. | |
const | LoginLanguageSelector |
Show a bar of language selection links in the user login and user registration forms; edit the "loginlanguagelinks" message to customise these. | |
const | ForceUIMsgAsContentMsg |
When translating messages with wfMessage(), it is not always clear what should be considered UI messages and what should be content messages. | |
const | RawHtmlMessages |
List of messages which might contain raw HTML. | |
const | Localtimezone |
Fake out the timezone that the server thinks it's in. | |
const | LocalTZoffset |
Set an offset from UTC in minutes to use for the default timezone setting for anonymous users and new user accounts. | |
const | OverrideUcfirstCharacters |
Map of Unicode characters for which capitalization is overridden in Language::ucfirst. | |
static | getDefaultLocaltimezone () |
Site language code. | |
static | getDefaultLocalTZoffset ( $localtimezone) |
Site language code. | |
ResourceLoader settings | |
const | MangleFlashPolicy |
Formerly a workaround for a security vulnerability caused by installation of Flash as a browser extension. | |
const | ResourceModules |
Define extra client-side modules to be registered with ResourceLoader. | |
const | ResourceModuleSkinStyles |
Add extra skin-specific styles to a resource module. | |
const | ResourceLoaderSources |
Extensions should register foreign module sources here. | |
const | ResourceBasePath |
The default 'remoteBasePath' value for instances of MediaWiki\ResourceLoader\FileModule. | |
const | ResourceLoaderMaxage |
Override how long a CDN or browser may cache a ResourceLoader HTTP response. | |
const | ResourceLoaderUseObjectCacheForDeps |
Use the main stash instead of the module_deps table for indirect dependency tracking. | |
const | ResourceLoaderDebug |
The default debug mode (on/off) for of ResourceLoader requests. | |
const | ResourceLoaderMaxQueryLength |
ResourceLoader will not generate URLs whose query string is more than this many characters long, and will instead use multiple requests with shorter query strings. | |
const | ResourceLoaderValidateJS |
If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it. | |
const | ResourceLoaderEnableJSProfiler |
When enabled, execution of JavaScript modules is profiled client-side. | |
const | ResourceLoaderStorageEnabled |
Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API. | |
const | ResourceLoaderStorageVersion |
Cache version for client-side ResourceLoader module storage. | |
const | AllowSiteCSSOnRestrictedPages |
Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on restricted pages like Special:UserLogin or Special:Preferences where JavaScript is disabled for security reasons. | |
const | VueDevelopmentMode |
Whether to use the development version of Vue.js. | |
static | getDefaultResourceBasePath ( $scriptPath) |
Page titles and redirects | |
const | MetaNamespace |
Name of the project namespace. | |
const | MetaNamespaceTalk |
Name of the project talk namespace. | |
const | CanonicalNamespaceNames |
Canonical namespace names. | |
const | ExtraNamespaces |
Additional namespaces. | |
const | ExtraGenderNamespaces |
Same as above, but for namespaces with gender distinction. | |
const | NamespaceAliases |
Define extra namespace aliases. | |
const | LegalTitleChars |
Allowed title characters – regex character class Don't change this unless you know what you're doing. | |
const | CapitalLinks |
Set this to false to avoid forcing the first letter of links to capitals. | |
const | CapitalLinkOverrides |
const | NamespacesWithSubpages |
Which namespaces should support subpages? See Language.php for a list of namespaces. | |
const | ContentNamespaces |
Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are concerned. | |
const | ShortPagesNamespaceExclusions |
Optional array of namespaces which should be excluded from Special:ShortPages. | |
const | ExtraSignatureNamespaces |
Array of namespaces, in addition to the talk namespaces, where signatures (~~~~) are likely to be used. | |
const | InvalidRedirectTargets |
Array of invalid page redirect targets. | |
const | DisableHardRedirects |
Disable redirects to special pages and interwiki redirects, which use a 302 and have no "redirected from" link. | |
const | FixDoubleRedirects |
Fix double redirects after a page move. | |
static | getDefaultMetaNamespace ( $sitename) |
Cookie settings | |
const | CookieExpiration |
Default cookie lifetime, in seconds. | |
const | ExtendedLoginCookieExpiration |
Default login cookie lifetime, in seconds. | |
const | CookieDomain |
Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net". | |
const | CookiePath |
Set this variable if you want to restrict cookies to a certain path within the domain specified by $wgCookieDomain. | |
const | CookieSecure |
Whether the "secure" flag should be set on the cookie. | |
const | DisableCookieCheck |
By default, MediaWiki checks if the client supports cookies during the login process, so that it can display an informative error message if cookies are disabled. | |
const | CookiePrefix |
Cookies generated by MediaWiki have names starting with this prefix. | |
const | CookieHttpOnly |
Set authentication cookies to HttpOnly to prevent access by JavaScript, in browsers that support this feature. | |
const | CookieSameSite |
The SameSite cookie attribute used for login cookies. | |
const | UseSameSiteLegacyCookies |
If true, when a cross-site cookie with SameSite=None is sent, a legacy cookie with an "ss0" prefix will also be sent, without SameSite=None. | |
const | CacheVaryCookies |
A list of cookies that vary the cache (for use by extensions) | |
const | SessionName |
Override to customise the session name. | |
const | CookieSetOnAutoblock |
Whether to set a cookie when a user is autoblocked. | |
const | CookieSetOnIpBlock |
Whether to set a cookie when a logged-out user is blocked. | |
static | getDefaultCookieSecure ( $forceHTTPS) |
Default cookie lifetime, in seconds. | |
static | getDefaultCookiePrefix ( $sharedDB, $sharedPrefix, $sharedTables, $dbName, $dbPrefix) |
Default cookie lifetime, in seconds. | |
Maintenance | |
const | CommandLineDarkBg |
For colorized maintenance script output, is your terminal background dark ? | |
const | ReadOnly |
Set this to a string to put the wiki into read-only mode. | |
const | ReadOnlyWatchedItemStore |
Set this to true to put the wiki watchlists into read-only mode. | |
const | ReadOnlyFile |
If this lock file exists (size > 0), the wiki will be forced into read-only mode. | |
const | UpgradeKey |
When you run the web-based upgrade utility, it will tell you what to set this to in order to authorize the upgrade process. | |
const | GitBin |
Fully specified path to git binary. | |
const | GitRepositoryViewers |
Map GIT repository URLs to viewer URLs to provide links in Special:Version. | |
static | getDefaultReadOnlyFile ( $uploadDirectory) |
This class contains schema declarations for all configuration variables known to MediaWiki core.
The schema definitions follow the JSON Schema specification.
The following JSON schema keys are used by MediaWiki:
MediaWiki\\Settings\\Source\\JsonTypeHelper
for details.The following additional keys are used by MediaWiki:
MediaWiki\\Settings\\Config\\MergeStrategy
.MediaWiki\\Settings\\Source\\ReflectionSchemaSource
and MediaWiki\\Settings\\DynamicDefaultValues
for details.Definition at line 119 of file MainConfigSchema.php.
|
static |
string | $script | Value of Script |
mixed | $usePathInfo | Value of UsePathInfo |
Definition at line 528 of file MainConfigSchema.php.
|
static |
Default cookie lifetime, in seconds.
Setting to 0 makes all cookies session-only.
Definition at line 9048 of file MainConfigSchema.php.
|
static |
Default cookie lifetime, in seconds.
Setting to 0 makes all cookies session-only.
Definition at line 9022 of file MainConfigSchema.php.
|
static |
Current wiki database name.
Should be alphanumeric, without spaces nor hyphens. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 3148 of file MainConfigSchema.php.
|
static |
mixed | $uploadDirectory | Value of UploadDirectory |
Definition at line 921 of file MainConfigSchema.php.
|
static |
mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 470 of file MainConfigSchema.php.
|
static |
mixed | $uploadDirectory | Value of UploadDirectory |
Definition at line 609 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 390 of file MainConfigSchema.php.
|
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.
Definition at line 1094 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 449 of file MainConfigSchema.php.
|
static |
Site language code.
See includes/languages/data/Names.php for languages supported by MediaWiki out of the box. Not all languages listed there have translations, see languages/messages/ for the list of languages with some localisation.
Warning: Don't use any of MediaWiki's deprecated language codes listed in LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no" for Norwegian (use "nb" instead). If you do, things will break unexpectedly.
This defines the default interface language for all users, but users can change it in their preferences.
This also defines the language of pages in the wiki. The content is wrapped in a html element with lang=XX attribute. This behavior can be overridden via hooks, see Title::getPageLanguage.
Definition at line 4888 of file MainConfigSchema.php.
|
static |
Site language code.
See includes/languages/data/Names.php for languages supported by MediaWiki out of the box. Not all languages listed there have translations, see languages/messages/ for the list of languages with some localisation.
Warning: Don't use any of MediaWiki's deprecated language codes listed in LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no" for Norwegian (use "nb" instead). If you do, things will break unexpectedly.
This defines the default interface language for all users, but users can change it in their preferences.
This also defines the language of pages in the wiki. The content is wrapped in a html element with lang=XX attribute. This behavior can be overridden via hooks, see Title::getPageLanguage.
Definition at line 4914 of file MainConfigSchema.php.
|
static |
mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 630 of file MainConfigSchema.php.
|
static |
mixed | $sitename | Value of Sitename |
Definition at line 5872 of file MainConfigSchema.php.
|
static |
mixed | $uploadDirectory | Value of UploadDirectory |
Definition at line 9948 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 5726 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 409 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 370 of file MainConfigSchema.php.
|
static |
mixed | $dbPrefix | Value of DBprefix |
Definition at line 2989 of file MainConfigSchema.php.
|
static |
mixed | $dbMwschema | Value of DBmwschema |
Definition at line 3019 of file MainConfigSchema.php.
|
static |
Definition at line 1409 of file MainConfigSchema.php.
|
static |
mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 429 of file MainConfigSchema.php.
|
static |
mixed | $baseDirectory | Value of BaseDirectory |
Definition at line 591 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 549 of file MainConfigSchema.php.
|
static |
Definition at line 346 of file MainConfigSchema.php.
|
static |
Returns the default value of the given config setting.
string | $name | The config setting name. |
Definition at line 174 of file MainConfigSchema.php.
|
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.
There should be no reason for application logic to do this.
string | $prefix | A prefix to prepend to each setting name. Typically, this will be "wg" when constructing global variable names. |
Definition at line 143 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AccountCreationThrottle |
Number of accounts each IP address may create per specified period(s).
Example:
Definition at line 8176 of file MainConfigSchema.php.
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
Definition at line 11431 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ActionPaths |
To set 'pretty' URL paths for actions other than plain page views, add to this array.
Example: Set pretty URL for the edit action:
There must be an appropriate script or rewrite rule in place to handle these URLs.
Definition at line 834 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Actions |
Map of allowed values for the "title=foo&action=<action>" parameter.
to the corrspeonding handler code. See ActionFactory for the syntax. Core defaults are in ActionFactory::CORE_ACTIONS, anything here overrides that.
Definition at line 11577 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ActiveUserDays |
How many days user must be idle before he is considered inactive.
Will affect the number shown on Special:Statistics, Special:ActiveUsers, and the {{NUMBEROFACTIVEUSERS}} magic word in wikitext.
You might want to leave this as the default value, to provide comparable numbers between different wikis.
Definition at line 6570 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AdaptiveMessageCache |
Instead of caching everything, only cache those messages which have been customised in the site content language.
This means that MediaWiki:Foo/ja is ignored if MediaWiki:Foo doesn't exist.
This option is probably only useful for translatewiki.net.
Definition at line 4113 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AddGroups |
$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:
Bureaucrats can only remove bots and sysops:
Sysops can make bots:
Sysops can disable other sysops in an emergency, and disable bots:
Definition at line 8098 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AdditionalMailParams |
Additional email parameters, will be passed as the last argument to mail() call.
Definition at line 2648 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AdvancedSearchHighlighting |
Set to true to have nicer highlighted text in search results, by default off due to execution overhead.
Definition at line 9635 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AdvertisedFeedTypes |
Which feed types should we provide by default? This can include 'rss', 'atom', neither, or both.
Definition at line 10281 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AjaxLicensePreview |
Enable previewing licences via AJAX.
Definition at line 11856 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AjaxUploadDestCheck |
Enable AJAX check for file overwrite, pre-upload.
Definition at line 11849 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowCopyUploads |
Allow for upload to be copied from an URL.
The timeout for copy uploads is set by $wgCopyUploadTimeout. You have to assign the user right 'upload_by_url' to a user group, to use this.
Definition at line 1426 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowCrossOrigin |
Allow anonymous cross origin requests to the REST API.
This should be disabled for intranet sites (sites behind a firewall).
Definition at line 8895 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowDisplayTitle |
Allow DISPLAYTITLE to change title display.
Definition at line 6476 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowedCorsHeaders |
List of allowed headers for cross-origin API requests.
Definition at line 11900 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowExternalImages |
Whether to allow inline image pointing to other websites.
Definition at line 6290 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowExternalImagesFrom |
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:
Definition at line 6308 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowExternalReqID |
Whether to respect/honour the request ID provided by the incoming request via the X-Request-Id
header.
Set to true
if the entity sitting in front of Mediawiki sanitises external requests. Default: false
.
Definition at line 12175 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 2656 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowImageTag |
A different approach to the above: simply allow the "<img>" tag to be used.
This allows you to specify alt text and other attributes, copy-paste HTML to your wiki more easily, etc. However, allowing external images in any manner will allow anyone with editing rights to snoop on your visitors' IP addresses and so forth, if they wanted to, by inserting links to images on sites they control.
instead.
Definition at line 6338 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowRequiringEmailForResets |
Temporary feature flag that controls whether users will see a checkbox allowing them to require providing email during password resets.
Definition at line 7389 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowSchemaUpdates |
Allow schema updates.
Definition at line 3513 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowSecuritySensitiveOperationIfCannotReauthenticate |
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.
Definition at line 6969 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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.
Definition at line 5835 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowSlowParserFunctions |
Enable slow parser functions.
Definition at line 3506 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowSpecialInclusion |
Allow special page inclusions such as {{Special:Allpages}}.
Definition at line 11520 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowUserCss |
Allow user Cascading Style Sheets (CSS)? This enables a lot of neat customizations, but may increase security risk to users and server load.
Definition at line 8762 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowUserCssPrefs |
Allow style-related user-preferences?
This controls whether the editfont
and underline
preferences are available to users.
Definition at line 8772 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowUserJs |
Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load.
Definition at line 8753 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllUnicodeFixes |
Set this to always convert certain Unicode sequences to modern ones regardless of the content language.
This has a small performance impact.
Definition at line 4686 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AmericanDates |
Enable dates like 'May 12' instead of '12 May', if the default date format is 'dmy or mdy'.
Definition at line 4708 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Antivirus |
Internal name of virus scanner.
This serves as a key to the $wgAntivirusSetup array. Set this to NULL to disable virus scanning. If not null, every file uploaded will be scanned for viruses.
Definition at line 2096 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AntivirusRequired |
Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected.
Definition at line 2156 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AntivirusSetup |
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.
"messagepattern" is a perl regular expression to extract the meaningful part of the scanners output. The relevant part should be matched as group one (\1). If not defined or the pattern does not match, the full message is shown to the user.
Definition at line 2136 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APICacheHelpTimeout |
Set the timeout for the API help text cache.
If set to 0, caching disabled
Definition at line 11830 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIFormatModules |
API format module extensions.
Associative array mapping format module name to module specs (see $wgAPIModules). Extension modules may override the core modules.
See ApiMain::FORMATS for a list of the core format modules.
Definition at line 11740 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ApiFrameOptions |
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:
Definition at line 8832 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIListModules |
API Query list module extensions.
Associative array mapping list module name to module specs (see $wgAPIModules). Extension modules may override the core modules.
See ApiQuery::QUERY_LIST_MODULES for a list of the core list modules.
Definition at line 11779 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIMaxDBRows |
Maximum amount of rows to scan in a DB query in the API The default value is generally fine.
Definition at line 11788 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
This should be lower than the 'max lag' value in $wgLBFactoryConf.
Definition at line 11815 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIMaxResultSize |
The maximum size (in bytes) of an API result.
Definition at line 11797 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIMaxUncachedDiffs |
The maximum number of uncached diffs that can be retrieved in one API request.
Set this to 0 to disable API diffs altogether
Definition at line 11805 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIMetaModules |
API Query meta module extensions.
Associative array mapping meta module name to module specs (see $wgAPIModules). Extension modules may override the core modules.
See ApiQuery::QUERY_META_MODULES for a list of the core meta modules.
Definition at line 11753 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIModules |
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:
Extension modules may override the core modules. See ApiMain::MODULES for a list of the core modules.
Definition at line 11727 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIPropModules |
API Query prop module extensions.
Associative array mapping prop module name to module specs (see $wgAPIModules). Extension modules may override the core modules.
See ApiQuery::QUERY_PROP_MODULES for a list of the core prop modules.
Definition at line 11766 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIRequestLog |
Log file or URL (TCP or UDP) to log API requests to, or false to disable API request logging.
Definition at line 11823 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIUselessQueryPages |
The ApiQueryQueryPages module should skip pages that are redundant to true API queries.
Definition at line 11838 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AppleTouchIcon |
The URL path of the icon for iPhone and iPod Touch web app bookmarks.
Defaults to no icon.
Definition at line 741 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ApplyIpBlocksToXff |
Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them.
This allows for IP blocks to work with correctly-configured (transparent) proxies without needing to block the proxies themselves.
Definition at line 8286 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ArticleCountMethod |
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:
See also See https://www.mediawiki.org/wiki/Manual:Article_count
Retroactively changing this variable will not affect the existing count, to update it, you will need to run the maintenance/updateArticleCount.php script.
Definition at line 6558 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ArticlePath |
The URL path for primary article page views.
This path should contain $1, which is replaced by the article title.
Defaults to "{$wgScript}/$1" or "{$wgScript}?title=$1", depending on $wgUsePathInfo.
Definition at line 518 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ArticleRobotPolicies |
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:
Example that DOES NOT WORK because the names are not canonical text forms:
Definition at line 11647 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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).
Definition at line 270 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AsyncHTTPTimeout |
Timeout for Asynchronous (background) HTTP requests, in seconds.
Definition at line 12123 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AttemptFailureEpoch |
Certain operations are avoided if there were too many recent failures, for example, thumbnail generation.
Bump this value to invalidate all memory of failed operations and thus allow further attempts to resume.
This is useful when a cause for the failures has been found and fixed.
Definition at line 2030 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AuthenticationTokenVersion |
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).
Definition at line 7346 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AuthManagerAutoConfig |
const MediaWiki\MainConfigSchema::AuthManagerConfig |
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:
Definition at line 6818 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutoblockExpiry |
Number of seconds before autoblock entries expire.
Default 86400 = 1 day.
Definition at line 7461 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutoConfirmAge |
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):
Set age to one day:
Definition at line 7949 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutoConfirmCount |
Number of edits an account requires before it is autoconfirmed.
Passing both this AND the time requirement is needed. Example:
Example:
Definition at line 7964 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutoCreateTempUser |
Configuration for automatic creation of temporary accounts on page save.
This can be enabled to avoid exposing the IP addresses of casual editors who do not explicitly create an account.
EXPERIMENTAL – enabling may break extensions.
An associative array with the following keys:
Definition at line 7440 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutoloadAttemptLowercase |
Switch controlling legacy case-insensitive classloading.
Do not disable if your wiki must support data created by PHP4, or by MediaWiki 1.4 or earlier.
Definition at line 10871 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Autopromote |
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:
APCOND_EMAILCONFIRMED
OR [ APCOND_EMAILCONFIRMED
][ APCOND_EDITCOUNT, 100 ]
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 conditionThe sets of conditions are evaluated recursively, so you can use nested sets of conditions linked by operands.
Note that if $wgEmailAuthentication is disabled, APCOND_EMAILCONFIRMED will be true for any user who has provided an e-mail address.
Definition at line 8025 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutopromoteOnce |
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:
Where event is either:
Criteria has the same format as $wgAutopromote
Definition at line 8055 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutopromoteOnceLogInRC |
Put user rights log entries for autopromotion in recent changes?
Definition at line 8065 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AvailableRights |
A list of available rights, in addition to the ones defined by the core.
For extensions only.
Definition at line 8116 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BaseDirectory |
Absolute filesystem path of the root directory of the MediaWiki installation.
The MW_INSTALL_PATH environment variable can be used to set this.
Definition at line 507 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BlockAllowsUTEdit |
Set this to true to allow blocked users to edit their own user talk page.
This only applies to sitewide blocks. Partial blocks always allow users to edit their own user talk page unless otherwise specified in the block restrictions.
Definition at line 7472 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BlockCIDRLimit |
Limits on the possible sizes of range blocks.
CIDR notation is hard to understand, it's easy to mistakenly assume that a /1 is a small range and a /31 is a large range. For IPv4, setting a limit of half the number of bits avoids such errors, and allows entire ISPs to be blocked using a small number of range blocks.
For IPv6, RFC 3177 recommends that a /48 be allocated to every residential customer, so range blocks larger than /64 (half the number of bits) will plainly be required. RFC 4692 implies that a very large ISP may be allocated a /19 if a generous HD-Ratio of 0.8 is used, so we will use that as our limit. As of 2012, blocking the whole world would require a /4 range.
Definition at line 7490 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BlockDisablesLogin |
If true, blocked users will not be allowed to login.
When using this with a public wiki, the effect of logging out blocked users may actually be avers: unless the user's address is also blocked (e.g. auto-block), logging the user out will again allow reading and editing, just as for anonymous visitors.
Definition at line 7505 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BotPasswordsCluster |
Cluster for the bot_passwords table.
Definition at line 8717 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BotPasswordsDatabase |
Database name for the bot_passwords table.
To use a database with a table prefix, set this variable to "{$database}-{$prefix}".
Definition at line 8730 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BreakFrames |
Break out of framesets.
This can be used to prevent clickjacking attacks, or to prevent external sites from framing your site with ads.
Definition at line 8794 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BrowserFormatDetection |
Override ability of certains browsers to attempt to autodetect dataformats in pages.
This is a default feature of many mobile browsers, but can have a lot of false positives, where for instance year ranges are confused with phone numbers. The default of this setting is to disable telephone number data detection. Set BrowserFormatDetection to false to fallback to browser defaults.
Definition at line 5044 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CacheDirectory |
Directory for caching data in the local filesystem.
Should not be accessible from the web.
Note: if multiple wikis share the same localisation cache directory, they must all have the same set of extensions. You can set a directory just for the localisation cache using $wgLocalisationCacheConf['storeDirectory'].
Definition at line 3655 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CacheEpoch |
Set this to current time to invalidate all prior cached pages.
Affects both client-side and server-side caching.
You can get the current date on your server by using the command:
date +%Y%m%d%H%M%S *
Definition at line 4177 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CachePages |
Allow client-side caching of pages.
Definition at line 4164 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CachePrefix |
Overwrite the caching key prefix with custom value.
Definition at line 9602 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CacheSharedUploads |
Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1270 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CacheVaryCookies |
A list of cookies that vary the cache (for use by extensions)
Definition at line 9095 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CanonicalNamespaceNames |
Canonical namespace names.
Must not be changed directly in configuration or by extensions, use $wgExtraNamespaces instead.
Definition at line 5893 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CanonicalServer |
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.
Definition at line 250 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CapitalLinkOverrides |
Example:
Definition at line 6022 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CapitalLinks |
Set this to false to avoid forcing the first letter of links to capitals.
Definition at line 6004 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CascadingRestrictionLevels |
Restriction levels that can be used with cascading protection.
A page can only be protected with cascading protection if the requested restriction level is included in this array.
'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility. 'sysop' is quietly rewritten to 'editprotected' for backwards compatibility.
Definition at line 7878 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CategoryCollation |
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:
To use the uca-default collation, you must have PHP's intl extension installed. See https://www.php.net/manual/en/intl.setup.php . The details of the resulting collation will depend on the version of ICU installed on the server.
After you change this, you must run maintenance/updateCollation.php to fix the sort keys in the database.
Extensions can define there own collations by subclassing Collation and using the Collation::factory hook.
Definition at line 11193 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CategoryMagicGallery |
On category pages, show thumbnail gallery for images belonging to that category instead of listing them as articles.
Definition at line 11156 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CategoryPagingLimit |
Paging limit for categories.
Definition at line 11163 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnMatchParameterOrder |
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.
Definition at line 4543 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnMaxAge |
Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI).
Without ESI, you should strip out s-maxage in the CDN config.
18000 seconds = 5 hours, more cache hits with 2678400 = 31 days.
Definition at line 4348 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnMaxageLagged |
Cache timeout for the CDN when DB replica DB lag is high.
Definition at line 4358 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnMaxageStale |
Cache timeout when delivering a stale ParserCache response due to PoolCounter contention.
Definition at line 4368 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnMaxageSubstitute |
Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load)
Definition at line 4397 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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.
Definition at line 4387 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnServers |
List of proxy servers to purge on changes; default port is 80.
Use IP addresses.
When MediaWiki is running behind a proxy, it will trust X-Forwarded-For headers sent/modified from these proxies when obtaining the remote IP address
For a list of trusted servers which aren't purged, see $wgSquidServersNoPurge.
Definition at line 4420 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnServersNoPurge |
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.
Definition at line 4433 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CentralIdLookupProvider |
Central ID lookup provider to use by default.
Definition at line 6685 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CentralIdLookupProviders |
Central ID lookup providers Key is the provider ID, value is a specification for ObjectFactory.
Definition at line 6669 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ChangeCredentialsBlacklist |
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).
Definition at line 6985 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CheckFileExtensions |
This is a flag to determine whether or not to check file extensions on upload.
Definition at line 1656 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ChronologyProtectorStash |
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).
Definition at line 4000 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CleanSignatures |
If true, removes (by substituting) templates in signatures.
Definition at line 6283 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CommandLineDarkBg |
For colorized maintenance script output, is your terminal background dark ?
Definition at line 9905 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CompressRevisions |
We can also compress text stored in the 'text' table.
If this is set on, new revisions will be compressed on page save if zlib support is available. Any compressed revisions will be decompressed on load regardless of this setting, but will not be readable at all if zlib support is not available.
Definition at line 3317 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ConfigRegistry |
Registry of factory functions to create config objects: The 'main' key must be set, and the value should be a valid callable.
Definition at line 197 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ContentHandlers |
Plugins for page content model handling.
Each entry in the array maps a model id to a class name or callback that creates an instance of the appropriate ContentHandler subclass.
Definition at line 3236 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ContentHandlerTextFallback |
How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText():
Definition at line 3282 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ContentNamespaces |
Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are concerned.
Useful if additional namespaces also contain "content" which should be considered when generating a count of the number of articles in the wiki.
Definition at line 6056 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookieDomain |
Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net".
Definition at line 8995 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookieExpiration |
Default cookie lifetime, in seconds.
Setting to 0 makes all cookies session-only.
Definition at line 8977 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookieHttpOnly |
Set authentication cookies to HttpOnly to prevent access by JavaScript, in browsers that support this feature.
This can mitigates some classes of XSS attack.
Definition at line 9062 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookiePath |
Set this variable if you want to restrict cookies to a certain path within the domain specified by $wgCookieDomain.
Definition at line 9003 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookiePrefix |
Cookies generated by MediaWiki have names starting with this prefix.
Set it to a string to use a custom prefix. Setting it to false causes the database name to be used as a prefix.
Definition at line 9041 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookieSameSite |
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.
Definition at line 9075 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookieSecure |
Whether the "secure" flag should be set on the cookie.
This can be:
If $wgForceHTTPS is true, session cookies will be secure regardless of this setting. However, other cookies will still be affected.
Definition at line 9017 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookieSetOnAutoblock |
Whether to set a cookie when a user is autoblocked.
Doing so means that a blocked user, even after logging out and moving to a new IP address, will still be blocked. This cookie will contain an authentication code if $wgSecretKey is set, or otherwise will just be the block ID (in which case there is a possibility of an attacker discovering the names of revdeleted users, so it is best to use this in conjunction with $wgSecretKey being set).
Definition at line 9114 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookieSetOnIpBlock |
Whether to set a cookie when a logged-out user is blocked.
Doing so means that a blocked user, even after moving to a new IP address, will still be blocked. This cookie will contain an authentication code if $wgSecretKey is set, or otherwise will just be the block ID (in which case there is a possibility of an attacker discovering the names of revdeleted users, so it is best to use this in conjunction with $wgSecretKey being set).
Definition at line 9125 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CopyUploadAllowOnWikiDomainConfig |
If true, the value of $wgCopyUploadsDomains will be merged with the contents of MediaWiki:Copyupload-allowed-domains.
Definition at line 1477 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CopyUploadProxy |
Proxy to use for copy upload requests.
Definition at line 1454 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CopyUploadsDomains |
A list of domains copy uploads can come from.
Definition at line 1435 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CopyUploadsFromSpecialUpload |
Enable copy uploads from Special:Upload.
$wgAllowCopyUploads must also be true. If $wgAllowCopyUploads is true, but this is false, you will only be able to perform copy uploads from the API or extensions (e.g. UploadWizard).
Definition at line 1445 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
False means fallback to default.
Definition at line 1466 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CountCategorizedImagesAsUsed |
On Special:Unusedimages, consider images "used", if they are put into a category.
Default (false) is not to count those as used.
Definition at line 11538 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CriticalSectionTimeLimit |
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.
Definition at line 3470 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 11892 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
This is currently only used by the API (requests to api.php) $wgCrossSiteAJAXdomains can be set using a wildcard syntax:
Example:
Definition at line 11882 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Ad-Ware).
List based on results from Wikimedia logs.
Definition at line 8867 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CSPHeader |
Controls Content-Security-Policy header [Experimental].
Definition at line 8843 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CSPReportOnlyHeader |
Controls Content-Security-Policy-Report-Only header.
Definition at line 8853 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CustomConvertCommand |
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:
Leave as false to skip this.
Definition at line 1827 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DatabaseReplicaLagCritical |
Definition at line 3189 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DatabaseReplicaLagWarning |
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.
Definition at line 3181 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DataCenterUpdateStickTTL |
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.
Definition at line 3112 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBadminpassword |
Separate password for maintenance tasks.
Leave as null to use the default.
Definition at line 2882 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBadminuser |
Separate username for maintenance tasks.
Leave as null to use the default.
Definition at line 2875 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBcompress |
Whether to use compression in DB connection.
This setting is only used $wgLBFactoryConf['class'] is set to '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise the DBO_COMPRESS flag must be set in the 'flags' option of the database connection to achieve the same functionality.
Definition at line 2868 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBDefaultGroup |
Default group to use when getting database connections.
Will be used as default query group in ILoadBalancer::getConnection.
Definition at line 2942 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBerrorLog |
File to log database errors to.
Definition at line 3119 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBerrorLogTZ |
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:
Definition at line 3143 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBmwschema |
Current wiki database schema name.
Should be alphanumeric, without spaces nor hyphens. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2797 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBname |
Current wiki database name.
Should be alphanumeric, without spaces nor hyphens. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2785 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBpassword |
Database user's password.
Definition at line 2838 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBport |
Database port number.
Definition at line 2824 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBprefix |
Current wiki database table name prefix.
Should be alphanumeric, without spaces nor hyphens, preferably ending in an underscore. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2810 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBserver |
Database host name or IP address.
Definition at line 2817 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBservers |
Database load balancer This is a two-dimensional array, a list of server info structures Fields are:
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:
Since the effect of writing to a replica DB is so damaging and difficult to clean up, we at Wikimedia set read_only=1 in my.cnf on all our DB servers, even our primaries, and then set read_only=0 on primaries at runtime.
Definition at line 3077 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBssl |
Whether to use SSL in DB connection.
This setting is only used if $wgLBFactoryConf['class'] is set to '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array; otherwise the 'ssl' parameter of the server array must be set to achieve the same functionality.
Definition at line 2856 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBTableOptions |
MySQL table options to use during installation or update.
Definition at line 2920 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBtype |
Database type.
Definition at line 2845 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBuser |
Database username.
Definition at line 2831 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugAPI |
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.
Definition at line 11688 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugComments |
Send debug data to an HTML comment in the output.
This may occasionally be useful when supporting a non-technical end-user. It's more secure than exposing the debug log file to the web, since the output only contains private data for the current user. But it's not ideal for development use since data is lost on fatal errors and redirects.
Definition at line 9193 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugDumpSql |
Write SQL queries to the debug log.
This setting is only used $wgLBFactoryConf['class'] is set to '\Wikimedia\Rdbms\LBFactorySimple'; otherwise the DBO_DEBUG flag must be set in the 'flags' option of the database connection to achieve the same functionality.
Definition at line 9204 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugLogFile |
Enable verbose debug logging for all channels and log levels.
See https://www.mediawiki.org/wiki/How_to_debug
For static requests, this enables all channels and warning-level and above only. Use $wgDebugRawPage to make those verbose as well.
The debug log file should be not be web-accessible if it is used in a production environment, as may contain private data.
Definition at line 9147 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugLogGroups |
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:
Example:
Advanced example:
Definition at line 9301 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugLogPrefix |
Prefix for debug log lines.
Definition at line 9154 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugRawPage |
If true, debug logging is also enabled for load.php and action=raw requests.
By default, $wgDebugLogFile enables all channels and warning-level and above for static requests.
This ensures that the debug log is likely a chronological record of of specific web request you are debugging, instead of overlapping with messages from static requests, which would make it unclear which message originated from what request.
Also, during development this can make browsing and JavaScript testing considerably slower (T85805).
Definition at line 9181 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugRedirects |
If true, instead of redirecting, show a page with a link to the redirect destination.
This allows for the inspection of PHP error messages, and easy resubmission of form data. For developer use only.
Definition at line 9163 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugToolbar |
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.
Definition at line 9614 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DefaultExternalStore |
The place to put new text blobs or false to put them in the text table of the local wiki database.
Example:
Definition at line 3371 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DefaultLanguageVariant |
Default variant code, if false, the default will be the language code.
Definition at line 4753 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DefaultRobotPolicy |
Default robot policy.
The default policy is to encourage indexing and fol- lowing of links. It may be overridden on a per-namespace and/or per-page basis.
Definition at line 11594 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DefaultSkin |
Default skin, for new users and anonymous visitors.
Registered users may change this to any one of the other available skins in their preferences.
Definition at line 5066 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DefaultUserOptions |
Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts.
For instance, to disable editing on double clicks: $wgDefaultUserOptions ['editondblclick'] = 0;
Definition at line 7224 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DeletedDirectory |
What directory to place deleted uploads in.
Defaults to "{$wgUploadDirectory}/deleted".
Definition at line 912 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DeleteRevisionsBatchSize |
Page deletions with > this number of revisions will use the job queue.
Revisions will be archived in batches of (at most) this size, one batch per job.
Definition at line 8134 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DeleteRevisionsLimit |
Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission.
(Default given to sysops.)
Definition at line 8125 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 9406 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DevelopmentWarnings |
If set to true MediaWiki will throw notices for some possible error conditions and for deprecated functions.
Definition at line 9397 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Diff |
Path to the GNU diff utility.
Definition at line 9861 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Diff3 |
Path to the GNU diff3 utility.
If the file doesn't exist, edit conflicts will fall back to the old behavior (no merging).
Definition at line 9854 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DiffEngine |
Specify the difference engine to use.
Supported values:
The default (null) is to use the first engine that's available.
Definition at line 3410 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DirectoryMode |
Default value for chmoding of new directories.
Definition at line 2411 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableAnonTalk |
Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history, Special:Recentchanges, etc.
Definition at line 10321 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableCookieCheck |
By default, MediaWiki checks if the client supports cookies during the login process, so that it can display an informative error message if cookies are disabled.
Set this to true if you want to disable this cookie check.
Definition at line 9032 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisabledVariants |
Disabled variants array of language variant conversion.
Example:
Definition at line 4775 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableHardRedirects |
Disable redirects to special pages and interwiki redirects, which use a 302 and have no "redirected from" link.
Definition at line 6111 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableInternalSearch |
Disable the internal MySQL-based search, to allow it to be implemented by an extension instead.
Definition at line 9740 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableLangConversion |
Whether to enable language variant conversion.
Definition at line 4739 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableOutputCompression |
Disable output compression (enabled by default if zlib is available)
Definition at line 5097 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableQueryPages |
Disable all query pages if miser mode is on, not just some.
Definition at line 3485 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableQueryPageUpdate |
Set this to an array of special page names to prevent maintenance/updateSpecialPages.php from updating those pages.
Mapping each special page name to an run mode like 'periodical' if a cronjob is set up.
Definition at line 11530 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableSearchUpdate |
If you've disabled search semi-permanently, this also disables updates to the table.
If you ever re-enable, be sure to rebuild the search table.
Definition at line 9717 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableTextSearch |
Set this to true to disable the full text search feature.
Definition at line 9627 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableTitleConversion |
Whether to enable language variant conversion for links.
Definition at line 4746 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableUploadScriptChecks |
Setting this to true will disable the upload system's checks for HTML/JavaScript.
Definition at line 1676 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DjvuDump |
Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';.
Definition at line 2454 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DjvuOutputExtension |
File extension for the DJVU post processor output.
Definition at line 2492 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 2484 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DjvuRenderer |
Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';.
Definition at line 2464 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DjvuTxt |
Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';.
Definition at line 2474 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DnsBlacklistUrls |
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:
Definition at line 8241 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DummyLanguageCodes |
Functionally the same as $wgExtraLanguageCodes, but deprecated.
Instead of appending values to this array, append them to $wgExtraLanguageCodes.
Definition at line 4674 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Edititis |
Display user edit counts in various prominent places.
Definition at line 5211 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EditPageFrameOptions |
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:
For extra safety, set $wgBreakFrames = true, to prevent framing on all pages, not just edit pages.
Definition at line 8817 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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".
Definition at line 4996 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EmailAuthentication |
Require email authentication before sending mail to an email address.
This is highly recommended. It prevents MediaWiki from being used as an open spam relay.
Definition at line 2680 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EmailConfirmToEdit |
Should editors be required to have a validated e-mail address before being allowed to edit?
Definition at line 7577 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EmergencyContact |
Site admin email address.
Defaults to "wikiadmin@$wgServerName" (in Setup.php).
Definition at line 2509 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableAsyncUploads |
Enable deferred upload tasks that use the job queue.
Only enable this if job runners are set up for both the 'AssembleUploadChunks' and 'PublishStashedFile' job types.
Definition at line 885 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableAutoRotation |
If set to true, images that contain certain the exif orientation tag will be rotated accordingly.
If set to null, try to auto-detect whether a scaler is available that can rotate.
Definition at line 2086 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableBotPasswords |
Definition at line 8707 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableCanonicalServerLink |
Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e.
$wgServer or $wgCanonicalServer. Since detection of the current server is unreliable, the link is sent unconditionally.
Definition at line 5250 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableDnsBlacklist |
Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies.
Definition at line 8213 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableEmail |
Set to true to enable the e-mail basic features: Password reminders, etc.
If sending e-mail on your server doesn't work, you might want to disable this.
Definition at line 2539 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableImageWhitelist |
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
Definition at line 6323 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableJavaScriptTest |
Allow running of QUnit tests via [[Special:JavaScriptTest]].
Definition at line 9593 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableMagicLinks |
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links.
Definition at line 6527 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableOpenSearchSuggest |
This was previously a used to force empty responses from ApiOpenSearch with the 'suggest' parameter set.
Definition at line 9685 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableParserLimitReporting |
Whether to include the NewPP limit report as a HTML comment.
Definition at line 10818 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnablePartialActionBlocks |
Flag to enable partial blocks against performing certain actions.
Definition at line 7514 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableRemoteBagOStuffTests |
If this is set to true, phpunit will run integration tests against remote caches defined in $wgObjectCaches.
Definition at line 4284 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableScaryTranscluding |
Enable interwiki transcluding.
Only when iw_trans=1 in the interwiki table.
Definition at line 6508 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableSearchContributorsByIP |
If true, searches for IP addresses will be redirected to that IP's contributions page.
E.g. searching for "1.2.3.4" will redirect to [[Special:Contributions/1.2.3.4]]
Definition at line 9801 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableSidebarCache |
If on, the sidebar navigation links are cached for users with the current language set.
This can save a touch of load on a busy site by shaving off extra message lookups.
However it is also fragile: changing the site configuration, or having a variable $wgArticlePath, can produce broken links that don't update as expected.
Definition at line 4225 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableSpecialMute |
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.
Definition at line 2559 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableUploads |
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.
Definition at line 865 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableUserEmail |
Set to true to enable user-to-user e-mail.
This can potentially be abused, as it's hard to track.
Definition at line 2548 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableUserEmailMuteList |
Set to true to enable user-to-user e-mail mutelist.
Definition at line 2568 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableWANCacheReaper |
Verify and enforce WAN cache purges using reliable DB sources as streams.
These secondary cache purges are de-duplicated via simple cache mutexes. This improves consistency when cache purges are lost, which becomes more likely as more cache servers are added or if there are multiple datacenters. Only keys related to important mutable content will be checked.
Definition at line 3910 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifFromEditor |
Allow sending of e-mail notifications with the editor's address as sender.
This setting depends on $wgEnotifRevealEditorAddress also being enabled. If both are enabled, notifications for actions from users that have opted-in, will be sent to other users with their address as "From" instead of "Reply-To".
If disabled, or not opted-in, notifications come from $wgPasswordSender.
Definition at line 2669 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifImpersonal |
Send a generic mail instead of a personalised mail for each user.
This always uses UTC as the time zone, and doesn't include the username.
For pages with many users watching, this can significantly reduce mail load. Has no effect when using sendmail rather than SMTP.
Definition at line 2743 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifMaxRecips |
Maximum number of users to mail at once when using impersonal mail.
Should match the limit on your mail server.
Definition at line 2751 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifMinorEdits |
Potentially send notification mails on minor edits to pages.
This is enabled by default. If this is false, users will never be notified on minor edits.
If it is true, editors with the 'nominornewtalk' right (typically bots) will still not trigger notifications for minor edits they make (to any page, not just user talk).
Finally, if the watcher/recipient has the 'enotifminoredits' user preference set to false, they will not receive notifications for minor edits.
User talk notifications are also affected by $wgEnotifMinorEdits, the above settings, $wgEnotifUserTalk, and the preference described there.
Definition at line 2732 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifRevealEditorAddress |
Allow sending of e-mail notifications with the editor's address in "Reply-To".
Note, enabling this only actually uses it in notification e-mails if the user opted-in to this feature. This feature flag also controls visibility of the 'enotifrevealaddr' preference, which, if users opt into, will make e-mail notifications about their actions use their address as "Reply-To".
To set the address as "From" instead of "Reply-To", also enable $wgEnotifFromEditor.
If disabled, or not opted-in, notifications come from $wgPasswordSender.
Definition at line 2714 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifUseRealName |
Use real name instead of username in e-mail "from" field.
Definition at line 2758 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifUserTalk |
Allow users to enable email notification ("enotif") when someone edits their user talk page.
The owner of the user talk page must also have the 'enotifusertalkpages' user preference set to true.
Definition at line 2698 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifWatchlist |
Allow users to enable email notification ("enotif") on watchlist changes.
Definition at line 2687 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EventRelayerConfig |
Mapping of event channels (or channel categories) to EventRelayer configuration.
By setting up a PubSub system (like Kafka) and enabling a corresponding EventRelayer class that uses it, MediaWiki can broadcast events to all subscribers. Certain features like WAN cache purging and CDN cache purging will emit events to this system. Appropriate listers can subscribe to the channel and take actions based on the events. For example, a local daemon can run on each CDN cache node and perform local purges based on the URL purge channel events.
Some extensions may want to use "channel categories" so that different channels can also share the same custom relayer instance (e.g. when it's likely to be overridden). They can use EventRelayerGroup::getRelayer() based on the category but call notify() on various different actual channels. One reason for this would be that some system have very different performance vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.
The 'default' key is for all channels (or channel categories) without an explicit entry here.
Definition at line 12309 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
If set to null, default to $wgContentNamespaces.
Example:
Definition at line 11663 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Exiftool |
Path to exiftool binary.
Used for lossless ICC profile swapping.
Definition at line 1887 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Exiv2Command |
Some tests and extensions use exiv2 to manipulate the Exif metadata in some image formats.
Definition at line 1878 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExpensiveParserFunctionLimit |
Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY.
Definition at line 6493 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExperiencedUserEdits |
Number of edits the user must have before becoming "experienced".
Definition at line 6604 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExperiencedUserMemberSince |
Number of days the user must exist before becoming "experienced".
Definition at line 6613 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportAllowAll |
Whether to allow exporting the entire wiki into a single file.
Definition at line 10650 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportAllowHistory |
If set to false, disables the full-history option on Special:Export.
This is currently poorly optimized for long edit histories, so is disabled on Wikimedia's sites.
Definition at line 10605 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportAllowListContributors |
Return distinct author list (when not returning full history)
Definition at line 10621 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportFromNamespaces |
Whether to allow the "export all pages in namespace" option.
Definition at line 10643 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportMaxHistory |
If set nonzero, Special:Export requests for history of pages with more revisions than this will be rejected.
On some big sites things could get bogged down by very very long pages.
Definition at line 10614 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Since this number can become really really large and could easily break your wiki, it's disabled by default for now.
Definition at line 10636 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportPagelistLimit |
Maximum number of pages returned by the GetPagesFromCategory and GetPagesFromNamespace functions.
Definition at line 10660 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtendedLoginCookieExpiration |
Default login cookie lifetime, in seconds.
Setting $wgExtendLoginCookieExpiration to null will use $wgCookieExpiration to calculate the cookie lifetime. As with $wgCookieExpiration, 0 will make login cookies session-only.
Definition at line 8987 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionAssetsPath |
The URL path of the extensions directory.
Defaults to "{$wgResourceBasePath}/extensions".
Definition at line 461 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionCredits |
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.
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.
Definition at line 10934 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionDirectory |
Extensions directory in the file system.
Definition at line 481 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionEntryPointListFiles |
Array of files with list(s) of extension entry points to be used in maintenance/mergeMessageFileList.php.
Definition at line 10789 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionFunctions |
A list of callback functions which are called once MediaWiki is fully initialised.
Definition at line 10713 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionInfoMTime |
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:
If set to false, the mtime for each individual JSON file will be checked, which can be slow if a large number of extensions are being loaded.
Definition at line 4273 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionMessagesFiles |
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:
Definition at line 10745 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExternalDiffEngine |
Name of the external diff engine to use.
Definition at line 3418 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExternalInterwikiFragmentMode |
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'.
Definition at line 5143 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExternalLinkTarget |
Set a default target for external links, e.g.
_blank to pop up a new window.
This will also set the "noreferrer" and "noopener" link rel to prevent the attack described at https://mathiasbynens.github.io/rel-noopener/ . Some older browsers may not support these link attributes, hence setting $wgExternalLinkTarget to _blank may represent a security risk to some of your users.
Definition at line 6423 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExternalServers |
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.
Example: Create a cluster named 'blobs_cluster1':
Definition at line 3354 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExternalStores |
List of enabled ExternalStore protocols.
Definition at line 3330 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtraGenderNamespaces |
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.
Definition at line 5937 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtraInterlanguageLinkPrefixes |
List of additional interwiki prefixes that should be treated as interlanguage links (i.e.
placed in the sidebar).
Notes:
Definition at line 4618 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtraLanguageCodes |
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.
Definition at line 4657 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtraLanguageNames |
List of language names or overrides for default names in Names.php.
Definition at line 4638 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtraNamespaces |
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.
Custom namespaces should start at 100 to avoid conflicting with standard namespaces, and should always follow the even/odd main/talk pattern.
Example:
Definition at line 5924 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtraSignatureNamespaces |
Array of namespaces, in addition to the talk namespaces, where signatures (~~~~) are likely to be used.
This determines whether to display the Signature button on the edit toolbar, and may also be used by extensions.
For example, "traditional" style wikis, where content and discussion are intermixed, could place NS_MAIN and NS_PROJECT namespaces in this array.
Definition at line 6082 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FallbackSkin |
Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
Definition at line 5075 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Favicon |
The URL path of the icon.
Definition at line 730 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FeaturePolicyReportOnly |
List of Feature Policy Reporting types to enable.
Each entry is turned into a Feature-Policy-Report-Only header.
Definition at line 12378 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Feed |
Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages.
Definition at line 10210 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FeedCacheTimeout |
Minimum timeout for cached Recentchanges feed, in seconds.
A cached version will continue to be served out even if changes are made, until this many seconds runs out since the last render.
If set to 0, feed caching is disabled. Use this for debugging only; feed generation can be pretty slow with diffs.
Definition at line 10231 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FeedClasses |
Available feeds objects.
Should probably only be defined when a page is syndicated ie when $wgOut->isSyndicated() is true.
Definition at line 10269 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FeedDiffCutoff |
When generating Recentchanges RSS/Atom feed, diffs will not be generated for pages larger than this size.
Definition at line 10239 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FeedLimit |
Set maximum number of results to return in syndication feeds (RSS, Atom) for eg Recentchanges, Newpages.
Definition at line 10218 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FetchCommonsDescriptions |
Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1233 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FileBackends |
File backend structure configuration.
This is an array of file backend configuration arrays. Each backend configuration has the following parameters:
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:
Definition at line 1366 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FileCacheDepth |
Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory.
The subdirectories will be named based on the MD5 hash of the title. A value of 0 means all cache files will be put directly into the main file cache directory.
Definition at line 4204 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FileCacheDirectory |
Directory where the cached page will be saved.
Defaults to "{$wgUploadDirectory}/cache".
Definition at line 600 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FileExtensions |
This is the list of preferred extensions for uploading files.
Uploading files with extensions not in this list will trigger a warning.
Definition at line 1594 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FilterLogTypes |
Show/hide links on Special:Log will be shown for these log types.
This is associative array of log type => boolean "hide by default"
See $wgLogTypes for a list of available log types.
Example:
‘$wgFilterLogTypes = [ 'move’ => true, 'import' => false ];`
Will display show/hide links for the move and import logs. Move logs will be hidden by default unless the link is clicked. Import logs will be shown by default, and hidden when the link is clicked.
A message of the form logeventslist-[type]-log should be added, and will be used for the link text.
Definition at line 11299 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FixDoubleRedirects |
Fix double redirects after a page move.
Tends to conflict with page move vandalism, use only on a private wiki.
Definition at line 6120 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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:
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.
Definition at line 5178 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ForceDeferredUpdatesPreSend |
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.
Definition at line 3623 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ForcedRawSMaxage |
Default maximum age for raw CSS/JS accesses.
300 seconds = 5 minutes.
Definition at line 4406 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ForceHTTPS |
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.
Definition at line 306 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ForceUIMsgAsContentMsg |
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:
Definition at line 4831 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ForeignFileRepos |
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).
Definition at line 1129 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ForeignUploadTargets |
Array of foreign file repo names (set in $wgForeignFileRepos above) that are allowable upload targets.
These wikis must have some method of authentication (i.e. CentralAuth), and be CORS-enabled for this wiki.
The string 'local' signifies the default local file repository.
Example: $wgForeignUploadTargets = [ 'shared' ];
Definition at line 1285 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FragmentMode |
How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of:
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.
Definition at line 5130 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GalleryOptions |
Parameters for the "<gallery>" tag.
Fields are:
Definition at line 2394 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GenerateThumbnailOnParse |
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:
Definition at line 2069 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GitBin |
Fully specified path to git binary.
Definition at line 9968 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GitInfoCacheDirectory |
Directory where GitInfo will look for pre-computed cache files.
If false, $wgCacheDirectory/gitinfo will be used.
Definition at line 4185 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GitRepositoryViewers |
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
Definition at line 9985 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GrammarForms |
Some languages need different word forms, usually for different cases.
Used in Language::convertGrammar().
Example:
Definition at line 4585 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GrantPermissionGroups |
Definition at line 8661 of file MainConfigSchema.php.
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.
Definition at line 8479 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GroupInheritsPermissions |
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":
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.
Definition at line 7789 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GroupPermissions |
Permission keys given to users in each group.
This is an array where the keys are all groups and each value is an array of the format (right => boolean).
The second format is used to support per-namespace permissions. Note that this feature does not fully work for all permission types.
All users are implicitly in the '*' group including anonymous visitors; logged-in users are all implicitly in the 'user' group. These will be combined with the permissions of all groups that a given user is listed in the user_groups table.
Note: Don't set $wgGroupPermissions = []; unless you know what you're doing! This will wipe all permissions, and may mean that your users are unable to perform certain essential tasks or access new functionality when new permissions are introduced and default grants established.
Functionality to make pages inaccessible has not been extensively tested for security. Use at your own risk!
This replaces $wgWhitelistAccount and $wgWhitelistEdit
Definition at line 7613 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GroupsAddToSelf |
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:
Example: Implicit groups may be used for the source group, for instance:
This allows users in the '*' group (i.e. any user) to remove themselves from any group that they happen to be in.
Definition at line 7827 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GroupsRemoveFromSelf |
Definition at line 7835 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HashedSharedUploadDirectory |
Shortcut for the 'hashLevels' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1210 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HashedUploadDirectory |
Shortcut for setting hashLevels=2
in $wgLocalFileRepo.
Definition at line 1581 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HiddenPrefs |
An array of preferences to not show for the user.
Definition at line 7297 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HideIdentifiableRedirects |
Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public.
Definition at line 7585 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HideInterlanguageLinks |
Hide interlanguage links from the sidebar.
Definition at line 4600 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HideUserContribLimit |
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.
Definition at line 8147 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HKDFAlgorithm |
Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers).
See also: $wgHKDFSecret
Definition at line 8964 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HKDFSecret |
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
Definition at line 8952 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Hooks |
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:
Definition at line 10968 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTCPMulticastTTL |
HTCP multicast TTL.
Definition at line 4521 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTCPRouting |
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:
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:
Definition at line 4511 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Html5Version |
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
Definition at line 4960 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTMLFormAllowTableFormat |
Temporary variable that allows HTMLForms to be rendered as tables.
Table based layouts cause various issues when designing for mobile. This global allows skins or extensions a means to force non-table based rendering. Setting to false forces form components to always render as div elements.
Definition at line 4973 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPConnectTimeout |
Timeout for connections done internally (in seconds).
Only supported if cURL is installed, ignored otherwise.
Definition at line 12082 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPImportTimeout |
Timeout for HTTP requests done internally for transwiki imports, in seconds.
Definition at line 12116 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPMaxConnectTimeout |
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".
Definition at line 12106 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPMaxTimeout |
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".
Definition at line 12094 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPProxy |
Proxy to use for CURL requests.
Definition at line 12130 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HttpsPort |
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.
Definition at line 285 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPTimeout |
Timeout for HTTP requests done internally, in seconds.
Definition at line 12070 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::IgnoreImageErrors |
If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an error message.
This may be useful if errors are transitory, especially if the site is configured to automatically render thumbnails on request.
On the other hand, it may obscure error conditions from debugging. Enable the debug log or the 'thumbnail' log group to make sure errors are logged to a file for review.
Definition at line 2045 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::IllegalFileChars |
Additional characters that are not allowed in filenames.
They are replaced with '-' when uploading. Like $wgLegalTitleChars, this is a regexp character class.
Slashes and backslashes are disallowed regardless of this setting, but included here for completeness.
Definition at line 903 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImageLimits |
Limit images on image description pages to a user-selectable limit.
In order to reduce disk usage, limits can only be selected from this list. The user preference is saved as an array offset in the database, by default the offset is set with $wgDefaultUserOptions['imagesize']. Make sure you change it if you alter the array (see T10858).
This list is also used by ImagePage for alternate size links.
Definition at line 2256 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImageMagickConvertCommand |
The convert command shipped with ImageMagick.
Definition at line 1779 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImageMagickTempDir |
Temporary directory used for ImageMagick.
The directory must exist. Leave this set to false to let ImageMagick decide for itself.
Definition at line 1811 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImagePreconnect |
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.
Definition at line 2441 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImgAuthDetails |
Set this to true if you use img_auth and want the user to see details on why access failed.
Definition at line 928 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImgAuthPath |
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.
Definition at line 565 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImgAuthUrlPathMap |
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.
Definition at line 947 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImplicitGroups |
Implicit groups, aren't shown on Special:Listusers or somewhere else.
Definition at line 7798 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImportSources |
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.
If you have a very complex import sources setup, you can lazy-load it using the ImportSources hook.
If a user has the 'import' permission but not the 'importupload' permission, they will only be able to run imports through this transwiki interface.
Definition at line 10582 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImportTargetNamespace |
Optional default target namespace for interwiki imports.
Can use this to create an incoming "transwiki"-style queue. Set to numeric key, not the name.
Users may override this in the Special:Import dialog.
Definition at line 10595 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InterlanguageLinkCodeMap |
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
Definition at line 4630 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InternalServer |
Internal server name as known to CDN, if different.
Example:
Definition at line 4335 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InterwikiCache |
Interwiki cache, either as an associative array or a path to a constant database (.cdb) file.
This data structure database is generated by the dumpInterwiki
maintenance script (which lives in the WikimediaMaintenance repository) and has key formats such as the following:
Sites mapping just specifies site name, other keys provide "local url" data layout.
Definition at line 6164 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InterwikiExpiry |
Expiry time for cache of interwiki table.
Definition at line 6144 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InterwikiFallbackSite |
Fallback site, if unable to resolve from cache.
Definition at line 6184 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InterwikiMagic |
Treat language links as magic connectors, not inline links.
Definition at line 4593 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InterwikiScopes |
Specify number of domains to check for messages.
Definition at line 6177 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InvalidateCacheOnLocalSettingsChange |
Invalidate various caches when LocalSettings.php changes.
This is equivalent to setting $wgCacheEpoch to the modification time of LocalSettings.php, as was previously done in the default LocalSettings.php file.
On high-traffic wikis, this should be set to false, to avoid the need to check the file modification time, and to avoid the performance impact of unnecessary cache invalidations.
Definition at line 4255 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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().
Definition at line 7044 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InvalidRedirectTargets |
Array of invalid page redirect targets.
Attempting to create a redirect to any of the pages in this array will make the redirect fail. Userlogout is hard-coded, so it does not need to be listed here. (T12569) Disallow Mypage and Mytalk as well.
As of now, this only checks special pages. Redirects to pages in other namespaces cannot be invalidated by this variable.
Definition at line 6098 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InvalidUsernameCharacters |
Characters to prevent during new account creations.
This is used in a regular expression character class during registration (regex metacharacters like / are escaped).
Definition at line 7308 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JobBackoffThrottling |
Map of job types to how many job "work items" should be run per second on each job runner process.
The meaning of "work items" varies per job, but typically would be something like "pages to update". A single job may have a variable number of work items, as is the case with batch jobs.
This is used by runJobs.php and not jobs run via $wgJobRunRate. These settings should be global to all wikis.
Definition at line 11055 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JobClasses |
Maps jobs to their handlers; extensions can add to this to provide custom jobs.
A job handler should either be a class name to be instantiated, or (since 1.30) a callback to use for creating the job object. The callback takes (Title, array map of parameters) as arguments.
Definition at line 10999 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JobQueueIncludeInMaxLagFactor |
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.
Definition at line 11117 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JobRunRate |
Number of jobs to perform per request.
May be less than one in which case jobs are performed probabilistically. If this is zero, jobs will not be done during ordinary apache requests. In this case, maintenance/runJobs.php should be run periodically.
Definition at line 12191 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JobSerialCommitThreshold |
Make job runners commit changes for replica DB-lag prone jobs one job at a time.
This is useful if there are many job workers that race on replica DB lag checks. If set, jobs taking this many seconds of DB write time have serialized commits.
Note that affected jobs may have worse lock contention. Also, if they affect several DBs at once they may have a smaller chance of being atomic due to the possibility of connection loss while queueing up to commit. Affected jobs may also fail due to the commit lock acquisition timeout.
Definition at line 11074 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JobTypeConf |
Map of job types to configuration arrays.
This determines which queue class and storage system is used for each job type. Job types that do not have explicit configuration will use the 'default' config. These settings should be global to all wikis.
Definition at line 11086 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JobTypesExcludedFromDefaultQueue |
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:
Definition at line 11041 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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.
Definition at line 1859 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JpegQuality |
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.
Definition at line 1870 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::JpegTran |
used for lossless jpeg rotation
Definition at line 1836 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LanguageCode |
Site language code.
See includes/languages/data/Names.php for languages supported by MediaWiki out of the box. Not all languages listed there have translations, see languages/messages/ for the list of languages with some localisation.
Warning: Don't use any of MediaWiki's deprecated language codes listed in LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no" for Norwegian (use "nb" instead). If you do, things will break unexpectedly.
This defines the default interface language for all users, but users can change it in their preferences.
This also defines the language of pages in the wiki. The content is wrapped in a html element with lang=XX attribute. This behavior can be overridden via hooks, see Title::getPageLanguage.
Definition at line 4570 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LanguageConverterCacheType |
The cache type for storing language conversion tables, which are used when parsing certain text and interface messages.
For available types see $wgMainCacheType.
Definition at line 3719 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LBFactoryConf |
Load balancer factory configuration To set up a multi-primary wiki farm, set the class here to something that can return a LoadBalancer with an appropriate primary on a call to getMainLB().
The class identified here is responsible for reading $wgDBservers, $wgDBserver, etc., so overriding it may cause those globals to be ignored.
The LBFactoryMulti class is provided for this purpose, please see includes/db/LBFactoryMulti.php for configuration information.
Definition at line 3093 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LearnerEdits |
The following variables define 3 user experience levels:
Definition at line 6586 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LearnerMemberSince |
Number of days the user must exist before becoming a learner.
Definition at line 6595 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LegacyEncoding |
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.
Definition at line 4700 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LegalTitleChars |
Allowed title characters – regex character class Don't change this unless you know what you're doing.
Problematic punctuation:
All three of these punctuation problems can be avoided by using an alias, instead of a rewrite rule of either variety.
The problem with % is that when using a path to query rewrite rule, URLs are double-unescaped: once by Apache's path conversion code, and again by PHP. So %253F, for example, becomes "?". Our code does not double-escape to compensate for this, indeed double escaping would break if the double-escaped title was passed in the query string rather than the path. This is a minor security issue because articles can be created such that they are hard to view or edit.
In some rare cases you may wish to remove + for compatibility with old links.
Definition at line 5993 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LinkHolderBatchSize |
LinkHolderArray batch size For debugging.
Definition at line 3600 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LoadScript |
The URL path to load.php.
Defaults to "{$wgScriptPath}/load.php".
Definition at line 381 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LocalDatabases |
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:
Definition at line 3168 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LocalFileRepo |
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:
Optional common properties:
For most core repos:
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.
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.
These settings describe a foreign MediaWiki installation. They are optional, and will be ignored for local repositories:
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.
Definition at line 1086 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LocalHTTPProxy |
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.
Definition at line 12165 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LocalInterwikis |
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 6136 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LocalisationCacheConf |
Localisation cache configuration.
Used by Language::getLocalisationCache() to decide how to construct the LocalisationCache instance. Associative array with keys:
class: The class to use for constructing the LocalisationCache object. This may be overridden by extensions to a subclass of LocalisationCache. Sub classes are expected to still honor the 'storeClass', 'storeDirectory' and 'manualRecache' options where applicable.
storeClass: Which LCStore class implementation to use. This is optional. The default LocalisationCache class offers the 'store' option as abstraction for this.
store: How and where to store localisation cache data. This option is ignored if 'storeClass' is explicitly set to a class name. Must be one of:
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 4148 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LocalStylePath |
The URL path of the skins directory.
Should not point to an external domain.
Defaults to "{$wgScriptPath}/skins".
Definition at line 440 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Localtimezone |
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:
Definition at line 4884 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LocalTZoffset |
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 4910 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LocalVirtualHosts |
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:
Definition at line 12149 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LockManagers |
List of lock manager backend configurations.
Each backend configuration has the following parameters:
See LockManager::__construct() for more details. Additional parameters are specific to the lock manager class used. These settings should be global to all wikis.
Definition at line 1382 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LogActions |
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 11367 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LogActionsHandlers |
The same as above, but here values are names of classes, not messages.
Definition at line 11379 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LogExceptionBacktrace |
If true, send the exception backtrace to the error log.
Definition at line 9363 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LogHeaders |
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.
Definition at line 11343 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LoginLanguageSelector |
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 4807 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LogNames |
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.
Definition at line 11317 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Logo |
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 621 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::LogoHD |
Array with URL paths to HD versions of the wiki logo.
The scaled logo size should be under 135x155 pixels. Only 1.5x and 2x versions are supported.
SVG is also supported but when enabled, it disables 1.5x and 2x as svg will already be optimised for screen resolution.
Definition at line 717 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Logos |
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 version1x
path to svg wordmark version (if you want to support browsers with SVG support with an SVG logo)width
width of the logo in pixelsheight
height of the logo in pixels The tagline
key may be null or array with the following fieldssrc
path to tagline imagewidth
width of the tagline in pixelsheight
height of the tagline in pixelsDefaults to [ "1x" => $wgLogo ], or [ "1x" => "$wgResourceBasePath/resources/assets/change-your-logo.svg" ] if $wgLogo is not set.
Definition at line 683 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 11276 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Note that code should call LogPage::validTypes() to get a list of valid log types instead of checking the global variable.
Definition at line 11249 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MainCacheType |
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:
Definition at line 3676 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MainPageIsDomainRoot |
Option to whether serve the main page as the domain root.
Definition at line 845 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MainStash |
The object store type of the main stash.
This should be a fast storage system optimized for lightweight data, both ephemeral and permanent, for things like counters, tokens, and blobs. The dataset access scope should include all the application servers in all datacenters. Thus, the data must be replicated among all datacenters. The store should have "Last Write Wins" eventual consistency. Per https://en.wikipedia.org/wiki/PACELC_theorem, the store should act as a PA/EL distributed system for these operations.
The multi-datacenter strategy for MediaWiki is to have CDN route HTTP POST requests to the primary datacenter and HTTP GET/HEAD/OPTIONS requests to the closest datacenter to the client. The stash accepts write operations from any datacenter, but cross-datacenter replication is asynchronous.
Modules that use the main stash can expect race conditions to occur if a key can receive write operations originating from multiple datacenters. To improve consistency, callers should avoid main stash updates during non-POST requests. In any case, callers should gracefully tolerate occasional key evictions, temporary inconsistencies among datacenters, and violations of linearizability (e.g. during timeouts). Modules that can never handle these kind of anamolies should use other storage mediums.
Valid options are the keys of $wgObjectCaches
, e.g. CACHE_* constants.
Definition at line 3943 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MainWANCache |
Main Wide-Area-Network cache type.
By default, this will wrap $wgMainCacheType (which is disabled, since the basic stock default of CACHE_DB is not fast enough to make it worthwhile).
For single server or single datacenter setup, setting $wgMainCacheType is enough.
For a multiple datacenter setup, WANObjectCache should be configured to broadcast some if its operations using Mcrouter or Dynomite. See Deploying WANObjectCache.
The options are:
Definition at line 3859 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MangleFlashPolicy |
Formerly a workaround for a security vulnerability caused by installation of Flash as a browser extension.
Definition at line 5267 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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
Definition at line 6635 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxAnimatedGifArea |
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 1987 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxArticleSize |
Maximum article size in kibibytes.
Definition at line 3520 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxCredits |
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 10540 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxExecutionTimeForExpensiveQueries |
Max execution time for queries of several expensive special pages such as RecentChanges in milliseconds.
Definition at line 3199 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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 1974 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaximalPasswordLength |
Specifies the maximal length of a user password (T64685).
It is not recommended to make this greater than the default, as it can allow DoS attacks by users setting really long passwords. In addition, this should not be lowered too much, as it enforces weak passwords.
Definition at line 7033 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaximumMovedPages |
Maximum number of pages to move at once when moving subpages with a page.
Definition at line 3607 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxInterlacingAreas |
Array of max pixel areas for interlacing per MIME type.
Definition at line 1788 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxJobDBWriteDuration |
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.
Definition at line 3591 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxMsgCacheEntrySize |
Maximum entry size in the message cache, in bytes.
Definition at line 4732 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxNameChars |
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 7186 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxPPExpandDepth |
Definition at line 6255 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxPPNodeCount |
A complexity limit on template expansion: the maximum number of nodes visited by PPFrame::expand()
Definition at line 6237 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxRedirectLinksRetrieved |
Maximum number of links to a redirect page listed on Special:Whatlinkshere/RedirectDestination.
Definition at line 11546 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxShellFileSize |
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 11949 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxShellMemory |
Maximum amount of virtual memory available to shell processes under linux, in KiB.
Definition at line 11941 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxShellTime |
Maximum CPU time in seconds for shell processes under Linux.
Definition at line 11956 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxShellWallClockTime |
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 11964 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxSigChars |
Maximum number of Unicode characters in signature.
Definition at line 7151 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxTemplateDepth |
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 6248 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxTocLevel |
Maximum indent level of toc.
Definition at line 6229 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxUploadSize |
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:
Default: 100 MiB.
Definition at line 1501 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MaxUserDBWriteDuration |
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.
Definition at line 3579 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MediaHandlers |
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 1718 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MediaInTargetLanguage |
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.
Definition at line 1953 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MemCachedPersistent |
Use persistent connections to MemCached, which are shared across multiple requests.
Definition at line 4080 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MemCachedServers |
The list of MemCached servers and port numbers.
Definition at line 4071 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MemCachedTimeout |
Read/write timeout for MemCached server communication, in microseconds.
Definition at line 4087 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MemoryLimit |
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 3528 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MessageCacheType |
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 3686 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MessagesDirs |
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:
Complex example:
Definition at line 10778 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MetaNamespace |
Name of the project namespace.
If left set to false, $wgSitename will be used instead.
Definition at line 5863 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MetaNamespaceTalk |
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 5883 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MetricsFormat |
Metrics output format.
If null, metrics will not be rendered nor sent. Note: this only affects metrics instantiated by the MetricsFactory service
Definition at line 9542 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MetricsPrefix |
Metrics service name prefix.
Required. Must not be zero-length. Defaults to: 'mediawiki' Note: this only affects metrics instantiated by the MetricsFactory service
Definition at line 9556 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MetricsTarget |
Metrics 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 MetricsFactory service
Definition at line 9528 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MimeDetectorCommand |
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:
Definition at line 2216 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MimeInfoFile |
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 2199 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MimeType |
The default Content-Type header.
Definition at line 4947 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MimeTypeExclusions |
Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled.
Definition at line 1629 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MimeTypeFile |
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 2190 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MinimalPasswordLength |
Specifies the minimal length of a user password.
If set to 0, empty pass- words are allowed.
Definition at line 7017 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MinUploadChunkSize |
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.
Definition at line 1519 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MiserMode |
Disable database-intensive features.
Definition at line 3478 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MultiShardSiteStats |
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.
Definition at line 3636 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::MWLoggerDefaultSpi |
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:
Definition at line 9327 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NamespaceAliases |
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:
Definition at line 5964 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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).
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).
Definition at line 3266 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NamespaceProtection |
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.
Definition at line 7907 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NamespaceRobotPolicies |
Robot policies per namespaces.
The default policy is given above, the array is made of namespace constants as defined in includes/Defines.php. You can- not specify a different default policy for NS_SPECIAL: it is always noindex, nofollow. This is because a number of special pages (e.g., ListPages) have many permutations of options that display the same data under redundant URLs, so search engine spiders risk getting lost in a maze of twisty special pages, all alike, and never reaching your actual content.
Example:
Definition at line 11613 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NamespacesToBeSearchedDefault |
List of namespaces which are searched by default.
Example:
Definition at line 9731 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NamespacesWithSubpages |
Which namespaces should support subpages? See Language.php for a list of namespaces.
Definition at line 6031 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NativeImageLazyLoading |
Toggles native image lazy loading, via the "loading" attribute.
Definition at line 1729 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NewPasswordExpiry |
The time, in seconds, when an emailed temporary password expires.
Definition at line 2596 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NewUserLog |
Maintain a log of newusers at Special:Log/newusers?
Definition at line 11498 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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 6460 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 6433 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NoFollowNsExceptions |
Namespaces in which $wgNoFollowLinks doesn't apply.
See Language.php for a list of namespaces.
Definition at line 6442 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NonincludableNamespaces |
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 7921 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::NoReplyAddress |
Reply-To address for e-mail notifications.
Defaults to $wgPasswordSender (in Setup.php).
Definition at line 2530 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ObjectCaches |
Advanced object cache configuration.
Use this to define the class names and constructor parameters which are used for the various cache types. Custom cache types may be defined here and referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType, or $wgLanguageConverterCacheType.
The format is an associative array where the key is a cache identifier, and the value is an associative array of parameters. One of the following parameters specifying the class must be given:
The following parameters are shared and understood by most classes:
For SqlBagOStuff, the main configured database will be used, unless one of the following three parameters is given:
SqlBagOStuff also accepts the following optional parameters:
modtoken
column must exist on the objectcache
table(s).For MemcachedPhpBagOStuff parameters see MemcachedPhpBagOStuff::__construct
For MemcachedPeclBagOStuff parameters see MemcachedPeclBagOStuff::__construct
For RedisBagOStuff parameters see RedisBagOStuff::__construct
Definition at line 3795 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ObjectCacheSessionExpiry |
The expiry time to use for session storage, in seconds.
Definition at line 4026 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OldRevisionParserCacheExpireTime |
The expiry time for the parser cache for old revisions, in seconds.
The default is 3600 (cache disabled).
Definition at line 4019 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OpenSearchDefaultLimit |
Integer defining default number of entries to show on OpenSearch call.
Definition at line 9694 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OpenSearchDescriptionLength |
Minimum length of extract in .
Actual extracts will last until the end of sentence.
Definition at line 9702 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OpenSearchTemplate |
Template for OpenSearch suggestions, defaults to API action=opensearch.
Sites with heavy load would typically have these point to a custom PHP wrapper to avoid firing up mediawiki for every keystroke
Placeholders: {searchTerms}
Definition at line 9657 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OpenSearchTemplates |
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 9671 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OriginTrials |
Origin Trials tokens.
Definition at line 12343 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OverrideHostname |
Override server hostname detection with a hardcoded value.
Should be a string, default false.
Definition at line 9389 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OverrideSiteFeed |
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
Definition at line 10258 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::OverrideUcfirstCharacters |
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.
Definition at line 4933 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PageCreationLog |
Maintain a log of page creations at Special:Log/create?
Definition at line 11507 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PageInfoTransclusionLimit |
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 9567 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PageLanguageUseDB |
Enable page language feature Allows setting page language in database.
Definition at line 3393 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PagePropLinkInvalidations |
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 11141 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ParserCacheExpireTime |
The expiry time for the parser cache, in seconds.
The default is 86400 (one day).
Definition at line 4010 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ParserCacheType |
The cache type for storing article HTML.
This is used to store data which is expensive to regenerate, and benefits from having plenty of storage space.
For available types see $wgMainCacheType.
Definition at line 3696 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ParserEnableLegacyMediaDOM |
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
Definition at line 6388 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ParserOutputHooks |
Parser output hooks.
This is an associative array where the key is an extension-defined tag (typically the extension name), and the value is a PHP callback. These will be called as an OutputPageParserOutput hook, if the relevant tag has been registered with the parser output object.
Registration is done with $pout->addOutputHook( $tag, $data ).
The callback has the form:
Definition at line 10810 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ParserTestFiles |
Parser test suite files to be run by parserTests.php when no specific filename is passed to it.
Extensions using extension.json will have any *.txt file in a tests/parser/ directory automatically run.
Core tests can be added to ParserTestRunner::$coreTestFiles.
Use full paths.
Definition at line 9584 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ParserTestMediaHandlers |
Media handler overrides for parser tests (they don't need to generate actual thumbnails, so a mock will do)
Definition at line 1738 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ParsoidCacheConfig |
Configuration for the caching related to parsoid output.
The configuration contains the following keys:
$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.Definition at line 3975 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ParsoidSettings |
Default Parsoid configuration.
Overriding the default configuration is strongly discouraged in production.
Definition at line 6374 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PasswordAttemptThrottle |
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.
Definition at line 8457 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PasswordConfig |
Configuration for built-in password types.
Maps the password type to an array of options. The 'class' option is the Password class to use. All other options are class-dependent.
An advanced example:
Definition at line 7080 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PasswordDefault |
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.
Definition at line 7056 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PasswordExpirationDays |
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 2611 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 2619 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PasswordPolicy |
Password policy for the wiki.
Structured as
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:
], 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:
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).
Definition at line 6755 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PasswordReminderResendTime |
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 2589 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Setting all of these to false (or the whole variable to false) has the effect of disabling password resets entirely
Definition at line 7140 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PasswordSender |
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 2521 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PhpCli |
Executable path of the PHP cli binary.
Should be set up on install.
Definition at line 11998 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PHPSessionHandling |
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.
Definition at line 4042 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Pingback |
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/
Definition at line 12333 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PoolCounterConf |
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:
Example using C daemon from https://www.mediawiki.org/wiki/Extension:PoolCounter:
Definition at line 3567 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PreprocessorCacheThreshold |
Preprocessor caching threshold Setting it to 'false' will disable the preprocessor cache.
Definition at line 6501 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PreviewOnOpenNamespaces |
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 9870 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PrivilegedGroups |
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.
Definition at line 7745 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Profiler |
Profiler configuration.
To use a profiler, set $wgProfiler in LocalSettings.php.
Options:
string
): The Profiler subclass to use. Default: ProfilerStub.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
.float
): Only process the recorded data if the total elapsed time for a request is more than this number of seconds. Default: 0.0
.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:
Profiler output classes available in MediaWiki:
Examples:
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.
Definition at line 9476 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ProhibitedFileExtensions |
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.
Definition at line 1607 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PropagateErrors |
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 9371 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ProxyList |
List of banned IP addresses.
This can have the following formats:
Definition at line 8254 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ProxyWhitelist |
Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say.
Definition at line 8263 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::PutIPinRC |
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 8433 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::QueryCacheLimit |
Number of rows to cache in 'querycache' table when miser mode is on.
Definition at line 3492 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::QueryPageDefaultLimit |
Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere.
Definition at line 8441 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RangeContributionsCIDRLimit |
Shortest CIDR limits that can be checked in any individual range check at Special:Contributions.
Definition at line 11556 of file MainConfigSchema.php.
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.
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.
Definition at line 8331 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RateLimitsExcludedIPs |
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 8423 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RawHtml |
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 6410 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RawHtmlMessages |
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.
Definition at line 4848 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 10305 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCEngines |
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.
Definition at line 10138 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCFeeds |
Configuration for feeds to which notifications about recent changes will be sent.
The following feed classes are available by default:
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:
FormattedRCFeed-specific options:
IRCColourfulRCFeedFormatter-specific options:
JSONRCFeedFormatter-specific options:
Examples:
Definition at line 10126 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCFilterByAge |
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 10039 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCLinkDays |
List of Days options to list in the Special:Recentchanges and Special:Recentchangeslinked pages.
Definition at line 10058 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCLinkLimits |
List of Limits options to list in the Special:Recentchanges and Special:Recentchangeslinked pages.
Definition at line 10047 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCMaxAge |
Recentchanges items are periodically purged; entries older than this many seconds will go.
Default: 90 days = about three months
Definition at line 10005 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCShowChangedSize |
Show the amount of changed characters in recent changes.
Definition at line 10296 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCShowWatchingUsers |
Show watching users in recent changes, watchlist and page history views.
Definition at line 10289 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RCWatchCategoryMembership |
Treat category membership changes as a RecentChange.
Changes are mentioned in RC for page actions as follows:
Definition at line 10158 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ReadOnly |
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 9917 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ReadOnlyFile |
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 9939 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ReadOnlyWatchedItemStore |
Set this to true to put the wiki watchlists into read-only mode.
Definition at line 9926 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ReauthenticateTime |
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:
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:
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.
Definition at line 6949 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RecentChangesFlags |
Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits.
To register a new one:
Definition at line 10404 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RedirectOnLogin |
Allow redirection to another page when a user logs in.
To enable, set to a string like 'Main Page'
Definition at line 12231 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RedirectSources |
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:
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 6204 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ReferrerPolicy |
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).
Definition at line 763 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RegisterInternalExternals |
By default MediaWiki does not register links pointing to same server in externallinks dataset, use this value to override:
Definition at line 6469 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RememberMe |
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.
Definition at line 6907 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RemoveCredentialsBlacklist |
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).
Definition at line 7003 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RemoveGroups |
Definition at line 8106 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 4212 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ReportToEndpoints |
List of endpoints for the Reporting API.
Definition at line 12365 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ReportToExpiry |
Expiry of the endpoint definition for the Reporting API.
Definition at line 12354 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RepositoryBaseUrl |
Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1222 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RequestTimeLimit |
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.
Definition at line 3438 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ReservedUsernames |
Array of usernames which may not be registered or logged in from Maintenance scripts can still use these.
Definition at line 7196 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceBasePath |
The default 'remoteBasePath' value for instances of MediaWiki\ResourceLoader\FileModule.
Defaults to $wgScriptPath.
Definition at line 5717 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceLoaderDebug |
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 5762 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceLoaderEnableJSProfiler |
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.
Definition at line 5802 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceLoaderMaxage |
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:
Definition at line 5742 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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
.
Definition at line 5778 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceLoaderSources |
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:
Definition at line 5707 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceLoaderStorageEnabled |
Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API.
Definition at line 5810 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceLoaderStorageVersion |
Cache version for client-side ResourceLoader module storage.
You can trigger invalidation of the contents of the module store by incrementing this value.
Definition at line 5820 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceLoaderUseObjectCacheForDeps |
Use the main stash instead of the module_deps table for indirect dependency tracking.
Definition at line 5753 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceLoaderValidateJS |
If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it.
Parse errors will result in a JS exception being thrown during module load, which avoids breaking other modules loaded in the same request.
Definition at line 5790 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceModules |
Define extra client-side modules to be registered with ResourceLoader.
ResourceModule
attribute in extension.json
or skin.json
when possible (instead of via PHP global variables).Registration is internally handled by ResourceLoader::register.
Modules that ship with MediaWiki core are registered via resources/Resources.php. For a full list with documentation, see: ResourceLoader/Core_modules.
class {string}
: By default a module is assumed to bundle file resources as handled by the MediaWiki\ResourceLoader\FileModule class. Use this option to use a different implementation of MediaWiki\ResourceLoader\Module instead.
Default: \\MediaWiki\\ResourceLoader\\FileModule
factory {string}
: Override the instantiation of the MediaWiki\ResourceLoader\Module class using a PHP callback. This allows dependency injection to be used. This option cannot be combined with the class
option.
Since: MW 1.30
dependencies {string[]|string}
: Modules that must be executed before this module. Module name string or list of module name strings.
Default: []
deprecated {boolean|string}
: Whether the module is deprecated and usage is discouraged. Set to boolean true, or a string to include in the warning message.
Default: false
group {string}
: Optional request group to override which modules may be downloaded together in an HTTP batch request. By default, any two modules may be loaded together in the same batch request. Set this option to a descriptive string to give the module its own HTTP request. To allow other modules to join this new request, give those the same request group.
Use this option with caution. The default behaviour is well-tuned already, and setting this often does more harm than good. For more about request balancing optimisations, see ResourceLoader/Architecture#Balance.
skipFunction {string}
: Allow this module to be satisfied as dependency without actually loading or executing scripts from the server, if the specified JavaScript function returns true.
Use this to provide polyfills that are natively available in newer browsers. Specify the relative path to a JavaScript file containing a top-level return statement. The contents of the file should not contain any wrapping function, it will be wrapped by ResourceLoader in an anonymous function and invoked when the module is considered for loading.
targets {string[]}
List of ResourceLoader targets where the module may be loaded from. This is used by the MobileFrontend extension to prevent certain modules from being loaded.
This option is deprecated. See T127268.
Default: ["desktop"]
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:
{string[]|string}
: Styles to include in specific skin contexts. Array keyed is by skin name with file path or list of file paths as value, relative to localBasePath
.Default: []
noflip {boolean}
: By default, CSSJanus will be used automatically to perform LTR-to-RTL flipping when loaded in a right-to-left (RTL) interface language context. Use this option to skip CSSJanus LTR-to-RTL flipping for this module, for example when registering an external library that already handles RTL styles.
Default: false
packageFiles {string[]|array[]}
Specify script files and (virtual) data files to include in the module. Each internal JavaScript file retains its own local module scope and its private exports can be accessed separately by other client-side code in the same module, via the local require()
function.
Modules that use package files should export any public API methods using module.exports
.
See examples at ResourceLoader/Package_files on mediawiki.org.
The packageFiles
feature cannot be combined with legacy scripts that use the scripts
option, including its extended variants languageScripts
, skinScripts
, and debugScripts
.
Since: MW 1.33
Default: []
scripts {string[]|string}
: Scripts to always include in the module. File path or list of file paths, relative to localBasePath
.
These files are concatenated blindly and executed as a single client-side script. Modules using this option are sometimes referred to as "legacy scripts" to distinguish them from those that use the packageFiles
option.
Modules that use legacy scripts usually attach any public APIs they have to the mw
global variable. If a module contains just one file, it is also supported to use the newer module.exports
mechanism, though if the module contains more than one legacy script, it is considered unsafe and unsupported to use this mechanism (use packageFiles
instead). See also Coding conventions/JavaScript.
Default: []
Extended options, concatenated in this order:
{string[]|string}
: Scripts to include in specific language contexts. Array is keyed by language code with file path or list of file path.{string[]|string}
: Scripts to include in specific skin contexts. Array keyed is by skin name with file path or list of file paths.{string[]|string}
: Scripts to include in debug contexts. File path or list of file paths.messages {string[]}
Localisation messages to bundle with this module, for client-side use via mw.msg()
and mw.message()
. List of message keys.
Default: []
templates {string[]}
List of template files to be loaded for client-side usage via mw.templates
.
Default: []
es6 {boolean}
: If true, this module will only be executed in browsers that support ES6. You should set this flag for modules that use ES6 in their JavaScript. Only use this for modules that provide progressive enhancements that are safe to not load in browsers that are not modern but still have a substantial user base, like IE11.
Since: MW 1.36
Default: false
Example: Using an alternate subclass
Example: Deprecated module
Example: Base paths in extension.json
Example: Base paths in core with PHP
Example: Define a skip function
Example: Contents of skip function file
Example: Module targets
Example: Package files
Example: Legacy scripts
Example: Template files
Definition at line 5592 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResourceModuleSkinStyles |
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:
This is effectively equivalent to:
Equivalent:
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:
This is effectively equivalent to:
Equivalent:
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:
Definition at line 5691 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ResponsiveImages |
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 2421 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RestAllowCrossOriginCookieAuth |
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.
Definition at line 8913 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RestAPIAdditionalRouteFiles |
Additional REST API Route files.
A common usage is to enable development/experimental endpoints only on test wikis.
Definition at line 11927 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RestPath |
The URL path to the REST API Defaults to "{$wgScriptPath}/rest.php".
Definition at line 400 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RestrictDisplayTitle |
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 6485 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RestrictionLevels |
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.
Definition at line 7864 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RestrictionTypes |
Set of available actions that can be restricted via action=protect You probably shouldn't change this.
Translated through restriction-* messages. Title::getRestrictionTypes() will remove restrictions that are not applicable to a specific title (create and upload)
Definition at line 7848 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RevertedTagMaxDepth |
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.
Definition at line 6652 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Set to 0 to disable, or number of seconds before cache expiry.
Definition at line 3382 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RevokePermissions |
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 7764 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RightsIcon |
Override for copyright metadata.
Definition at line 10522 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RightsPage |
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 10493 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RightsText |
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 10515 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::RightsUrl |
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 10503 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 12202 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Script |
The URL path to index.php.
Defaults to "{$wgScriptPath}/index.php".
Definition at line 361 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ScriptPath |
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 321 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SearchForwardUrl |
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:
Definition at line 9761 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SearchHighlightBoundaries |
Regexp to match word boundaries, defaults for non-CJK languages should be empty for CJK since the words are not separate.
Definition at line 9643 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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'].
Definition at line 9828 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SearchRunSuggestedQuery |
Controls whether zero-result search queries with suggestions should display results for these suggestions.
Definition at line 9839 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SearchSuggestCacheExpiry |
Expiry time for search suggestion responses.
Definition at line 9709 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SearchType |
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 2897 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SearchTypeAlternatives |
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 2913 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SecretKey |
This should always be customised in LocalSettings.php.
Definition at line 8744 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SecureLogin |
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
Definition at line 7333 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SemiprotectedRestrictionLevels |
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 7895 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Send404Code |
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 5226 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Server |
URL of the server.
Example:
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 237 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ServerName |
Server name.
This is automatically computed by parsing the bare hostname out of $wgCanonicalServer. It should not be customized.
Definition at line 260 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ServiceWiringFiles |
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.
Definition at line 10986 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SessionCacheType |
The cache backend for storing session data.
Used by MediaWiki\Session\SessionManager. See $wgMainCacheType for available types.
See SessionManager Storage expectations.
Definition at line 3707 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
But it would be much more secure to just install the OpenSSL extension.
Definition at line 8938 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SessionName |
Override to customise the session name.
Definition at line 9103 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SessionPbkdf2Iterations |
Number of internal PBKDF2 iterations to use when deriving session secrets.
Definition at line 4064 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SessionProviders |
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.
Definition at line 7360 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SessionSecret |
Secret for session storage.
This should be set in LocalSettings.php, otherwise $wgSecretKey will be used.
Definition at line 8926 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedDB |
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 2973 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedPrefix |
Definition at line 2980 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedSchema |
Definition at line 3010 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedTables |
Definition at line 2997 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedThumbnailScriptPath |
Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1571 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedUploadDBname |
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.
Definition at line 1246 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedUploadDBprefix |
Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1258 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedUploadDirectory |
Shortcut for the 'directory' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1186 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharedUploadPath |
Shortcut for the 'url' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1198 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharpenParameter |
Sharpening parameter to ImageMagick.
Definition at line 1796 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SharpenReductionThreshold |
Reduction in linear dimensions below which sharpening will be enabled.
Definition at line 1803 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShellboxSecretKey |
The secret key for HMAC verification of Shellbox requests.
Set this to a long random string.
Definition at line 12054 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShellboxUrl |
Definition at line 12022 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShellboxUrls |
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
Definition at line 12040 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShellCgroup |
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:
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 11991 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShellRestrictionMethod |
Method to use to restrict shell commands.
Supported options:
Definition at line 12014 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShortPagesNamespaceExclusions |
Optional array of namespaces which should be excluded from Special:ShortPages.
Only pages inside $wgContentNamespaces but not $wgShortPagesNamespaceExclusions will be shown on that page.
Definition at line 6069 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShowArchiveThumbnails |
Show thumbnails for old images on the image description page.
Definition at line 2077 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShowCreditsIfMax |
If there are more than $wgMaxCredits authors, show $wgMaxCredits of them.
Otherwise, link to a separate credits page.
Definition at line 10549 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShowDebug |
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 9338 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShowExceptionDetails |
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 9356 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShowEXIF |
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
Definition at line 1402 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShowHostnames |
Expose backend server host names through the API and various HTML comments.
Definition at line 9378 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShowRollbackEditCount |
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.
Definition at line 5240 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ShowUpdatedMarker |
Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes.
Definition at line 10313 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SidebarCacheExpiry |
Expiry time for the sidebar cache, in seconds.
Definition at line 4232 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SignatureAllowedLintErrors |
List of lint error codes which don't cause signature validation to fail.
Definition at line 7177 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SignatureValidation |
Behavior of signature validation.
Allowed values are:
Definition at line 7167 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 9770 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SitemapNamespacesPriorities |
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:
Definition at line 9791 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Sitename |
Name of the site.
It must be changed in LocalSettings.php
Definition at line 207 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SiteNotice |
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 5028 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SiteTypes |
Register handlers for specific types of sites.
Definition at line 6213 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SkinMetaTags |
An array of open graph tags which should be added by all skins.
Accepted values are "og:title", "og:type" and "twitter:card". Since some of these fields can be provided by extensions it defaults to an empty array.
Definition at line 5057 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SkinsPreferred |
List of preferred skins to be listed higher in Special:Preferences.
Definition at line 12388 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SkipSkins |
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.
Definition at line 5089 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SMTP |
SMTP Mode.
For using a direct (authenticated) SMTP server connection. Default to false or fill an array :
Definition at line 2640 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SoftBlockRanges |
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.
Definition at line 8275 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SoftwareTags |
List of core tags to enable.
Definition at line 10350 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SpamRegex |
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.
Definition at line 8194 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SpecialPageCacheUpdates |
Additional functions to be performed with updateSpecialPages.
Expensive Querypages are already updated.
Definition at line 11126 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SpecialPages |
Special page list.
This is an associative array mapping the (canonical) names of special pages to either a class name to be instantiated, or a callback to use for creating the special page object. In both cases, the result must be an instance of SpecialPage.
Definition at line 10858 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SpecialSearchFormOptions |
Options for Special:Search completion widget form created by SearchFormWidget class.
Settings that can be used:
Definition at line 9815 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SpecialVersionShowHooks |
Show the contents of $wgHooks in Special:Version.
Definition at line 9345 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SQLiteDataDir |
To override default SQLite data directory ($docroot/../data)
Definition at line 2949 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SQLMode |
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 2931 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SquidPurgeUseHostHeader |
Whether to use a Host header in purge requests sent to the proxy servers configured in $wgCdnServers.
Set this to false to support a CDN configured in forward-proxy mode.
If this is set to true, a Host header will be sent, and only the path component of the URL will appear on the request line, as if the request were a non-proxy HTTP 1.1 request. Varnish only supports this style of request. Squid supports this style of request only if reverse-proxy mode (http_port ... accel) is enabled.
If this is set to false, no Host header will be sent, and the absolute URL will be sent in the request line, as is the standard for an HTTP proxy request in both HTTP 1.0 and 1.1. This style of request is not supported by Varnish, but is supported by Squid in either configuration (forward or reverse).
Definition at line 4458 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::StatsCacheType |
The object cache type for stats storage.
\\Wikimedia\\WRStats\\WRStatsFactory
Definition at line 3727 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::StatsdMetricPrefix |
Prefix for metric names sent to $wgStatsdServer.
Definition at line 9503 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::StatsdSamplingRates |
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).
Definition at line 9515 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::StatsdServer |
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.
Definition at line 9492 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::StrictFileExtensions |
If this is turned off, users may override the warning for files not covered by $wgFileExtensions.
Definition at line 1666 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::StructuredChangeFiltersLiveUpdatePollingRate |
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 10180 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::StyleDirectory |
Skins directory in the file system.
Definition at line 493 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::StylePath |
The URL path of the skins directory.
Defaults to "{$wgResourceBasePath}/skins".
Definition at line 420 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SummarySpamRegex |
Same as SpamRegex except for edit summaries.
Definition at line 8202 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SuspiciousIpExpiry |
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.
Definition at line 4054 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SVGConverter |
Pick a converter defined in $wgSVGConverters.
Definition at line 1917 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SVGConverterPath |
If not in the executable PATH, specify the SVG converter path.
Definition at line 1924 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SVGConverters |
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 1901 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SVGMaxSize |
Don't scale a SVG larger than this.
Definition at line 1931 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::SVGMetadataCutoff |
Don't read SVG metadata beyond this point.
Default is 1024*256 bytes
Definition at line 1940 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TempCategoryCollations |
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:
Definition at line 11208 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TemplateLinksSchemaMigrationStage |
Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields.
Use the SCHEMA_COMPAT_XXX flags. Supported values:
History:
Definition at line 3217 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TextModelsToParse |
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.
Definition at line 3302 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ThumbLimits |
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 2273 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ThumbnailBuckets |
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 2295 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ThumbnailEpoch |
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 2019 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ThumbnailMinimumBucketDistance |
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 2315 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
This is necessary if some of your apache servers don't have read/write access to the thumbnail path.
Example:
Definition at line 1560 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ThumbPath |
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.
Definition at line 575 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 2404 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TidyConfig |
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:
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 6361 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TiffThumbnailType |
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:
Definition at line 2006 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TmpDirectory |
The local filesystem path to a temporary directory.
This must not be web accessible.
When this setting is set to false, its value will automatically be decided through the first call to wfTempDir(). See that method's implementation for the actual detection logic.
To find the temporary path for the current wiki, developers must not use this variable directly. Use the global function wfTempDir() instead.
The temporary directory is expected to be shared with other applications, including other MediaWiki instances (which might not run the same version or configution). When storing files here, take care to avoid conflicts with other instances of MediaWiki. For example, when caching the result of a computation, the file name should incorporate the input of the computation so that it cannot be confused for the result of a similar computation by another MediaWiki instance.
Definition at line 789 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TrackingCategories |
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.
Definition at line 11227 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TransactionalTimeLimit |
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.
Definition at line 3452 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TranscludeCacheExpiry |
Expiry time for transcluded templates cached in object cache.
Only used $wgEnableInterwikiTranscluding is set to true.
Definition at line 6517 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TranslateNumerals |
For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface.
Definition at line 4716 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TrivialMimeDetection |
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 2226 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TrustedMediaFormats |
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 1698 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::TrxProfilerLimits |
Performance expectations for DB usage.
Definition at line 9213 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UniversalEditButton |
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 9882 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UnwatchedPageSecret |
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.
Definition at line 10028 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 10375 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UpdateCompatibleMetadata |
Shortcut for the 'updateCompatibleMetadata' setting of $wgLocalFileRepo.
Definition at line 1416 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UpdateRowsPerJob |
Number of rows to update per job.
Definition at line 12209 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UpdateRowsPerQuery |
Number of rows to update per query.
Definition at line 12216 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
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 9961 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadBaseUrl |
If set, this URL is added to the start of $wgUploadPath to form a complete upload URL.
Definition at line 799 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadDialog |
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 1299 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadDirectory |
The filesystem path of the images directory.
Defaults to "{$IP}/images".
Definition at line 582 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadMaintenance |
To disable file delete/restore temporarily.
Definition at line 892 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadMissingFileUrl |
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 1543 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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).
Example:
Definition at line 1534 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadPath |
The URL path for the images directory.
Defaults to "{$wgScriptPath}/images".
Definition at line 540 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadSizeWarning |
Warn if uploaded files are larger than this (in bytes), or false to disable.
Definition at line 1683 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadStashMaxAge |
The maximum age of temporary (incomplete) uploaded files.
Definition at line 872 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadStashScalerBaseUrl |
To enable remote on-demand scaling, set this to the thumbnail base URL.
Full thumbnail URL will be like $wgUploadStashScalerBaseUrl/e/e6/Foo.jpg/123px-Foo.jpg where 'e6' are the first two characters of the MD5 hash of the file name.
If $wgUploadStashScalerBaseUrl and thumbProxyUrl are both false, thumbs are rendered locally as needed.
Definition at line 815 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadThumbnailRenderHttpCustomDomain |
When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to.
Definition at line 2364 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadThumbnailRenderHttpCustomHost |
When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header.
Definition at line 2354 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadThumbnailRenderMap |
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.
Definition at line 2328 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UploadThumbnailRenderMethod |
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.
Definition at line 2344 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UrlProtocols |
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.
Definition at line 6269 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseAutomaticEditSummaries |
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 9891 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseCdn |
Enable/disable CDN.
See https://www.mediawiki.org/wiki/Manual:Performance_tuning#Page_view_caching
Definition at line 4310 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseCombinedLoginLink |
Login / create account link behavior when it's possible for anonymous users to create an account.
Definition at line 5204 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseContentMediaStyles |
Temporary flag to ship 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.
Definition at line 6400 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseCopyrightUpload |
Set this to true if you want detailed copyright information forms on Upload.
Definition at line 10529 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseDatabaseMessages |
Translation using MediaWiki: namespace.
Interface messages will be loaded from the database.
Definition at line 4725 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseFileCache |
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 4194 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseFilePatrol |
Use file patrolling to check new files on Special:Newfiles.
Definition at line 10203 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseGzip |
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 4242 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseImageMagick |
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 1772 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseImageResize |
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 1759 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseInstantCommons |
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.
Definition at line 1143 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseLocalMessageCache |
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 4102 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseMediaWikiUIEverywhere |
Temporary variable that applies MediaWiki UI wherever it can be supported.
Temporary variable that should be removed when mediawiki ui is more stable and change has been communicated.
Definition at line 4985 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseNPPatrol |
Use new page patrolling to check new pages on Special:Newpages.
Definition at line 10191 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UsePathInfo |
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.
Definition at line 339 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UsePigLatinVariant |
Whether to enable the pig Latin variant of English (en-x-piglatin), used to ease variant development work.
Definition at line 4761 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UsePrivateIPs |
Should forwarded Private IPs be accepted?
Definition at line 4528 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseRCPatrol |
Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files are included.
Definition at line 10170 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UserEmailConfirmationTokenExpiry |
The time, in seconds, when an email confirmation email expires.
Definition at line 2603 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UserEmailUseReplyTo |
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 2581 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
"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 7321 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UsersNotifiedOnAllChanges |
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 2766 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseSameSiteLegacyCookies |
If true, when a cross-site cookie with SameSite=None is sent, a legacy cookie with an "ss0" prefix will also be sent, without SameSite=None.
This is a workaround for broken behaviour in Chrome 51-66 and similar browsers.
Definition at line 9087 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseSharedUploads |
Shortcut for adding an entry to $wgForeignFileRepos.
Uses the following variables:
If $wgSharedUploadDBname is set, it uses the ForeignDBRepo class, with also the following variables:
Definition at line 1174 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseSiteCss |
Use the site's Cascading Style Sheets (CSS)?
Definition at line 8786 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseSiteJs |
Use the site's Javascript page?
Definition at line 8779 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::UseTagFilter |
Allow filtering by change tag in recentchanges, history, etc Has no effect if no tags are defined.
Definition at line 10329 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::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.
Definition at line 2375 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ValidSkinNames |
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:
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 10847 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::VariantArticlePath |
Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which parts of the URL contain the language variant.
Example:
A link to /wiki/ would be redirected to /sr/Главна_страна
It is important that $wgArticlePath not overlap with possible values of $wgVariantArticlePath.
Definition at line 4798 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::VaryOnXFP |
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 4322 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::VerifyMimeType |
Determines if the MIME type of uploaded files should be checked.
Definition at line 2163 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::VerifyMimeTypeIE |
Determines whether extra checks for IE type detection should be applied.
This is a conservative check for exactly what IE 6 or so checked for, and shouldn't trigger on for instance JPEG files containing links in EXIF metadata.
Definition at line 2176 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::VirtualRestConfig |
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:
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', ];
Definition at line 12271 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::VueDevelopmentMode |
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.
Definition at line 5849 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WANObjectCaches |
Advanced WAN object cache configuration.
The format is an associative array where the key is an identifier that may be referenced by $wgMainWANCache, and the value is an array of options:
Any other options are treated as constructor parameters to WANObjectCache, except for 'cache', 'logger', 'stats' and 'asyncHandler' which are unconditionally set by MediaWiki core's ServiceWiring.
Example:
Definition at line 3890 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WantedPagesThreshold |
Number of links to a page required before it is deemed "wanted".
Definition at line 3499 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WatchersMaxAge |
Page watchers inactive for more than this many seconds are considered inactive.
Used mainly by action=info. Default: 180 days = about six months.
Definition at line 10016 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WatchlistExpiry |
Whether to enable the watchlist expiry feature.
Definition at line 10441 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WatchlistExpiryMaxDuration |
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.
Definition at line 10475 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WatchlistPurgeRate |
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.
Definition at line 10456 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WhitelistRead |
Pages anonymous user may see, set as an array of pages titles.
Example:
Special:Userlogin and Special:ChangePassword are always allowed.
Definition at line 7538 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WhitelistReadRegexp |
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]]:
Example: To allow reading any page starting with 'User' regardless of the case:
Will allow both [[User is banned]] and [[User:JohnDoe]]
Definition at line 7569 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WikiFarmSettingsDirectory |
EXPERIMENTAL: 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.
Definition at line 10687 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::WikiFarmSettingsExtension |
EXPERIMENTAL: The file extension to be used when looking up site-specific settings files in $wgWikiFarmSettingsDirectory, such as 'json' or 'yaml'.
Definition at line 10699 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::XhtmlNamespaces |
Permit other namespaces in addition to the w3.org default.
Use the prefix for the key and the namespace for the value.
Example:
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 5016 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::XmlDumpSchemaVersion |
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 10668 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::XMLMimeTypes |
Additional XML types we can allow via MIME-detection.
array = [ 'rootElement' => 'associatedMimeType' ]
Definition at line 2235 of file MainConfigSchema.php.