View source for Manual:Parameters to Special:Export

<languages/>
{{See also|Manual:DumpBackup.php}}
Wiki pages can be exported in a special [[w:XML|XML]] format to [[meta:Help:Import|upload]] into another MediaWiki.<ref>
If this function is enabled on the destination wiki, and the user is a sysop there. The export can be used  for analyzing the content.
See also [[m:Syndication feeds|Syndication feeds]] for exporting other information but pages and [[meta:Help:Import|Help:Import]] on importing pages.
</ref>
See [[Special:MyLanguage/Help:Export|Help:Export]] for more details.

<translate>
==Available parameters== <!--T:1-->
</translate>
Below is the list of available parameters for [[Special:Export]] as of version 1.16.
<translate><!--T:2--> Not all of these are available through the Special:Export UI.</translate>

{| class="wikitable"
! <translate><!--T:3--> Parameter</translate>
! <translate><!--T:4--> Variable type</translate>
!class="unsortable"|Description
|-
|<code>action</code>
| <translate><!--T:5--> String</translate>
|Unused; set to "submit" in the export form.
|-
! colspan=3 | <translate><!--T:6--> Page Selection</translate>
|-
|<code>/</code> ''(no parameter)''
|
|Selects up to one page, e.g. [[Special:Export/Sandbox]].
|-
|<code>pages</code>
|?
|A list of page titles, separated by linefeed (%0A) characters. Maximum of 35 pages.
|-
|<code>addcat</code>/<code><translate><!--T:34--> category-name</translate></code>
|rowspan=2 | <translate><!--T:7--> String?</translate>
|rowspan=2|These were added later. <code>addcat</code> returns all members of the category <code>catname</code> added to it. If [[Manual:$wgExportFromNamespaces|$wgExportFromNamespaces is enabled]], <code>addns</code> and <code>nsindex</code> do the same, but with namespaces and their numerical indexes. A maximum of 5000 page titles will be returned.

For example, the following is for all pages in [[:en:Category:Books]]:

https://en.wikipedia.org/w/index.php?title=Special:Export&addcat&catname=Books&pages=XXXX
|-
|<code>addns</code>/<code><translate><!--T:35--> namespace-index</translate></code>
|-
! colspan=3 | <translate><!--T:8--> Sorting</translate>
|-
| <code>dir</code><ref name="historynote">These parameters are ignored if either <code>curonly</code> or <code>history</code> are supplied, or if passed via a GET request (e.g., a browser address bar). See [[#URL parameter requests do not work|URL parameter requests do not work]] for more information.</ref>
| <translate><!--T:9--> String</translate>
|Should be set to "desc" to retrieve revisions in reverse chronological order. 

The default, with this parameter omitted, is to retrieve revisions in ascending order of timestamp (oldest to newest). 
|-
! colspan=3 | <translate><!--T:10--> Limiting Results</translate>
|-
|<code>offset</code><ref name="historynote" />
|?
|The timestamp at which to start, which is non-inclusive. The timestamp may be in several formats, including the 14-character format usually used by MediaWiki, and an ISO 8601 format like the one that is output by the XML dumps. 
|-
|<code>limit</code><ref name="historynote" />
| <translate><!--T:11--> Integer</translate>
|The maximum number of revisions to return. If you request more than a site-specific maximum (defined in [[Manual:$wgExportMaxHistory|$wgExportMaxHistory]]: 1000 on Wikimedia projects at present), it will be reduced to this number.

This limit is cumulative across all the pages specified in the ''pages'' parameter. For example, if you request a limit of 100, for two pages with 70 revisions each, you will get 70 from one and 30 from the other.<ref>The order is by page_id, pages with lower page_id get more revisions. The reason for this is that Special:Export only ever does one database query per HTTP request. If you want to request all the history of several pages with many revisions each, you have to do it one page at a time.</ref>
|-
|<code>curonly</code>
| <translate><!--T:12--> Boolean</translate>
| <translate><!--T:36--> Include only the current revision (default for GET requests).</translate>
|-
|<code>history</code>
|?
|Include the full history, overriding <code>dir</code>, <code>limit</code>, and <code>offset</code>.
This is not working for all say https://en.wikipedia.org/w/index.php?title=Special:Export&pages=US_Open_(tennis)&history=1&action=submit works fine and gives all revisions but https://en.wikipedia.org/w/index.php?title=Special:Export&pages=India&history=1&action=submit doesn't.
|-
! colspan=3 | <translate><!--T:13--> Extras</translate>
|-
|<code>templates</code>
|?
| <translate><!--T:37--> Includes any transcluded templates on any pages listed for export.</translate>
|-
|<code>listauthors</code>
| <translate><!--T:14--> Boolean</translate>
| <translate><!--T:38--> Include a list of all contributors' names and user IDs for each page.</translate> Functionality is disabled by default; can be enabled by changing [[Manual:$wgExportAllowListContributors|$wgExportAllowListContributors]].
|-
|<code>pagelink-depth</code>
| <translate><!--T:15--> Integer</translate>
| <translate><!--T:39--> Includes any linked pages to the depth specified.</translate> Limited to [[Manual:$wgExportMaxLinkDepth|$wgExportMaxLinkDepth]] (defaults to 0, disabling the feature), or 5 if user does not have permission to change limits.
|-
|<code>wpDownload</code>
|?
| <translate><!--T:40--> Save as file, named with current time stamp.</translate> Implemented through <code>[[:w:en:MIME#Content-Disposition|content-disposition]]:attachment</code> HTTP header.
|}

<translate>
== URL parameter requests do not work  == <!--T:16-->
</translate>
The <code>dir</code>, <code>offset</code> and <code>limit</code> parameters only work for [[w:POST (HTTP)|POST requests]].
<translate><!--T:41--> [[w:HTTP#Request methods|GET requests]] through a URL are ignored.</translate>

<translate><!--T:17--> When you use the URL as in a browser, you are submitting via GET.</translate>
<translate><!--T:18--> In the ruby script, you are using POST.</translate>

As an example, the following parameter request does not work, it returns all revisions of a page despite the parameter limit=5.

https://en.wikipedia.org/w/index.php?title=Special:Export&pages=XXXX&offset=1&limit=5&action=submit

<translate>
==Retrieving earliest 5 revisions== <!--T:19-->
</translate>
A POST request is generated by [[:en:cURL|cURL]] when passing <code>-d ""</code>.
<translate><!--T:20--> The following retrieves the earliest 5 revisions from the English Wikipedia main page and its talk page:</translate>

 curl -d "" 'https://en.wikipedia.org/w/index.php?title=Special:Export&pages=Main_Page%0ATalk:Main_Page&offset=1&limit=5&action=submit'

<translate><!--T:21--> And here are the next 5 revisions of the main page only:</translate>

 curl -d "" 'https://en.wikipedia.org/w/index.php?title=Special:Export&pages=Main_Page&offset=2002-01-27T20:25:56Z&limit=5&action=submit'

<translate><!--T:22--> Here the timestamp from the last revision of the previous query is copied into the offset field of the URL.</translate>
Because the offset field is non-inclusive, that 5th revision is not displayed again, and instead we get revisions 6-10.<ref>
This parameter convention is very similar to the one for UI history pages.
</ref>

<translate>
==POST request to download== <!--T:23-->
</translate>
A more explicit example, especially if you also want to save the darn thing, would be 
 curl -d "&pages=Main_Page&offset=1&action=submit" https://en.wikipedia.org/w/index.php?title=Special:Export -o "somefilename.xml"
The URL root needs to follow the MediaWiki parameters... also, note the fact that you need to add the curl parameters at the end for saving the file as something.
<translate><!--T:24--> Otherwise it will just scroll on your screen and nothing will be saved.</translate>
<translate><!--T:25--> Currently, it appears that Wikipedia servers are under maintenance, hence the above method is showing error and not providing the xml.</translate>

If you instead have the list of titles in a file, say <code>title-list</code>, you must pass the list as a parameter to curl and encode the linefeeds correctly (for some reason, <code>--data-urlencode</code> and <code>@</code> do not work):
 curl -d "&action=submit&pages=$(cat title-list | hexdump -v -e '/1 "%02x"' | sed 's/\(..\)/%\1/g' )" https://en.wikipedia.org/w/index.php?title=Special:Export -o "somefilename.xml"

<translate><!--T:26--> If you want to save bandwidth, append the following arguments as well:</translate>

 --compressed -H 'Accept-Encoding: gzip,deflate'

<translate>
==Stopping the export of your MediaWiki== <!--T:27-->

<!--T:28-->
Please keep in mind that making it difficult for your users to back up their work could discourage them from contributing to your wiki.
</translate>

If [[Manual:$wgExportAllowHistory|$wgExportAllowHistory]] is set to false in [[Manual:LocalSettings.php|LocalSettings.php]], only the current version can be exported, not the full history.

<translate>
<!--T:29-->
By default with GET requests, only the current (last) version of each page is returned.
</translate>

If the $wgExportAllowHistory parameter is true in [[Manual:LocalSettings.php|LocalSettings.php]], and the "Include only the current revision, not the full history" is unchecked, then all versions of each page are returned.

To disable export completely, you need to set a callback-function in your LocalSettings.php:
<syntaxhighlight lang="php">
function removeExportSpecial(&$aSpecialPages)
{
	unset($aSpecialPages['Export']);
	return true;
}
$wgHooks['SpecialPage_initList'][] = 'removeExportSpecial';
</syntaxhighlight>
If you want to define a permission for export, put the following in your LocalSettings.php:

<syntaxhighlight lang="php">
// Override SpecialExport, which is work for MW1.35
// the parameters of __construct() are changed in later versions
class SpecialExport2 extends SpecialExport {
    public function __construct() {
        parent::__construct();
        $this->mRestriction = 'export';
    }
    public function execute( $par ) {
        $this->checkPermissions();
        parent::execute( $par );
    }
}
function adjustExportSpecial(&$aSpecialPages)
{
	$aSpecialPages['Export'] = SpecialExport2::class;
	return true;
}
$wgHooks['SpecialPage_initList'][] = 'adjustExportSpecial';
$wgGroupPermissions['sysop']['export'] = true; // Add export permission to sysop only
</syntaxhighlight>

<translate>
<!--T:30-->
Keep in mind that exporting is still possible, if you have the API enabled.

==Notes== <!--T:31-->
</translate>
<references/>

<translate>
==See also== <!--T:32-->
</translate>
* {{ll|Help:Export}}
* {{ll|Manual:Moving a wiki}}

<translate>
==External links== <!--T:33-->
</translate>
* wikibooks: [[b:en:MediaWiki Administrator's Handbook/Importing|MediaWiki Administrator's Handbook/Importing]]
* https://github.com/wikimedia/mediawiki/blob/master/includes/specials/SpecialExport.php

[[Category:Wiki page URLs{{#translation:}}|{{PAGENAME}}]]
[[Category:Special Pages{{#translation:}}|{{PAGENAME}}]]
[[Category:Parameters to special pages{{#translation:}}]]