Manual:$wgWhitelistReadRegexp

From MediaWiki.org
Jump to navigation Jump to search

Other languages:
Deutsch • ‎English • ‎español • ‎français • ‎italiano • ‎日本語 • ‎polski • ‎português • ‎português do Brasil
User Access: $wgWhitelistReadRegexp
Whitelists publicly readable titles with regular expressions.
Introduced in version: 1.21.0 (Gerrit change 11137; git #550b878e)
Removed in version: still in use
Allowed values: Array of regexes, or false
Default value: false
Other settings: Alphabetical | By function

Details[edit]

It is similar to $wgWhitelistReadManual:$wgWhitelistRead, but uses a list of regular expressions.

This would be useful in a semi-public team wiki situation where one would want to hide everything except for an entire namespace from everyone.

This function will match the regexp against the title name, which is without underscore. Unless ^ and/or $ is specified, a regular expression might match pages not intended to be whitelisted.

This configuration parameter will only work if the following is set:

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

Otherwise, all pages are accessible, regardless of this setting.

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.

Examples[edit]

Whitelist "Main Page" or "Security Main Page":

$wgWhitelistReadRegexp = [ "/Main Page/" ];

Allow reading any page starting with 'User' regardless of the case, e.g. "User is banned" and "User:JohnDoe":

$wgWhitelistReadRegexp = [ "@^UsEr.*@i" ];

Allow reading "Main Page" and all pages in namespace "Foo Bar":

$wgWhitelistReadRegexp = [
    '/Main Page/',
    '/Foo Bar:/'
    ];