Manual:$wgCrossSiteAJAXdomains

From MediaWiki.org
Jump to: navigation, search

Other languages:
English • ‎français • ‎日本語 • ‎polski
API: $wgCrossSiteAJAXdomains
Domains that may make cross-site Ajax requests to the MediaWiki API.
Introduced in version: 1.16.0 (r54127)
Removed in version: still in use
Allowed values: array
Default value: array()
Other settings: Alphabetical | By function

Details[edit]

Allows Ajax requests from certain domains to make cross-site requests to a wiki's API (see Manual:CORSManual:CORS for example usage). This uses the Access-Control-Allow-Origin HTTP header. Note that some older browsers don't support this. This only affects requests to the API. Other entry points (index.php) are not affected.

The value must be a list of allowed domain names, which can include shell-style wildcards (? to match any character, * to match any number (including zero) of characters). An empty array means no external access is allowed.

Some examples:

Allow any domain to access the API via Ajax:

$wgCrossSiteAJAXdomains = array( '*' );

Allow two specific domains:

$wgCrossSiteAJAXdomains = array( 'en.wikipedia.org', 'en.wikibooks.org' );

Allow all subdomains of a domain (including "deep" subdomains such as en.m.wikipedia.org):

$wgCrossSiteAJAXdomains = array( '*.wikipedia.org' );

See gerrit:9624 for a usage example.

See also[edit]