API:Imagerotate
Appearance
This page is part of the MediaWiki Action API documentation. |
Imagerotate | ||
---|---|---|
Rotate one or more images. This module cannot be used as a generator. | ||
Prefix | none | |
Required rights | edit, upload | |
Post only? | Yes | |
Generated help | Current | |
Version added |
|
This module is currently disabled on all Wikimedia wikis due to performance concerns (phab:T35186).
Token
[edit]To rotate an image, a CSRF token is required.
The CSRF token is the same for all pages, but changes at every login.
CSRF tokens can be obtained via action=query&meta=tokens
with type=csrf
(MW 1.24+).
For older versions, you can use API:Tokens (action) or API:Info to get an edit token.
Parameters
[edit]This module incorporates ApiPageSet and behaves similar to a query in most respects. See specifying pages and resolve redirects for more information.
rotation
: Degrees to rotate image clockwise. Possible values: 90, 180, 270continue
: When more results are available, use this to continue. (See continuing queries.) 1.24+tags
: Tags to apply to the entry in the upload log. 1.29+titles
: A list of titles to work on. Separate values with |. No more than 50 (500 for bots) allowed. 1.23+pageids
: A list of page IDs to work on. Separate values with |. No more than 50 (500 for bots) allowed. Type: list of integersrevids
: A list of revision IDs to work on. Separate values with |. No more than 50 (500 for bots) allowed. Type: list of integersgenerator
: Get the list of pages to work on by executing the specified query module. Note: Generator parameter names must be prefixed with a "g". Possible values: see MediaWiki API generatorsredirects
: Automatically resolve redirects in titles, pageids, and revids, and in pages returned by generator.converttitles
: Convert titles to other variants if necessary. Only works if the wiki's content language supports variant conversion. Languages that support variant conversion include: gan, iu, kk, ku, shi, sr, tg, uz, zhtoken
: A "csrf" token retrieved from action=query&meta=tokens
Error Codes
[edit]In addition to the usual stuff, any failure to rotate an image will be reported in the errormessage field in the results.
Example
[edit]Rotate File:Example.png by 90 degrees.
api.php? action=imagerotate& titles=File:Example.png& rotation=90& token=0123456789012345678901234567890123456789%2b%5c [try in ApiSandbox]
Result |
---|
{
"imagerotate": [
{
"id": 20,
"ns": 6,
"title": "File:Example.png",
"result": "Success"
}
]
}
|
The following documentation is the output of Special: |
action=imagerotate
(main | imagerotate)
- Source: MediaWiki
- License: GPL-2.0-or-later
This module has been disabled.