MediaWiki master
|
This class contains schema declarations for all configuration variables known to MediaWiki core. More...
Static Public Member Functions | |
static | getDefaultValue (string $name) |
Returns the default value of the given config setting. | |
static | listDefaultValues (string $prefix='') |
Returns a generator for iterating over all config settings and their default values. | |
Public Attributes | |
const | ConfigRegistry |
Registry of factory functions to create config objects: The 'main' key must be set, and the value should be a valid callable. | |
const | Sitename |
Name of the site. | |
DJVU settings | |
const | DjvuUseBoxedCommand |
Whether to use BoxedCommand or not. | |
const | DjvuDump |
Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';. | |
const | DjvuRenderer |
Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';. | |
const | DjvuTxt |
Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';. | |
const | DjvuPostProcessor |
Shell command for the DJVU post processor Default: pnmtojpeg, since ddjvu generates ppm output Set this to false to output the ppm file directly. | |
const | DjvuOutputExtension |
File extension for the DJVU post processor output. | |
Email settings | |
const | EmergencyContact |
Site admin email address. | |
const | PasswordSender |
Sender email address for e-mail notifications. | |
const | NoReplyAddress |
Reply-To address for e-mail notifications. | |
const | EnableEmail |
Set to true to enable the e-mail basic features: Password reminders, etc. | |
const | EnableUserEmail |
Set to true to enable user-to-user e-mail. | |
const | EnableSpecialMute |
Set to true to enable the Special Mute page. | |
const | EnableUserEmailMuteList |
Set to true to enable user-to-user e-mail mutelist. | |
const | UserEmailUseReplyTo |
If true put the sending user's email in a Reply-To header instead of From (false). | |
const | PasswordReminderResendTime |
Minimum time, in hours, which must elapse between password reminder emails for a given account. | |
const | NewPasswordExpiry |
The time, in seconds, when an emailed temporary password expires. | |
const | UserEmailConfirmationTokenExpiry |
The time, in seconds, when an email confirmation email expires. | |
const | PasswordExpirationDays |
The number of days that a user's password is good for. | |
const | PasswordExpireGrace |
If a user's password is expired, the number of seconds when they can still login, and cancel their password change, but are sent to the password change form on each login. | |
const | SMTP |
SMTP Mode. | |
const | AdditionalMailParams |
Additional email parameters, will be passed as the last argument to mail() call. | |
const | AllowHTMLEmail |
For parts of the system that have been updated to provide HTML email content, send both text and HTML parts as the body of the email. | |
const | EnotifFromEditor |
Allow sending of e-mail notifications with the editor's address as sender. | |
const | EmailAuthentication |
Require email authentication before sending mail to an email address. | |
const | EnotifWatchlist |
Allow users to enable email notification ("enotif") on watchlist changes. | |
const | EnotifUserTalk |
Allow users to enable email notification ("enotif") when someone edits their user talk page. | |
const | EnotifRevealEditorAddress |
Allow sending of e-mail notifications with the editor's address in "Reply-To". | |
const | EnotifMinorEdits |
Potentially send notification mails on minor edits to pages. | |
const | EnotifImpersonal |
Send a generic mail instead of a personalised mail for each user. | |
const | EnotifMaxRecips |
Maximum number of users to mail at once when using impersonal mail. | |
const | EnotifUseRealName |
Use real name instead of username in e-mail "from" field. | |
const | UsersNotifiedOnAllChanges |
Array of usernames who will be sent a notification email for every change which occurs on a wiki. | |
Content handlers and storage | |
const | ContentHandlers |
Plugins for page content model handling. | |
const | NamespaceContentModels |
Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by default (use the CONTENT_MODEL_XXX constants). | |
const | TextModelsToParse |
Determines which types of text are parsed as wikitext. | |
const | CompressRevisions |
We can also compress text stored in the 'text' table. | |
const | ExternalStores |
List of enabled ExternalStore protocols. | |
const | ExternalServers |
Shortcut for setting $wgLBFactoryConf["externalClusters"] . | |
const | DefaultExternalStore |
The place to put new text blobs or false to put them in the text table of the local wiki database. | |
const | RevisionCacheExpiry |
Revision text may be cached in the main WAN cache to reduce load on external storage servers and object extraction overhead for frequently-loaded revisions. | |
const | RevisionSlotsCacheExpiry |
Revision slots may be cached in the main WAN cache and/or the local server cache to reduce load on the database. | |
const | PageLanguageUseDB |
Enable page language feature Allows setting page language in database. | |
const | DiffEngine |
Specify the difference engine to use. | |
const | ExternalDiffEngine |
Name of the external diff engine to use. | |
const | Wikidiff2Options |
Options for wikidiff2: | |
Performance hacks and limits | |
const | RequestTimeLimit |
Set a limit on server request wall clock time. | |
const | TransactionalTimeLimit |
The request time limit for "slow" write requests that should not be interrupted due to the risk of data corruption. | |
const | CriticalSectionTimeLimit |
The maximum time critical sections are allowed to stay open. | |
const | MiserMode |
Disable database-intensive features. | |
const | DisableQueryPages |
Disable all query pages if miser mode is on, not just some. | |
const | QueryCacheLimit |
Number of rows to cache in 'querycache' table when miser mode is on. | |
const | WantedPagesThreshold |
Number of links to a page required before it is deemed "wanted". | |
const | AllowSlowParserFunctions |
Enable slow parser functions. | |
const | AllowSchemaUpdates |
Allow schema updates. | |
const | MaxArticleSize |
Maximum article size in kibibytes. | |
const | MemoryLimit |
The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount. | |
const | PoolCounterConf |
Configuration for processing pool control, for use in high-traffic wikis. | |
const | PoolCountClientConf |
Configuration array for the PoolCounter client. | |
const | MaxUserDBWriteDuration |
Max time (in seconds) a user-generated transaction can spend in writes. | |
const | MaxJobDBWriteDuration |
Max time (in seconds) a job-generated transaction can spend in writes. | |
const | LinkHolderBatchSize |
LinkHolderArray batch size For debugging. | |
const | MaximumMovedPages |
Maximum number of pages to move at once when moving subpages with a page. | |
const | ForceDeferredUpdatesPreSend |
Force deferred updates to be run before sending a response to the client, instead of attempting to run them after sending the response. | |
const | MultiShardSiteStats |
Whether site_stats table should have multiple rows. | |
Cache settings | |
const | CacheDirectory |
Directory for caching data in the local filesystem. | |
const | MainCacheType |
Main cache type. | |
const | MessageCacheType |
The cache type for storing the contents of the MediaWiki namespace. | |
const | ParserCacheType |
The cache type for storing page content HTML (e.g. | |
const | SessionCacheType |
The cache backend for storing session data. | |
const | LanguageConverterCacheType |
The cache type for storing language conversion tables, which are used when parsing certain text and interface messages. | |
const | ObjectCaches |
Advanced object cache configuration. | |
const | WANObjectCache |
Extra parameters to the WANObjectCache constructor. | |
const | MicroStashType |
The stash store backend for MicroStash. | |
const | MainStash |
The object store type of the main stash. | |
const | ParsoidCacheConfig |
Configuration for the caching related to parsoid output. | |
const | ParsoidSelectiveUpdateSampleRate |
Sample rate for collecting statistics on Parsoid selective update. | |
const | ParserCacheFilterConfig |
Per-namespace configuration for the ParserCache filter. | |
const | ChronologyProtectorSecret |
Secret string for HMAC hashing in ChronologyProtector [optional]. | |
const | ParserCacheExpireTime |
The expiry time for the parser cache, in seconds. | |
const | ParserCacheAsyncExpireTime |
The expiry time for "not ready" asynchronous content in the parser cache, in seconds. | |
const | OldRevisionParserCacheExpireTime |
The expiry time for the parser cache for old revisions, in seconds. | |
const | ObjectCacheSessionExpiry |
The expiry time to use for session storage, in seconds. | |
const | PHPSessionHandling |
Whether to use PHP session handling ($_SESSION and session_*() functions) | |
const | SuspiciousIpExpiry |
Time in seconds to remember IPs for, for the purposes of logging IP changes within the same session. | |
const | SessionPbkdf2Iterations |
Number of internal PBKDF2 iterations to use when deriving session secrets. | |
const | MemCachedServers |
The list of MemCached servers and port numbers. | |
const | MemCachedPersistent |
Use persistent connections to MemCached, which are shared across multiple requests. | |
const | MemCachedTimeout |
Read/write timeout for MemCached server communication, in microseconds. | |
const | UseLocalMessageCache |
Set this to true to maintain a copy of the message cache on the local server. | |
const | AdaptiveMessageCache |
Instead of caching everything, only cache those messages which have been customised in the site content language. | |
const | LocalisationCacheConf |
Localisation cache configuration. | |
const | CachePages |
Allow client-side caching of pages. | |
const | CacheEpoch |
Set this to current time to invalidate all prior cached pages. | |
const | GitInfoCacheDirectory |
Directory where GitInfo will look for pre-computed cache files. | |
const | UseFileCache |
This will cache static pages for non-logged-in users to reduce database traffic on public sites. | |
const | FileCacheDepth |
Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory. | |
const | RenderHashAppend |
Append a configured value to the parser cache and the sitenotice key so that they can be kept separate for some class of activity. | |
const | EnableSidebarCache |
If on, the sidebar navigation links are cached for users with the current language set. | |
const | SidebarCacheExpiry |
Expiry time for the sidebar cache, in seconds. | |
const | UseGzip |
When using the file cache, we can store the cached HTML gzipped to save disk space. | |
const | InvalidateCacheOnLocalSettingsChange |
Invalidate various caches when LocalSettings.php changes. | |
const | ExtensionInfoMTime |
When loading extensions through the extension registration system, this can be used to invalidate the cache. | |
const | EnableRemoteBagOStuffTests |
If this is set to true, phpunit will run integration tests against remote caches defined in $wgObjectCaches. | |
HTTP proxy (CDN) settings | |
Many of these settings apply to any HTTP proxy used in front of MediaWiki, although they are sometimes still referred to as Squid settings for historical reasons. Achieving a high hit ratio with an HTTP proxy requires special configuration. See https://www.mediawiki.org/wiki/Manual:Performance_tuning#Page_view_caching for more details. | |
const | UseCdn |
Enable/disable CDN. | |
const | VaryOnXFP |
Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds. | |
const | InternalServer |
Internal server name as known to CDN, if different. | |
const | CdnMaxAge |
Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI). | |
const | CdnMaxageLagged |
Cache timeout for the CDN when DB replica DB lag is high. | |
const | CdnMaxageStale |
Cache timeout when delivering a stale ParserCache response due to PoolCounter contention. | |
const | CdnReboundPurgeDelay |
If set, any SquidPurge call on a URL or URLs will send a second purge no less than this many seconds later via the job queue. | |
const | CdnMaxageSubstitute |
Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load) | |
const | ForcedRawSMaxage |
Default maximum age for raw CSS/JS accesses. | |
const | CdnServers |
List of proxy servers to purge on changes; default port is 80. | |
const | CdnServersNoPurge |
As with $wgCdnServers, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc. | |
const | HTCPRouting |
Routing configuration for HTCP multicast purging. | |
const | HTCPMulticastTTL |
HTCP multicast TTL. | |
const | UsePrivateIPs |
Should forwarded Private IPs be accepted? | |
const | CdnMatchParameterOrder |
Set this to false if MediaWiki is behind a CDN that re-orders query parameters on incoming requests. | |
Output format and skin settings | |
const | MimeType |
The default Content-Type header. | |
const | Html5Version |
Defines the value of the version attribute in the <html> tag, if any. | |
const | EditSubmitButtonLabelPublish |
Whether to label the store-to-database-and-show-to-others button in the editor as "Save page"/"Save changes" if false (the default) or, if true, instead as "Publish page"/"Publish changes". | |
const | XhtmlNamespaces |
Permit other namespaces in addition to the w3.org default. | |
const | SiteNotice |
Site notice shown at the top of each page. | |
const | BrowserFormatDetection |
Override the ability of certain browsers to attempt to autodetect dataformats in pages. | |
const | SkinMetaTags |
An array of open graph tags which should be added by all skins. | |
const | DefaultSkin |
Default skin, for new users and anonymous visitors. | |
const | FallbackSkin |
Fallback skin used when the skin defined by $wgDefaultSkin can't be found. | |
const | SkipSkins |
Specify the names of skins that should not be presented in the list of available skins in user preferences. | |
const | DisableOutputCompression |
Disable output compression (enabled by default if zlib is available) | |
const | FragmentMode |
How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of: | |
const | ExternalInterwikiFragmentMode |
Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragmentMode above for details of each mode. | |
const | FooterIcons |
Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can add new icons to the built in copyright or poweredby, or you can create a new block. | |
const | UseCombinedLoginLink |
Login / create account link behavior when it's possible for anonymous users to create an account. | |
const | Edititis |
Display user edit counts in various prominent places. | |
const | Send404Code |
Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output. | |
const | ShowRollbackEditCount |
The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back. | |
const | EnableCanonicalServerLink |
Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e. | |
const | InterwikiLogoOverride |
List of interwiki logos overrides. | |
Interwiki links and sites | |
const | LocalInterwikis |
Array for local interwiki values, for each of the interwiki prefixes that point to the current wiki. | |
const | InterwikiExpiry |
Expiry time for cache of interwiki table. | |
const | InterwikiCache |
Interwiki cache as an associative array. | |
const | InterwikiScopes |
Specify number of domains to check for messages. | |
const | InterwikiFallbackSite |
Fallback site, if unable to resolve from cache. | |
const | RedirectSources |
If local interwikis are set up which allow redirects, set this regexp to restrict URLs which will be displayed as 'redirected from' links. | |
const | SiteTypes |
Register handlers for specific types of sites. | |
Parser settings | |
These settings configure the transformation from wikitext to HTML. | |
const | MaxTocLevel |
Maximum indent level of toc. | |
const | MaxPPNodeCount |
A complexity limit on template expansion: the maximum number of nodes visited by PPFrame::expand() | |
const | MaxTemplateDepth |
Maximum recursion depth for templates within templates. | |
const | MaxPPExpandDepth |
const | UrlProtocols |
URL schemes that should be recognized as valid by UrlUtils::parse(). | |
const | CleanSignatures |
If true, removes (by substituting) templates in signatures. | |
const | AllowExternalImages |
Whether to allow inline image pointing to other websites. | |
const | AllowExternalImagesFrom |
If the above is false, you can specify an exception here. | |
const | EnableImageWhitelist |
If $wgAllowExternalImages is false, you can allow an on-wiki allow list of regular expression fragments to match the image URL against. | |
const | TidyConfig |
Configuration for HTML postprocessing tool. | |
const | ParsoidSettings |
Default Parsoid configuration. | |
const | ParsoidFragmentSupport |
Enable fragment support in Parsoid (transclusions returning html). | |
const | ParsoidExperimentalParserFunctionOutput |
If set, Parsoid's HTML output for parser functions will be different from Parsoid HTML spec 2.x.x and lets us experiment with a better output that might be rolled out in a future 3.x Parsoid HTML version. | |
const | ParserEnableLegacyMediaDOM |
Enable legacy media HTML structure in the output from the Parser. | |
const | ParserEnableLegacyHeadingDOM |
Enable legacy HTML structure for headings in the output from the Parser. | |
const | UseContentMediaStyles |
Enable shipping the styles for the media HTML structure that replaces legacy, when $wgParserEnableLegacyMediaDOM is false . | |
const | UseLegacyMediaStyles |
Disable shipping the styles for the legacy media HTML structure that has been replaced when $wgParserEnableLegacyMediaDOM is false . | |
const | RawHtml |
Allow raw, unchecked HTML in "<html>...</html>" sections. | |
const | ExternalLinkTarget |
Set a default target for external links, e.g. | |
const | NoFollowLinks |
If true, external URL links in wiki text will be given the rel="nofollow" attribute as a hint to search engines that they should not be followed for ranking purposes as they are user-supplied and thus subject to spamming. | |
const | NoFollowNsExceptions |
Namespaces in which $wgNoFollowLinks doesn't apply. | |
const | NoFollowDomainExceptions |
If this is set to an array of domains, external links to these domain names (or any subdomains) will not be set to rel="nofollow" regardless of the value of $wgNoFollowLinks. | |
const | RegisterInternalExternals |
By default MediaWiki does not register links pointing to same server in externallinks dataset, use this value to override: | |
const | AllowDisplayTitle |
Allow DISPLAYTITLE to change title display. | |
const | RestrictDisplayTitle |
For consistency, restrict DISPLAYTITLE to text that normalizes to the same canonical DB key. | |
const | ExpensiveParserFunctionLimit |
Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY. | |
const | PreprocessorCacheThreshold |
Preprocessor caching threshold Setting it to 'false' will disable the preprocessor cache. | |
const | EnableScaryTranscluding |
Enable interwiki transcluding. | |
const | TranscludeCacheExpiry |
Expiry time for transcluded templates cached in object cache. | |
const | EnableMagicLinks |
Enable the magic links feature of automatically turning ISBN xxx, PMID xxx, RFC xxx into links. | |
const | ParserEnableUserLanguage |
Set this to true to allow the {{USERLANGUAGE}} magic word to return the actual user language. | |
Statistics and content analysis | |
const | ArticleCountMethod |
Method used to determine if a page in a content namespace should be counted as a valid article. | |
const | ActiveUserDays |
How many days user must be idle before he is considered inactive. | |
const | LearnerEdits |
The following variables define 3 user experience levels: | |
const | LearnerMemberSince |
Number of days the user must exist before becoming a learner. | |
const | ExperiencedUserEdits |
Number of edits the user must have before becoming "experienced". | |
const | ExperiencedUserMemberSince |
Number of days the user must exist before becoming "experienced". | |
const | ManualRevertSearchRadius |
Maximum number of revisions of a page that will be checked against every new edit made to determine whether the edit was a manual revert. | |
const | RevertedTagMaxDepth |
Maximum depth (revision count) of reverts that will have their reverted edits marked with the mw-reverted change tag. | |
User accounts, authentication | |
const | CentralIdLookupProviders |
Central ID lookup providers Key is the provider ID, value is a specification for ObjectFactory. | |
const | CentralIdLookupProvider |
Central ID lookup provider to use by default. | |
const | UserRegistrationProviders |
User registration timestamp provider classes. | |
const | PasswordPolicy |
Password policy for the wiki. | |
const | AuthManagerConfig |
Configure AuthManager. | |
const | AuthManagerAutoConfig |
const | RememberMe |
Configures RememberMe authentication request added by AuthManager. | |
const | ReauthenticateTime |
Time frame for re-authentication. | |
const | AllowSecuritySensitiveOperationIfCannotReauthenticate |
Whether to allow security-sensitive operations when re-authentication is not possible. | |
const | ChangeCredentialsBlacklist |
List of AuthenticationRequest class names which are not changeable through Special:ChangeCredentials and the changeauthenticationdata API. | |
const | RemoveCredentialsBlacklist |
List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata API. | |
const | InvalidPasswordReset |
Specifies if users should be sent to a password-reset form on login, if their password doesn't meet the requirements of User::isValidPassword(). | |
const | PasswordDefault |
Default password type to use when hashing user passwords. | |
const | PasswordConfig |
Configuration for built-in password types. | |
const | PasswordResetRoutes |
Whether to allow password resets ("enter some identifying data, and we'll send an email
with a temporary password you can use to get back into the account") identified by various bits of data. | |
const | MaxSigChars |
Maximum number of Unicode characters in signature. | |
const | SignatureValidation |
Behavior of signature validation. | |
const | SignatureAllowedLintErrors |
List of lint error codes which don't cause signature validation to fail. | |
const | MaxNameChars |
Maximum number of bytes in username. | |
const | ReservedUsernames |
Array of usernames which may not be registered or logged in from Maintenance scripts can still use these. | |
const | DefaultUserOptions |
Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts. | |
const | ConditionalUserOptions |
Conditional defaults for user options. | |
const | HiddenPrefs |
An array of preferences to not show for the user. | |
const | InvalidUsernameCharacters |
Characters to prevent during new account creations. | |
const | UserrightsInterwikiDelimiter |
Character used as a delimiter when testing for interwiki userrights (In Special:UserRights, it is possible to modify users on different databases if the delimiter is used, e.g. | |
const | SecureLogin |
This is to let user authenticate using https when they come from http. | |
const | AuthenticationTokenVersion |
Versioning for authentication tokens. | |
const | SessionProviders |
MediaWiki\Session\SessionProvider configuration. | |
const | AutoCreateTempUser |
Configuration for automatic creation of temporary accounts on page save. | |
User rights, access control and monitoring | |
const | AutoblockExpiry |
Number of seconds before autoblock entries expire. | |
const | BlockAllowsUTEdit |
Set this to true to allow blocked users to edit their own user talk page. | |
const | BlockCIDRLimit |
Limits on the possible sizes of range blocks. | |
const | BlockDisablesLogin |
If true, sitewide blocked users will not be allowed to login. | |
const | EnablePartialActionBlocks |
Flag to enable partial blocks against performing certain actions. | |
const | EnableMultiBlocks |
If this is false, the number of blocks of a given target is limited to only 1. | |
const | BlockTargetMigrationStage |
Ipblocks table schema migration stage, for normalizing ipb_address field and adding the block_target table. | |
const | WhitelistRead |
Pages anonymous user may see, set as an array of pages titles. | |
const | WhitelistReadRegexp |
Pages anonymous user may see, set as an array of regular expressions. | |
const | EmailConfirmToEdit |
Should editors be required to have a validated e-mail address before being allowed to edit? | |
const | HideIdentifiableRedirects |
Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public. | |
const | GroupPermissions |
Permission keys given to users in each group. | |
const | PrivilegedGroups |
List of groups which should be considered privileged (user accounts belonging in these groups can be abused in dangerous ways). | |
const | RevokePermissions |
Permission keys revoked from users in each group. | |
const | GroupInheritsPermissions |
Groups that should inherit permissions from another group. | |
const | ImplicitGroups |
Implicit groups, aren't shown on Special:Listusers or somewhere else. | |
const | GroupsAddToSelf |
A map of group names that the user is in, to group names that those users are allowed to add or revoke. | |
const | GroupsRemoveFromSelf |
const | RestrictionTypes |
Set of available actions that can be restricted via action=protect You probably shouldn't change this. | |
const | RestrictionLevels |
Rights which can be required for each protection level (via action=protect) | |
const | CascadingRestrictionLevels |
Restriction levels that can be used with cascading protection. | |
const | SemiprotectedRestrictionLevels |
Restriction levels that should be considered "semiprotected". | |
const | NamespaceProtection |
Set the minimum permissions required to edit pages in each namespace. | |
const | NonincludableNamespaces |
Pages in namespaces in this array can not be used as templates. | |
const | AutoConfirmAge |
Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group membership. | |
const | AutoConfirmCount |
Number of edits an account requires before it is autoconfirmed. | |
const | Autopromote |
Array containing the conditions of automatic promotion of a user to specific groups. | |
const | AutopromoteOnce |
Automatically add a usergroup to any user who matches certain conditions. | |
const | AutopromoteOnceLogInRC |
Put user rights log entries for autopromotion in recent changes? | |
const | AutopromoteOnceRCExcludedGroups |
Defines a denylist of group names. | |
const | AddGroups |
$wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups at Special:Userrights. | |
const | RemoveGroups |
const | AvailableRights |
A list of available rights, in addition to the ones defined by the core. | |
const | ImplicitRights |
A list of implicit rights, in addition to the ones defined by the core. | |
const | DeleteRevisionsLimit |
Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission. | |
const | DeleteRevisionsBatchSize |
Page deletions with > this number of revisions will use the job queue. | |
const | HideUserContribLimit |
The maximum number of edits a user can have and can still be hidden by users with the hideuser permission. | |
const | AccountCreationThrottle |
Number of accounts each IP address may create per specified period(s). | |
const | TempAccountCreationThrottle |
Number of temporary accounts each IP address may create per specified period(s). | |
const | TempAccountNameAcquisitionThrottle |
Number of temporary accounts usernames each IP address may acquire per specified period(s). | |
const | SpamRegex |
Edits matching these regular expressions in body text will be recognised as spam and rejected automatically. | |
const | SummarySpamRegex |
Same as SpamRegex except for edit summaries. | |
const | EnableDnsBlacklist |
Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies. | |
const | DnsBlacklistUrls |
List of DNS blacklists to use, if $wgEnableDnsBlacklist is true. | |
const | ProxyList |
List of banned IP addresses. | |
const | ProxyWhitelist |
Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say. | |
const | SoftBlockRanges |
IP ranges that should be considered soft-blocked (anon-only, account creation allowed). | |
const | ApplyIpBlocksToXff |
Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them. | |
const | RateLimits |
Simple rate limiter options to brake edit floods. | |
const | RateLimitsExcludedIPs |
Array of IPs / CIDR ranges which should be excluded from rate limits. | |
const | PutIPinRC |
Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g. | |
const | QueryPageDefaultLimit |
Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere. | |
const | PasswordAttemptThrottle |
Limit password attempts to X attempts per Y seconds per IP per account. | |
const | GrantPermissions |
Users authorize consumers (like Apps) to act on their behalf but only with a subset of the user's normal account rights (signed off on by the user). | |
const | GrantPermissionGroups |
Grant groups are used on some user interfaces to display conceptually similar grants together. | |
const | GrantRiskGroups |
Group grants by risk level. | |
const | EnableBotPasswords |
const | BotPasswordsCluster |
Cluster for the bot_passwords table. | |
const | BotPasswordsDatabase |
Database name for the bot_passwords table. | |
Security | |
const | SecretKey |
This should always be customised in LocalSettings.php. | |
const | AllowUserJs |
Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load. | |
const | AllowUserCss |
Allow user Cascading Style Sheets (CSS)? This enables a lot of neat customizations, but may increase security risk to users and server load. | |
const | AllowUserCssPrefs |
Allow style-related user-preferences? | |
const | UseSiteJs |
Use the site's Javascript page? | |
const | UseSiteCss |
Use the site's Cascading Style Sheets (CSS)? | |
const | BreakFrames |
Break out of framesets. | |
const | EditPageFrameOptions |
The X-Frame-Options header to send on pages sensitive to clickjacking attacks, such as edit pages. | |
const | ApiFrameOptions |
Disallow framing of API pages directly, by setting the X-Frame-Options header. | |
const | AllowAuthenticatedCrossOrigin |
Allow non-anonymous cross-origin requests to the Action API. | |
const | CSPHeader |
Controls Content-Security-Policy header. | |
const | CSPReportOnlyHeader |
Controls Content-Security-Policy-Report-Only header. | |
const | CSPFalsePositiveUrls |
List of urls which appear often to be triggering CSP reports but do not appear to be caused by actual content, but by client software inserting scripts (i.e. | |
const | AllowCrossOrigin |
Allow anonymous cross origin requests to the REST API. | |
const | RestAllowCrossOriginCookieAuth |
Allows authenticated cross-origin requests to the REST API with session cookies. | |
const | SessionSecret |
Secret for session storage. | |
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 | StatsTarget |
Stats output target URI e.g. | |
const | StatsFormat |
Stats output format. | |
const | StatsPrefix |
Stats service name prefix. | |
const | OpenTelemetryConfig |
Configuration for OpenTelemetry instrumentation, or null to disable it. | |
const | PageInfoTransclusionLimit |
InfoAction retrieves a list of transclusion links (both to and from). | |
const | EnableJavaScriptTest |
Allow running of QUnit tests via [[Special:JavaScriptTest]]. | |
const | CachePrefix |
Overwrite the caching key prefix with custom value. | |
const | DebugToolbar |
Display the new debugging toolbar. | |
Search | |
const | DisableTextSearch |
Set this to true to disable the full text search feature. | |
const | AdvancedSearchHighlighting |
Set to true to have nicer highlighted text in search results, by default off due to execution overhead. | |
const | SearchHighlightBoundaries |
Regexp to match word boundaries, defaults for non-CJK languages should be empty for CJK since the words are not separate. | |
const | OpenSearchTemplates |
Templates for OpenSearch suggestions, defaults to API action=opensearch. | |
const | EnableOpenSearchSuggest |
This was previously a used to force empty responses from ApiOpenSearch with the 'suggest' parameter set. | |
const | OpenSearchDefaultLimit |
Integer defining default number of entries to show on OpenSearch call. | |
const | OpenSearchDescriptionLength |
Minimum length of extract in . | |
const | SearchSuggestCacheExpiry |
Expiry time for search suggestion responses. | |
const | DisableSearchUpdate |
If you've disabled search semi-permanently, this also disables updates to the table. | |
const | NamespacesToBeSearchedDefault |
List of namespaces which are searched by default. | |
const | DisableInternalSearch |
Disable the internal MySQL-based search, to allow it to be implemented by an extension instead. | |
const | SearchForwardUrl |
Set this to a URL to forward search requests to some external location. | |
const | SitemapNamespaces |
Array of namespaces to generate a Google sitemap for when the maintenance/generateSitemap.php script is run, or false if one is to be generated for all namespaces. | |
const | SitemapNamespacesPriorities |
Custom namespace priorities for sitemaps. | |
const | EnableSearchContributorsByIP |
If true, searches for IP addresses will be redirected to that IP's contributions page. | |
const | SpecialSearchFormOptions |
Options for Special:Search completion widget form created by SearchFormWidget class. | |
const | SearchMatchRedirectPreference |
Set true to allow logged-in users to set a preference whether or not matches in search results should force redirection to that page. | |
const | SearchRunSuggestedQuery |
Controls whether zero-result search queries with suggestions should display results for these suggestions. | |
Edit user interface | |
const | Diff3 |
Path to the GNU diff3 utility. | |
const | Diff |
Path to the GNU diff utility. | |
const | PreviewOnOpenNamespaces |
Which namespaces have special treatment where they should be preview-on-open Internally only Category: pages apply, but using this extensions (e.g. | |
const | UniversalEditButton |
Enable the UniversalEditButton for browsers that support it (currently only Firefox with an extension) See http://universaleditbutton.org for more background information. | |
const | UseAutomaticEditSummaries |
If user doesn't specify any edit summary when making a an edit, MediaWiki will try to automatically create one. | |
Recent changes, new pages, watchlist and history | |
const | RCMaxAge |
Recentchanges items are periodically purged; entries older than this many seconds will go. | |
const | WatchersMaxAge |
Page watchers inactive for more than this many seconds are considered inactive. | |
const | UnwatchedPageSecret |
If active watchers (per above) are this number or less, do not disclose it. | |
const | RCFilterByAge |
Filter $wgRCLinkDays by $wgRCMaxAge to avoid showing links for numbers higher than what will be stored. | |
const | RCLinkLimits |
List of Limits options to list in the Special:Recentchanges and Special:Recentchangeslinked pages. | |
const | RCLinkDays |
List of Days options to list in the Special:Recentchanges and Special:Recentchangeslinked pages. | |
const | RCFeeds |
Configuration for feeds to which notifications about recent changes will be sent. | |
const | RCEngines |
Used by RecentChange::getEngine to find the correct engine for a given URI scheme. | |
const | RCWatchCategoryMembership |
Treat category membership changes as a RecentChange. | |
const | UseRCPatrol |
Use RC Patrolling to check for vandalism (from recent changes and watchlists) New pages and new files are included. | |
const | StructuredChangeFiltersLiveUpdatePollingRate |
Polling rate, in seconds, used by the 'live update' and 'view newest' features of the RCFilters app on SpecialRecentChanges and Special:Watchlist. | |
const | UseNPPatrol |
Use new page patrolling to check new pages on Special:Newpages. | |
const | UseFilePatrol |
Use file patrolling to check new files on Special:Newfiles. | |
const | Feed |
Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages. | |
const | FeedLimit |
Set maximum number of results to return in syndication feeds (RSS, Atom) for eg Recentchanges, Newpages. | |
const | FeedCacheTimeout |
Minimum timeout for cached Recentchanges feed, in seconds. | |
const | FeedDiffCutoff |
When generating Recentchanges RSS/Atom feed, diffs will not be generated for pages larger than this size. | |
const | OverrideSiteFeed |
Override the site's default RSS/ATOM feed for recentchanges that appears on every page. | |
const | FeedClasses |
Available feeds objects. | |
const | AdvertisedFeedTypes |
Which feed types should we provide by default? This can include 'rss', 'atom', neither, or both. | |
const | RCShowWatchingUsers |
Show watching users in recent changes, watchlist and page history views. | |
const | RCShowChangedSize |
Show the amount of changed characters in recent changes. | |
const | RCChangedSizeThreshold |
If the difference between the character counts of the text before and after the edit is below that value, the value will be highlighted on the RC page. | |
const | ShowUpdatedMarker |
Show "Updated (since my last visit)" marker in RC view, watchlist and history view for watched pages with new changes. | |
const | DisableAnonTalk |
Disable links to talk pages of anonymous users (IPs) in listings on special pages like page history, Special:Recentchanges, etc. | |
const | UseTagFilter |
Allow filtering by change tag in recentchanges, history, etc Has no effect if no tags are defined. | |
const | SoftwareTags |
List of core tags to enable. | |
const | UnwatchedPageThreshold |
If set to an integer, pages that are watched by this many users or more will not require the unwatchedpages permission to view the number of watchers. | |
const | RecentChangesFlags |
Flags (letter symbols) shown in recent changes and watchlist to indicate certain types of edits. | |
const | WatchlistExpiry |
Whether to enable the watchlist expiry feature. | |
const | WatchlistPurgeRate |
Chance of expired watchlist items being purged on any page edit. | |
const | WatchlistExpiryMaxDuration |
Relative maximum duration for watchlist expiries, as accepted by strtotime(). | |
Copyright and credits settings | |
const | RightsPage |
Override for copyright metadata. | |
const | RightsUrl |
Set this to specify an external URL containing details about the content license used on your wiki. | |
const | RightsText |
If either $wgRightsUrl or $wgRightsPage is specified then this variable gives the text for the link. | |
const | RightsIcon |
Override for copyright metadata. | |
const | UseCopyrightUpload |
Set this to true if you want detailed copyright information forms on Upload. | |
const | MaxCredits |
Set this to the number of authors that you want to be credited below an article text. | |
const | ShowCreditsIfMax |
If there are more than $wgMaxCredits authors, show $wgMaxCredits of them. | |
Import / Export | |
const | ImportSources |
List of interwiki prefixes for wikis we'll accept as sources for Special:Import and API action=import. | |
const | ImportTargetNamespace |
Optional default target namespace for interwiki imports. | |
const | ExportAllowHistory |
If set to false, disables the full-history option on Special:Export. | |
const | ExportMaxHistory |
If set nonzero, Special:Export requests for history of pages with more revisions than this will be rejected. | |
const | ExportAllowListContributors |
Return distinct author list (when not returning full history) | |
const | ExportMaxLinkDepth |
If non-zero, Special:Export accepts a "pagelink-depth" parameter up to this specified level, which will cause it to include all pages linked to from the pages you specify. | |
const | ExportFromNamespaces |
Whether to allow the "export all pages in namespace" option. | |
const | ExportAllowAll |
Whether to allow exporting the entire wiki into a single file. | |
const | ExportPagelistLimit |
Maximum number of pages returned by the GetPagesFromCategory and GetPagesFromNamespace functions. | |
const | XmlDumpSchemaVersion |
The schema to use by default when generating XML dumps. | |
Wiki Farm | |
const | WikiFarmSettingsDirectory |
A directory that contains site-specific configuration files. | |
const | WikiFarmSettingsExtension |
The file extension to be used when looking up site-specific settings files in $wgWikiFarmSettingsDirectory, such as 'json' or 'yaml'. | |
Extensions | |
const | ExtensionFunctions |
A list of callback functions which are called once MediaWiki is fully initialised. | |
const | ExtensionMessagesFiles |
Extension messages files. | |
const | MessagesDirs |
Extension messages directories. | |
const | TranslationAliasesDirs |
Message directories containing JSON files for localisation of special page aliases. | |
const | ExtensionEntryPointListFiles |
Array of files with list(s) of extension entry points to be used in maintenance/mergeMessageFileList.php. | |
const | EnableParserLimitReporting |
Whether to include the NewPP limit report as a HTML comment. | |
const | ValidSkinNames |
List of valid skin names. | |
const | SpecialPages |
Special page list. | |
const | AutoloadAttemptLowercase |
Obsolete switch that controlled legacy case-insensitive classloading. | |
const | ExtensionCredits |
Add information about an installed extension, keyed by its type. | |
const | Hooks |
Global list of hooks. | |
const | ServiceWiringFiles |
List of service wiring files to be loaded by the default instance of MediaWikiServices. | |
const | JobClasses |
Maps jobs to their handlers; extensions can add to this to provide custom jobs. | |
const | JobTypesExcludedFromDefaultQueue |
Jobs that must be explicitly requested, i.e. | |
const | JobBackoffThrottling |
Map of job types to how many job "work items" should be run per second on each job runner process. | |
const | JobTypeConf |
Map of job types to configuration arrays. | |
const | JobQueueIncludeInMaxLagFactor |
Whether to include the number of jobs that are queued for the API's maxlag parameter. | |
const | SpecialPageCacheUpdates |
Additional functions to be performed with updateSpecialPages. | |
const | PagePropLinkInvalidations |
Page property link table invalidation lists. | |
Categories | |
const | CategoryMagicGallery |
On category pages, show thumbnail gallery for images belonging to that category instead of listing them as articles. | |
const | CategoryPagingLimit |
Paging limit for categories. | |
const | CategoryCollation |
Specify how category names should be sorted, when listed on a category page. | |
const | TempCategoryCollations |
Additional category collations to store during LinksUpdate. | |
const | SortedCategories |
Whether to sort categories in OutputPage for display. | |
const | TrackingCategories |
Array holding default tracking category names. | |
Logging | |
const | LogTypes |
The logging system has two levels: an event type, which describes the general category and can be viewed as a named subset of all logs; and an action, which is a specific kind of event that can exist in that log type. | |
const | LogRestrictions |
This restricts log access to those who have a certain right Users without this will not see it in the option menu and can not view it Restricted logs are not added to recent changes Logs should remain non-transcludable Format: logtype => permissiontype. | |
const | FilterLogTypes |
Show/hide links on Special:Log will be shown for these log types. | |
const | LogNames |
Lists the message key string for each log type. | |
const | LogHeaders |
Lists the message key string for descriptive text to be shown at the top of each log type. | |
const | LogActions |
Maps log actions to message keys, for formatting log entries of each type and action when displaying logs to the user. | |
const | LogActionsHandlers |
The same as above, but here values are class names or ObjectFactory specifications, not messages. | |
const | ActionFilteredLogs |
List of log types that can be filtered by action types. | |
const | NewUserLog |
Maintain a log of newusers at Special:Log/newusers? | |
const | PageCreationLog |
Maintain a log of page creations at Special:Log/create? | |
Special pages (general and miscellaneous) | |
const | AllowSpecialInclusion |
Allow special page inclusions such as {{Special:Allpages}}. | |
const | DisableQueryPageUpdate |
Set this to an array of special page names to prevent maintenance/updateSpecialPages.php from updating those pages. | |
const | CountCategorizedImagesAsUsed |
On Special:Unusedimages, consider images "used", if they are put into a category. | |
const | MaxRedirectLinksRetrieved |
Maximum number of links to a redirect page listed on Special:Whatlinkshere/RedirectDestination. | |
const | RangeContributionsCIDRLimit |
Shortest CIDR limits that can be checked in any individual range check at Special:Contributions. | |
Actions | |
const | Actions |
Map of allowed values for the "title=foo&action=<action>" parameter. | |
Robot (search engine crawler) policy | |
const | DefaultRobotPolicy |
Default robot policy. | |
const | NamespaceRobotPolicies |
Robot policies per namespaces. | |
const | ArticleRobotPolicies |
Robot policies per article. | |
const | ExemptFromUserRobotsControl |
An array of namespace keys in which the INDEX/__NOINDEX__ magic words will not function, so users can't decide whether pages in that namespace are indexed by search engines. | |
Action API and REST API | |
const | DebugAPI |
WARNING: SECURITY THREAT - debug use only. | |
const | APIModules |
API module extensions. | |
const | APIFormatModules |
API format module extensions. | |
const | APIMetaModules |
API Query meta module extensions. | |
const | APIPropModules |
API Query prop module extensions. | |
const | APIListModules |
API Query list module extensions. | |
const | APIMaxDBRows |
Maximum amount of rows to scan in a DB query in the API The default value is generally fine. | |
const | APIMaxResultSize |
The maximum size (in bytes) of an API result. | |
const | APIMaxUncachedDiffs |
The maximum number of uncached diffs that can be retrieved in one API request. | |
const | APIMaxLagThreshold |
Maximum amount of DB lag on a majority of DB replica DBs to tolerate before forcing bots to retry any write requests via API errors. | |
const | APIRequestLog |
Log file or URL (TCP or UDP) to log API requests to, or false to disable API request logging. | |
const | APICacheHelpTimeout |
Set the timeout for the API help text cache. | |
const | APIUselessQueryPages |
The ApiQueryQueryPages module should skip pages that are redundant to true API queries. | |
const | AjaxLicensePreview |
Enable previewing licences via AJAX. | |
const | CrossSiteAJAXdomains |
Settings for incoming cross-site AJAX requests: Newer browsers support cross-site AJAX when the target resource allows requests from the origin domain by the Access-Control-Allow-Origin header. | |
const | CrossSiteAJAXdomainExceptions |
Domains that should not be allowed to make AJAX requests, even if they match one of the domains allowed by $wgCrossSiteAJAXdomains Uses the same syntax as $wgCrossSiteAJAXdomains. | |
const | AllowedCorsHeaders |
List of allowed headers for cross-origin API requests. | |
const | RestAPIAdditionalRouteFiles |
Additional REST API Route files. | |
const | RestSandboxSpecs |
A list of OpenAPI specs to be made available for exploration on Special:RestSandbox. | |
Shell and process control | |
const | MaxShellMemory |
Maximum amount of virtual memory available to shell processes under linux, in KiB. | |
const | MaxShellFileSize |
Maximum file size created by shell processes under linux, in KiB ImageMagick convert for example can be fairly hungry for scratch space. | |
const | MaxShellTime |
Maximum CPU time in seconds for shell processes under Linux. | |
const | MaxShellWallClockTime |
Maximum wall clock time (i.e. | |
const | ShellCgroup |
Under Linux: a cgroup directory used to constrain memory usage of shell commands. | |
const | PhpCli |
Executable path of the PHP cli binary. | |
const | ShellRestrictionMethod |
Method to use to restrict shell commands. | |
const | ShellboxUrls |
Shell commands can be run on a remote server using Shellbox. | |
const | ShellboxSecretKey |
The secret key for HMAC verification of Shellbox requests. | |
const | ShellboxShell |
The POSIX-compatible shell to use when running scripts. | |
HTTP client | |
const | HTTPTimeout |
Timeout for HTTP requests done internally, in seconds. | |
const | HTTPConnectTimeout |
Timeout for connections done internally (in seconds). | |
const | HTTPMaxTimeout |
The maximum HTTP request timeout in seconds. | |
const | HTTPMaxConnectTimeout |
The maximum HTTP connect timeout in seconds. | |
const | HTTPImportTimeout |
Timeout for HTTP requests done internally for transwiki imports, in seconds. | |
const | AsyncHTTPTimeout |
Timeout for Asynchronous (background) HTTP requests, in seconds. | |
const | HTTPProxy |
Proxy to use for CURL requests. | |
const | LocalVirtualHosts |
A list of URL domains that will be routed to the proxy specified by $wgLocalHTTPProxy. | |
const | LocalHTTPProxy |
Proxy to use for requests to domains in $wgLocalVirtualHosts. | |
const | AllowExternalReqID |
Whether to respect/honour. | |
Job queue | |
const | JobRunRate |
Number of jobs to perform per request. | |
const | RunJobsAsync |
When $wgJobRunRate > 0, try to run jobs asynchronously, spawning a new process to handle the job execution, instead of blocking the request until the job execution finishes. | |
const | UpdateRowsPerJob |
Number of rows to update per job. | |
const | UpdateRowsPerQuery |
Number of rows to update per query. | |
Miscellaneous | |
const | RedirectOnLogin |
Allow redirection to another page when a user logs in. | |
const | VirtualRestConfig |
Global configuration variable for Virtual REST Services. | |
const | EventRelayerConfig |
Mapping of event channels (or channel categories) to EventRelayer configuration. | |
const | Pingback |
Share data about this installation with MediaWiki developers. | |
const | OriginTrials |
Origin Trials tokens. | |
const | ReportToExpiry |
Expiry of the endpoint definition for the Reporting API. | |
const | ReportToEndpoints |
List of endpoints for the Reporting API. | |
const | FeaturePolicyReportOnly |
List of Feature Policy Reporting types to enable. | |
const | SkinsPreferred |
List of preferred skins to be listed higher in Special:Preferences. | |
const | SpecialContributeSkinsEnabled |
List of skins that show a link to the Special:Contribute page. | |
const | EnableEditRecovery |
Whether to enable the client-side edit recovery feature. | |
const | EditRecoveryExpiry |
Number of seconds to keep edit recovery data after the edit is stored. | |
const | UseCodexSpecialBlock |
Whether to use Codex in Special:Block form. | |
const | ShowLogoutConfirmation |
Whether to display a confirmation screen during user log out. | |
const | EnableProtectionIndicators |
Whether to show indicators on a page when it is protected. | |
const | OutputPipelineStages |
OutputPipelineStages to add to the DefaultOutputPipeline. | |
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. | |
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 | ArticlePath |
The URL path for primary article page views. | |
const | UploadPath |
The URL path for the images directory. | |
const | ImgAuthPath |
The base path for img_auth.php. | |
const | ThumbPath |
The base path for thumb_handler.php. | |
const | UploadDirectory |
The filesystem path of the images directory. | |
const | FileCacheDirectory |
Directory where the cached page will be saved. | |
const | Logo |
The URL path of the wiki logo. | |
const | Logos |
Specification for different versions of the wiki logo. | |
const | Favicon |
The URL path of the icon. | |
const | AppleTouchIcon |
The URL path of the icon for iPhone and iPod Touch web app bookmarks. | |
const | ReferrerPolicy |
Value for the referrer policy meta tag. | |
const | TmpDirectory |
The local filesystem path to a temporary directory. | |
const | UploadBaseUrl |
If set, this URL is added to the start of $wgUploadPath to form a complete upload URL. | |
const | UploadStashScalerBaseUrl |
To enable remote on-demand scaling, set this to the thumbnail base URL. | |
const | ActionPaths |
To set 'pretty' URL paths for actions other than plain page views, add to this array. | |
const | MainPageIsDomainRoot |
When enabled, the domain root will show the wiki's main page, instead of redirecting to the main page. | |
static | getDefaultUsePathInfo () |
URL of the server. | |
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 | getDefaultFileCacheDirectory ( $uploadDirectory) |
static | getDefaultLogo ( $resourceBasePath) |
Files and file uploads | |
const | EnableUploads |
Allow users to upload files. | |
const | UploadStashMaxAge |
The maximum age of temporary (incomplete) uploaded files. | |
const | EnableAsyncUploads |
Enable deferred upload tasks that use the job queue. | |
const | EnableAsyncUploadsByURL |
Enable the async processing of upload by url in Special:Upload. | |
const | UploadMaintenance |
To disable file delete/restore temporarily. | |
const | IllegalFileChars |
Additional characters that are not allowed in filenames. | |
const | DeletedDirectory |
What directory to place deleted uploads in. | |
const | ImgAuthDetails |
Set this to true if you use img_auth and want the user to see details on why access failed. | |
const | ImgAuthUrlPathMap |
Map of relative URL directories to match to internal mwstore:// base storage paths. | |
const | LocalFileRepo |
File repository structures. | |
const | ForeignFileRepos |
Enable the use of files from one or more other wikis. | |
const | UseInstantCommons |
Use Wikimedia Commons as a foreign file repository. | |
const | UseSharedUploads |
Shortcut for adding an entry to $wgForeignFileRepos. | |
const | SharedUploadDirectory |
Shortcut for the 'directory' setting of $wgForeignFileRepos. | |
const | SharedUploadPath |
Shortcut for the 'url' setting of $wgForeignFileRepos. | |
const | HashedSharedUploadDirectory |
Shortcut for the 'hashLevels' setting of $wgForeignFileRepos. | |
const | RepositoryBaseUrl |
Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos. | |
const | FetchCommonsDescriptions |
Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos. | |
const | SharedUploadDBname |
Shortcut for the ForeignDBRepo 'dbName' setting in $wgForeignFileRepos. | |
const | SharedUploadDBprefix |
Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos. | |
const | CacheSharedUploads |
Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos. | |
const | ForeignUploadTargets |
Array of foreign file repo names (set in $wgForeignFileRepos above) that are allowable upload targets. | |
const | UploadDialog |
Configuration for file uploads using the embeddable upload dialog (https://www.mediawiki.org/wiki/Upload_dialog). | |
const | FileBackends |
File backend structure configuration. | |
const | LockManagers |
List of lock manager backend configurations. | |
const | ShowEXIF |
Whether to show Exif data. | |
const | UpdateCompatibleMetadata |
Shortcut for the 'updateCompatibleMetadata' setting of $wgLocalFileRepo. | |
const | AllowCopyUploads |
Allow for upload to be copied from an URL. | |
const | CopyUploadsDomains |
A list of domains copy uploads can come from. | |
const | CopyUploadsFromSpecialUpload |
Enable copy uploads from Special:Upload. | |
const | CopyUploadProxy |
Proxy to use for copy upload requests. | |
const | CopyUploadTimeout |
Different timeout for upload by url This could be useful since when fetching large files, you may want a timeout longer than the default $wgHTTPTimeout. | |
const | CopyUploadAllowOnWikiDomainConfig |
If true, the value of $wgCopyUploadsDomains will be merged with the contents of MediaWiki:Copyupload-allowed-domains. | |
const | MaxUploadSize |
Max size for uploads, in bytes. | |
const | MinUploadChunkSize |
Minimum upload chunk size, in bytes. | |
const | UploadNavigationUrl |
Point the upload navigation link to an external URL Useful if you want to use a shared repository by default without disabling local uploads (use $wgEnableUploads = false for that). | |
const | UploadMissingFileUrl |
Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl. | |
const | ThumbnailScriptPath |
Give a path here to use thumb.php for thumbnail generation on client request, instead of generating them on render and outputting a static URL. | |
const | SharedThumbnailScriptPath |
Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos. | |
const | HashedUploadDirectory |
Shortcut for setting hashLevels=2 in $wgLocalFileRepo. | |
const | FileExtensions |
This is the list of preferred extensions for uploading files. | |
const | ProhibitedFileExtensions |
Files with these extensions will never be allowed as uploads. | |
const | MimeTypeExclusions |
Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled. | |
const | CheckFileExtensions |
This is a flag to determine whether or not to check file extensions on upload. | |
const | StrictFileExtensions |
If this is turned off, users may override the warning for files not covered by $wgFileExtensions. | |
const | DisableUploadScriptChecks |
Setting this to true will disable the upload system's checks for HTML/JavaScript. | |
const | UploadSizeWarning |
Warn if uploaded files are larger than this (in bytes), or false to disable. | |
const | TrustedMediaFormats |
list of trusted media-types and MIME types. | |
const | MediaHandlers |
Plugins for media file type handling. | |
const | NativeImageLazyLoading |
Toggles native image lazy loading, via the "loading" attribute. | |
const | ParserTestMediaHandlers |
Media handler overrides for parser tests (they don't need to generate actual thumbnails, so a mock will do) | |
const | UseImageResize |
Whether to enable server-side image thumbnailing. | |
const | UseImageMagick |
Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party converter, e.g. | |
const | ImageMagickConvertCommand |
The convert command shipped with ImageMagick. | |
const | MaxInterlacingAreas |
Array of max pixel areas for interlacing per MIME type. | |
const | SharpenParameter |
Sharpening parameter to ImageMagick. | |
const | SharpenReductionThreshold |
Reduction in linear dimensions below which sharpening will be enabled. | |
const | ImageMagickTempDir |
Temporary directory used for ImageMagick. | |
const | CustomConvertCommand |
Use another resizing converter, e.g. | |
const | JpegTran |
used for lossless jpeg rotation | |
const | JpegPixelFormat |
At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma subsampling to reduce file size, at the cost of possible color fringing at sharp edges. | |
const | JpegQuality |
When scaling a JPEG thumbnail, this is the quality we request from the backend. | |
const | Exiv2Command |
Some tests and extensions use exiv2 to manipulate the Exif metadata in some image formats. | |
const | Exiftool |
Path to exiftool binary. | |
const | SVGConverters |
Scalable Vector Graphics (SVG) may be uploaded as images. | |
const | SVGConverter |
Pick a converter defined in $wgSVGConverters. | |
const | SVGConverterPath |
If not in the executable PATH, specify the SVG converter path. | |
const | SVGMaxSize |
Don't scale a SVG larger than this. | |
const | SVGMetadataCutoff |
Don't read SVG metadata beyond this point. | |
const | SVGNativeRendering |
Whether native rendering by the browser agent is allowed. | |
const | SVGNativeRenderingSizeLimit |
Filesize limit for allowing SVGs to render natively by the browser agent. | |
const | MediaInTargetLanguage |
Whether thumbnails should be generated in target language (usually, same as page language), if available. | |
const | MaxImageArea |
The maximum number of pixels a source image can have if it is to be scaled down by a scaler that requires the full source image to be decompressed and stored in decompressed form, before the thumbnail is generated. | |
const | MaxAnimatedGifArea |
Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnail. | |
const | TiffThumbnailType |
Browsers don't support TIFF inline generally... For inline display, we need to convert to PNG or JPEG. | |
const | ThumbnailEpoch |
If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if the file didn't already exist. | |
const | AttemptFailureEpoch |
Certain operations are avoided if there were too many recent failures, for example, thumbnail generation. | |
const | IgnoreImageErrors |
If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an error message. | |
const | GenerateThumbnailOnParse |
Render thumbnails while parsing wikitext. | |
const | ShowArchiveThumbnails |
Show thumbnails for old images on the image description page. | |
const | EnableAutoRotation |
If set to true, images that contain certain the exif orientation tag will be rotated accordingly. | |
const | Antivirus |
Internal name of virus scanner. | |
const | AntivirusSetup |
Configuration for different virus scanners. | |
const | AntivirusRequired |
Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected. | |
const | VerifyMimeType |
Determines if the MIME type of uploaded files should be checked. | |
const | MimeTypeFile |
Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php. | |
const | MimeInfoFile |
Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php. | |
const | MimeDetectorCommand |
Sets an external MIME detector program. | |
const | TrivialMimeDetection |
Switch for trivial MIME detection. | |
const | XMLMimeTypes |
Additional XML types we can allow via MIME-detection. | |
const | ImageLimits |
Limit images on image description pages to a user-selectable limit. | |
const | ThumbLimits |
Adjust thumbnails on image pages according to a user setting. | |
const | ThumbnailNamespaces |
Defines what namespaces thumbnails will be displayed for in Special:Search. | |
const | ThumbnailBuckets |
When defined, is an array of image widths used as buckets for thumbnail generation. | |
const | ThumbnailMinimumBucketDistance |
When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size. | |
const | UploadThumbnailRenderMap |
When defined, is an array of thumbnail widths to be rendered at upload time. | |
const | UploadThumbnailRenderMethod |
The method through which the thumbnails will be prerendered for the entries in $wgUploadThumbnailRenderMap. | |
const | UploadThumbnailRenderHttpCustomHost |
When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header. | |
const | UploadThumbnailRenderHttpCustomDomain |
When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to. | |
const | UseTinyRGBForJPGThumbnails |
When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight (and free) TinyRGB profile when generating thumbnails. | |
const | GalleryOptions |
Parameters for the "<gallery>" tag. | |
const | ThumbUpright |
Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright images without the need to fix the width by hardcoded px in wiki sourcecode. | |
const | DirectoryMode |
Default value for chmod-ing of new directories. | |
const | ResponsiveImages |
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities. | |
const | ImagePreconnect |
Add a preconnect link for browsers to a remote FileRepo host. | |
static | getDefaultDeletedDirectory ( $uploadDirectory) |
static | getDefaultLocalFileRepo ( $uploadDirectory, $scriptPath, $favicon, $uploadBaseUrl, $uploadPath, $hashedUploadDirectory, $thumbnailScriptPath, $generateThumbnailOnParse, $deletedDirectory, $updateCompatibleMetadata) |
Allow users to upload files. | |
static | getDefaultShowEXIF () |
Allow users to upload files. | |
Database settings | |
const | DBname |
Current wiki database name. | |
const | DBmwschema |
Current wiki database schema name. | |
const | DBprefix |
Current wiki database table name prefix. | |
const | DBserver |
Database host name or IP address. | |
const | DBport |
Database port number. | |
const | DBuser |
Database username. | |
const | DBpassword |
Database user's password. | |
const | DBtype |
Database type. | |
const | DBssl |
Whether to use SSL in DB connection. | |
const | DBcompress |
Whether to use compression in DB connection. | |
const | DBStrictWarnings |
Check for warnings after DB queries and throw an exception if an unacceptable warning is detected. | |
const | DBadminuser |
Separate username for maintenance tasks. | |
const | DBadminpassword |
Separate password for maintenance tasks. | |
const | SearchType |
Search type. | |
const | SearchTypeAlternatives |
Alternative search types. | |
const | DBTableOptions |
MySQL table options to use during installation or update. | |
const | SQLMode |
SQL Mode - default is turning off all modes, including strict, if set. | |
const | DBDefaultGroup |
Default group to use when getting database connections. | |
const | SQLiteDataDir |
To override default SQLite data directory ($docroot/../data) | |
const | SharedDB |
Shared database for multiple wikis. | |
const | SharedPrefix |
const | SharedTables |
const | SharedSchema |
const | DBservers |
Database load balancer This is a two-dimensional array, a list of server info structures Fields are: | |
const | LBFactoryConf |
Configuration for the ILBFactory service. | |
const | DataCenterUpdateStickTTL |
After a state-changing request is done by a client, this determines how many seconds that client should keep using the primary datacenter. | |
const | DBerrorLog |
File to log database errors to. | |
const | DBerrorLogTZ |
Timezone to use in the error log. | |
const | LocalDatabases |
Other wikis on this site, can be administered from a single developer account. | |
const | DatabaseReplicaLagWarning |
If lag is higher than $wgDatabaseReplicaLagWarning, show a warning in some special pages (like watchlist). | |
const | DatabaseReplicaLagCritical |
const | MaxExecutionTimeForExpensiveQueries |
Max execution time for queries of several expensive special pages such as RecentChanges in milliseconds. | |
const | VirtualDomainsMapping |
Mapping of virtual domain to external cluster db. | |
const | PageLinksSchemaMigrationStage |
Pagelinks table schema migration stage, for normalizing pl_namespace and pl_title fields. | |
const | FileSchemaMigrationStage |
Migration stage for file tables. | |
const | CategoryLinksSchemaMigrationStage |
Migration stage for categorylinks tables. | |
const | ExternalLinksDomainGaps |
Gaps in the externallinks table for certain domains. | |
static | getDefaultSharedPrefix ( $dbPrefix) |
static | getDefaultSharedSchema ( $dbMwschema) |
static | getDefaultDBerrorLogTZ ( $localtimezone) |
Current wiki database name. | |
Language, regional and character encoding settings | |
const | LanguageCode |
Site language code. | |
const | GrammarForms |
Some languages need different word forms, usually for different cases. | |
const | InterwikiMagic |
Treat language links as magic connectors, not inline links. | |
const | HideInterlanguageLinks |
Hide interlanguage links from the sidebar. | |
const | ExtraInterlanguageLinkPrefixes |
List of additional interwiki prefixes that should be treated as interlanguage links (i.e. | |
const | InterlanguageLinkCodeMap |
Map of interlanguage link codes to language codes. | |
const | ExtraLanguageNames |
List of language names or overrides for default names in Names.php. | |
const | ExtraLanguageCodes |
List of mappings from one language code to another. | |
const | DummyLanguageCodes |
Functionally the same as $wgExtraLanguageCodes, but deprecated. | |
const | AllUnicodeFixes |
Set this to always convert certain Unicode sequences to modern ones regardless of the content language. | |
const | LegacyEncoding |
Set this to eg 'ISO-8859-1' to perform character set conversion when loading old revisions not marked with "utf-8" flag. | |
const | AmericanDates |
Enable dates like 'May 12' instead of '12 May', if the default date format is 'dmy or mdy'. | |
const | TranslateNumerals |
For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface. | |
const | UseDatabaseMessages |
Translation using MediaWiki: namespace. | |
const | MaxMsgCacheEntrySize |
Maximum entry size in the message cache, in bytes. | |
const | DisableLangConversion |
Whether to enable language variant conversion. | |
const | DisableTitleConversion |
Whether to enable language variant conversion for links. | |
const | DefaultLanguageVariant |
Default variant code. | |
const | UsePigLatinVariant |
Whether to enable the pig Latin variant of English (en-x-piglatin), used to ease variant development work. | |
const | DisabledVariants |
Disabled variants array of language variant conversion. | |
const | VariantArticlePath |
Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which parts of the URL contain the language variant. | |
const | UseXssLanguage |
Whether to enable the 'x-xss' language code, used for development. | |
const | LoginLanguageSelector |
Show a bar of language selection links in the user login and user registration forms; edit the "loginlanguagelinks" message to customise these. | |
const | ForceUIMsgAsContentMsg |
When translating messages with wfMessage(), it is not always clear what should be considered UI messages and what should be content messages. | |
const | RawHtmlMessages |
List of messages which might contain raw HTML. | |
const | AllowRawHtmlCopyrightMessages |
Whether on-wiki overrides for the 'copyright' and 'history_copyright' messages, which allow raw HTML, will be used. | |
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 | ResourceLoaderDebug |
The default debug mode (on/off) for of ResourceLoader requests. | |
const | ResourceLoaderMaxQueryLength |
ResourceLoader will not generate URLs whose query string is more than this many characters long, and will instead use multiple requests with shorter query strings. | |
const | ResourceLoaderValidateJS |
Validate JavaScript code loaded from wiki pages. | |
const | ResourceLoaderEnableJSProfiler |
When enabled, execution of JavaScript modules is profiled client-side. | |
const | ResourceLoaderStorageEnabled |
Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API. | |
const | ResourceLoaderStorageVersion |
Cache version for client-side ResourceLoader module storage. | |
const | ResourceLoaderEnableSourceMapLinks |
Whether to include a SourceMap header in ResourceLoader responses for JavaScript modules. | |
const | AllowSiteCSSOnRestrictedPages |
Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on restricted pages like Special:UserLogin or Special:Preferences where JavaScript is disabled for security reasons. | |
const | VueDevelopmentMode |
Whether to use the development version of Vue.js. | |
const | CodexDevelopmentDir |
If this is set, MediaWiki will look for Codex files in this directory instead of in resources/lib/codex/ and friends. | |
static | getDefaultResourceBasePath ( $scriptPath) |
Page titles and redirects | |
const | MetaNamespace |
Name of the project namespace. | |
const | MetaNamespaceTalk |
Name of the project talk namespace. | |
const | CanonicalNamespaceNames |
Canonical namespace names. | |
const | ExtraNamespaces |
Additional namespaces. | |
const | ExtraGenderNamespaces |
Same as above, but for namespaces with gender distinction. | |
const | NamespaceAliases |
Define extra namespace aliases. | |
const | LegalTitleChars |
Allowed title characters – regex character class Don't change this unless you know what you're doing. | |
const | CapitalLinks |
Set this to false to avoid forcing the first letter of links to capitals. | |
const | CapitalLinkOverrides |
const | NamespacesWithSubpages |
Which namespaces should support subpages? See Language.php for a list of namespaces. | |
const | ContentNamespaces |
Array of namespaces which can be deemed to contain valid "content", as far as the site statistics are concerned. | |
const | ShortPagesNamespaceExclusions |
Optional array of namespaces which should be excluded from Special:ShortPages. | |
const | ExtraSignatureNamespaces |
Array of namespaces, in addition to the talk namespaces, where signatures (~~~~) are likely to be used. | |
const | InvalidRedirectTargets |
Array of invalid page redirect targets. | |
const | DisableHardRedirects |
Disable redirects to special pages and interwiki redirects, which use a 302 and have no "redirected from" link. | |
const | FixDoubleRedirects |
Fix double redirects after a page move. | |
static | getDefaultMetaNamespace ( $sitename) |
Cookie settings | |
const | CookieExpiration |
Default cookie lifetime, in seconds. | |
const | ExtendedLoginCookieExpiration |
Default login cookie lifetime, in seconds. | |
const | CookieDomain |
Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net". | |
const | CookiePath |
Set this variable if you want to restrict cookies to a certain path within the domain specified by $wgCookieDomain. | |
const | CookieSecure |
Whether the "secure" flag should be set on the cookie. | |
const | CookiePrefix |
Cookies generated by MediaWiki have names starting with this prefix. | |
const | CookieHttpOnly |
Set authentication cookies to HttpOnly to prevent access by JavaScript, in browsers that support this feature. | |
const | CookieSameSite |
The SameSite cookie attribute used for login cookies. | |
const | CacheVaryCookies |
A list of cookies that vary the cache (for use by extensions) | |
const | SessionName |
Override to customise the session name. | |
const | CookieSetOnAutoblock |
Whether to set a cookie when a user is autoblocked. | |
const | CookieSetOnIpBlock |
Whether to set a cookie when a logged-out user is blocked. | |
static | getDefaultCookieSecure ( $forceHTTPS) |
Default cookie lifetime, in seconds. | |
static | getDefaultCookiePrefix ( $sharedDB, $sharedPrefix, $sharedTables, $dbName, $dbPrefix) |
Default cookie lifetime, in seconds. | |
Maintenance | |
const | CommandLineDarkBg |
For colorized maintenance script output, is your terminal background dark ? | |
const | ReadOnly |
Set this to a string to put the wiki into read-only mode. | |
const | ReadOnlyWatchedItemStore |
Set this to true to put the wiki watchlists into read-only mode. | |
const | ReadOnlyFile |
If this lock file exists (size > 0), the wiki will be forced into read-only mode. | |
const | UpgradeKey |
When you run the web-based upgrade utility, it will tell you what to set this to in order to authorize the upgrade process. | |
const | GitBin |
Fully specified path to git binary. | |
const | GitRepositoryViewers |
Map GIT repository URLs to viewer URLs to provide links in Special:Version. | |
const | InstallerInitialPages |
Initial content to create when installing a wiki. | |
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 134 of file MainConfigSchema.php.
|
static |
string | $script | Value of Script |
mixed | $usePathInfo | Value of UsePathInfo |
Definition at line 533 of file MainConfigSchema.php.
|
static |
Default cookie lifetime, in seconds.
Setting to 0 makes all cookies session-only.
Definition at line 9575 of file MainConfigSchema.php.
|
static |
Default cookie lifetime, in seconds.
Setting to 0 makes all cookies session-only.
Definition at line 9559 of file MainConfigSchema.php.
|
static |
Current wiki database name.
This should only contain alphanumeric and underscore characters ([A-Za-z0-9_]+). Spaces, quotes, backticks, dots, and hyphens are likely to be problematic.
This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 3178 of file MainConfigSchema.php.
|
static |
mixed | $uploadDirectory | Value of UploadDirectory |
Definition at line 892 of file MainConfigSchema.php.
|
static |
mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 486 of file MainConfigSchema.php.
|
static |
mixed | $uploadDirectory | Value of UploadDirectory |
Definition at line 608 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 406 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 1066 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 465 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 5098 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 5124 of file MainConfigSchema.php.
|
static |
mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 629 of file MainConfigSchema.php.
|
static |
mixed | $sitename | Value of Sitename |
Definition at line 6097 of file MainConfigSchema.php.
|
static |
mixed | $uploadDirectory | Value of UploadDirectory |
Definition at line 10441 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 5931 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 425 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 386 of file MainConfigSchema.php.
|
static |
mixed | $dbPrefix | Value of DBprefix |
Definition at line 3020 of file MainConfigSchema.php.
|
static |
mixed | $dbMwschema | Value of DBmwschema |
Definition at line 3050 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 1378 of file MainConfigSchema.php.
|
static |
mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 445 of file MainConfigSchema.php.
|
static |
mixed | $scriptPath | Value of ScriptPath |
Definition at line 554 of file MainConfigSchema.php.
|
static |
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 362 of file MainConfigSchema.php.
|
static |
Returns the default value of the given config setting.
string | $name | The config setting name. |
Definition at line 193 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 158 of file MainConfigSchema.php.
Referenced by MediaWiki\Installer\Installer\getExistingLocalSettings().
const MediaWiki\MainConfigSchema::AccountCreationThrottle |
Number of accounts each IP address may create per specified period(s).
Example:
Definition at line 8602 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 12012 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 796 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Actions |
Map of allowed values for the "title=foo&action=<action>" parameter.
to the corresponding handler code. See ActionFactory for the syntax. Core defaults are in ActionFactory::CORE_ACTIONS, anything here overrides that.
Definition at line 12158 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 6868 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 4313 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 8498 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AdditionalMailParams |
Additional email parameters, will be passed as the last argument to mail() call.
Definition at line 2657 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 10142 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 10801 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AjaxLicensePreview |
Enable previewing licences via AJAX.
Definition at line 12431 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowAuthenticatedCrossOrigin |
Allow non-anonymous cross-origin requests to the Action API.
If true, certain session providers (such as OAuth, but not cookie-based sessions) may allow users to make cross-origin requests that are treated as logged in. Users must request this via 'crossorigin=1' in the URL, replacing 'origin=*' (which allows logged-out cross-origin requests).
This setting is currently experimental, and may be removed or enabled by default later.
Definition at line 9404 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 1395 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 9470 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowDisplayTitle |
Allow DISPLAYTITLE to change title display.
Definition at line 6761 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowedCorsHeaders |
List of allowed headers for cross-origin API requests.
Definition at line 12475 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowExternalImages |
Whether to allow inline image pointing to other websites.
Definition at line 6522 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 6540 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowExternalReqID |
Whether to respect/honour.
X-Request-Id
tracestate
and traceparent
Set to true
if the entity sitting in front of MediaWiki sanitises external requests.
Default: false
.
Definition at line 12777 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 2665 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowRawHtmlCopyrightMessages |
Whether on-wiki overrides for the 'copyright' and 'history_copyright' messages, which allow raw HTML, will be used.
Definition at line 5065 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowSchemaUpdates |
Allow schema updates.
Definition at line 3653 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 7283 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 6043 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowSlowParserFunctions |
Enable slow parser functions.
Definition at line 3646 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AllowSpecialInclusion |
Allow special page inclusions such as {{Special:Allpages}}.
Definition at line 12101 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 9315 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 9325 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 9306 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 4867 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 4889 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 2091 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 2151 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 2131 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 12412 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 12321 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 9385 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 12360 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 12369 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 12396 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIMaxResultSize |
The maximum size (in bytes) of an API result.
Definition at line 12378 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 12386 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 12334 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 12308 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 12347 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 12404 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::APIUselessQueryPages |
The ApiQueryQueryPages module should skip pages that are redundant to true API queries.
Definition at line 12420 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 703 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 8788 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 6856 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 523 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 12228 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 289 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AsyncHTTPTimeout |
Timeout for Asynchronous (background) HTTP requests, in seconds.
Definition at line 12734 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 2025 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 7690 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 7132 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutoblockExpiry |
Number of seconds before autoblock entries expire.
Default 86400 = 1 day.
Definition at line 7822 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 8338 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 8353 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.
An associative array with the following keys:
expireAfterDays: (int|null, default 90) If not null, how many days should the temporary accounts expire? Requires expireTemporaryAccounts.php to be periodically executed in order to work.
Definition at line 7797 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutoloadAttemptLowercase |
Obsolete switch that controlled legacy case-insensitive classloading.
Case-insensitive classloading was needed for loading data that had been serialized by PHP 4 with the class names converted to lowercase. It is no longer necessary since 1.31; the lowercase forms in question are now listed in autoload.php (T166759).
Definition at line 11403 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 8414 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:
The only recognised value for event is 'onEdit' (when the user edits).
Criteria has the same format as $wgAutopromote
Definition at line 8443 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutopromoteOnceLogInRC |
Put user rights log entries for autopromotion in recent changes?
Definition at line 8453 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AutopromoteOnceRCExcludedGroups |
Defines a denylist of group names.
One-shot autopromotions into these groups will not cause a RecentChanges entry to be inserted even if AutopromoteOnceLogInRC is set, as long as they are the only new groups the user was autopromoted to.
Definition at line 8464 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::AvailableRights |
A list of available rights, in addition to the ones defined by the core.
Rights in this list are denied unless explicitly granted, typically using GroupPermissions.
For extensions only.
Definition at line 8521 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 7833 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 7851 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BlockDisablesLogin |
If true, sitewide blocked users will not be allowed to login.
(Direct blocks only; IP blocks are ignored.) This can be used to remove users' read access on a private wiki.
Definition at line 7864 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BlockTargetMigrationStage |
Ipblocks table schema migration stage, for normalizing ipb_address field and adding the block_target table.
Use the SCHEMA_COMPAT_XXX flags. Supported values:
History:
Definition at line 7906 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BotPasswordsCluster |
Cluster for the bot_passwords table.
Definition at line 9269 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 9283 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 9347 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::BrowserFormatDetection |
Override the ability of certain browsers to attempt to autodetect dataformats in pages.
This is a default feature of many mobile browsers, but can have a lot of false positives, where for instance, year ranges are confused with phone numbers. The default of this setting is to disable telephone number data detection. Set BrowserFormatDetection to false to fallback to the browser defaults.
Definition at line 5239 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 3825 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 4377 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CachePages |
Allow client-side caching of pages.
Definition at line 4364 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CachePrefix |
Overwrite the caching key prefix with custom value.
Definition at line 10109 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 1242 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CacheVaryCookies |
A list of cookies that vary the cache (for use by extensions)
Definition at line 9610 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 6118 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 269 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CapitalLinkOverrides |
Example:
Definition at line 6250 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 6232 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 8267 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 11753 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CategoryLinksSchemaMigrationStage |
Migration stage for categorylinks tables.
Use the SCHEMA_COMPAT_XXX flags. Supported values:
History:
Definition at line 3296 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 11716 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CategoryPagingLimit |
Paging limit for categories.
Definition at line 11723 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 4718 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 4548 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnMaxageLagged |
Cache timeout for the CDN when DB replica DB lag is high.
Definition at line 4558 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CdnMaxageStale |
Cache timeout when delivering a stale ParserCache response due to PoolCounter contention.
Definition at line 4568 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 4597 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 4587 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 4620 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 4633 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CentralIdLookupProvider |
Central ID lookup provider to use by default.
Definition at line 6984 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 6967 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 7299 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 1625 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ChronologyProtectorSecret |
Secret string for HMAC hashing in ChronologyProtector [optional].
Definition at line 4187 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CleanSignatures |
If true, removes (by substituting) templates in signatures.
Definition at line 6515 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CodexDevelopmentDir |
If this is set, MediaWiki will look for Codex files in this directory instead of in resources/lib/codex/ and friends.
To use a local development version of Codex, set this to the full file path of the root directory of a local clone of the Codex repository, and run npm run build-all
in the Codex root directory. Rerun this command after making any changes.
This should be disabled for production installations.
Definition at line 6074 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CommandLineDarkBg |
For colorized maintenance script output, is your terminal background dark ?
Definition at line 10398 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 3414 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ConditionalUserOptions |
Conditional defaults for user options.
Map of user options to conditional defaults descriptors, which is an array of conditional cases [ VALUE, CONDITION1, CONDITION2 ], where VALUE is the default value for all users that meet ALL conditions, and each CONDITION is either a: (a) a CUDCOND_* constant (when condition does not take any arguments), or (b) an array [ CUDCOND_*, argument1, argument1, ... ] (when chosen condition takes at least one argument).
When null
is used as the VALUE, it is interpreted as "no conditional default for this
condition". In other words, null
and $wgDefaultUserOptions['user-option'] can be used interchangeably as the VALUE.
All conditions are evaluated in order. When no condition matches. $wgDefaultUserOptions is used instead.
Example of valid configuration: $wgConditionalUserOptions['user-option'] = [ [ 'registered in 2024', [ CUDCOND_AFTER, '20240101000000' ] ] ];
List of valid conditions:
Definition at line 7633 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 216 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ContentHandlers |
Plugins for page content model handling.
Each entry in the array maps a model id to an ObjectFactory specification that creates an instance of the appropriate ContentHandler subclass.
Definition at line 3338 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 6284 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 9532 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CookieExpiration |
Default cookie lifetime, in seconds.
Setting to 0 makes all cookies session-only.
Definition at line 9514 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 9589 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 9540 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 9568 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 9602 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 9554 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 9629 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 9640 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 1446 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CopyUploadProxy |
Proxy to use for copy upload requests.
Definition at line 1423 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CopyUploadsDomains |
A list of domains copy uploads can come from.
Definition at line 1404 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 1414 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 1435 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 12119 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 3610 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 12467 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 12457 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 9442 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CSPHeader |
Controls Content-Security-Policy header.
Definition at line 9418 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::CSPReportOnlyHeader |
Controls Content-Security-Policy-Report-Only header.
Definition at line 9428 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 1796 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DatabaseReplicaLagCritical |
Definition at line 3219 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 3211 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 3142 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBadminpassword |
Separate password for maintenance tasks.
Leave as null to use the default.
Definition at line 2913 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBadminuser |
Separate username for maintenance tasks.
Leave as null to use the default.
Definition at line 2906 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 2884 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 2973 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBerrorLog |
File to log database errors to.
Definition at line 3149 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 3173 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBmwschema |
Current wiki database schema name.
This should only contain alphanumeric and underscore characters ([A-Za-z0-9_]+). Spaces, quotes, backticks, dots, and hyphens are likely to be problematic.
This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2810 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBname |
Current wiki database name.
This should only contain alphanumeric and underscore characters ([A-Za-z0-9_]+). Spaces, quotes, backticks, dots, and hyphens are likely to be problematic.
This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2796 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBpassword |
Database user's password.
Definition at line 2854 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBport |
Database port number.
Definition at line 2840 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBprefix |
Current wiki database table name prefix.
This should only contain alphanumeric and underscore characters ([A-Za-z0-9_]+). If it's a non-empty string, then it preferably should end with an underscore. Spaces, quotes, backticks, dots, and hyphens are especially likely to be problematic.
This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2826 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBserver |
Database host name or IP address.
Definition at line 2833 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 3108 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 2872 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBStrictWarnings |
Check for warnings after DB queries and throw an exception if an unacceptable warning is detected.
This setting is only used if $wgLBFactoryConf['class'] is set to '\Wikimedia\Rdbms\LBFactorySimple' and $wgDBservers is an empty array. Otherwise, the 'strictWarnings' parameter of the server array must be set to achieve the same functionality.
Definition at line 2899 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBTableOptions |
MySQL table options to use during installation or update.
Definition at line 2951 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBtype |
Database type.
Definition at line 2861 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DBuser |
Database username.
Definition at line 2847 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 12269 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 9708 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 9719 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 9662 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 9816 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DebugLogPrefix |
Prefix for debug log lines.
Definition at line 9669 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 9696 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 9678 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 10121 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 3468 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DefaultLanguageVariant |
Default variant code.
If false, the default will be the static default variant of the language.
Definition at line 4936 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 12175 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 5261 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;
To save storage space, no user_properties row will be stored for users with the default setting for a given option, even if the user manually selects that option. This means that a change to the defaults will change the setting for all users who have been using the default setting; there is no way for users to opt out of this. $wgConditionalUserOptions can be used to change the default value for future users only.
Definition at line 7527 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DeletedDirectory |
What directory to place deleted uploads in.
Defaults to "{$wgUploadDirectory}/deleted".
Definition at line 883 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 8559 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 8550 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 9921 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 9912 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Diff |
Path to the GNU diff utility.
Definition at line 10354 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 10347 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 3521 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DirectoryMode |
Default value for chmod-ing of new directories.
Definition at line 2404 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 10841 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisabledVariants |
Disabled variants array of language variant conversion.
Example:
Definition at line 4958 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 6339 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 10233 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableLangConversion |
Whether to enable language variant conversion.
Definition at line 4920 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableOutputCompression |
Disable output compression (enabled by default if zlib is available)
Definition at line 5292 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableQueryPages |
Disable all query pages if miser mode is on, not just some.
Definition at line 3625 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 a run mode like 'periodical' if a cronjob is set up.
Definition at line 12111 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 10210 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableTextSearch |
Set this to true to disable the full text search feature.
Definition at line 10134 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DisableTitleConversion |
Whether to enable language variant conversion for links.
Note that this option is slightly misnamed.
Definition at line 4928 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 1645 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DjvuDump |
Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';.
If this is set, self::ShellboxShell
must be set to the correct shell path.
Definition at line 2460 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DjvuOutputExtension |
File extension for the DJVU post processor output.
Definition at line 2501 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 2493 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 2470 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';.
If this is set, self::ShellboxShell
must be set to the correct shell path.
Definition at line 2483 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::DjvuUseBoxedCommand |
Whether to use BoxedCommand or not.
Definition at line 2448 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 8743 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 4855 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Edititis |
Display user edit counts in various prominent places.
Definition at line 5406 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 9370 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EditRecoveryExpiry |
Number of seconds to keep edit recovery data after the edit is stored.
Definition at line 13030 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 5192 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 2689 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 7969 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EmergencyContact |
Site admin email address.
Defaults to "wikiadmin@$wgServerName" (in Setup.php).
Definition at line 2518 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','PublishStashedFile' and 'UploadFromUrl' job types.
Definition at line 844 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableAsyncUploadsByURL |
Enable the async processing of upload by url in Special:Upload.
Only works if EnableAsyncUploads is also enabled
Definition at line 853 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 2081 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableBotPasswords |
Definition at line 9258 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 5445 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableDnsBlacklist |
Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies.
Definition at line 8715 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableEditRecovery |
Whether to enable the client-side edit recovery feature.
Definition at line 13022 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 2548 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 6555 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableJavaScriptTest |
Allow running of QUnit tests via [[Special:JavaScriptTest]].
Definition at line 10100 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 6812 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableMultiBlocks |
If this is false, the number of blocks of a given target is limited to only 1.
Definition at line 7884 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 10176 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableParserLimitReporting |
Whether to include the NewPP limit report as a HTML comment.
Definition at line 11349 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnablePartialActionBlocks |
Flag to enable partial blocks against performing certain actions.
Definition at line 7874 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableProtectionIndicators |
Whether to show indicators on a page when it is protected.
Definition at line 13062 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 4484 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableScaryTranscluding |
Enable interwiki transcluding.
Only when iw_trans=1 in the interwiki table.
Definition at line 6793 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 10294 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 4425 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 2568 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 827 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 2557 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnableUserEmailMuteList |
Set to true to enable user-to-user e-mail mutelist.
Definition at line 2577 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 2678 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 2752 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 2760 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 2741 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 2723 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifUseRealName |
Use real name instead of username in e-mail "from" field.
Definition at line 2767 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 2707 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::EnotifWatchlist |
Allow users to enable email notification ("enotif") on watchlist changes.
Definition at line 2696 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 listeners can subscribe to the channel and take actions based on the events. For example, a local daemon can run on each CDN cache node and perform local purges based on the URL purge channel events.
Some extensions may want to use "channel categories" so that different channels can also share the same custom relayer instance (e.g. when it's likely to be overridden). They can use EventRelayerGroup::getRelayer() based on the category but call notify() on various different actual channels. One reason for this would be that some systems have very different performance vs durability needs, so one system (e.g. Kafka) may not be suitable for all uses.
The 'default' key is for all channels (or channel categories) without an explicit entry here.
Definition at line 12922 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 12244 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Exiftool |
Path to exiftool binary.
Used for lossless ICC profile swapping.
Definition at line 1856 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 1847 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExpensiveParserFunctionLimit |
Maximum number of calls per parse to expensive parser functions such as PAGESINCATEGORY.
Definition at line 6778 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExperiencedUserEdits |
Number of edits the user must have before becoming "experienced".
Definition at line 6902 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExperiencedUserMemberSince |
Number of days the user must exist before becoming "experienced".
Definition at line 6911 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportAllowAll |
Whether to allow exporting the entire wiki into a single file.
Definition at line 11172 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 11127 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportAllowListContributors |
Return distinct author list (when not returning full history)
Definition at line 11143 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportFromNamespaces |
Whether to allow the "export all pages in namespace" option.
Definition at line 11165 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 11136 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 11158 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExportPagelistLimit |
Maximum number of pages returned by the GetPagesFromCategory and GetPagesFromNamespace functions.
Definition at line 11182 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 9524 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionAssetsPath |
The URL path of the extensions directory.
Defaults to "{$wgResourceBasePath}/extensions".
Definition at line 477 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 11468 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionDirectory |
Extensions directory in the file system.
Defaults to "{$IP}/extensions" in Setup.php
Definition at line 498 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 11341 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtensionFunctions |
A list of callback functions which are called once MediaWiki is fully initialised.
Definition at line 11234 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 4473 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 11266 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExternalDiffEngine |
Name of the external diff engine to use.
Definition at line 3529 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 5338 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExternalLinksDomainGaps |
Gaps in the externallinks table for certain domains.
If you have identified certain domains for which externallinks searches are slow, you can use this setting to make MediaWiki skip large el_id ranges, rather than having the database scan through them fruitlessly.
Each key in the array is a domain name in el_to_domain_index form, e.g. 'https://com.example.'. The value is an array with integer keys and values, where each entry is a range (from => to, both inclusive) of el_id values where this domain is known to have no entries. (Subdomains are included, i.e., configuring an entry here guarantees to MediaWiki that there are no rows where the el_to_domain_index starts with this value.)
History:
Definition at line 3319 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 6708 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 3451 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExternalStores |
List of enabled ExternalStore protocols.
Definition at line 3427 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 6162 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 4799 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 4838 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ExtraLanguageNames |
List of language names or overrides for default names in Names.php.
Definition at line 4819 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 6149 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 6310 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FallbackSkin |
Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
Definition at line 5270 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Favicon |
The URL path of the icon.
Definition at line 692 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 12991 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::Feed |
Provide syndication feeds (RSS, Atom) for, e.g., Recentchanges, Newpages.
Definition at line 10730 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 10751 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 10789 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 10759 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 10738 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FetchCommonsDescriptions |
Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1205 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 1338 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 4404 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FileCacheDirectory |
Directory where the cached page will be saved.
Defaults to "{$wgUploadDirectory}/cache".
Definition at line 599 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 1563 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::FileSchemaMigrationStage |
Migration stage for file tables.
Use the SCHEMA_COMPAT_XXX flags. Supported values:
History:
Definition at line 3280 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 11874 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 6348 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 5373 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 3793 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ForcedRawSMaxage |
Default maximum age for raw CSS/JS accesses.
300 seconds = 5 minutes.
Definition at line 4606 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 325 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 5033 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 1101 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 1257 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 5325 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GalleryOptions |
Parameters for the "<gallery>" tag.
Fields are:
Definition at line 2387 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 2064 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GitBin |
Fully specified path to git binary.
Definition at line 10461 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 4385 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 10478 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 4760 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GrantPermissionGroups |
Grant groups are used on some user interfaces to display conceptually similar grants together.
This configuration value should usually be set by extensions, not site administrators.
Definition at line 9170 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 8982 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GrantRiskGroups |
Group grants by risk level.
Keys are grant names (i.e. keys from GrantPermissions), values are GrantsInfo::RISK_* constants.
Note that this classification is only informative; merely applying 'security' or 'internal' to a grant won't prevent it from being available. It's used to give guidance to users in various interfaces about the riskiness of the various grants.
Definition at line 9223 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 8178 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 8005 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 8216 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::GroupsRemoveFromSelf |
Definition at line 8224 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HashedSharedUploadDirectory |
Shortcut for the 'hashLevels' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1182 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HashedUploadDirectory |
Shortcut for setting hashLevels=2
in $wgLocalFileRepo.
Definition at line 1550 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HiddenPrefs |
An array of preferences to not show for the user.
Definition at line 7641 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 7977 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HideInterlanguageLinks |
Hide interlanguage links from the sidebar.
Definition at line 4775 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 8572 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 11502 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTCPMulticastTTL |
HTCP multicast TTL.
Definition at line 4696 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 4686 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 5181 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 12693 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPImportTimeout |
Timeout for HTTP requests done internally for transwiki imports, in seconds.
Definition at line 12727 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 12717 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 12705 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPProxy |
Proxy to use for CURL requests.
Definition at line 12741 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 304 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::HTTPTimeout |
Timeout for HTTP requests done internally, in seconds.
Definition at line 12681 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 2040 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 873 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 2238 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImageMagickConvertCommand |
The convert command shipped with ImageMagick.
Definition at line 1748 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 1780 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 2434 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 899 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 570 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 918 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImplicitGroups |
Implicit groups, aren't shown on Special:Listusers or somewhere else.
Definition at line 8187 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::ImplicitRights |
A list of implicit rights, in addition to the ones defined by the core.
Rights in this list are granted implicitly to all users, but rate limits may apply to them.
Extensions that define rate limits should add the corresponding right to either ImplicitRights or AvailableRights, depending on whether the right should be granted to everyone.
Definition at line 8540 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 11104 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 11117 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InstallerInitialPages |
Initial content to create when installing a wiki.
An array of page info arrays. Each must contain at least one of:
And one of:
The text may contain
Definition at line 10503 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 4811 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InternalServer |
Internal server name as known to CDN, if different.
Example:
Definition at line 4535 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InterwikiCache |
Interwiki cache as an associative array.
When set, the InterwikiLookup service will not use the built-in interwiki
database table, but instead use this static array as its source.
This cache data structure can be generated by the dumpInterwiki.php
maintenance script (which lives in the WikimediaMaintenance repository) and has key formats such as the following:
Sites mapping just specifies site name, other keys provide "local url" data layout.
Definition at line 6396 of file MainConfigSchema.php.
const MediaWiki\MainConfigSchema::InterwikiExpiry |
Expiry time for cache of interwiki table.
Definition at line 6372 of file MainConfigSchema.php