Manual:$wgWhitelistRead

From MediaWiki.org
Jump to: navigation, search

Other languages:
English • ‎español • ‎日本語 • ‎polski
User Access: $wgWhitelistRead
Pages anonymous user may see.
Introduced in version: 1.1.0
Removed in version: still in use
Allowed values: Array of page names, or false
Default value: false
Other settings: Alphabetical | By function

Details[edit]

If a group of users is blocked from viewing the wiki by using the $wgGroupPermissionsManual:$wgGroupPermissions setting...

$wgGroupPermissions[...]['read'] = false;

...you may still want them to be able to view certain key pages, in particular the login page! This setting holds an array of page names that all users are allowed to view, regardless of their group permissions.

A recommended minimum which allows everyone to view the home page and the login screen as well as loading CSS/JS customizations is as follows:

Note Note: "Main Page" uses spaces instead of underscores between words.

MediaWiki ≥ 1.18.1[1]
$wgWhitelistRead = array(
    "Main Page", "MediaWiki:Common.css", "MediaWiki:Common.js"
    );
MediaWiki 1.18.0
$wgWhitelistRead = array(
    "Main Page", "Special:UserLogin", "Special:UserLogout", "Special:PasswordReset", "MediaWiki:Common.css", "MediaWiki:Common.js"
    );
MediaWiki 1.17.x
$wgWhitelistRead = array(
    "Main Page", "Special:UserLogin", "Special:UserLogout", "MediaWiki:Common.css", "MediaWiki:Common.js"
    );
MediaWiki ≤ 1.16.5
$wgWhitelistRead = array(
    "Main Page", "Special:UserLogin", "Special:UserLogout", "-", "MediaWiki:Common.css", "MediaWiki:Common.js"
    );

Note Note: In old MediaWiki versions, "-" is a special page that loads user CSS/JS customizations; adding it in $wgWhitelistRead is required to load styles and scripts in a private wiki.

Warning Warning: If you are using a content language other than English, you may need to use the translated special page names instead of their English names.

See also[edit]

References[edit]

  1. Starting with r105428 "Special:PasswordReset" is always whitelisted just like "Special:UserLogin" and "Special:ChangePassword".