3 THIS IS NOT A RELEASE YET
5 MediaWiki 1.27 is an alpha-quality branch and is not recommended for use in
8 === PHP version requirement ===
9 As of 1.27, MediaWiki now requires PHP 5.5.9 or higher. This corresponds with
12 === Configuration changes in 1.27 ===
13 * $wgAllowMicrodataAttributes and $wgAllowRdfaAttributes were removed,
14 now always enabled. If you use RDFa on your wiki, you now have to explicitly
15 set $wgHtml5Version to 'HTML+RDFa 1.0' or 'XHTML+RDFa 1.0'.
16 * $wgUseLinkNamespaceDBFields was removed.
17 * Deprecated $wgResourceLoaderMinifierStatementsOnOwnLine and
18 $wgResourceLoaderMinifierMaxLineLength, because there was little value in
19 making the behavior configurable. The default values (`false` for the former,
20 1000 for the latter) are now hard-coded.
21 * $wgDebugDumpSqlLength was removed (deprecated in 1.24).
22 * $wgDebugDBTransactions was removed (deprecated in 1.20).
23 * $wgUseXVO has been removed, as it provides functionality only used by
24 custom Wikimedia patches against Squid 2.x that probably noone uses in
25 production anymore. There is now $wgUseKeyHeader that provides similar
26 functionality but instead of the MediaWiki-specific X-Vary-Options header,
27 uses the draft Key header standard.
28 * $wgScriptExtension (and support for '.php5' entry points) was removed. See the
29 deprecation notice in the release notes for version 1.25 for advice on how to
30 preserve support for '.php5' entry points via URL rewriting.
31 * Password handling via the User object has been deprecated and partially
32 removed, pending the future introduction of AuthManager. In particular:
33 ** expirePassword(), getPasswordExpireDate(), resetPasswordExpiration(), and
34 getPasswordExpired() have been removed. They were unused outside of core.
35 ** The mPassword, mNewpassword, mNewpassTime, and mPasswordExpires fields are
36 now private and will be removed in the future.
37 ** The getPassword() and getTemporaryPassword() methods now throw
38 BadMethodCallException and will be removed in the future.
39 ** The ability to pass 'password' and 'newpassword' to createNew() has been
40 removed. The only users of it seem to have been using it to set invalid
41 passwords, and so shouldn't be greatly affected.
42 ** setPassword(), setInternalPassword(), and setNewpassword() have been
43 deprecated, pending the introduction of AuthManager.
44 ** User::randomPassword() is deprecated in favor of a new method
45 PasswordFactory::generateRandomPasswordString()
46 ** User::getPasswordFactory() is deprecated, callers should just create a
47 PasswordFactory themselves.
48 ** A new constructor, User::newSystemUser(), has been added to simplify the
49 creation of passwordless "system" users for logged actions.
50 * $wgMaxSquidPurgeTitles was removed.
51 * $wgAjaxWatch was removed. This is now enabled by default.
52 * $wgUseInstantCommons now hotlinks Commons images by default instead of
53 downloading originals and thumbnailing them locally. This allows wikis to save
54 on CPU and bandwidth while reducing time to first byte for pages, even without
55 a thumbnail handler. See $wgForeignFileRepos documentation for tweaks.
56 * (T27397) WebP is enabled by default as an uploadable filetype.
57 * (T48998) $wgArticlePath must now be either a full url, or start with a "/".
58 * $wgRateLimitLog was removed; use $wgDebugLogGroups['ratelimit'] instead.
59 * Deprecated API formats dbg, txt, and yaml have been removed.
60 * CLDRPluralRule* classes have been replaced with
61 wikimedia/cldr-plural-rule-parser.
62 * Removed $wgProfilePerHost, $wgUDPProfilerHost, $wgUDPProfilerPort,
63 $wgUDPProfilerFormatString, $wgStatsMethod, $wgAggregateStatsID,
64 $wgStatsFormatString, and $wgProfileCallTree (deprecated since 1.20).
65 * For proper operation of LocalIdLookup with shared user tables, ensure that
66 $wgSharedDB and $wgSharedTables are properly set even on the "central" wiki
67 that all others are sharing from and that $wgLocalDatabases is set to the
68 full list of sharing wikis on all those wikis.
69 * Massive overhaul to session handling:
70 ** $wgSessionsInObjectCache is no longer supported and must be true, due to
71 MediaWiki\Session\SessionManager. $wgSessionHandler is similarly no longer
73 ** ObjectCacheSessionHandler is removed, replaced with
74 MediaWiki\Session\PhpSessionHandler.
75 ** PHP session handling in general ($_SESSION, session_id(), and so on) is
76 deprecated. Use MediaWiki\Session\SessionManager instead. A new config
77 variable, $wgPHPSessionHandling, is available to cause use of $_SESSION to
78 issue a deprecation warning or to cause most PHP session handling to throw
80 ** Deprecated UserSetCookies hook. Session-handling extensions should generally
81 be creating a custom subclass of CookieSessionProvider. Other extensions
82 messing with cookies can no longer count on user data being saved in cookies
84 ** Deprecated UserLoadFromSession hook, extensions should create a
85 MediaWiki\Session\SessionProvider.
86 ** The User cannot be loaded from session until after Setup.php completes.
87 Attempts to do so will be ignored and the User will remain unloaded.
88 ** CSRF tokens may be fetched from the MediaWiki\Session\Session, which uses
89 the MediaWiki\Session\Token class.
90 * MediaWiki will now auto-create users as necessary, removing the need for
91 extensions to do so. An 'autocreateaccount' right is added to allow
92 auto-creation when 'createaccount' is not granted to all users.
93 * Deprecated AuthPluginAutoCreate hook in favor of LocalUserCreated.
94 * Most cookie-handling methods in User are deprecated.
95 * $wgAllowAsyncCopyUploads and $CopyUploadAsyncTimeout were removed. This was an
96 experimental feature that has never worked.
97 * Login and createaccount tokens now vary by timestamp.
98 * LoginForm::getLoginToken() and LoginForm::getCreateaccountToken()
99 return a MediaWiki\Session\Token, and tokens must be checked using that
101 * $wgEnotifUseJobQ was removed and the job queue is always used.
102 * The functionality of the ApiSandbox extension has been merged into core. The
103 extension should no longer be used.
104 * $wgPreloadJavaScriptMwUtil was removed (deprecated in 1.26).
105 Extensions, skins, gadgets and scripts that use the mediawiki.util module must
106 express a dependency on it.
107 * $wgIncludeLegacyJavaScript, deprecated in MediaWiki 1.26, now defaults false.
108 Extensions, skins, gadgets and scripts that need the mediawiki.legacy.wikibits
109 module should express a dependency on it.
111 === New features in 1.27 ===
112 * $wgDataCenterUpdateStickTTL was also added. This decides how long a user
113 sticks to the primary DC (via cookies) after they make changes to the site.
114 * Added a new hook, 'UserMailerTransformContent', to transform the contents
115 of an email. This is similar to the EmailUser hook but applies to all mail
117 * Added a new hook, 'UserMailerTransformMessage', to transform the contents
118 of an emai after MIME encoding.
119 * Added a new hook, 'UserMailerSplitTo', to control which users have to be
120 emailed separately (ie. there is a single address in the To: field) so
121 user-specific changes to the email can be applied safely.
122 * $wgCdnMaxageLagged was added, which limits the CDN cache TTL
123 when any load balancer uses a DB that is lagged beyond the 'max lag'
124 setting in the relevant section of $wgLBFactoryConf.
125 * User::newSystemUser() may be used to simplify the creation of passwordless
126 "system" users for logged actions from scripts and extensions.
127 * Extensions can now return detailed error information via the API when
128 preventing user actions using 'getUserPermissionsErrors' and similar hooks
129 by using ApiMessage instances instead of strings for the $result value.
130 * $wgAPIMaxLagThreshold was added to limit bot changes when databases lag
132 * Skins and extensions can now use FlexBox mixins (.flex-display(@display: flex)
133 and .flex(@grow: 1, @shrink: 1, @width: auto, @order: 1)) in Less to create
134 cross-browser-compatible FlexBox rules. Users will still need to add fallback
135 float rules or the like for compatibility with IE9- separately.
136 * Added MWTimestamp::getTimezoneString() which returns the localized timezone
137 string, if available. To localize this string, see the comments of
138 $wgLocaltimezone in includes/DefaultSettings.php.
139 * Added CentralIdLookup, a service that allows extensions needing a concept of
140 "central" users to get that without having to know about specific central
141 authentication extensions.
142 * $wgMaxUserDBWriteDuration added to limit huge user-generated transactions.
143 Regular web request transactions that takes longer than this are aborted.
144 * Added a new hook, 'TitleMoveCompleting', which runs before a page move is
146 * $wgCdnReboundPurgeDelay was added to provide secondary delayed purges of URLs
147 from CDN to mitigate DB replication lag and WAN cache purge lag.
148 * (T49162) Installer will default to setting CACHE_ACCEL as the main cache type
150 * It is now possible to patrol file uploads (both for new files and new versions
151 of existing files). Special:NewFiles has gained an option to filter by patrol
152 status. This functionality can be disabled using $wgUseFilePatrol.
153 * MediaWiki\Session infrastructure allows for easier use of session mechanisms
154 other than the usual cookies.
155 ** SessionMetadata and SessionCheckInfo hooks allow for setting and checking
156 custom session metadata.
157 * Added MWGrants and associated configuration settings $wgGrantPermissions and
158 $wgGrantPermissionGroups to hold configuration for authentication features
159 such as OAuth that want to allow restricting the user rights a user may make
161 ** If you're already using the OAuth extension, these new variables are
162 identical to (and will replace) $wgMWOAuthGrantPermissions and
163 $wgMWOAuthGrantPermissionGroups.
164 * Added MWRestrictions as a class to check restrictions on a WebRequest, e.g.
165 to assert that the request comes from a particular IP range.
166 * Added bot passwords, a rights-restricted login mechanism for API-using bots.
167 * Whitelisted the following HTML attributes for all elements in wikitext:
168 aria-describedby, aria-flowto, aria-label, aria-labelledby, aria-owns.
169 * Removed "presentation" restriction on the HTML role attribute in wikitext.
170 All values are now allowed for the role attribute.
171 * $wgContentHandlers now also supports callbacks to create an instance of the
172 appropriate ContentHandler subclass.
173 * Added $wgAuthenticationTokenVersion, which if non-null prevents the
174 user_token database field from being exposed in cookies. Setting this would
175 be a good idea, but will log out all current sessions.
176 * $wgEventRelayerConfig was added, for managing PubSub event relay configuration,
177 specifically for reliable CDN url purges.
178 * Requests have unique IDs, equal to the UNIQUE_ID environment variable (when
179 MediaWiki is behind Apache+mod_unique_id or something similar) or a randomly-
180 generated 24-character string. This request ID is used to annotate log records
181 and error messages. It is available client-side via mw.config.get( 'wgRequestId' ).
182 The request ID supplants exception IDs. Accordingly, MWExceptionHandler::getLogId()
185 === External library changes in 1.27 ===
187 ==== Upgraded external libraries ====
188 * Updated oojs/oojs-ui from v0.12.12 to v0.13.3.
189 * Updated composer/semver from v1.0.0 to v1.2.0.
190 * Updated liuggio/statsd-php-client to 1.0.18.
191 * Updated QUnit from v1.18.0 to v1.22.0.
193 ==== New external libraries ====
194 * Added wikimedia/base-convert v1.0.1.
195 * Added wikimedia/cldr-plural-rule-parser v1.0.0.
196 * Added wikimedia/relpath v1.0.3.
197 * Added wikimedia/running-stat v1.1.0.
198 * Added wikimedia/php-session-serializer v1.0.3.
200 ==== Removed and replaced external libraries ====
202 === Bug fixes in 1.27 ===
203 * Special:Upload will now display correct maximum allowed file size when running
204 under HHVM (T116347).
206 === Action API changes in 1.27 ===
207 * Added list=allrevisions.
208 * generator=recentchanges now has the option to generate revids.
209 * ApiPageSet::setRedirectMergePolicy() was added. This allows generator
210 modules to define how generator data for a redirect source gets merged
211 into the redirect destination.
212 * prop=imageinfo&iiprop=uploadwarning will no longer include the possibility of
213 "was-deleted" warning.
214 * Added difftotextpst to query=revisions which preforms a pre-save transform on
215 the text before diffing it.
216 * Deprecated formats dbg, txt, and yaml have been removed.
217 * (T47988) The protect log event details now use new-style formatting.
218 * The following response properties from action=login are deprecated, and may
219 be removed in the future: lgtoken, cookieprefix, sessionid. Clients should
220 handle cookies to properly manage session state.
221 * action=login transparently allows login using bot passwords. Clients should
222 merely need to change the username and password used after setting up a bot
224 * action=upload no longer understands statuskey, asyncdownload or leavemessage.
226 === Action API internal changes in 1.27 ===
227 * ApiQueryORM removed.
228 * The following classes have been removed:
232 * ApiBase::addTokenProperties() was removed (deprecated since 1.24).
233 * ApiBase::getFinalPossibleErrors() was removed (deprecated since 1.24).
234 * ApiBase::getFinalResultProperties() was removed (deprecated since 1.24).
235 * ApiBase::getRequireAtLeastOneParameterErrorMessages() was removed (deprecated since 1.24).
236 * ApiBase::getPossibleErrors() was removed (deprecated since 1.24).
237 * ApiBase::getRequireMaxOneParameterErrorMessages() was removed (deprecated since 1.24).
238 * ApiBase::getRequireOnlyOneParameterErrorMessages() was removed (deprecated since 1.24).
239 * ApiBase::getResultProperties() was removed (deprecated since 1.24).
240 * ApiBase::getTitleOrPageIdErrorMessage() was removed (deprecated since 1.24).
241 * ApiBase::parseErrors() was removed (deprecated since 1.24).
242 * ApiQueryBase::titleToKey(), ApiQueryBase::keyToTitle() and
243 ApiQueryBase::keyPartToTitle() all removed (deprecated since 1.24).
244 * ApiQueryBase::checkRowCount() was removed (deprecated since 1.24).
245 * ApiQueryBase::getDirectionDescription() was removed (deprecated since 1.25).
246 * ApiQuery::getGenerators() was removed (deprecated since 1.21).
247 * ApiQuery::getModules() was removed (deprecated since 1.21).
248 * ApiQuery::getModuleType() was removed (deprecated since 1.21).
249 * ApiQuery::setGeneratorContinue() was removed (deprecated since 1.24).
250 * ApiMain::getModules() was removed (deprecated since 1.21).
251 * ApiBase::getVersion() was removed (deprecated since 1.21).
252 * Language::getLangObj() was removed (deprecated since 1.24).
253 * Language::getLanguageName() was removed (deprecated since 1.20).
254 * Language::getLanguageNames() was removed (deprecated since 1.20).
255 * Language::getTranslatedLanguageNames() was removed (deprecated since 1.20).
256 * Language::specialPage() was removed (deprecated since 1.24).
257 * MediaWikiTestCase::assertException() was removed (deprecated since 1.22).
258 * OutputPage::getHeadItems() was removed (deprecated since 1.24).
259 * OutputPage::getScript() was removed (deprecated since 1.24).
260 * OutputPage::out() was removed (deprecated since 1.22).
261 * OutputPage::setAllowedModules() was removed (deprecated since 1.24).
263 === Languages updated in 1.27 ===
265 MediaWiki supports over 350 languages. Many localisations are updated
266 regularly. Below only new and removed languages are listed, as well as
267 changes to languages because of Phabricator reports.
269 * (T113688) Change default numerals from Gurmukhi to Arabic for Punjabi locale.
271 === Other changes in 1.27 ===
272 * ProfilerOutputUdp was removed. Note that there is a ProfilerOutputStats class.
273 * WikiPage::doDeleteArticleReal() and WikiPage::doDeleteArticle() now
274 ignore the 2nd and 3rd arguments (formerly $id and $commit).
275 * Removed "loaderScripts" option from ResourceLoaderFileModule class.
276 * Removed ORM-like wrapper added in 1.20.
277 * LinkCache::getGoodLinks and LinkCache::getBadLinks were removed
278 (deprecated in 1.26).
279 * WikiPage::doQuickEdit() was removed (deprecated since 1.21).
280 * Removed SiteObject and SiteArray classes (deprecated in 1.21).
281 * MessageBlobStore::getInstance() was removed (deprecated since 1.25).
282 * (T84937) Free external links ("autolinked" urls) will now be terminated
283 by and HTML entity encodings of  , <, and >.
284 * (T36948) The default file revert message's timestamp is now in
285 $wgLocaltimezone, instead of UTC.
286 * The default name of the 'suppress' group page has been changed from
287 'Project:Oversight' to 'Project:Suppress'.
288 * DatabaseBase::resultObject() is now protected (use outside Database classes
289 not necessary since 1.11).
290 * Calling ResourceLoaderFileModule::readStyleFiles() without a
291 ResourceLoaderContext instance is deprecated.
292 * ResourceLoader::getLessCompiler() now takes an optional parameter of
293 additional LESS variables to set for the compiler.
294 * wfBaseConvert() marked as deprecated, use Wikimedia\base_convert() directly
296 * Obsolete maintenance scripts clearCacheStats.php and showCacheStats.php
297 were removed. The underlying data is sent to StatsD (see $wgStatsdServer).
298 * Removed msg_resource_links database table and associated code.
299 * Removed msg_resource database table and associated code.
300 * Skin::getNamespaceNotice() was removed.
301 * wfIsConfiguredProxy() was removed (deprecated since 1.24).
302 * wfDebugTimer() was removed (deprecated since 1.25).
303 * wfIsTrustedProxy() was removed (deprecated since 1.24).
304 * wfGetIP() was removed (deprecated since 1.19).
305 * MWHookException was removed.
306 * OutputPage::appendSubtitle() was removed (deprecated since 1.19).
307 * OutputPage::loginToUse() was removed (deprecated since 1.19).
308 * Article::loadContent() was removed (deprecated since 1.19).
309 * User::editToken() was removed (deprecated since 1.19).
310 * Removed --force-normal option of dumpBackup.php, as it no longer served
311 any useful purpose since 1.22.
312 * The functions processOption() and processArgs() on the BackupDumper and
313 TextPassDumper classes have been removed.
314 * The maintenance/backupTextPass.inc file was deleted. You should include
315 maintenance/dumpTextPass.php instead.
316 * WikiPage::getUsedTemplates() was removed (deprecated since 1.19).
317 * wfEmptyMsg() was removed (deprecated since 1.18).
318 * OutputPage::permissionRequired() was removed (deprecated since 1.18).
319 * OutputPage::blockedPage() was removed (deprecated since 1.18).
320 * User::getSkin() was removed (deprecated since 1.18).
321 * OutputPage::includeJQuery() was removed (deprecated since 1.17).
322 * WikiPage::updateRestrictions() was removed (deprecated since 1.19).
323 * WikiPage::testPreSaveTransform() was removed (deprecated since 1.19).
324 * LogPage::logName() was removed (deprecated since 1.19).
325 * LogPage::logHeader() was removed (deprecated since 1.19).
326 * wfCheckLimits() was removed (deprecated since 1.24).
327 * Linker::makeKnownLinkObj() was removed (deprecated since 1.16).
328 * Linker::makeLinkObj() was removed (deprecated since 1.16).
329 * wfMsgForContentNoTrans() was removed (deprecated since 1.18).
330 * ChangesList::usePatrol was removed (deprecated since 1.22).
331 * wfMsgNoTrans() was removed (deprecated since 1.18).
332 * Linker::makeImageLink2 was removed (deprecated since 1.20).
333 * Title::userIsWatching() was removed (deprecated since 1.20).
334 * Removed WaitForSlave maintenance script; use SELECT MASTER_POS_WAIT()
335 database function directly instead.
336 * wfMsg() was removed (deprecated since 1.18).
337 * wfMsgForContent() was removed (deprecated since 1.18).
338 * wfMsgReal() was removed (deprecated since 1.18).
339 * wfMsgGetKey() was removed (deprecated since 1.18).
340 * wfMsgHtml() was removed (deprecated since 1.18).
341 * wfMsgWikiHtml() was removed (deprecated since 1.18).
342 * wfMsgExt() was removed (deprecated since 1.18).
343 * Language::armourMath() was removed (deprecated since 1.22).
344 * LanguageConverter::armourMath() was removed (deprecated since 1.22).
345 * FakeConverter::armourMath() was removed (deprecated since 1.22).
346 * The unused jquery.validate ResourceLoader module was removed.
347 * FileRepo::getRootUrl() was removed (deprecated since 1.20).
348 * User::generateToken() was removed (deprecated since 1.20).
349 * WikiPage::getRawText() was removed (deprecated since 1.21).
350 * ParserOutput::hasCustomDataUpdates() was removed (deprecated since 1.25).
351 * ParserOutput::addSecondaryDataUpdate() was removed (deprecated since 1.25).
352 * ParserOutput::getSecondaryDataUpdates() was removed (deprecated since 1.25).
353 * Gallery images with multiple caption pipes no longer concatenate them all
354 together but instead pick the final one, similar to image syntax.
355 * XML-like parser tags (such as <gallery>), when unclosed, will be left unparsed
356 rather than consume everything until the end of the page.
357 * New maintenance script resetUserEmail.php allows sysadmins to reset user emails in case
358 a user forgot password/account was stolen.
359 * wfCheckEntropy() was removed (deprecated in 1.27).
360 * Browser support for Internet Explorer 8 lowered from Grade A to Grade C.
361 * ContentHandler::supportsCategories method added. Default is true.
362 CategoryMembershipChangeJob updates are skipped for content that
363 does not support categories.
364 * wikidiff difference engine is no longer supported, anyone still using it are encouraged
365 to upgrade to wikidiff2 which is actively maintained and has better package availability.
366 * Database logic was removed from WatchedItem and a WatchedItemStore was created:
367 ** WatchedItem::IGNORE_USER_RIGHTS and WatchedItem::CHECK_USER_RIGHTS were deprecated.
368 User::IGNORE_USER_RIGHTS and User::CHECK_USER_RIGHTS were introduced.
369 ** WatchedItem::fromUserTitle was deprecated in favour of the constructor.
370 ** WatchedItem::resetNotificationTimestamp was deprecated.
371 ** WatchedItem::batchAddWatch was deprecated.
372 ** WatchedItem::addWatch was deprecated.
373 ** WatchedItem::removeWatch was deprecated.
374 ** WatchedItem::isWatched was deprecated.
375 ** WatchedItem::duplicateEntries was deprecated.
376 ** EmailNotification::updateWatchlistTimestamp was deprecated.
377 ** User::getWatchedItem was removed.
378 * Unit tests don't work with external PHPUnit anymore, Composer is now the only supported
379 way. Run `composer install` to install it and other dev dependencies to run unit tests.
380 * wl_id field added to the watchlist table.
384 MediaWiki 1.27 requires PHP 5.5.9 or later. There is experimental support for
387 MySQL is the recommended DBMS. PostgreSQL or SQLite can also be used, but
388 support for them is somewhat less mature. There is experimental support for
389 Oracle and Microsoft SQL Server.
391 The supported versions are:
393 * MySQL 5.0.3 or later
394 * PostgreSQL 8.3 or later
395 * SQLite 3.3.7 or later
396 * Oracle 9.0.1 or later
397 * Microsoft SQL Server 2005 (9.00.1399)
401 1.27 has several database changes since 1.26, and will not work without schema
402 updates. Note that due to changes to some very large tables like the revision
403 table, the schema update may take quite long (minutes on a medium sized site,
404 many hours on a large site).
406 If upgrading from before 1.11, and you are using a wiki as a commons
407 repository, make sure that it is updated as well. Otherwise, errors may arise
408 due to database schema changes.
410 If upgrading from before 1.7, you may want to run refreshLinks.php to ensure
411 new database fields are filled with data.
413 If you are upgrading from MediaWiki 1.4.x or earlier, you should upgrade to
414 1.5 first. The upgrade script maintenance/upgrade1_5.php has been removed
417 Don't forget to always back up your database before upgrading!
419 See the file UPGRADE for more detailed upgrade instructions.
421 For notes on 1.26.x and older releases, see HISTORY.
423 == Online documentation ==
425 Documentation for both end-users and site administrators is available on
426 MediaWiki.org, and is covered under the GNU Free Documentation License (except
427 for pages that explicitly state that their contents are in the public domain):
429 https://www.mediawiki.org/wiki/Documentation
433 A mailing list is available for MediaWiki user support and discussion:
435 https://lists.wikimedia.org/mailman/listinfo/mediawiki-l
437 A low-traffic announcements-only list is also available:
439 https://lists.wikimedia.org/mailman/listinfo/mediawiki-announce
441 It's highly recommended that you sign up for one of these lists if you're
442 going to run a public MediaWiki, so you can be notified of security fixes.
446 There's usually someone online in #mediawiki on irc.freenode.net.