|
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. More... | |
| static | listDefaultValues (string $prefix='') |
| Returns a generator for iterating over all config settings and their default values. More... | |
Public Attributes | |
| const | ConfigRegistry |
| Registry of factory functions to create config objects: The 'main' key must be set, and the value should be a valid callable. More... | |
| const | Sitename |
| Name of the site. More... | |
DJVU settings | |
| const | DjvuDump |
| Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';. More... | |
| const | DjvuRenderer |
| Path of the ddjvu DJVU renderer Enable this and $wgDjvuDump to enable djvu rendering example: $wgDjvuRenderer = 'ddjvu';. More... | |
| const | DjvuTxt |
| Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';. More... | |
| const | DjvuPostProcessor |
| Shell command for the DJVU post processor Default: pnmtojpeg, since ddjvu generates ppm output Set this to false to output the ppm file directly. More... | |
| const | DjvuOutputExtension |
| File extension for the DJVU post processor output. More... | |
Email settings | |
| const | EmergencyContact |
| Site admin email address. More... | |
| const | PasswordSender |
| Sender email address for e-mail notifications. More... | |
| const | NoReplyAddress |
| Reply-To address for e-mail notifications. More... | |
| const | EnableEmail |
| Set to true to enable the e-mail basic features: Password reminders, etc. More... | |
| const | EnableUserEmail |
| Set to true to enable user-to-user e-mail. More... | |
| const | EnableSpecialMute |
| Set to true to enable the Special Mute page. More... | |
| const | EnableUserEmailMuteList |
| Set to true to enable user-to-user e-mail mutelist. More... | |
| const | UserEmailUseReplyTo |
| If true put the sending user's email in a Reply-To header instead of From (false). More... | |
| const | PasswordReminderResendTime |
| Minimum time, in hours, which must elapse between password reminder emails for a given account. More... | |
| const | NewPasswordExpiry |
| The time, in seconds, when an emailed temporary password expires. More... | |
| const | UserEmailConfirmationTokenExpiry |
| The time, in seconds, when an email confirmation email expires. More... | |
| const | PasswordExpirationDays |
| The number of days that a user's password is good for. More... | |
| const | PasswordExpireGrace |
| If a user's password is expired, the number of seconds when they can still login, and cancel their password change, but are sent to the password change form on each login. More... | |
| const | SMTP |
| SMTP Mode. More... | |
| const | AdditionalMailParams |
| Additional email parameters, will be passed as the last argument to mail() call. More... | |
| const | AllowHTMLEmail |
| For parts of the system that have been updated to provide HTML email content, send both text and HTML parts as the body of the email. More... | |
| const | EnotifFromEditor |
| Allow sending of e-mail notifications with the editor's address as sender. More... | |
| const | EmailAuthentication |
| Require email authentication before sending mail to an email address. More... | |
| const | EnotifWatchlist |
| Allow users to enable email notification ("enotif") on watchlist changes. More... | |
| const | EnotifUserTalk |
| Allow users to enable email notification ("enotif") when someone edits their user talk page. More... | |
| const | EnotifRevealEditorAddress |
| Allow sending of e-mail notifications with the editor's address in "Reply-To". More... | |
| const | EnotifMinorEdits |
| Potentially send notification mails on minor edits to pages. More... | |
| const | EnotifImpersonal |
| Send a generic mail instead of a personalised mail for each user. More... | |
| const | EnotifMaxRecips |
| Maximum number of users to mail at once when using impersonal mail. More... | |
| const | EnotifUseRealName |
| Use real name instead of username in e-mail "from" field. More... | |
| const | UsersNotifiedOnAllChanges |
| Array of usernames who will be sent a notification email for every change which occurs on a wiki. More... | |
Content handlers and storage | |
| const | ContentHandlers |
| Plugins for page content model handling. More... | |
| const | NamespaceContentModels |
| Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by default (use the CONTENT_MODEL_XXX constants). More... | |
| const | ContentHandlerTextFallback |
| How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText(): More... | |
| const | TextModelsToParse |
| Determines which types of text are parsed as wikitext. More... | |
| const | CompressRevisions |
| We can also compress text stored in the 'text' table. More... | |
| const | ExternalStores |
| List of enabled ExternalStore protocols. More... | |
| const | ExternalServers |
Shortcut for setting $wgLBFactoryConf["externalClusters"]. More... | |
| const | DefaultExternalStore |
| The place to put new text blobs or false to put them in the text table of the local wiki database. More... | |
| const | RevisionCacheExpiry |
| Revision text may be cached in the main WAN cache to reduce load on external storage servers and object extraction overhead for frequently-loaded revisions. More... | |
| const | PageLanguageUseDB |
| Enable page language feature Allows setting page language in database. More... | |
| const | DiffEngine |
| Specify the difference engine to use. More... | |
| const | ExternalDiffEngine |
| Name of the external diff engine to use. More... | |
Performance hacks and limits | |
| const | RequestTimeLimit |
| Set a limit on server request wall clock time. More... | |
| const | TransactionalTimeLimit |
| The request time limit for "slow" write requests that should not be interrupted due to the risk of data corruption. More... | |
| const | CriticalSectionTimeLimit |
| The maximum time critical sections are allowed to stay open. More... | |
| const | MiserMode |
| Disable database-intensive features. More... | |
| const | DisableQueryPages |
| Disable all query pages if miser mode is on, not just some. More... | |
| const | QueryCacheLimit |
| Number of rows to cache in 'querycache' table when miser mode is on. More... | |
| const | WantedPagesThreshold |
| Number of links to a page required before it is deemed "wanted". More... | |
| const | AllowSlowParserFunctions |
| Enable slow parser functions. More... | |
| const | AllowSchemaUpdates |
| Allow schema updates. More... | |
| const | MaxArticleSize |
| Maximum article size in kibibytes. More... | |
| const | MemoryLimit |
| The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount. More... | |
| const | PoolCounterConf |
| Configuration for processing pool control, for use in high-traffic wikis. More... | |
| const | PoolCountClientConf |
| Configuration array for the PoolCounter client. More... | |
| const | MaxUserDBWriteDuration |
| Max time (in seconds) a user-generated transaction can spend in writes. More... | |
| const | MaxJobDBWriteDuration |
| Max time (in seconds) a job-generated transaction can spend in writes. More... | |
| const | LinkHolderBatchSize |
| LinkHolderArray batch size For debugging. More... | |
| const | MaximumMovedPages |
| Maximum number of pages to move at once when moving subpages with a page. More... | |
| const | ForceDeferredUpdatesPreSend |
| Force deferred updates to be run before sending a response to the client, instead of attempting to run them after sending the response. More... | |
| const | MultiShardSiteStats |
| Whether site_stats table should have multiple rows. More... | |
Cache settings | |
| const | CacheDirectory |
| Directory for caching data in the local filesystem. More... | |
| const | MainCacheType |
| Main cache type. More... | |
| const | MessageCacheType |
| The cache type for storing the contents of the MediaWiki namespace. More... | |
| const | ParserCacheType |
| The cache type for storing page content HTML (e.g. More... | |
| const | SessionCacheType |
| The cache backend for storing session data. More... | |
| const | LanguageConverterCacheType |
| The cache type for storing language conversion tables, which are used when parsing certain text and interface messages. More... | |
| const | StatsCacheType |
| The object cache type for stats storage. More... | |
| const | ObjectCaches |
| Advanced object cache configuration. More... | |
| const | WANObjectCache |
| Extra parameters to the WANObjectCache constructor. More... | |
| const | MainStash |
| The object store type of the main stash. More... | |
| const | ParsoidCacheConfig |
| Configuration for the caching related to parsoid output. More... | |
| const | ChronologyProtectorStash |
| The object store type for the ChronologyProtector store. More... | |
| const | ParserCacheExpireTime |
| The expiry time for the parser cache, in seconds. More... | |
| const | OldRevisionParserCacheExpireTime |
| The expiry time for the parser cache for old revisions, in seconds. More... | |
| const | ObjectCacheSessionExpiry |
| The expiry time to use for session storage, in seconds. More... | |
| const | PHPSessionHandling |
| Whether to use PHP session handling ($_SESSION and session_*() functions) More... | |
| const | SuspiciousIpExpiry |
| Time in seconds to remember IPs for, for the purposes of logging IP changes within the same session. More... | |
| const | SessionPbkdf2Iterations |
| Number of internal PBKDF2 iterations to use when deriving session secrets. More... | |
| const | MemCachedServers |
| The list of MemCached servers and port numbers. More... | |
| const | MemCachedPersistent |
| Use persistent connections to MemCached, which are shared across multiple requests. More... | |
| const | MemCachedTimeout |
| Read/write timeout for MemCached server communication, in microseconds. More... | |
| const | UseLocalMessageCache |
| Set this to true to maintain a copy of the message cache on the local server. More... | |
| const | AdaptiveMessageCache |
| Instead of caching everything, only cache those messages which have been customised in the site content language. More... | |
| const | LocalisationCacheConf |
| Localisation cache configuration. More... | |
| const | CachePages |
| Allow client-side caching of pages. More... | |
| const | CacheEpoch |
| Set this to current time to invalidate all prior cached pages. More... | |
| const | GitInfoCacheDirectory |
| Directory where GitInfo will look for pre-computed cache files. More... | |
| const | UseFileCache |
| This will cache static pages for non-logged-in users to reduce database traffic on public sites. More... | |
| const | FileCacheDepth |
| Depth of the subdirectory hierarchy to be created under $wgFileCacheDirectory. More... | |
| const | RenderHashAppend |
| Append a configured value to the parser cache and the sitenotice key so that they can be kept separate for some class of activity. More... | |
| const | EnableSidebarCache |
| If on, the sidebar navigation links are cached for users with the current language set. More... | |
| const | SidebarCacheExpiry |
| Expiry time for the sidebar cache, in seconds. More... | |
| const | UseGzip |
| When using the file cache, we can store the cached HTML gzipped to save disk space. More... | |
| const | InvalidateCacheOnLocalSettingsChange |
| Invalidate various caches when LocalSettings.php changes. More... | |
| const | ExtensionInfoMTime |
| When loading extensions through the extension registration system, this can be used to invalidate the cache. More... | |
| const | EnableRemoteBagOStuffTests |
| If this is set to true, phpunit will run integration tests against remote caches defined in $wgObjectCaches. More... | |
HTTP proxy (CDN) settings | |
Many of these settings apply to any HTTP proxy used in front of MediaWiki, although they are sometimes still referred to as Squid settings for historical reasons. Achieving a high hit ratio with an HTTP proxy requires special configuration. See https://www.mediawiki.org/wiki/Manual:Performance_tuning#Page_view_caching for more details. | |
| const | UseCdn |
| Enable/disable CDN. More... | |
| const | VaryOnXFP |
| Add X-Forwarded-Proto to the Vary and Key headers for API requests and RSS/Atom feeds. More... | |
| const | InternalServer |
| Internal server name as known to CDN, if different. More... | |
| const | CdnMaxAge |
| Cache TTL for the CDN sent as s-maxage (without ESI) or Surrogate-Control (with ESI). More... | |
| const | CdnMaxageLagged |
| Cache timeout for the CDN when DB replica DB lag is high. More... | |
| const | CdnMaxageStale |
| Cache timeout when delivering a stale ParserCache response due to PoolCounter contention. More... | |
| const | CdnReboundPurgeDelay |
| If set, any SquidPurge call on a URL or URLs will send a second purge no less than this many seconds later via the job queue. More... | |
| const | CdnMaxageSubstitute |
| Cache timeout for the CDN when a response is known to be wrong or incomplete (due to load) More... | |
| const | ForcedRawSMaxage |
| Default maximum age for raw CSS/JS accesses. More... | |
| const | CdnServers |
| List of proxy servers to purge on changes; default port is 80. More... | |
| const | CdnServersNoPurge |
| As with $wgCdnServers, except these servers aren't purged on page changes; use to set a list of trusted proxies, etc. More... | |
| const | SquidPurgeUseHostHeader |
| Whether to use a Host header in purge requests sent to the proxy servers configured in $wgCdnServers. More... | |
| const | HTCPRouting |
| Routing configuration for HTCP multicast purging. More... | |
| const | HTCPMulticastTTL |
| HTCP multicast TTL. More... | |
| const | UsePrivateIPs |
| Should forwarded Private IPs be accepted? More... | |
| const | CdnMatchParameterOrder |
| Set this to false if MediaWiki is behind a CDN that re-orders query parameters on incoming requests. More... | |
Output format and skin settings | |
| const | MimeType |
| The default Content-Type header. More... | |
| const | Html5Version |
| Defines the value of the version attribute in the <html> tag, if any. More... | |
| const | HTMLFormAllowTableFormat |
| Temporary variable that allows HTMLForms to be rendered as tables. More... | |
| const | UseMediaWikiUIEverywhere |
| Temporary variable that applies MediaWiki UI wherever it can be supported. More... | |
| const | EditSubmitButtonLabelPublish |
| Whether to label the store-to-database-and-show-to-others button in the editor as "Save page"/"Save changes" if false (the default) or, if true, instead as "Publish page"/"Publish changes". More... | |
| const | XhtmlNamespaces |
| Permit other namespaces in addition to the w3.org default. More... | |
| const | SiteNotice |
| Site notice shown at the top of each page. More... | |
| const | BrowserFormatDetection |
| Override ability of certains browsers to attempt to autodetect dataformats in pages. More... | |
| const | SkinMetaTags |
| An array of open graph tags which should be added by all skins. More... | |
| const | DefaultSkin |
| Default skin, for new users and anonymous visitors. More... | |
| const | FallbackSkin |
| Fallback skin used when the skin defined by $wgDefaultSkin can't be found. More... | |
| const | SkipSkins |
| Specify the names of skins that should not be presented in the list of available skins in user preferences. More... | |
| const | ResourceLoaderClientPreferences |
| Enable client-side preferences for unregistered users. More... | |
| const | DisableOutputCompression |
| Disable output compression (enabled by default if zlib is available) More... | |
| const | FragmentMode |
| How should section IDs be encoded? This array can contain 1 or 2 elements, each of them can be one of: More... | |
| const | ExternalInterwikiFragmentMode |
| Which ID escaping mode should be used for external interwiki links? See documentation for $wgFragmentMode above for details of each mode. More... | |
| const | FooterIcons |
| Abstract list of footer icons for skins in place of old copyrightico and poweredbyico code You can add new icons to the built in copyright or poweredby, or you can create a new block. More... | |
| const | UseCombinedLoginLink |
| Login / create account link behavior when it's possible for anonymous users to create an account. More... | |
| const | Edititis |
| Display user edit counts in various prominent places. More... | |
| const | Send404Code |
| Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output. More... | |
| const | ShowRollbackEditCount |
| The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back. More... | |
| const | EnableCanonicalServerLink |
| Output a <link rel="canonical"> tag on every page indicating the canonical server which should be used, i.e. More... | |
| const | InterwikiLogoOverride |
| List of interwiki logos overrides. More... | |
User rights, access control and monitoring | |
| const | AutoblockExpiry |
| Number of seconds before autoblock entries expire. More... | |
| const | BlockAllowsUTEdit |
| Set this to true to allow blocked users to edit their own user talk page. More... | |
| const | BlockCIDRLimit |
| Limits on the possible sizes of range blocks. More... | |
| const | BlockDisablesLogin |
| If true, sitewide blocked users will not be allowed to login. More... | |
| const | EnablePartialActionBlocks |
| Flag to enable partial blocks against performing certain actions. More... | |
| const | WhitelistRead |
| Pages anonymous user may see, set as an array of pages titles. More... | |
| const | WhitelistReadRegexp |
| Pages anonymous user may see, set as an array of regular expressions. More... | |
| const | EmailConfirmToEdit |
| Should editors be required to have a validated e-mail address before being allowed to edit? More... | |
| const | HideIdentifiableRedirects |
| Should MediaWiki attempt to protect user's privacy when doing redirects? Keep this true if access counts to articles are made public. More... | |
| const | GroupPermissions |
| Permission keys given to users in each group. More... | |
| const | RevokePermissions |
| Permission keys revoked from users in each group. More... | |
| const | GroupInheritsPermissions |
| Groups that should inherit permissions from another group. More... | |
| const | ImplicitGroups |
| Implicit groups, aren't shown on Special:Listusers or somewhere else. More... | |
| const | GroupsAddToSelf |
| A map of group names that the user is in, to group names that those users are allowed to add or revoke. More... | |
| const | GroupsRemoveFromSelf |
| const | RestrictionTypes |
| Set of available actions that can be restricted via action=protect You probably shouldn't change this. More... | |
| const | RestrictionLevels |
| Rights which can be required for each protection level (via action=protect) More... | |
| const | CascadingRestrictionLevels |
| Restriction levels that can be used with cascading protection. More... | |
| const | SemiprotectedRestrictionLevels |
| Restriction levels that should be considered "semiprotected". More... | |
| const | NamespaceProtection |
| Set the minimum permissions required to edit pages in each namespace. More... | |
| const | NonincludableNamespaces |
| Pages in namespaces in this array can not be used as templates. More... | |
| const | AutoConfirmAge |
| Number of seconds an account is required to age before it's given the implicit 'autoconfirm' group membership. More... | |
| const | AutoConfirmCount |
| Number of edits an account requires before it is autoconfirmed. More... | |
| const | Autopromote |
| Array containing the conditions of automatic promotion of a user to specific groups. More... | |
| const | AutopromoteOnce |
| Automatically add a usergroup to any user who matches certain conditions. More... | |
| const | AutopromoteOnceLogInRC |
| Put user rights log entries for autopromotion in recent changes? More... | |
| const | AddGroups |
| $wgAddGroups and $wgRemoveGroups can be used to give finer control over who can assign which groups at Special:Userrights. More... | |
| const | RemoveGroups |
| const | AvailableRights |
| A list of available rights, in addition to the ones defined by the core. More... | |
| const | DeleteRevisionsLimit |
| Optional to restrict deletion of pages with higher revision counts to users with the 'bigdelete' permission. More... | |
| const | DeleteRevisionsBatchSize |
| Page deletions with > this number of revisions will use the job queue. More... | |
| const | HideUserContribLimit |
| The maximum number of edits a user can have and can still be hidden by users with the hideuser permission. More... | |
| const | AccountCreationThrottle |
| Number of accounts each IP address may create per specified period(s). More... | |
| const | SpamRegex |
| Edits matching these regular expressions in body text will be recognised as spam and rejected automatically. More... | |
| const | SummarySpamRegex |
| Same as SpamRegex except for edit summaries. More... | |
| const | EnableDnsBlacklist |
| Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies. More... | |
| const | DnsBlacklistUrls |
| List of DNS blacklists to use, if $wgEnableDnsBlacklist is true. More... | |
| const | ProxyList |
| List of banned IP addresses. More... | |
| const | ProxyWhitelist |
| Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say. More... | |
| const | SoftBlockRanges |
| IP ranges that should be considered soft-blocked (anon-only, account creation allowed). More... | |
| const | ApplyIpBlocksToXff |
| Whether to look at the X-Forwarded-For header's list of (potentially spoofed) IPs and apply IP blocks to them. More... | |
| const | RateLimits |
| Simple rate limiter options to brake edit floods. More... | |
| const | RateLimitsExcludedIPs |
| Array of IPs / CIDR ranges which should be excluded from rate limits. More... | |
| const | PutIPinRC |
| Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g. More... | |
| const | QueryPageDefaultLimit |
| Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere. More... | |
| const | PasswordAttemptThrottle |
| Limit password attempts to X attempts per Y seconds per IP per account. More... | |
| const | GrantPermissions |
| Users authorize consumers (like Apps) to act on their behalf but only with a subset of the user's normal account rights (signed off on by the user). More... | |
| const | GrantPermissionGroups |
| const | EnableBotPasswords |
| const | BotPasswordsCluster |
| Cluster for the bot_passwords table. More... | |
| const | BotPasswordsDatabase |
| Database name for the bot_passwords table. More... | |
Security | |
| const | SecretKey |
| This should always be customised in LocalSettings.php. More... | |
| const | AllowUserJs |
| Allow user Javascript page? This enables a lot of neat customizations, but may increase security risk to users and server load. More... | |
| const | AllowUserCss |
| Allow user Cascading Style Sheets (CSS)? This enables a lot of neat customizations, but may increase security risk to users and server load. More... | |
| const | AllowUserCssPrefs |
| Allow style-related user-preferences? More... | |
| const | UseSiteJs |
| Use the site's Javascript page? More... | |
| const | UseSiteCss |
| Use the site's Cascading Style Sheets (CSS)? More... | |
| const | BreakFrames |
| Break out of framesets. More... | |
| const | EditPageFrameOptions |
| The X-Frame-Options header to send on pages sensitive to clickjacking attacks, such as edit pages. More... | |
| const | ApiFrameOptions |
| Disallow framing of API pages directly, by setting the X-Frame-Options header. More... | |
| const | CSPHeader |
| Controls Content-Security-Policy header [Experimental]. More... | |
| const | CSPReportOnlyHeader |
| Controls Content-Security-Policy-Report-Only header. More... | |
| const | CSPFalsePositiveUrls |
| List of urls which appear often to be triggering CSP reports but do not appear to be caused by actual content, but by client software inserting scripts (i.e. More... | |
| const | AllowCrossOrigin |
| Allow anonymous cross origin requests. More... | |
| const | RestAllowCrossOriginCookieAuth |
| Allows authenticated cross-origin requests to the REST API with session cookies. More... | |
| const | SessionSecret |
| Secret for session storage. More... | |
| const | SessionInsecureSecrets |
| If for some reason you can't install the PHP OpenSSL extension, you can set this to true to make MediaWiki work again at the cost of storing sensitive session data insecurely. More... | |
| const | HKDFSecret |
| Secret for hmac-based key derivation function (fast, cryptographically secure random numbers). More... | |
| const | HKDFAlgorithm |
| Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers). More... | |
Cookie settings | |
| const | CookieExpiration |
| Default cookie lifetime, in seconds. More... | |
| const | ExtendedLoginCookieExpiration |
| Default login cookie lifetime, in seconds. More... | |
| const | CookieDomain |
| Set to set an explicit domain on the login cookies eg, "justthis.domain.org" or ".any.subdomain.net". More... | |
Server URLs and file paths | |
In this section, a "path" is usually a host-relative URL, i.e. a URL without the host part, that starts with a slash. In most cases a full URL is also acceptable. A "directory" is a local file path. In both paths and directories, trailing slashes should not be included. | |
| const | Server |
| URL of the server. More... | |
| const | CanonicalServer |
| Canonical URL of the server, to use in IRC feeds and notification e-mails. More... | |
| const | ServerName |
| Server name. More... | |
| const | AssumeProxiesUseDefaultProtocolPorts |
| When the wiki is running behind a proxy and this is set to true, assumes that the proxy exposes the wiki on the standard ports (443 for https and 80 for http). More... | |
| const | HttpsPort |
| For installations where the canonical server is HTTP but HTTPS is optionally supported, you can specify a non-standard HTTPS port here. More... | |
| const | ForceHTTPS |
| If this is true, when an insecure HTTP request is received, always redirect to HTTPS. More... | |
| const | ScriptPath |
| The path we should point to. More... | |
| const | UsePathInfo |
| Whether to support URLs like index.php/Page_title. More... | |
| const | Script |
| The URL path to index.php. More... | |
| const | LoadScript |
| The URL path to load.php. More... | |
| const | RestPath |
| The URL path to the REST API Defaults to "{$wgScriptPath}/rest.php". More... | |
| const | StylePath |
| The URL path of the skins directory. More... | |
| const | LocalStylePath |
| The URL path of the skins directory. More... | |
| const | ExtensionAssetsPath |
| The URL path of the extensions directory. More... | |
| const | ExtensionDirectory |
| Extensions directory in the file system. More... | |
| const | StyleDirectory |
| Skins directory in the file system. More... | |
| const | BaseDirectory |
| Absolute filesystem path of the root directory of the MediaWiki installation. More... | |
| const | ArticlePath |
| The URL path for primary article page views. More... | |
| const | UploadPath |
| The URL path for the images directory. More... | |
| const | ImgAuthPath |
| The base path for img_auth.php. More... | |
| const | ThumbPath |
| The base path for thumb_handler.php. More... | |
| const | UploadDirectory |
| The filesystem path of the images directory. More... | |
| const | FileCacheDirectory |
| Directory where the cached page will be saved. More... | |
| const | Logo |
| The URL path of the wiki logo. More... | |
| const | Logos |
| Specification for different versions of the wiki logo. More... | |
| const | LogoHD |
| Array with URL paths to HD versions of the wiki logo. More... | |
| const | Favicon |
| The URL path of the icon. More... | |
| const | AppleTouchIcon |
| The URL path of the icon for iPhone and iPod Touch web app bookmarks. More... | |
| const | ReferrerPolicy |
| Value for the referrer policy meta tag. More... | |
| const | TmpDirectory |
| The local filesystem path to a temporary directory. More... | |
| const | UploadBaseUrl |
| If set, this URL is added to the start of $wgUploadPath to form a complete upload URL. More... | |
| const | UploadStashScalerBaseUrl |
| To enable remote on-demand scaling, set this to the thumbnail base URL. More... | |
| const | ActionPaths |
| To set 'pretty' URL paths for actions other than plain page views, add to this array. More... | |
| const | MainPageIsDomainRoot |
| Option to whether serve the main page as the domain root. More... | |
| static | getDefaultUsePathInfo () |
| static | getDefaultScript ( $scriptPath) |
| static | getDefaultLoadScript ( $scriptPath) |
| static | getDefaultRestPath ( $scriptPath) |
| static | getDefaultStylePath ( $resourceBasePath) |
| static | getDefaultLocalStylePath ( $scriptPath) |
| static | getDefaultExtensionAssetsPath ( $resourceBasePath) |
| static | getDefaultArticlePath (string $script, $usePathInfo) |
| static | getDefaultUploadPath ( $scriptPath) |
| static | getDefaultUploadDirectory ( $baseDirectory) |
| static | getDefaultFileCacheDirectory ( $uploadDirectory) |
| static | getDefaultLogo ( $resourceBasePath) |
Files and file uploads | |
| const | EnableUploads |
| Allow users to upload files. More... | |
| const | UploadStashMaxAge |
| The maximum age of temporary (incomplete) uploaded files. More... | |
| const | EnableAsyncUploads |
| Enable deferred upload tasks that use the job queue. More... | |
| const | UploadMaintenance |
| To disable file delete/restore temporarily. More... | |
| const | IllegalFileChars |
| Additional characters that are not allowed in filenames. More... | |
| const | DeletedDirectory |
| What directory to place deleted uploads in. More... | |
| const | ImgAuthDetails |
| Set this to true if you use img_auth and want the user to see details on why access failed. More... | |
| const | ImgAuthUrlPathMap |
| Map of relative URL directories to match to internal mwstore:// base storage paths. More... | |
| const | LocalFileRepo |
| File repository structures. More... | |
| const | ForeignFileRepos |
| Enable the use of files from one or more other wikis. More... | |
| const | UseInstantCommons |
| Use Wikimedia Commons as a foreign file repository. More... | |
| const | UseSharedUploads |
| Shortcut for adding an entry to $wgForeignFileRepos. More... | |
| const | SharedUploadDirectory |
| Shortcut for the 'directory' setting of $wgForeignFileRepos. More... | |
| const | SharedUploadPath |
| Shortcut for the 'url' setting of $wgForeignFileRepos. More... | |
| const | HashedSharedUploadDirectory |
| Shortcut for the 'hashLevels' setting of $wgForeignFileRepos. More... | |
| const | RepositoryBaseUrl |
| Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos. More... | |
| const | FetchCommonsDescriptions |
| Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos. More... | |
| const | SharedUploadDBname |
| Shortcut for the ForeignDBRepo 'dbName' setting in $wgForeignFileRepos. More... | |
| const | SharedUploadDBprefix |
| Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos. More... | |
| const | CacheSharedUploads |
| Shortcut for the ForeignDBRepo 'hasSharedCache' setting in $wgForeignFileRepos. More... | |
| const | ForeignUploadTargets |
| Array of foreign file repo names (set in $wgForeignFileRepos above) that are allowable upload targets. More... | |
| const | UploadDialog |
| Configuration for file uploads using the embeddable upload dialog (https://www.mediawiki.org/wiki/Upload_dialog). More... | |
| const | FileBackends |
| File backend structure configuration. More... | |
| const | LockManagers |
| List of lock manager backend configurations. More... | |
| const | ShowEXIF |
| Whether to show Exif data. More... | |
| const | UpdateCompatibleMetadata |
| Shortcut for the 'updateCompatibleMetadata' setting of $wgLocalFileRepo. More... | |
| const | AllowCopyUploads |
| Allow for upload to be copied from an URL. More... | |
| const | CopyUploadsDomains |
| A list of domains copy uploads can come from. More... | |
| const | CopyUploadsFromSpecialUpload |
| Enable copy uploads from Special:Upload. More... | |
| const | CopyUploadProxy |
| Proxy to use for copy upload requests. More... | |
| const | CopyUploadTimeout |
| Different timeout for upload by url This could be useful since when fetching large files, you may want a timeout longer than the default $wgHTTPTimeout. More... | |
| const | CopyUploadAllowOnWikiDomainConfig |
| If true, the value of $wgCopyUploadsDomains will be merged with the contents of MediaWiki:Copyupload-allowed-domains. More... | |
| const | MaxUploadSize |
| Max size for uploads, in bytes. More... | |
| const | MinUploadChunkSize |
| Minimum upload chunk size, in bytes. More... | |
| const | UploadNavigationUrl |
| Point the upload navigation link to an external URL Useful if you want to use a shared repository by default without disabling local uploads (use $wgEnableUploads = false for that). More... | |
| const | UploadMissingFileUrl |
| Point the upload link for missing files to an external URL, as with $wgUploadNavigationUrl. More... | |
| const | ThumbnailScriptPath |
| Give a path here to use thumb.php for thumbnail generation on client request, instead of generating them on render and outputting a static URL. More... | |
| const | SharedThumbnailScriptPath |
| Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos. More... | |
| const | HashedUploadDirectory |
Shortcut for setting hashLevels=2 in $wgLocalFileRepo. More... | |
| const | FileExtensions |
| This is the list of preferred extensions for uploading files. More... | |
| const | ProhibitedFileExtensions |
| Files with these extensions will never be allowed as uploads. More... | |
| const | MimeTypeExclusions |
| Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled. More... | |
| const | CheckFileExtensions |
| This is a flag to determine whether or not to check file extensions on upload. More... | |
| const | StrictFileExtensions |
| If this is turned off, users may override the warning for files not covered by $wgFileExtensions. More... | |
| const | DisableUploadScriptChecks |
| Setting this to true will disable the upload system's checks for HTML/JavaScript. More... | |
| const | UploadSizeWarning |
| Warn if uploaded files are larger than this (in bytes), or false to disable. More... | |
| const | TrustedMediaFormats |
| list of trusted media-types and MIME types. More... | |
| const | MediaHandlers |
| Plugins for media file type handling. More... | |
| const | NativeImageLazyLoading |
| Toggles native image lazy loading, via the "loading" attribute. More... | |
| const | ParserTestMediaHandlers |
| Media handler overrides for parser tests (they don't need to generate actual thumbnails, so a mock will do) More... | |
| const | UseImageResize |
| Whether to enable server-side image thumbnailing. More... | |
| const | UseImageMagick |
| Resizing can be done using PHP's internal image libraries or using ImageMagick or another third-party converter, e.g. More... | |
| const | ImageMagickConvertCommand |
| The convert command shipped with ImageMagick. More... | |
| const | MaxInterlacingAreas |
| Array of max pixel areas for interlacing per MIME type. More... | |
| const | SharpenParameter |
| Sharpening parameter to ImageMagick. More... | |
| const | SharpenReductionThreshold |
| Reduction in linear dimensions below which sharpening will be enabled. More... | |
| const | ImageMagickTempDir |
| Temporary directory used for ImageMagick. More... | |
| const | CustomConvertCommand |
| Use another resizing converter, e.g. More... | |
| const | JpegTran |
| used for lossless jpeg rotation More... | |
| const | JpegPixelFormat |
| At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma subsampling to reduce file size, at the cost of possible color fringing at sharp edges. More... | |
| const | JpegQuality |
| When scaling a JPEG thumbnail, this is the quality we request from the backend. More... | |
| const | Exiv2Command |
| Some tests and extensions use exiv2 to manipulate the Exif metadata in some image formats. More... | |
| const | Exiftool |
| Path to exiftool binary. More... | |
| const | SVGConverters |
| Scalable Vector Graphics (SVG) may be uploaded as images. More... | |
| const | SVGConverter |
| Pick a converter defined in $wgSVGConverters. More... | |
| const | SVGConverterPath |
| If not in the executable PATH, specify the SVG converter path. More... | |
| const | SVGMaxSize |
| Don't scale a SVG larger than this. More... | |
| const | SVGMetadataCutoff |
| Don't read SVG metadata beyond this point. More... | |
| const | SVGNativeRendering |
| Whether native rendering by the browser agent is allowed. More... | |
| const | SVGNativeRenderingSizeLimit |
| Filesize limit for allowing SVGs to render natively by the browser agent. More... | |
| const | MediaInTargetLanguage |
| Whether thumbnails should be generated in target language (usually, same as page language), if available. More... | |
| const | MaxImageArea |
| The maximum number of pixels a source image can have if it is to be scaled down by a scaler that requires the full source image to be decompressed and stored in decompressed form, before the thumbnail is generated. More... | |
| const | MaxAnimatedGifArea |
| Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnail. More... | |
| const | TiffThumbnailType |
| Browsers don't support TIFF inline generally... More... | |
| const | ThumbnailEpoch |
| If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if the file didn't already exist. More... | |
| const | AttemptFailureEpoch |
| Certain operations are avoided if there were too many recent failures, for example, thumbnail generation. More... | |
| const | IgnoreImageErrors |
| If set, inline scaled images will still produce "<img>" tags ready for output instead of showing an error message. More... | |
| const | GenerateThumbnailOnParse |
| Render thumbnails while parsing wikitext. More... | |
| const | ShowArchiveThumbnails |
| Show thumbnails for old images on the image description page. More... | |
| const | EnableAutoRotation |
| If set to true, images that contain certain the exif orientation tag will be rotated accordingly. More... | |
| const | Antivirus |
| Internal name of virus scanner. More... | |
| const | AntivirusSetup |
| Configuration for different virus scanners. More... | |
| const | AntivirusRequired |
| Determines if a failed virus scan (AV_SCAN_FAILED) will cause the file to be rejected. More... | |
| const | VerifyMimeType |
| Determines if the MIME type of uploaded files should be checked. More... | |
| const | MimeTypeFile |
| Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php. More... | |
| const | MimeInfoFile |
| Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php. More... | |
| const | MimeDetectorCommand |
| Sets an external MIME detector program. More... | |
| const | TrivialMimeDetection |
| Switch for trivial MIME detection. More... | |
| const | XMLMimeTypes |
| Additional XML types we can allow via MIME-detection. More... | |
| const | ImageLimits |
| Limit images on image description pages to a user-selectable limit. More... | |
| const | ThumbLimits |
| Adjust thumbnails on image pages according to a user setting. More... | |
| const | ThumbnailNamespaces |
| Defines what namespaces thumbnails will be displayed for in Special:Search. More... | |
| const | ThumbnailBuckets |
| When defined, is an array of image widths used as buckets for thumbnail generation. More... | |
| const | ThumbnailMinimumBucketDistance |
| When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size. More... | |
| const | UploadThumbnailRenderMap |
| When defined, is an array of thumbnail widths to be rendered at upload time. More... | |
| const | UploadThumbnailRenderMethod |
| The method through which the thumbnails will be prerendered for the entries in $wgUploadThumbnailRenderMap. More... | |
| const | UploadThumbnailRenderHttpCustomHost |
| When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom Host HTTP header. More... | |
| const | UploadThumbnailRenderHttpCustomDomain |
| When using the "http" $wgUploadThumbnailRenderMethod, lets one specify a custom domain to send the HTTP request to. More... | |
| const | UseTinyRGBForJPGThumbnails |
| When this variable is true and JPGs use the sRGB ICC profile, swaps it for the more lightweight (and free) TinyRGB profile when generating thumbnails. More... | |
| const | GalleryOptions |
| Parameters for the "<gallery>" tag. More... | |
| const | ThumbUpright |
| Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright images without the need to fix the width by hardcoded px in wiki sourcecode. More... | |
| const | DirectoryMode |
| Default value for chmoding of new directories. More... | |
| const | ResponsiveImages |
| Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities. More... | |
| const | ImagePreconnect |
| Add a preconnect link for browsers to a remote FileRepo host. More... | |
| static | getDefaultDeletedDirectory ( $uploadDirectory) |
| static | getDefaultLocalFileRepo ( $uploadDirectory, $scriptPath, $favicon, $uploadBaseUrl, $uploadPath, $hashedUploadDirectory, $thumbnailScriptPath, $generateThumbnailOnParse, $deletedDirectory, $updateCompatibleMetadata) |
| Allow users to upload files. More... | |
| static | getDefaultShowEXIF () |
Database settings | |
| const | DBname |
| Current wiki database name. More... | |
| const | DBmwschema |
| Current wiki database schema name. More... | |
| const | DBprefix |
| Current wiki database table name prefix. More... | |
| const | DBserver |
| Database host name or IP address. More... | |
| const | DBport |
| Database port number. More... | |
| const | DBuser |
| Database username. More... | |
| const | DBpassword |
| Database user's password. More... | |
| const | DBtype |
| Database type. More... | |
| const | DBssl |
| Whether to use SSL in DB connection. More... | |
| const | DBcompress |
| Whether to use compression in DB connection. More... | |
| const | DBadminuser |
| Separate username for maintenance tasks. More... | |
| const | DBadminpassword |
| Separate password for maintenance tasks. More... | |
| const | SearchType |
| Search type. More... | |
| const | SearchTypeAlternatives |
| Alternative search types. More... | |
| const | DBTableOptions |
| MySQL table options to use during installation or update. More... | |
| const | SQLMode |
| SQL Mode - default is turning off all modes, including strict, if set. More... | |
| const | DBDefaultGroup |
| Default group to use when getting database connections. More... | |
| const | SQLiteDataDir |
| To override default SQLite data directory ($docroot/../data) More... | |
| const | SharedDB |
| Shared database for multiple wikis. More... | |
| const | SharedPrefix |
| const | SharedTables |
| const | SharedSchema |
| const | DBservers |
| Database load balancer This is a two-dimensional array, a list of server info structures Fields are: More... | |
| const | LBFactoryConf |
| Configuration for the ILBFactory service. More... | |
| const | DataCenterUpdateStickTTL |
| After a state-changing request is done by a client, this determines how many seconds that client should keep using the primary datacenter. More... | |
| const | DBerrorLog |
| File to log database errors to. More... | |
| const | DBerrorLogTZ |
| Timezone to use in the error log. More... | |
| const | LocalDatabases |
| Other wikis on this site, can be administered from a single developer account. More... | |
| const | DatabaseReplicaLagWarning |
| If lag is higher than $wgDatabaseReplicaLagWarning, show a warning in some special pages (like watchlist). More... | |
| const | DatabaseReplicaLagCritical |
| const | MaxExecutionTimeForExpensiveQueries |
| Max execution time for queries of several expensive special pages such as RecentChanges in milliseconds. More... | |
| const | TemplateLinksSchemaMigrationStage |
| Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields. More... | |
| const | ExternalLinksSchemaMigrationStage |
| Externallinks table schema migration stage. More... | |
| const | CommentTempTableSchemaMigrationStage |
| Comment temp tables schema migration stage. More... | |
| static | getDefaultSharedPrefix ( $dbPrefix) |
| static | getDefaultSharedSchema ( $dbMwschema) |
| static | getDefaultDBerrorLogTZ ( $localtimezone) |
| Current wiki database name. More... | |
Language, regional and character encoding settings | |
| const | LanguageCode |
| Site language code. More... | |
| const | GrammarForms |
| Some languages need different word forms, usually for different cases. More... | |
| const | InterwikiMagic |
| Treat language links as magic connectors, not inline links. More... | |
| const | HideInterlanguageLinks |
| Hide interlanguage links from the sidebar. More... | |
| const | ExtraInterlanguageLinkPrefixes |
| List of additional interwiki prefixes that should be treated as interlanguage links (i.e. More... | |
| const | InterlanguageLinkCodeMap |
| Map of interlanguage link codes to language codes. More... | |
| const | ExtraLanguageNames |
| List of language names or overrides for default names in Names.php. More... | |
| const | ExtraLanguageCodes |
| List of mappings from one language code to another. More... | |
| const | DummyLanguageCodes |
| Functionally the same as $wgExtraLanguageCodes, but deprecated. More... | |
| const | AllUnicodeFixes |
| Set this to always convert certain Unicode sequences to modern ones regardless of the content language. More... | |
| const | LegacyEncoding |
| Set this to eg 'ISO-8859-1' to perform character set conversion when loading old revisions not marked with "utf-8" flag. More... | |
| const | AmericanDates |
| Enable dates like 'May 12' instead of '12 May', if the default date format is 'dmy or mdy'. More... | |
| const | TranslateNumerals |
| For Hindi and Arabic use local numerals instead of Western style (0-9) numerals in interface. More... | |
| const | UseDatabaseMessages |
| Translation using MediaWiki: namespace. More... | |
| const | MaxMsgCacheEntrySize |
| Maximum entry size in the message cache, in bytes. More... | |
| const | DisableLangConversion |
| Whether to enable language variant conversion. More... | |
| const | DisableTitleConversion |
| Whether to enable language variant conversion for links. More... | |
| const | DefaultLanguageVariant |
| Default variant code. More... | |
| const | UsePigLatinVariant |
| Whether to enable the pig Latin variant of English (en-x-piglatin), used to ease variant development work. More... | |
| const | DisabledVariants |
| Disabled variants array of language variant conversion. More... | |
| const | VariantArticlePath |
| Like $wgArticlePath, but on multi-variant wikis, this provides a path format that describes which parts of the URL contain the language variant. More... | |
| const | LoginLanguageSelector |
| Show a bar of language selection links in the user login and user registration forms; edit the "loginlanguagelinks" message to customise these. More... | |
| const | ForceUIMsgAsContentMsg |
| When translating messages with wfMessage(), it is not always clear what should be considered UI messages and what should be content messages. More... | |
| const | RawHtmlMessages |
| List of messages which might contain raw HTML. More... | |
| const | Localtimezone |
| Fake out the timezone that the server thinks it's in. More... | |
| const | LocalTZoffset |
| Set an offset from UTC in minutes to use for the default timezone setting for anonymous users and new user accounts. More... | |
| const | OverrideUcfirstCharacters |
| Map of Unicode characters for which capitalization is overridden in Language::ucfirst. More... | |
| static | getDefaultLocaltimezone () |
| Site language code. More... | |
| static | getDefaultLocalTZoffset ( $localtimezone) |
| Site language code. More... | |
ResourceLoader settings | |
| const | MangleFlashPolicy |
| Formerly a workaround for a security vulnerability caused by installation of Flash as a browser extension. More... | |
| const | ResourceModules |
| Define extra client-side modules to be registered with ResourceLoader. More... | |
| const | ResourceModuleSkinStyles |
| Add extra skin-specific styles to a resource module. More... | |
| const | ResourceLoaderSources |
| Extensions should register foreign module sources here. More... | |
| const | ResourceBasePath |
| The default 'remoteBasePath' value for instances of MediaWiki\ResourceLoader\FileModule. More... | |
| const | ResourceLoaderMaxage |
| Override how long a CDN or browser may cache a ResourceLoader HTTP response. More... | |
| const | ResourceLoaderUseObjectCacheForDeps |
| Use the main stash instead of the module_deps table for indirect dependency tracking. More... | |
| const | ResourceLoaderDebug |
| The default debug mode (on/off) for of ResourceLoader requests. More... | |
| const | ResourceLoaderMaxQueryLength |
| ResourceLoader will not generate URLs whose query string is more than this many characters long, and will instead use multiple requests with shorter query strings. More... | |
| const | ResourceLoaderValidateJS |
| If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it. More... | |
| const | ResourceLoaderEnableJSProfiler |
| When enabled, execution of JavaScript modules is profiled client-side. More... | |
| const | ResourceLoaderStorageEnabled |
| Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API. More... | |
| const | ResourceLoaderStorageVersion |
| Cache version for client-side ResourceLoader module storage. More... | |
| const | AllowSiteCSSOnRestrictedPages |
| Whether to allow site-wide CSS (MediaWiki:Common.css and friends) on restricted pages like Special:UserLogin or Special:Preferences where JavaScript is disabled for security reasons. More... | |
| const | VueDevelopmentMode |
| Whether to use the development version of Vue.js. More... | |
| static | getDefaultResourceBasePath ( $scriptPath) |
Page titles and redirects | |
| const | MetaNamespace |
| Name of the project namespace. More... | |
| const | MetaNamespaceTalk |
| Name of the project talk namespace. More... | |
| const | CanonicalNamespaceNames |
| Canonical namespace names. More... | |
| const | ExtraNamespaces |
| Additional namespaces. More... | |
| const | ExtraGenderNamespaces |
| Same as above, but for namespaces with gender distinction. More... | |
| const | NamespaceAliases |
| Define extra namespace aliases. More... | |
| const | LegalTitleChars |
| Allowed title characters – regex character class Don't change this unless you know what you're doing. More... | |
| const | RememberMe |
| Configures RememberMe authentication request added by AuthManager. More... | |
| const | ReauthenticateTime |
| Time frame for re-authentication. More... | |
| const | AllowSecuritySensitiveOperationIfCannotReauthenticate |
| Whether to allow security-sensitive operations when re-authentication is not possible. More... | |
| const | ChangeCredentialsBlacklist |
| List of AuthenticationRequest class names which are not changeable through Special:ChangeCredentials and the changeauthenticationdata API. More... | |
| const | RemoveCredentialsBlacklist |
| List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata API. More... | |
| const | MinimalPasswordLength |
| Specifies the minimal length of a user password. More... | |
| const | MaximalPasswordLength |
| Specifies the maximal length of a user password (T64685). More... | |
| const | InvalidPasswordReset |
| Specifies if users should be sent to a password-reset form on login, if their password doesn't meet the requirements of User::isValidPassword(). More... | |
| const | PasswordDefault |
| Default password type to use when hashing user passwords. More... | |
| const | PasswordConfig |
| Configuration for built-in password types. More... | |
| const | PasswordResetRoutes |
| Whether to allow password resets ("enter some identifying data, and we'll send an email
with a temporary password you can use to get back into the account") identified by various bits of data. More... | |
| const | MaxSigChars |
| Maximum number of Unicode characters in signature. More... | |
| const | SignatureValidation |
| Behavior of signature validation. More... | |
| const | SignatureAllowedLintErrors |
| List of lint error codes which don't cause signature validation to fail. More... | |
| const | MaxNameChars |
| Maximum number of bytes in username. More... | |
| const | ReservedUsernames |
| Array of usernames which may not be registered or logged in from Maintenance scripts can still use these. More... | |
| const | DefaultUserOptions |
| Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts. More... | |
| const | HiddenPrefs |
| An array of preferences to not show for the user. More... | |
| const | InvalidUsernameCharacters |
| Characters to prevent during new account creations. More... | |
| const | UserrightsInterwikiDelimiter |
| Character used as a delimiter when testing for interwiki userrights (In Special:UserRights, it is possible to modify users on different databases if the delimiter is used, e.g. More... | |
| const | SecureLogin |
| This is to let user authenticate using https when they come from http. More... | |
| const | AuthenticationTokenVersion |
| Versioning for authentication tokens. More... | |
| const | SessionProviders |
| MediaWiki\Session\SessionProvider configuration. More... | |
| const | AllowRequiringEmailForResets |
| Temporary feature flag that controls whether users will see a checkbox allowing them to require providing email during password resets. More... | |
| const | AutoCreateTempUser |
| Configuration for automatic creation of temporary accounts on page save. More... | |
| static | getDefaultMetaNamespace ( $sitename) |
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:
The following additional keys are used by MediaWiki:
Definition at line 120 of file MainConfigSchema.php.
|
static |
| string | $script | Value of Script |
| mixed | $usePathInfo | Value of UsePathInfo |
Definition at line 533 of file MainConfigSchema.php.
|
static |
Current wiki database name.
Should be alphanumeric, without spaces nor hyphens. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 3169 of file MainConfigSchema.php.
|
static |
| mixed | $uploadDirectory | Value of UploadDirectory |
Definition at line 923 of file MainConfigSchema.php.
|
static |
| mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 475 of file MainConfigSchema.php.
|
static |
| mixed | $uploadDirectory | Value of UploadDirectory |
Definition at line 614 of file MainConfigSchema.php.
|
static |
| mixed | $scriptPath | Value of ScriptPath |
Definition at line 395 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 1096 of file MainConfigSchema.php.
|
static |
| mixed | $scriptPath | Value of ScriptPath |
Definition at line 454 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 4944 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 4970 of file MainConfigSchema.php.
|
static |
| mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 635 of file MainConfigSchema.php.
|
static |
| mixed | $sitename | Value of Sitename |
Definition at line 5962 of file MainConfigSchema.php.
|
static |
| mixed | $scriptPath | Value of ScriptPath |
Definition at line 5816 of file MainConfigSchema.php.
|
static |
| mixed | $scriptPath | Value of ScriptPath |
Definition at line 414 of file MainConfigSchema.php.
|
static |
| mixed | $scriptPath | Value of ScriptPath |
Definition at line 375 of file MainConfigSchema.php.
|
static |
| mixed | $dbPrefix | Value of DBprefix |
Definition at line 3011 of file MainConfigSchema.php.
|
static |
| mixed | $dbMwschema | Value of DBmwschema |
Definition at line 3041 of file MainConfigSchema.php.
|
static |
Definition at line 1411 of file MainConfigSchema.php.
|
static |
| mixed | $resourceBasePath | Value of ResourceBasePath |
Definition at line 434 of file MainConfigSchema.php.
|
static |
| mixed | $baseDirectory | Value of BaseDirectory |
Definition at line 596 of file MainConfigSchema.php.
|
static |
| mixed | $scriptPath | Value of ScriptPath |
Definition at line 554 of file MainConfigSchema.php.
|
static |
Definition at line 351 of file MainConfigSchema.php.
|
static |
Returns the default value of the given config setting.
| string | $name | The config setting name. |
Definition at line 179 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 144 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AccountCreationThrottle |
Number of accounts each IP address may create per specified period(s).
Example:
Definition at line 8264 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 839 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 4162 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 8186 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AdditionalMailParams |
Additional email parameters, will be passed as the last argument to mail() call.
Definition at line 2670 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 1428 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AllowCrossOrigin |
Allow anonymous cross origin requests.
This should be disabled for intranet sites (sites behind a firewall).
Definition at line 8983 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 2678 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AllowRequiringEmailForResets |
Temporary feature flag that controls whether users will see a checkbox allowing them to require providing email during password resets.
Definition at line 7490 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AllowSchemaUpdates |
Allow schema updates.
Definition at line 3573 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 7063 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 5925 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AllowSlowParserFunctions |
Enable slow parser functions.
Definition at line 3566 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 8850 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 8860 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 8841 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 4741 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 4763 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 2120 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 2180 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 2160 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 8920 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 746 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 8374 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::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 275 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 2054 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 7448 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AutoblockExpiry |
Number of seconds before autoblock entries expire.
Default 86400 = 1 day.
Definition at line 7567 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 8037 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 8052 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AutoCreateTempUser |
Configuration for automatic creation of temporary accounts on page save.
This can be enabled to avoid exposing the IP addresses of casual editors who do not explicitly create an account.
EXPERIMENTAL – enabling may break extensions.
An associative array with the following keys:
Definition at line 7545 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 8113 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AutopromoteOnce |
Automatically add a usergroup to any user who matches certain conditions.
Does not add the user to the group again if it has been removed. Also, does not remove the group if the user no longer meets the criteria.
The format is:
Where event is either:
Criteria has the same format as $wgAutopromote
Definition at line 8143 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AutopromoteOnceLogInRC |
Put user rights log entries for autopromotion in recent changes?
Definition at line 8153 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::AvailableRights |
A list of available rights, in addition to the ones defined by the core.
For extensions only.
Definition at line 8204 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::BaseDirectory |
Absolute filesystem path of the root directory of the MediaWiki installation.
The MW_INSTALL_PATH environment variable can be used to set this.
Definition at line 512 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 7578 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 7596 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 7609 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::BotPasswordsCluster |
Cluster for the bot_passwords table.
Definition at line 8805 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 8818 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 8882 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::BrowserFormatDetection |
Override ability of certains browsers to attempt to autodetect dataformats in pages.
This is a default feature of many mobile browsers, but can have a lot of false positives, where for instance year ranges are confused with phone numbers. The default of this setting is to disable telephone number data detection. Set BrowserFormatDetection to false to fallback to browser defaults.
Definition at line 5099 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 3745 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 4226 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CachePages |
Allow client-side caching of pages.
Definition at line 4213 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 1272 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 5983 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 255 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 7966 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 4592 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 4397 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CdnMaxageLagged |
Cache timeout for the CDN when DB replica DB lag is high.
Definition at line 4407 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CdnMaxageStale |
Cache timeout when delivering a stale ParserCache response due to PoolCounter contention.
Definition at line 4417 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 4446 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 4436 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 4469 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 4482 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 7079 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 1654 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ChronologyProtectorStash |
The object store type for the ChronologyProtector store.
This should be a fast storage system optimized for lightweight ephemeral data. Data stored should be readable by all application servers in the local datacenter.
See ChronologyProtector requirements for more detailed system administrator requirements (especially for multi-dc operations).
Valid options are the keys of $wgObjectCaches, e.g. CACHE_* constants. Defaults to $wgMainCacheType (in ServiceWiring.php).
Definition at line 4049 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CommentTempTableSchemaMigrationStage |
Comment temp tables schema migration stage.
Use the SCHEMA_COMPAT_XXX flags.
History:
Definition at line 3267 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 3377 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 202 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 3286 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ContentHandlerTextFallback |
How to react if a plain text version of a non-text Content object is requested using ContentHandler::getContentText():
Definition at line 3342 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 9083 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CookieExpiration |
Default cookie lifetime, in seconds.
Setting to 0 makes all cookies session-only.
Definition at line 9065 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 1479 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CopyUploadProxy |
Proxy to use for copy upload requests.
Definition at line 1456 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CopyUploadsDomains |
A list of domains copy uploads can come from.
Definition at line 1437 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 1447 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 1468 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 3530 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 8955 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CSPHeader |
Controls Content-Security-Policy header [Experimental].
Definition at line 8931 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::CSPReportOnlyHeader |
Controls Content-Security-Policy-Report-Only header.
Definition at line 8941 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 1825 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DatabaseReplicaLagCritical |
Definition at line 3210 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 3202 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 3133 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBadminpassword |
Separate password for maintenance tasks.
Leave as null to use the default.
Definition at line 2904 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBadminuser |
Separate username for maintenance tasks.
Leave as null to use the default.
Definition at line 2897 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 2890 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 2964 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBerrorLog |
File to log database errors to.
Definition at line 3140 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 3164 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBmwschema |
Current wiki database schema name.
Should be alphanumeric, without spaces nor hyphens. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2819 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBname |
Current wiki database name.
Should be alphanumeric, without spaces nor hyphens. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2807 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBpassword |
Database user's password.
Definition at line 2860 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBport |
Database port number.
Definition at line 2846 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBprefix |
Current wiki database table name prefix.
Should be alphanumeric, without spaces nor hyphens, preferably ending in an underscore. This is used to determine the current/local wiki ID (WikiMap::getCurrentWikiDbDomain).
This should still be set even if $wgLBFactoryConf is configured.
Definition at line 2832 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBserver |
Database host name or IP address.
Definition at line 2839 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 3099 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 2878 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBTableOptions |
MySQL table options to use during installation or update.
Definition at line 2942 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBtype |
Database type.
Definition at line 2867 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DBuser |
Database username.
Definition at line 2853 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 3431 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 4809 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 5121 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DefaultUserOptions |
Settings added to this array will override the default globals for the user preferences used by anonymous visitors and newly created accounts.
For instance, to disable editing on double clicks: $wgDefaultUserOptions ['editondblclick'] = 0;
Definition at line 7325 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DeletedDirectory |
What directory to place deleted uploads in.
Defaults to "{$wgUploadDirectory}/deleted".
Definition at line 914 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 8222 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 8213 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 3470 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DirectoryMode |
Default value for chmoding of new directories.
Definition at line 2433 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DisabledVariants |
Disabled variants array of language variant conversion.
Example:
Definition at line 4831 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DisableLangConversion |
Whether to enable language variant conversion.
Definition at line 4794 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DisableOutputCompression |
Disable output compression (enabled by default if zlib is available)
Definition at line 5167 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DisableQueryPages |
Disable all query pages if miser mode is on, not just some.
Definition at line 3545 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DisableTitleConversion |
Whether to enable language variant conversion for links.
Definition at line 4801 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 1674 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DjvuDump |
Path of the djvudump executable Enable this and $wgDjvuRenderer to enable djvu rendering example: $wgDjvuDump = 'djvudump';.
Definition at line 2476 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DjvuOutputExtension |
File extension for the DJVU post processor output.
Definition at line 2514 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 2506 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 2486 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::DjvuTxt |
Path of the djvutxt DJVU text extraction utility Enable this and $wgDjvuDump to enable text layer extraction from djvu files example: $wgDjvuTxt = 'djvutxt';.
Definition at line 2496 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 8329 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 4729 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Edititis |
Display user edit counts in various prominent places.
Definition at line 5281 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 8905 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 5051 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 2702 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 7681 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::EmergencyContact |
Site admin email address.
Defaults to "wikiadmin@$wgServerName" (in Setup.php).
Definition at line 2531 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::EnableAsyncUploads |
Enable deferred upload tasks that use the job queue.
Only enable this if job runners are set up for both the 'AssembleUploadChunks' and 'PublishStashedFile' job types.
Definition at line 887 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 2110 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::EnableBotPasswords |
Definition at line 8795 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 5320 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::EnableDnsBlacklist |
Whether to use DNS blacklists in $wgDnsBlacklistUrls to check for open proxies.
Definition at line 8301 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 2561 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::EnablePartialActionBlocks |
Flag to enable partial blocks against performing certain actions.
Definition at line 7618 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 4333 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 4274 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 2581 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 870 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 2570 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::EnableUserEmailMuteList |
Set to true to enable user-to-user e-mail mutelist.
Definition at line 2590 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 2691 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 2765 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 2773 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 2754 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 2736 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::EnotifUseRealName |
Use real name instead of username in e-mail "from" field.
Definition at line 2780 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 2720 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::EnotifWatchlist |
Allow users to enable email notification ("enotif") on watchlist changes.
Definition at line 2709 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Exiftool |
Path to exiftool binary.
Used for lossless ICC profile swapping.
Definition at line 1885 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 1876 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 9075 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ExtensionAssetsPath |
The URL path of the extensions directory.
Defaults to "{$wgResourceBasePath}/extensions".
Definition at line 466 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ExtensionDirectory |
Extensions directory in the file system.
Definition at line 486 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 4322 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ExternalDiffEngine |
Name of the external diff engine to use.
Definition at line 3478 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 5213 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ExternalLinksSchemaMigrationStage |
Externallinks table schema migration stage.
Use the SCHEMA_COMPAT_XXX flags. Supported values:
History:
Definition at line 3254 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 3414 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ExternalStores |
List of enabled ExternalStore protocols.
Definition at line 3390 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 6027 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 4673 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 4712 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ExtraLanguageNames |
List of language names or overrides for default names in Names.php.
Definition at line 4693 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 6014 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::FallbackSkin |
Fallback skin used when the skin defined by $wgDefaultSkin can't be found.
Definition at line 5130 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Favicon |
The URL path of the icon.
Definition at line 735 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::FetchCommonsDescriptions |
Shortcut for the 'fetchDescription' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1235 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 1368 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 4253 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::FileCacheDirectory |
Directory where the cached page will be saved.
Defaults to "{$wgUploadDirectory}/cache".
Definition at line 605 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 1596 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 5248 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 3713 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ForcedRawSMaxage |
Default maximum age for raw CSS/JS accesses.
300 seconds = 5 minutes.
Definition at line 4455 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 311 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 4887 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 1131 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 1287 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 5200 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::GalleryOptions |
Parameters for the "<gallery>" tag.
Fields are:
Definition at line 2416 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 2093 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 4234 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 4634 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::GrantPermissionGroups |
Definition at line 8749 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 8567 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 7877 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 7717 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 7915 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::GroupsRemoveFromSelf |
Definition at line 7923 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::HashedSharedUploadDirectory |
Shortcut for the 'hashLevels' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1212 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::HashedUploadDirectory |
Shortcut for setting hashLevels=2 in $wgLocalFileRepo.
Definition at line 1583 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::HiddenPrefs |
An array of preferences to not show for the user.
Definition at line 7399 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 7689 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::HideInterlanguageLinks |
Hide interlanguage links from the sidebar.
Definition at line 4649 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 8235 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::HKDFAlgorithm |
Algorithm for hmac-based key derivation function (fast, cryptographically secure random numbers).
See also: $wgHKDFSecret
Definition at line 9052 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::HKDFSecret |
Secret for hmac-based key derivation function (fast, cryptographically secure random numbers).
This should be set in LocalSettings.php, otherwise $wgSecretKey will be used. See also: $wgHKDFAlgorithm
Definition at line 9040 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::HTCPMulticastTTL |
HTCP multicast TTL.
Definition at line 4570 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 4560 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 5015 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::HTMLFormAllowTableFormat |
Temporary variable that allows HTMLForms to be rendered as tables.
Table based layouts cause various issues when designing for mobile. This global allows skins or extensions a means to force non-table based rendering. Setting to false forces form components to always render as div elements.
Definition at line 5028 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 290 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 2069 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 905 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 2267 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ImageMagickConvertCommand |
The convert command shipped with ImageMagick.
Definition at line 1777 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 1809 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 2463 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 930 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 949 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ImplicitGroups |
Implicit groups, aren't shown on Special:Listusers or somewhere else.
Definition at line 7886 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 4685 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::InternalServer |
Internal server name as known to CDN, if different.
Example:
Definition at line 4384 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::InterwikiLogoOverride |
List of interwiki logos overrides.
This is used by the sister project sidebar. This list accept a key equal to the interwiki ID (as defined in the interwiki links), and accept a Codex icon name (https://doc.wikimedia.org/codex/latest/icons/all-icons.html) or a base URL for the given interwiki.
Example : $wgInterwikiLogoOverride = [ 'c' => 'logoWikimediaCommons', 'wikit' => 'https://mySpecialWiki.com' ];
Definition at line 5337 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::InterwikiMagic |
Treat language links as magic connectors, not inline links.
Definition at line 4642 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::InvalidateCacheOnLocalSettingsChange |
Invalidate various caches when LocalSettings.php changes.
This is equivalent to setting $wgCacheEpoch to the modification time of LocalSettings.php, as was previously done in the default LocalSettings.php file.
On high-traffic wikis, this should be set to false, to avoid the need to check the file modification time, and to avoid the performance impact of unnecessary cache invalidations.
Definition at line 4304 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::InvalidPasswordReset |
Specifies if users should be sent to a password-reset form on login, if their password doesn't meet the requirements of User::isValidPassword().
Definition at line 7138 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::InvalidUsernameCharacters |
Characters to prevent during new account creations.
This is used in a regular expression character class during registration (regex metacharacters like / are escaped).
Definition at line 7410 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::JpegPixelFormat |
At default setting of 'yuv420', JPEG thumbnails will use 4:2:0 chroma subsampling to reduce file size, at the cost of possible color fringing at sharp edges.
See https://en.wikipedia.org/wiki/Chroma_subsampling
Supported values: false - use scaling system's default (same as pre-1.27 behavior) 'yuv444' - luma and chroma at same resolution 'yuv422' - chroma at 1/2 resolution horizontally, full vertically 'yuv420' - chroma at 1/2 resolution in both dimensions
This setting is currently supported only for the ImageMagick backend; others may default to 4:2:0 or 4:4:4 or maintaining the source file's sampling in the thumbnail.
Definition at line 1857 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::JpegQuality |
When scaling a JPEG thumbnail, this is the quality we request from the backend.
It should be an integer between 1 and 100, with 100 indicating 100% quality.
Definition at line 1868 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::JpegTran |
used for lossless jpeg rotation
Definition at line 1834 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LanguageCode |
Site language code.
See includes/languages/data/Names.php for languages supported by MediaWiki out of the box. Not all languages listed there have translations, see languages/messages/ for the list of languages with some localisation.
Warning: Don't use any of MediaWiki's deprecated language codes listed in LanguageCode::getDeprecatedCodeMapping or $wgDummyLanguageCodes, like "no" for Norwegian (use "nb" instead). If you do, things will break unexpectedly.
This defines the default interface language for all users, but users can change it in their preferences.
This also defines the language of pages in the wiki. The content is wrapped in a html element with lang=XX attribute. This behavior can be overridden via hooks, see Title::getPageLanguage.
Definition at line 4619 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LanguageConverterCacheType |
The cache type for storing language conversion tables, which are used when parsing certain text and interface messages.
For available types see $wgMainCacheType.
Definition at line 3834 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LBFactoryConf |
Configuration for the ILBFactory service.
The "class" setting must point to a LBFactory subclass, which is also responsible for reading $wgDBservers, $wgDBserver, etc.
To set up a wiki farm with multiple database clusters, set the "class" to LBFactoryMulti. See LBFactoryMulti docs for information on how to configure the rest of the $wgLBFactoryConf array.
Definition at line 3114 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LegacyEncoding |
Set this to eg 'ISO-8859-1' to perform character set conversion when loading old revisions not marked with "utf-8" flag.
Use this when converting a wiki from MediaWiki 1.4 or earlier to UTF-8 without the burdensome mass conversion of old text data.
Definition at line 4755 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LegalTitleChars |
Allowed title characters – regex character class Don't change this unless you know what you're doing.
Problematic punctuation:
All three of these punctuation problems can be avoided by using an alias, instead of a rewrite rule of either variety.
The problem with % is that when using a path to query rewrite rule, URLs are double-unescaped: once by Apache's path conversion code, and again by PHP. So %253F, for example, becomes "?". Our code does not double-escape to compensate for this, indeed double escaping would break if the double-escaped title was passed in the query string rather than the path. This is a minor security issue because articles can be created such that they are hard to view or edit.
In some rare cases you may wish to remove + for compatibility with old links.
Definition at line 6083 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LinkHolderBatchSize |
LinkHolderArray batch size For debugging.
Definition at line 3690 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LoadScript |
The URL path to load.php.
Defaults to "{$wgScriptPath}/load.php".
Definition at line 386 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LocalDatabases |
Other wikis on this site, can be administered from a single developer account.
List of wiki DB domain IDs; the format of each ID consist of 1-3 hyphen delimited alphanumeric components (each with no hyphens nor spaces) of any of the forms:
Definition at line 3189 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LocalFileRepo |
File repository structures.
$wgLocalFileRepo is a single repository structure, and $wgForeignFileRepos is an array of such structures. Each repository structure is an associative array of properties configuring the repository.
Properties required for all repos:
Optional common properties:
For most core repos:
Set this to 0 if you do not want MediaWiki to divide your images
directory into many subdirectories.
It is recommended to leave this enabled. In previous versions of
MediaWiki, some users set this to false to allow images to be added to
the wiki by copying them into $wgUploadDirectory and then running
maintenance/rebuildImages.php to register them in the database.
This is no longer supported, use maintenance/importImages.php instead.
Default: 2.
updateCompatibleMetadata When true, image metadata will be upgraded by reloading it from the original file, if the handler indicates that it is out of date.
By default, when purging a file or otherwise refreshing file metadata, it is only reloaded when the metadata is invalid. Valid data originally loaded by a current or older compatible version is left unchanged. Enable this to also reload and upgrade metadata that was stored by an older compatible version. See also MediaHandler::isMetadataValid, and RefreshImageMetadata.
Default: false.
These settings describe a foreign MediaWiki installation. They are optional, and will be ignored for local repositories:
If you leave $wgLocalFileRepo set to false, Setup will fill in appropriate values. Otherwise, set $wgLocalFileRepo to a repository structure as described above. If you set $wgUseInstantCommons to true, it will add an entry for Commons. If you set $wgForeignFileRepos to an array of repository structures, those will be searched after the local file repo. Otherwise, you will only have access to local media files.
Definition at line 1088 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LocalisationCacheConf |
Localisation cache configuration.
Used by service wiring to decide how to construct the LocalisationCache instance. Associative array with keys:
class: The class to use for constructing the LocalisationCache object. This may be overridden by extensions to a subclass of LocalisationCache. Sub classes are expected to still honor the 'storeClass', 'storeDirectory' and 'manualRecache' options where applicable.
storeClass: Which LCStore class implementation to use. This is optional. The default LocalisationCache class offers the 'store' option as abstraction for this.
store: How and where to store localisation cache data. This option is ignored if 'storeClass' is explicitly set to a class name. Must be one of:
storeDirectory: If the selected LCStore class puts its data in files, then it will use this directory. If set to false (default), then $wgCacheDirectory is used instead.
manualRecache: Set this to true to disable cache updates on web requests. Use maintenance/rebuildLocalisationCache.php instead.
Definition at line 4197 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LocalStylePath |
The URL path of the skins directory.
Should not point to an external domain.
Defaults to "{$wgScriptPath}/skins".
Definition at line 445 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Localtimezone |
Fake out the timezone that the server thinks it's in.
This will be used for date display and not for what's stored in the DB. Leave to null to retain your server's OS-based timezone value.
This variable is currently used only for signature formatting and for local time/date parser variables ({{LOCALTIME}} etc.)
Timezones can be translated by editing MediaWiki messages of type timezone-nameinlowercase like timezone-utc.
A list of usable timezones can found at: https://www.php.net/manual/en/timezones.php
Examples:
Definition at line 4940 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LocalTZoffset |
Set an offset from UTC in minutes to use for the default timezone setting for anonymous users and new user accounts.
This setting is used for most date/time displays in the software, and is overridable in user preferences. It is not used for signature timestamps.
By default, this will be set to match $wgLocaltimezone.
Definition at line 4966 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LockManagers |
List of lock manager backend configurations.
Each backend configuration has the following parameters:
See LockManager::__construct() for more details. Additional parameters are specific to the lock manager class used. These settings should be global to all wikis.
Definition at line 1384 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LoginLanguageSelector |
Show a bar of language selection links in the user login and user registration forms; edit the "loginlanguagelinks" message to customise these.
Definition at line 4863 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Logo |
The URL path of the wiki logo.
The logo size should be 135x135 pixels.
Defaults to "$wgResourceBasePath/resources/assets/change-your-logo.svg". Developers should retrieve this logo (and other variants) using the static function MediaWiki\ResourceLoader\SkinModule::getAvailableLogos Ignored if $wgLogos is set.
Definition at line 626 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::LogoHD |
Array with URL paths to HD versions of the wiki logo.
The scaled logo size should be under 135x155 pixels. Only 1.5x and 2x versions are supported.
SVG is also supported but when enabled, it disables 1.5x and 2x as svg will already be optimised for screen resolution.
Definition at line 722 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Logos |
Specification for different versions of the wiki logo.
This is an array which should have the following k/v pairs: All path values can be either absolute or relative URIs
The 1x key is a path to the 1x version of square logo (should be 135x135 pixels) The 1.5x key is a path to the 1.5x version of square logo The 2x key is a path to the 2x version of square logo The svg key is a path to the svg version of square logo The icon key is a path to the version of the logo without wordmark and tagline The wordmark key may be null or an array with the following fields
src path to wordmark version1x path to svg wordmark version (if you want to support browsers with SVG support with an SVG logo)width width of the logo in pixelsheight height of the logo in pixels The tagline key may be null or array with the following fieldssrc path to tagline imagewidth width of the tagline in pixelsheight height of the tagline in pixelsDefaults to [ "1x" => $wgLogo ], or [ "1x" => "$wgResourceBasePath/resources/assets/change-your-logo.svg" ] if $wgLogo is not set.
Definition at line 688 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MainCacheType |
Main cache type.
This should be a cache with fast access, but it may have limited space. By default, it is disabled, since the stock database cache is not fast enough to make it worthwhile.
The options are:
For a multi-datacenter setup, the underlying service should be configured to broadcast operations by WANObjectCache using Mcrouter or Dynomite. See Deploying WANObjectCache. To configure the broadcastRoutingPrefix WANObjectCache parameter, use $wgWANObjectCache.
Definition at line 3772 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MainPageIsDomainRoot |
Option to whether serve the main page as the domain root.
Definition at line 850 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MainStash |
The object store type of the main stash.
This should be a fast storage system optimized for lightweight data, both ephemeral and permanent, for things like counters, tokens, and blobs. The dataset access scope should include all the application servers in all datacenters. Thus, the data must be replicated among all datacenters. The store should have "Last Write Wins" eventual consistency. Per https://en.wikipedia.org/wiki/PACELC_theorem, the store should act as a PA/EL distributed system for these operations.
The multi-datacenter strategy for MediaWiki is to have CDN route HTTP POST requests to the primary datacenter and HTTP GET/HEAD/OPTIONS requests to the closest datacenter to the client. The stash accepts write operations from any datacenter, but cross-datacenter replication is asynchronous.
Modules that use the main stash can expect race conditions to occur if a key can receive write operations originating from multiple datacenters. To improve consistency, callers should avoid main stash updates during non-POST requests. In any case, callers should gracefully tolerate occasional key evictions, temporary inconsistencies among datacenters, and violations of linearizability (e.g. during timeouts). Modules that can never handle these kind of anamolies should use other storage mediums.
Valid options are the keys of $wgObjectCaches, e.g. CACHE_* constants.
Definition at line 3992 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MangleFlashPolicy |
Formerly a workaround for a security vulnerability caused by installation of Flash as a browser extension.
Definition at line 5356 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxAnimatedGifArea |
Force thumbnailing of animated GIFs above this size to a single frame instead of an animated thumbnail.
As of MW 1.17 this limit is checked against the total size of all frames in the animation.
It probably makes sense to keep this equal to $wgMaxImageArea.
Definition at line 2011 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxArticleSize |
Maximum article size in kibibytes.
Definition at line 3580 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxExecutionTimeForExpensiveQueries |
Max execution time for queries of several expensive special pages such as RecentChanges in milliseconds.
Definition at line 3220 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxImageArea |
The maximum number of pixels a source image can have if it is to be scaled down by a scaler that requires the full source image to be decompressed and stored in decompressed form, before the thumbnail is generated.
This provides a limit on memory usage for the decompression side of the image scaler. The limit is used when scaling PNGs with any of the built-in image scalers, such as ImageMagick or GD. It is ignored for JPEGs with ImageMagick, and when using the VipsScaler extension.
If set to false, MediaWiki will not check the size of the image before attempting to scale it. Extensions may still override this setting by using the BitmapHandlerCheckImageArea hook.
The default is 50 MB if decompressed to RGBA form, which corresponds to 12.5 million pixels or 3500x3500.
Definition at line 1998 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaximalPasswordLength |
Specifies the maximal length of a user password (T64685).
It is not recommended to make this greater than the default, as it can allow DoS attacks by users setting really long passwords. In addition, this should not be lowered too much, as it enforces weak passwords.
Definition at line 7127 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaximumMovedPages |
Maximum number of pages to move at once when moving subpages with a page.
Definition at line 3697 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxInterlacingAreas |
Array of max pixel areas for interlacing per MIME type.
Definition at line 1786 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxJobDBWriteDuration |
Max time (in seconds) a job-generated transaction can spend in writes.
If exceeded, the transaction is rolled back with an error instead of being committed.
Definition at line 3681 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxMsgCacheEntrySize |
Maximum entry size in the message cache, in bytes.
Definition at line 4787 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxNameChars |
Maximum number of bytes in username.
You want to run the maintenance script ./maintenance/checkUsernames.php once you have changed this value.
Definition at line 7287 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxSigChars |
Maximum number of Unicode characters in signature.
Definition at line 7252 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxUploadSize |
Max size for uploads, in bytes.
If not set to an array, applies to all uploads. If set to an array, per upload type maximums can be set, using the file and url keys. If the * key is set this value will be used as maximum for non-specified types.
The below example would set the maximum for all uploads to 250 KiB except, for upload-by-url, which would have a maximum of 500 KiB.
Example:
Default: 100 MiB.
Definition at line 1503 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MaxUserDBWriteDuration |
Max time (in seconds) a user-generated transaction can spend in writes.
If exceeded, the transaction is rolled back with an error instead of being committed.
Definition at line 3669 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MediaHandlers |
Plugins for media file type handling.
Each entry in the array maps a MIME type to a class name
Core media handlers are listed in MediaHandlerFactory, and extensions should use extension.json.
Definition at line 1716 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MediaInTargetLanguage |
Whether thumbnails should be generated in target language (usually, same as page language), if available.
Currently, applies only to SVG images that use the systemLanguage attribute to specify text language.
Definition at line 1977 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MemCachedPersistent |
Use persistent connections to MemCached, which are shared across multiple requests.
Definition at line 4129 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MemCachedServers |
The list of MemCached servers and port numbers.
Definition at line 4120 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MemCachedTimeout |
Read/write timeout for MemCached server communication, in microseconds.
Definition at line 4136 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MemoryLimit |
The minimum amount of memory that MediaWiki "needs"; MediaWiki will try to raise PHP's memory limit if it's below this amount.
Definition at line 3588 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MessageCacheType |
The cache type for storing the contents of the MediaWiki namespace.
This cache is used for a small amount of data which is expensive to regenerate.
For available types see $wgMainCacheType.
Definition at line 3782 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MetaNamespace |
Name of the project namespace.
If left set to false, $wgSitename will be used instead.
Definition at line 5953 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MetaNamespaceTalk |
Name of the project talk namespace.
Normally you can ignore this and it will be something like $wgMetaNamespace . "_talk". In some languages, you may want to set this manually for grammatical reasons.
Definition at line 5973 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MimeDetectorCommand |
Sets an external MIME detector program.
The command must print only the MIME type to standard output.
The name of the file to process will be appended to the command given here. If not set or NULL, PHP's mime_content_type function will be used.
Example:
Definition at line 2227 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MimeInfoFile |
Sets the MIME type info file to use by includes/libs/mime/MimeAnalyzer.php.
Set to null to use the minimum set of built-in defaults only.
Definition at line 2210 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MimeType |
The default Content-Type header.
Definition at line 5002 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MimeTypeExclusions |
Files with these MIME types will never be allowed as uploads if $wgVerifyMimeType is enabled.
Definition at line 1629 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MimeTypeFile |
Sets the MIME type definition file to use by includes/libs/mime/MimeAnalyzer.php.
When this is set to the path of a mime.types file, MediaWiki will use this file to map MIME types to file extensions and vice versa, in lieu of its internal MIME map. Note that some MIME mappings are considered "baked in" and cannot be overridden. See includes/libs/mime/MimeMapMinimal.php for a full list. example: $wgMimeTypeFile = '/etc/mime.types';
Definition at line 2201 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MinimalPasswordLength |
Specifies the minimal length of a user password.
If set to 0, empty pass- words are allowed.
Definition at line 7111 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MinUploadChunkSize |
Minimum upload chunk size, in bytes.
When using chunked upload, non-final chunks smaller than this will be rejected.
Note that this may be further reduced by the upload_max_filesize and post_max_size PHP settings. Use ApiUpload::getMinUploadChunkSize to get the effective minimum chunk size used by MediaWiki.
Default: 1 KiB.
Definition at line 1521 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MiserMode |
Disable database-intensive features.
Definition at line 3538 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::MultiShardSiteStats |
Whether site_stats table should have multiple rows.
If set to true, in each update, one of ten rows gets updated at random to reduce lock wait time in wikis that have lots of concurrent edits. It should be set to true in really large wikis with big flow of edits, Otherwise it can cause inaccuracy in data.
Definition at line 3726 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::NamespaceAliases |
Define extra namespace aliases.
These are alternate names for the primary localised namespace names, which are defined by $wgExtraNamespaces and the language file. If a page is requested with such a prefix, the request will be redirected to the primary name.
Set this to a map from namespace names to IDs.
Example:
Definition at line 6054 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::NamespaceContentModels |
Associative array mapping namespace IDs to the name of the content model pages in that namespace should have by default (use the CONTENT_MODEL_XXX constants).
If no special content type is defined for a given namespace, pages in that namespace will use the CONTENT_MODEL_WIKITEXT (except for the special case of JS and CS pages).
Definition at line 3326 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::NamespaceProtection |
Set the minimum permissions required to edit pages in each namespace.
If you list more than one permission, a user must have all of them to edit pages in that namespace.
Definition at line 7995 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::NativeImageLazyLoading |
Toggles native image lazy loading, via the "loading" attribute.
Definition at line 1727 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::NewPasswordExpiry |
The time, in seconds, when an emailed temporary password expires.
Definition at line 2618 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::NonincludableNamespaces |
Pages in namespaces in this array can not be used as templates.
Elements MUST be numeric namespace ids, you can safely use the MediaWiki namespaces constants (NS_USER, NS_MAIN...).
Among other things, this may be useful to enforce read-restrictions which may otherwise be bypassed by using the template mechanism.
Definition at line 8009 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::NoReplyAddress |
Reply-To address for e-mail notifications.
Defaults to $wgPasswordSender (in Setup.php).
Definition at line 2552 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ObjectCaches |
Advanced object cache configuration.
Use this to define the class names and constructor parameters which are used for the various cache types. Custom cache types may be defined here and referenced from $wgMainCacheType, $wgMessageCacheType, $wgParserCacheType, or $wgLanguageConverterCacheType.
The format is an associative array where the key is a cache identifier, and the value is an associative array of parameters. One of the following parameters specifying the class must be given:
The following parameters are shared and understood by most classes:
For SqlBagOStuff, the main configured database will be used, unless one of the following three parameters is given:
SqlBagOStuff also accepts the following optional parameters:
modtoken column must exist on the objectcache table(s).For MemcachedPhpBagOStuff parameters see MemcachedPhpBagOStuff::__construct
For MemcachedPeclBagOStuff parameters see MemcachedPeclBagOStuff::__construct
For RedisBagOStuff parameters see RedisBagOStuff::__construct
Definition at line 3910 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ObjectCacheSessionExpiry |
The expiry time to use for session storage, in seconds.
Definition at line 4075 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::OldRevisionParserCacheExpireTime |
The expiry time for the parser cache for old revisions, in seconds.
The default is 3600 (cache disabled).
Definition at line 4068 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::OverrideUcfirstCharacters |
Map of Unicode characters for which capitalization is overridden in Language::ucfirst.
The characters should be represented as char_to_convert => conversion_override. See T219279 for details on why this is useful during php version transitions.
Definition at line 4988 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PageLanguageUseDB |
Enable page language feature Allows setting page language in database.
Definition at line 3453 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ParserCacheExpireTime |
The expiry time for the parser cache, in seconds.
The default is 86400 (one day).
Definition at line 4059 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ParserCacheType |
The cache type for storing page content HTML (e.g.
parsed from wikitext).
Parsing wikitext is considered an expensive operation. It is recommended to give your parser cache plenty of storage space, such that long tail cache hits are possible.
The default parser cache backend (when MainCacheType is left to CACHE_NONE) is effectively CACHE_DB (SqlBagOStuff). If you set up a main cache type such as memcached, it is recommended to set this explicitly to CACHE_DB.
Advice for large wiki farms:
For available types see $wgMainCacheType.
Definition at line 3811 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ParserTestMediaHandlers |
Media handler overrides for parser tests (they don't need to generate actual thumbnails, so a mock will do)
Definition at line 1736 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ParsoidCacheConfig |
Configuration for the caching related to parsoid output.
The configuration contains the following keys:
Definition at line 4024 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PasswordAttemptThrottle |
Limit password attempts to X attempts per Y seconds per IP per account.
Value is an array of arrays. Each sub-array must have a key for count (ie count of how many attempts before throttle) and a key for seconds. If the key 'allIPs' (case sensitive) is present, then the limit is just per account instead of per IP per account.
Definition at line 8545 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PasswordConfig |
Configuration for built-in password types.
Maps the password type to an array of options:
All other options are class-dependent.
An advanced example:
Definition at line 7181 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PasswordDefault |
Default password type to use when hashing user passwords.
Must be set to a type defined in $wgPasswordConfig, or a type that is registered by default in PasswordFactory.php.
Definition at line 7150 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PasswordExpirationDays |
The number of days that a user's password is good for.
After this number of days, the user will be asked to reset their password. Set to false to disable password expiration.
Definition at line 2633 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PasswordExpireGrace |
If a user's password is expired, the number of seconds when they can still login, and cancel their password change, but are sent to the password change form on each login.
Definition at line 2641 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PasswordReminderResendTime |
Minimum time, in hours, which must elapse between password reminder emails for a given account.
This is to prevent abuse by mail flooding.
Definition at line 2611 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PasswordResetRoutes |
Whether to allow password resets ("enter some identifying data, and we'll send an email with a temporary password you can use to get back into the account") identified by various bits of data.
Setting all of these to false (or the whole variable to false) has the effect of disabling password resets entirely
Definition at line 7241 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PasswordSender |
Sender email address for e-mail notifications.
The address we use as sender when a user requests a password reminder, as well as other e-mail notifications.
Defaults to "apache@$wgServerName" (in Setup.php).
Definition at line 2543 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PHPSessionHandling |
Whether to use PHP session handling ($_SESSION and session_*() functions)
If the constant MW_NO_SESSION is defined, this is forced to 'disable'.
If the constant MW_NO_SESSION_HANDLER is defined, this is ignored and PHP session handling will function independently of SessionHandler. SessionHandler and PHP's session handling may attempt to override each others' cookies.
Definition at line 4091 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PoolCountClientConf |
Configuration array for the PoolCounter client.
timeout and will be retried once if a connection fails to be established. Background: https://phabricator.wikimedia.org/T105378.Definition at line 3652 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PoolCounterConf |
Configuration for processing pool control, for use in high-traffic wikis.
An implementation is provided in the PoolCounter extension.
This configuration array maps pool types to an associative array. The only defined key in the associative array is "class", which gives the class name. The remaining elements are passed through to the class as constructor parameters.
Example using local redis instance:
Example using C daemon from https://gerrit.wikimedia.org/g/mediawiki/services/poolcounter
Definition at line 3635 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ProhibitedFileExtensions |
Files with these extensions will never be allowed as uploads.
An array of file extensions to prevent being uploaded. You should append to this array if you want to prevent additional file extensions.
Definition at line 1609 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ProxyList |
List of banned IP addresses.
This can have the following formats:
Definition at line 8342 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ProxyWhitelist |
Proxy whitelist, list of addresses that are assumed to be non-proxy despite what the other methods might say.
Definition at line 8351 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::PutIPinRC |
Log IP addresses in the recentchanges table; can be accessed only by extensions (e.g.
CheckUser) or a DB admin Used for retroactive autoblocks
Definition at line 8521 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::QueryCacheLimit |
Number of rows to cache in 'querycache' table when miser mode is on.
Definition at line 3552 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::QueryPageDefaultLimit |
Integer defining default number of entries to show on special pages which are query-pages such as Special:Whatlinkshere.
Definition at line 8529 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RateLimits |
Simple rate limiter options to brake edit floods.
Maximum number actions allowed in the given number of seconds; after that the violating client receives HTTP 500 error pages until the period elapses.
Example: Limits per configured per action and then type of users.
Normally, the 'noratelimit' right allows a user to bypass any rate limit checks. This can be disabled on a per-action basis by setting the special '&can-bypass' key to false in that action's configuration.
Definition at line 8419 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RateLimitsExcludedIPs |
Array of IPs / CIDR ranges which should be excluded from rate limits.
This may be useful for allowing NAT gateways for conferences, etc.
Definition at line 8511 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RawHtmlMessages |
List of messages which might contain raw HTML.
Extensions should add their insecure raw HTML messages to extension.json. The list is used for access control: changing messages listed here will require editsitecss and editsitejs rights.
Message names must be given with underscores rather than spaces and with lowercase first letter.
Definition at line 4904 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ReauthenticateTime |
Time frame for re-authentication.
With only password-based authentication, you'd just ask the user to re-enter their password to verify certain operations like changing the password or changing the account's email address. But under AuthManager, the user might not have a password (you might even have to redirect the browser to a third-party service or something complex like that), you might want to have both factors of a two-factor authentication, and so on. So, the options are:
MediaWiki currently takes the second option. This setting configures the "X seconds".
This allows for configuring different time frames for different "operations". The operations used in MediaWiki core include:
Additional operations may be used by extensions, either explicitly by calling AuthManager::securitySensitiveOperationStatus(), ApiAuthManagerHelper::securitySensitiveOperation() or SpecialPage::checkLoginSecurityLevel(), or implicitly by overriding SpecialPage::getLoginSecurityLevel() or by subclassing AuthManagerSpecialPage.
The key 'default' is used if a requested operation isn't defined in the array.
Definition at line 7043 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ReferrerPolicy |
Value for the referrer policy meta tag.
One or more of the values defined in the Referrer Policy specification: https://w3c.github.io/webappsec-referrer-policy/ ('no-referrer', 'no-referrer-when-downgrade', 'same-origin', 'origin', 'strict-origin', 'origin-when-cross-origin', 'strict-origin-when-cross-origin', or 'unsafe-url') Setting it to false prevents the meta tag from being output (which results in falling back to the Referrer-Policy header, or 'no-referrer-when-downgrade' if that's not set either.) Setting it to an array (supported since 1.31) will create a meta tag for each value, in the reverse of the order (meaning that the first array element will be the default and the others used as fallbacks for browsers which do not understand it).
Definition at line 768 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RememberMe |
Configures RememberMe authentication request added by AuthManager.
It can show a "remember me" checkbox that, when checked, will cause it to take more time for the authenticated session to expire. It can also be configured to always or to never extend the authentication session.
Valid values are listed in RememberMeAuthenticationRequest::ALLOWED_FLAGS.
Definition at line 7001 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RemoveCredentialsBlacklist |
List of AuthenticationRequest class names which are not removable through Special:RemoveCredentials and the removeauthenticationdata API.
This is only enforced on the client level; AuthManager itself (e.g. AuthManager::allowsAuthenticationDataChange calls) is not affected. Class names are checked for exact match (not for subclasses).
Definition at line 7097 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RemoveGroups |
Definition at line 8194 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RenderHashAppend |
Append a configured value to the parser cache and the sitenotice key so that they can be kept separate for some class of activity.
Definition at line 4261 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RepositoryBaseUrl |
Shortcut for the 'descBaseUrl' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1224 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RequestTimeLimit |
Set a limit on server request wall clock time.
If the Excimer extension is enabled, setting this will cause an exception to be thrown after the specified number of seconds. If the extension is not available, set_time_limit() will be called instead.
Definition at line 3498 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ReservedUsernames |
Array of usernames which may not be registered or logged in from Maintenance scripts can still use these.
Definition at line 7297 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceBasePath |
The default 'remoteBasePath' value for instances of MediaWiki\ResourceLoader\FileModule.
Defaults to $wgScriptPath.
Definition at line 5807 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderClientPreferences |
Enable client-side preferences for unregistered users.
This is only supported for unregistered users. For registered users, skins and extensions must use user preferences (e.g. hidden or API-only options) and swap class names server-side through the Skin interface.
Definition at line 5160 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderDebug |
The default debug mode (on/off) for of ResourceLoader requests.
This will still be overridden when the debug URL parameter is used.
Definition at line 5852 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderEnableJSProfiler |
When enabled, execution of JavaScript modules is profiled client-side.
Instrumentation happens in mw.loader.profiler. Use ‘mw.inspect('time’)` from the browser console to display the data.
Definition at line 5892 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderMaxage |
Override how long a CDN or browser may cache a ResourceLoader HTTP response.
Maximum time in seconds. Used for the max-age and s-maxage Cache-Control headers.
Valid keys:
Definition at line 5832 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderMaxQueryLength |
ResourceLoader will not generate URLs whose query string is more than this many characters long, and will instead use multiple requests with shorter query strings.
Using multiple requests may degrade performance, but may be needed based on the query string limit supported by your web server and/or your user's web browsers.
Default: 2000.
Definition at line 5868 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderSources |
Extensions should register foreign module sources here.
'local' is a built-in source that is not in this array, but defined by ResourceLoader::__construct() so that it cannot be unset.
Example:
Definition at line 5797 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderStorageEnabled |
Whether ResourceLoader should attempt to persist modules in localStorage on browsers that support the Web Storage API.
Definition at line 5900 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderStorageVersion |
Cache version for client-side ResourceLoader module storage.
You can trigger invalidation of the contents of the module store by incrementing this value.
Definition at line 5910 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderUseObjectCacheForDeps |
Use the main stash instead of the module_deps table for indirect dependency tracking.
Definition at line 5843 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceLoaderValidateJS |
If set to true, JavaScript modules loaded from wiki pages will be parsed prior to minification to validate it.
Parse errors will result in a JS exception being thrown during module load, which avoids breaking other modules loaded in the same request.
Definition at line 5880 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceModules |
Define extra client-side modules to be registered with ResourceLoader.
ResourceModule attribute in extension.json or skin.json when possible (instead of via PHP global variables).Registration is internally handled by ResourceLoader::register.
Modules that ship with MediaWiki core are registered via resources/Resources.php. For a full list with documentation, see: ResourceLoader/Core_modules.
class {string}: By default a module is assumed to bundle file resources as handled by the MediaWiki\ResourceLoader\FileModule class. Use this option to use a different implementation of MediaWiki\ResourceLoader\Module instead.
Default: \\MediaWiki\\ResourceLoader\\FileModule
factory {string}: Override the instantiation of the MediaWiki\ResourceLoader\Module class using a PHP callback. This allows dependency injection to be used. This option cannot be combined with the class option.
Since: MW 1.30
dependencies {string[]|string}: Modules that must be executed before this module. Module name string or list of module name strings.
Default: []
deprecated {boolean|string}: Whether the module is deprecated and usage is discouraged. Set to boolean true, or a string to include in the warning message.
Default: false
group {string}: Optional request group to override which modules may be downloaded together in an HTTP batch request. By default, any two modules may be loaded together in the same batch request. Set this option to a descriptive string to give the module its own HTTP request. To allow other modules to join this new request, give those the same request group.
Use this option with caution. The default behaviour is well-tuned already, and setting this often does more harm than good. For more about request balancing optimisations, see ResourceLoader/Architecture#Balance.
skipFunction {string}: Allow this module to be satisfied as dependency without actually loading or executing scripts from the server, if the specified JavaScript function returns true.
Use this to provide polyfills that are natively available in newer browsers. Specify the relative path to a JavaScript file containing a top-level return statement. The contents of the file should not contain any wrapping function, it will be wrapped by ResourceLoader in an anonymous function and invoked when the module is considered for loading.
targets {string[]} List of ResourceLoader targets where the module may be loaded from. This is used by the MobileFrontend extension to prevent certain modules from being loaded.
This option is deprecated. See T127268.
Default: ["desktop"]
localBasePath {string}: Base file path to prepend to relative file paths specified in other options.
Default: $IP
remoteBasePath {string}: Base URL path to prepend to relative file paths specified in other options. This is used to form URLs for files, such as when referencing images in stylesheets, or in debug mode to serve JavaScript files directly.
Default: $wgResourceBasePath (which defaults to $wgScriptPath)
remoteExtPath {string}: Shortcut for remoteBasePath that is relative to $wgExtensionAssetsPath. Use this when defining modules from an extension, so as to avoid hardcoding the script path of the MediaWiki install or the location of the extensions directory.
This option is mutually exclusive with remoteBasePath.
styles {string[]|string|array<string,array>}: Styles to always include in the module. File path or list of file paths, relative to localBasePath. The stylesheet can be automatically wrapped in a @media query by specifying the file path as the key in an object (instead of the value), with the value specifying a media query.
See Stylesheet examples below.
See also $wgResourceModuleSkinStyles.
Extended options:
{string[]|string}: Styles to include in specific skin contexts. Array keyed is by skin name with file path or list of file paths as value, relative to localBasePath.Default: []
noflip {boolean}: By default, CSSJanus will be used automatically to perform LTR-to-RTL flipping when loaded in a right-to-left (RTL) interface language context. Use this option to skip CSSJanus LTR-to-RTL flipping for this module, for example when registering an external library that already handles RTL styles.
Default: false
packageFiles {string[]|array[]} Specify script files and (virtual) data files to include in the module. Each internal JavaScript file retains its own local module scope and its private exports can be accessed separately by other client-side code in the same module, via the local require() function.
Modules that use package files should export any public API methods using module.exports.
See examples at ResourceLoader/Package_files on mediawiki.org.
The packageFiles feature cannot be combined with legacy scripts that use the scripts option, including its extended variants languageScripts, skinScripts, and debugScripts.
Since: MW 1.33
Default: []
scripts {string[]|string|array[]}: Scripts to always include in the module. File path or list of file paths, relative to localBasePath.
These files are concatenated blindly and executed as a single client-side script. Modules using this option are sometimes referred to as "legacy scripts" to distinguish them from those that use the packageFiles option.
Modules that use legacy scripts usually attach any public APIs they have to the mw global variable. If a module contains just one file, it is also supported to use the newer module.exports mechanism, though if the module contains more than one legacy script, it is considered unsafe and unsupported to use this mechanism (use packageFiles instead). See also Coding conventions/JavaScript.
Since MW 1.41, an element of scripts may be an array in the same format as packageFiles, giving a callback to call for content generation.
Default: []
Extended options, concatenated in this order:
{string[]|string|array[]}: Scripts to include in specific language contexts. Array is keyed by language code with file path or list of file path.{string[]|string|array[]}: Scripts to include in specific skin contexts. Array keyed is by skin name with file path or list of file paths.{string[]|string|array[]}: Scripts to include in debug contexts. File path or list of file paths.messages {string[]} Localisation messages to bundle with this module, for client-side use via mw.msg() and mw.message(). List of message keys.
Default: []
templates {string[]} List of template files to be loaded for client-side usage via mw.templates.
Default: []
es6 {boolean}: Since: MW 1.36; ignored since MW 1.41.
Default: true
Example: Using an alternate subclass
Example: Deprecated module
Example: Base paths in extension.json
Example: Base paths in core with PHP
Example: Define a skip function
Example: Contents of skip function file
Example: Module targets
Example: Package files
Example: Legacy scripts
Example: Template files
Definition at line 5682 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResourceModuleSkinStyles |
Add extra skin-specific styles to a resource module.
These are automatically added by ResourceLoader to the 'skinStyles' list of the existing module. The 'styles' list cannot be modified or disabled.
For example, below a module "bar" is defined and skin Foo provides additional styles for it:
Example:
This is effectively equivalent to:
Equivalent:
If the module already defines its own entry in skinStyles for a given skin, then $wgResourceModuleSkinStyles is ignored.
If a module defines a ‘skinStyles['default’]the skin may want to extend that instead of replacing it. This can be done using the+` prefix.
Example:
This is effectively equivalent to:
Equivalent:
In other words, as a module author, use the styles list for stylesheets that may not be disabled by a skin. To provide default styles that may be extended or replaced, use ‘skinStyles['default’]`.
As with $wgResourceModules, always set the localBasePath and remoteBasePath keys (or one of remoteExtPath/remoteSkinPath).
Example:
Definition at line 5781 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ResponsiveImages |
Generate and use thumbnails suitable for screens with 1.5 and 2.0 pixel densities.
This means a 320x240 use of an image on the wiki will also generate 480x360 and 640x480 thumbnails, output via the srcset attribute.
Definition at line 2443 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RestAllowCrossOriginCookieAuth |
Allows authenticated cross-origin requests to the REST API with session cookies.
With this option enabled, any orgin specified in $wgCrossSiteAJAXdomains may send session cookies for authorization in the REST API.
There is a performance impact by enabling this option. Therefore, it should be left disabled for most wikis and clients should instead use OAuth to make cross-origin authenticated requests.
Definition at line 9001 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RestPath |
The URL path to the REST API Defaults to "{$wgScriptPath}/rest.php".
Definition at line 405 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RestrictionLevels |
Rights which can be required for each protection level (via action=protect)
You can add a new protection level that requires a specific permission by manipulating this array. The ordering of elements dictates the order on the protection form's lists.
Definition at line 7952 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RestrictionTypes |
Set of available actions that can be restricted via action=protect You probably shouldn't change this.
Translated through restriction-* messages. RestrictionStore::listApplicableRestrictionTypes() will remove restrictions that are not applicable to a specific title (create and upload)
Definition at line 7936 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RevisionCacheExpiry |
Revision text may be cached in the main WAN cache to reduce load on external storage servers and object extraction overhead for frequently-loaded revisions.
Set to 0 to disable, or number of seconds before cache expiry.
Definition at line 3442 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::RevokePermissions |
Permission keys revoked from users in each group.
This acts the same way as $wgGroupPermissions above, except that if the user is in a group here, the permission will be removed from them.
Improperly setting this could mean that your users will be unable to perform certain essential tasks, so use at your own risk!
Definition at line 7852 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Script |
The URL path to index.php.
Defaults to "{$wgScriptPath}/index.php".
Definition at line 366 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ScriptPath |
The path we should point to.
It might be a virtual path in case with use apache mod_rewrite for example.
This needs to be set correctly.
Other paths will be set to defaults based on it unless they are directly set in LocalSettings.php
Definition at line 326 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SearchType |
Search type.
Leave as null to select the default search engine for the selected database type (eg SearchMySQL), or set to a class name to override to a custom search engine.
If the canonical name for the search engine doesn't match the class name (because it's namespaced for example), you can add a mapping for this in SearchMappings in extension.json.
Definition at line 2919 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SearchTypeAlternatives |
Alternative search types.
Sometimes you want to support multiple search engines for testing. This allows users to select their search engine of choice via url parameters to Special:Search and the action=search API. If using this, there's no need to add $wgSearchType to it, that is handled automatically.
If the canonical name for the search engine doesn't match the class name (because it's namespaced for example), you can add a mapping for this in SearchMappings in extension.json.
Definition at line 2935 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SecretKey |
This should always be customised in LocalSettings.php.
Definition at line 8832 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SecureLogin |
This is to let user authenticate using https when they come from http.
Based on an idea by George Herbert on wikitech-l: https://lists.wikimedia.org/pipermail/wikitech-l/2010-October/050039.html
Definition at line 7435 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SemiprotectedRestrictionLevels |
Restriction levels that should be considered "semiprotected".
Certain places in the interface recognize a dichotomy between "protected" and "semiprotected", without further distinguishing the specific levels. In general, if anyone can be eligible to edit a protection level merely by reaching some condition in $wgAutopromote, it should probably be considered "semiprotected".
'autoconfirmed' is quietly rewritten to 'editsemiprotected' for backwards compatibility. 'sysop' is not changed, since it really shouldn't be here.
Definition at line 7983 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Send404Code |
Some web hosts attempt to rewrite all responses with a 404 (not found) status code, mangling or hiding MediaWiki's output.
If you are using such a host, you should start looking for a better one. While you're doing that, set this to false to convert some of MediaWiki's 404 responses to 200 so that the generated error pages can be seen.
In cases where for technical reasons it is more important for MediaWiki to send the correct status code than for the body to be transmitted intact, this configuration variable is ignored.
Definition at line 5296 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Server |
URL of the server.
Example:
This must be set in LocalSettings.php. The MediaWiki installer does this automatically since 1.18.
If you want to use protocol-relative URLs on your wiki, set this to a protocol-relative URL like '//example.com' and set $wgCanonicalServer to a fully qualified URL.
Definition at line 242 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ServerName |
Server name.
This is automatically computed by parsing the bare hostname out of $wgCanonicalServer. It should not be customized.
Definition at line 265 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SessionCacheType |
The cache backend for storing session data.
Used by MediaWiki\Session\SessionManager. See $wgMainCacheType for available types.
See SessionManager Storage expectations.
Definition at line 3822 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SessionInsecureSecrets |
If for some reason you can't install the PHP OpenSSL extension, you can set this to true to make MediaWiki work again at the cost of storing sensitive session data insecurely.
But it would be much more secure to just install the OpenSSL extension.
Definition at line 9026 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SessionPbkdf2Iterations |
Number of internal PBKDF2 iterations to use when deriving session secrets.
Definition at line 4113 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SessionProviders |
MediaWiki\Session\SessionProvider configuration.
Values are ObjectFactory specifications for the SessionProviders to be used. Keys in the array are ignored; the class name is conventionally used as the key to avoid collisions. Order is not significant.
Definition at line 7462 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SessionSecret |
Secret for session storage.
This should be set in LocalSettings.php, otherwise $wgSecretKey will be used.
Definition at line 9014 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedDB |
Shared database for multiple wikis.
Commonly used for storing a user table for single sign-on. The server for this database must be the same as for the main database.
For backwards compatibility the shared prefix is set to the same as the local prefix, and the user table is listed in the default list of shared tables. The user_properties table is also added so that users will continue to have their preferences shared (preferences were stored in the user table prior to 1.16)
$wgSharedTables may be customized with a list of tables to share in the shared database. However it is advised to limit what tables you do share as many of MediaWiki's tables may have side effects if you try to share them.
$wgSharedPrefix is the table prefix for the shared database. It defaults to $wgDBprefix.
$wgSharedSchema is the table schema for the shared database. It defaults to $wgDBmwschema.
Definition at line 2995 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedPrefix |
Definition at line 3002 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedSchema |
Definition at line 3032 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedTables |
Definition at line 3019 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedThumbnailScriptPath |
Shortcut for the 'thumbScriptUrl' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1573 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedUploadDBname |
Shortcut for the ForeignDBRepo 'dbName' setting in $wgForeignFileRepos.
Set this to false if the uploads do not come from a wiki. Only used if $wgUseSharedUploads is enabled.
Definition at line 1248 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedUploadDBprefix |
Shortcut for the ForeignDBRepo 'tablePrefix' setting in $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1260 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedUploadDirectory |
Shortcut for the 'directory' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1188 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharedUploadPath |
Shortcut for the 'url' setting of $wgForeignFileRepos.
Only used if $wgUseSharedUploads is enabled.
Definition at line 1200 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharpenParameter |
Sharpening parameter to ImageMagick.
Definition at line 1794 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SharpenReductionThreshold |
Reduction in linear dimensions below which sharpening will be enabled.
Definition at line 1801 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ShowArchiveThumbnails |
Show thumbnails for old images on the image description page.
Definition at line 2101 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ShowEXIF |
Whether to show Exif data.
The effective default value is determined at runtime: enabled if PHP's EXIF extension module is loaded.
Requires PHP's Exif extension: https://www.php.net/manual/en/ref.exif.php
Definition at line 1404 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ShowRollbackEditCount |
The $wgShowRollbackEditCount variable is used to show how many edits can be rolled back.
The numeric value of the variable controls how many edits MediaWiki will look back to determine whether a rollback is allowed (by checking that they are all from the same author). If the value is false or 0, the edits are not counted. Disabling this will prevent MediaWiki from hiding some useless rollback links.
Definition at line 5310 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SidebarCacheExpiry |
Expiry time for the sidebar cache, in seconds.
Definition at line 4281 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SignatureAllowedLintErrors |
List of lint error codes which don't cause signature validation to fail.
Definition at line 7278 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SignatureValidation |
Behavior of signature validation.
Allowed values are:
Definition at line 7268 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::Sitename |
Name of the site.
It must be changed in LocalSettings.php
Definition at line 212 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SiteNotice |
Site notice shown at the top of each page.
MediaWiki:Sitenotice page, which will override this. You can also provide a separate message for logged-out users using the MediaWiki:Anonnotice page.
Definition at line 5083 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SkinMetaTags |
An array of open graph tags which should be added by all skins.
Accepted values are "og:title", "og:type" and "twitter:card". Since some of these fields can be provided by extensions it defaults to an empty array.
Definition at line 5112 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SkipSkins |
Specify the names of skins that should not be presented in the list of available skins in user preferences.
NOTE: This does not uninstall the skin, and it will still be accessible via the useskin query parameter. To uninstall a skin, remove its inclusion from LocalSettings.php.
Definition at line 5144 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SMTP |
SMTP Mode.
For using a direct (authenticated) SMTP server connection. Default to false or fill an array :
Definition at line 2662 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SoftBlockRanges |
IP ranges that should be considered soft-blocked (anon-only, account creation allowed).
The intent is to use this to prevent anonymous edits from shared resources such as Wikimedia Labs.
Definition at line 8363 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SpamRegex |
Edits matching these regular expressions in body text will be recognised as spam and rejected automatically.
There's no administrator override on-wiki, so be careful what you set. :) May be an array of regexes or a single string for backwards compatibility.
Definition at line 8282 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SQLiteDataDir |
To override default SQLite data directory ($docroot/../data)
Definition at line 2971 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SQLMode |
SQL Mode - default is turning off all modes, including strict, if set.
null can be used to skip the setting for performance reasons and assume DBA has done his best job. String override can be used for some additional fun :-)
Definition at line 2953 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SquidPurgeUseHostHeader |
Whether to use a Host header in purge requests sent to the proxy servers configured in $wgCdnServers.
Set this to false to support a CDN configured in forward-proxy mode.
If this is set to true, a Host header will be sent, and only the path component of the URL will appear on the request line, as if the request were a non-proxy HTTP 1.1 request. Varnish only supports this style of request. Squid supports this style of request only if reverse-proxy mode (http_port ... accel) is enabled.
If this is set to false, no Host header will be sent, and the absolute URL will be sent in the request line, as is the standard for an HTTP proxy request in both HTTP 1.0 and 1.1. This style of request is not supported by Varnish, but is supported by Squid in either configuration (forward or reverse).
Definition at line 4507 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::StatsCacheType |
The object cache type for stats storage.
\\Wikimedia\\WRStats\\WRStatsFactory
Definition at line 3842 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::StrictFileExtensions |
If this is turned off, users may override the warning for files not covered by $wgFileExtensions.
Definition at line 1664 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::StyleDirectory |
Skins directory in the file system.
Definition at line 498 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::StylePath |
The URL path of the skins directory.
Defaults to "{$wgResourceBasePath}/skins".
Definition at line 425 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SummarySpamRegex |
Same as SpamRegex except for edit summaries.
Definition at line 8290 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SuspiciousIpExpiry |
Time in seconds to remember IPs for, for the purposes of logging IP changes within the same session.
This is meant more for debugging errors in the authentication system than for detecting abuse.
Definition at line 4103 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SVGConverter |
Pick a converter defined in $wgSVGConverters.
Definition at line 1915 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SVGConverterPath |
If not in the executable PATH, specify the SVG converter path.
Definition at line 1922 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SVGConverters |
Scalable Vector Graphics (SVG) may be uploaded as images.
Since SVG support is not yet standard in browsers, it is necessary to rasterize SVGs to PNG as a fallback format.
An external program is required to perform this conversion. If set to an array, the first item is a PHP callable and any further items are passed as parameters after $srcPath, $dstPath, $width, $height
Definition at line 1899 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SVGMaxSize |
Don't scale a SVG larger than this.
Definition at line 1929 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SVGMetadataCutoff |
Don't read SVG metadata beyond this point.
Default is 1024*256 bytes
Definition at line 1938 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SVGNativeRendering |
Whether native rendering by the browser agent is allowed.
Default is false. Setting it to true disables all SVG conversion. Setting to the string 'partial' will only allow native rendering when the filesize is below SVGNativeRenderingSizeLimit and if the file contains at most 1 language.
Definition at line 1952 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::SVGNativeRenderingSizeLimit |
Filesize limit for allowing SVGs to render natively by the browser agent.
Default is 50kB.
Definition at line 1964 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::TemplateLinksSchemaMigrationStage |
Templatelinks table schema migration stage, for normalizing tl_namespace and tl_title fields.
Use the SCHEMA_COMPAT_XXX flags. Supported values:
History:
Definition at line 3238 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::TextModelsToParse |
Determines which types of text are parsed as wikitext.
This does not imply that these kinds of texts are also rendered as wikitext, it only means that links, magic words, etc will have the effect on the database they would have on a wikitext page.
Note that table of contents information will be suppressed for all text models in this list other than wikitext.
Definition at line 3362 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ThumbLimits |
Adjust thumbnails on image pages according to a user setting.
In order to reduce disk usage, the values can only be selected from a list. This is the list of settings the user can choose from:
Definition at line 2284 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ThumbnailBuckets |
When defined, is an array of image widths used as buckets for thumbnail generation.
The goal is to save resources by generating thumbnails based on reference buckets instead of always using the original. This will incur a speed gain but cause a quality loss.
The buckets generation is chained, with each bucket generated based on the above bucket when possible. File handlers have to opt into using that feature. For now only BitmapHandler supports it.
Definition at line 2317 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ThumbnailEpoch |
If rendered thumbnail files are older than this timestamp, they will be rerendered on demand as if the file didn't already exist.
Update if there is some need to force thumbs and SVG rasterizations to rerender, such as fixes to rendering bugs.
Definition at line 2043 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ThumbnailMinimumBucketDistance |
When using thumbnail buckets as defined above, this sets the minimum distance to the bucket above the requested size.
The distance represents how many extra pixels of width the bucket needs in order to be used as the reference for a given thumbnail. For example, with the following buckets:
$wgThumbnailBuckets = [ 128, 256, 512 ];
and a distance of 50:
$wgThumbnailMinimumBucketDistance = 50;
If we want to render a thumbnail of width 220px, the 512px bucket will be used, because 220 + 50 = 270 and the closest bucket bigger than 270px is 512.
Definition at line 2337 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ThumbnailNamespaces |
Defines what namespaces thumbnails will be displayed for in Special:Search.
This is the list of namespaces for which thumbnails (or a placeholder in the absence of a thumbnail) will be shown:
Definition at line 2301 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ThumbnailScriptPath |
Give a path here to use thumb.php for thumbnail generation on client request, instead of generating them on render and outputting a static URL.
This is necessary if some of your apache servers don't have read/write access to the thumbnail path.
Example:
Definition at line 1562 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ThumbPath |
The base path for thumb_handler.php.
This is used to interpret the request URL for requests to thumb_handler.php that do not match the base upload path.
Definition at line 580 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::ThumbUpright |
Adjust width of upright images when parameter 'upright' is used This allows a nicer look for upright images without the need to fix the width by hardcoded px in wiki sourcecode.
Definition at line 2426 of file MainConfigSchema.php.
| const MediaWiki\MainConfigSchema::TiffThumbnailType |
Browsers don't support TIFF inline generally...
For inline display, we need to convert to PNG or JPEG.
Note scaling should work with ImageMagick, but may not with GD scaling.
Example:
Definition at line 2030 of file MainConfigSchema.php.