API:Imageinfo

From MediaWiki.org
Jump to: navigation, search
This page is part of the MediaWiki action API documentation.

MediaWiki action API

v · d · e

Gets image information for any titles in the image namespace. Note that files located on Commons will appear to be missing when accessed from other MediaWiki wikis.

This will eventually get superseded by prop=fileinfo.

Parameters[edit]

  • iiprop: Which properties to get: (Default: timestamp|user)
    • timestamp: The time and date of the revision.
    • user: The user who made the revision.
    • userid: The id of the user who made the revision. 1.17+
    • comment: The edit comment.
    • parsedcomment: Parsed version of comment. 1.17+
    • canonicaltitle: The canonical title of the image file. 1.23+
    • url: URLs of the image and its description page.
    • size: The image's size in bytes, plus width and height. A page count is also returned if the image is in a format that supports multiple pages.
    • dimensions: (Alias for size) 1.16+
    • sha1: The image's SHA-1 hash.
    • mime: The image's MIME type. 1.13+
    • thumbmime: The image thumbnail's MIME type (for use with the iiurl parameters). 1.17+
    • mediatype: The media type of the image. 1.18+
    • metadata: Exif metadata for the image, if available. See File metadata handling for information on file metadata handling in MediaWiki. 1.12+
    • commonmetadata: Generic metadata for the file format, if available. 1.23+
    • extmetadata: HTML metadata from extensions which implement the GetExtendedMetadata hook. Also contains most of metadata, but in a somewhat standardized format. 1.23+
    • archivename: Archive name (old images only). 1.13+
    • bitdepth: The bit depth of the image. 1.14+
    • uploadwarning: Used by Special:Upload to get information about an existing file. Not intended for use outside the MediaWiki core. 1.22+
  • iihistory: Include upload history. (Removed in 1.12)
  • iilimit: How many image revisions to return. (Default: 1) 1.12+
  • iistart: Timestamp to start listing from. 1.12+
  • iiend: Timestamp to stop listing at. 1.12+
  • iiurlwidth: If iiprop=url is set, a URL to an image scaled to this width will be returned as well in thumburl along with thumbwidth and thumbheight. Old versions of images can't be scaled. 1.12+
  • iiurlheight: Similar to iiurlwidth. 1.12+
  • iimetadataversion: What version of metadata to use. Only affects JPEGs (as of this writing). This should normally be set to latest. 1.18+
  • iiextmetadatalanguage: What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted. 1.23+
  • iiextmetadatamultilang: If translations for extmetadata property are available, fetch all of them. The values of the multi-languaged metadata items will be in the multi-language array format. (Which items are multilanguaged might change from image to image.) 1.23+
  • iiextmetadatafilter 1.23+
  • iiurlparam: The thumb parameter string. Allows optional specification of other parameters than width and height (like page number for PDFs). Format of the field varies with image format. PDF uses a format like page<number>-<width>px (e.g., page3-140px). Generally the part before the filename in the url of a thumbnail. 1.18+
  • iicontinue: When more results are available, use this to continue. 1.15+
  • iilocalonly: Only show local images. 1.20+

Examples[edit]

Get default image information for File:Albert Einstein Head.jpg from Commons.

Get the URL for a 220-pixel-wide thumbnail of File:Albert Einstein Head.jpg from Commons.




prop=imageinfo (ii)

(main | query | imageinfo)
  • This module requires read rights.
  • Source: MediaWiki
  • License: GPL-2.0+

Returns file information and upload history.

Parameters:
iiprop

Which file information to get:

timestamp

Adds timestamp for the uploaded version.
user
Adds the user who uploaded each file version.
userid
Add the ID of the user that uploaded each file version.
comment
Comment on the version.
parsedcomment
Parse the comment on the version.
canonicaltitle
Adds the canonical title of the file.
url
Gives URL to the file and the description page.
size
Adds the size of the file in bytes and the height, width and page count (if applicable).
dimensions
Alias for size.
sha1
Adds SHA-1 hash for the file.
mime
Adds MIME type of the file.
thumbmime
Adds MIME type of the image thumbnail (requires url and param iiurlwidth).
mediatype
Adds the media type of the file.
metadata
Lists Exif metadata for the version of the file.
commonmetadata
Lists file format generic metadata for the version of the file.
extmetadata
Lists formatted metadata combined from multiple sources. Results are HTML formatted.
archivename
Adds the filename of the archive version for non-latest versions.
bitdepth
Adds the bit depth of the version.
uploadwarning
Used by the Special:Upload page to get information about an existing file. Not intended for use outside MediaWiki core.
badfile

Adds whether the file is on the MediaWiki:Bad image list
Values (separate with | or alternative): timestamp, user, userid, comment, parsedcomment, canonicaltitle, url, size, dimensions, sha1, mime, thumbmime, mediatype, metadata, commonmetadata, extmetadata, archivename, bitdepth, uploadwarning, badfile
Default: timestamp|user
iilimit

How many file revisions to return per file.

No more than 500 (5,000 for bots) allowed.
Type: integer or max
Default: 1
iistart

Timestamp to start listing from.

Type: timestamp (allowed formats)
iiend

Timestamp to stop listing at.

Type: timestamp (allowed formats)
iiurlwidth

If iiprop=url is set, a URL to an image scaled to this width will be returned.

For performance reasons if this option is used, no more than 50 scaled images will be returned.

Type: integer
Default: -1
iiurlheight

Similar to iiurlwidth.

Type: integer
Default: -1
iimetadataversion

Version of metadata to use. If latest is specified, use latest version. Defaults to 1 for backwards compatibility.

Default: 1
iiextmetadatalanguage

What language to fetch extmetadata in. This affects both which translation to fetch, if multiple are available, as well as how things like numbers and various values are formatted.

Default: en
iiextmetadatamultilang

If translations for extmetadata property are available, fetch all of them.

Type: boolean (details)
iiextmetadatafilter

If specified and non-empty, only these keys will be returned for iiprop=extmetadata.

Separate values with | or alternative. Maximum number of values is 50 (500 for bots).
iiurlparam

A handler specific parameter string. For example, PDFs might use page15-100px. iiurlwidth must be used and be consistent with iiurlparam.

Default: (empty)
iibadfilecontexttitle

If badfilecontexttitleprop=badfile is set, this is the page title used when evaluating the MediaWiki:Bad image list

iicontinue

When more results are available, use this to continue.

iilocalonly

Look only for files in the local repository.

Type: boolean (details)