Extension:PageImages
![]() Release status: stable |
|
---|---|
Implementation | API , Parser extension |
Description | Stores information about images representing a page |
Author(s) | Max Semenik (MaxSemtalk) |
Latest version | continuous updates |
Compatibility policy | Snapshots releases along with MediaWiki. Master is not backward compatible. |
MediaWiki | 1.37+ |
PHP | 7.3.19+ |
Database changes | No |
License | WTFPL 2.0 |
Download | |
|
|
Quarterly downloads | 138 (Ranked 42nd) |
Public wikis using | 2,271 (Ranked 191st) |
Translate the PageImages extension if it is available at translatewiki.net | |
Issues | Open tasks · Report a bug |
The PageImages extension collects information about images used on a page.
Its aim is to return the single most appropriate thumbnail associated with an article.
PageImages also provides OpenGraph protocol metadata for articles on the wiki for 3rd parties like Facebook to extract.
Installation
[edit]- Download and move the extracted
PageImages
folder to yourextensions/
directory.
Developers and code contributors should install the extension from Git instead, using:cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/PageImages - Add the following code at the bottom of your LocalSettings.php file:
wfLoadExtension( 'PageImages' );
- Configure as required
- To initially assign the page images to the pages, run the "initImageData.php" script from the extensions maintenance directory (
/path/to/extensions/PageImages/maintenance/
) Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.
Configuration
[edit]$wgPageImagesDenylist is an array of sources for image denylists. Listed images will never be selected as page images. Examples:
$wgPageImagesDenylist = [
// Page on local wiki
[
'type' => 'db',
'page' => 'MediaWiki:Pageimages-denylist',
'db' => false,
],
// Page on Wikimedia Commons, for other Wikimedia projects using direct DB access
[
'type' => 'db',
'page' => 'MediaWiki:Pageimages-denylist',
'db' => 'commonswiki',
],
// Page on Commons, for third-party sites using web access
[
'type' => 'url',
'url' => 'http://commons.wikimedia.org/w/index.php?title=somepage&action=raw',
],
];
More than one source can be used at the same time.
The denylist itself should contain wikilinks to files, the rest of the content is irrelevant (and can contain links to other pages). For example:
* [[:File:First denylisted file.png]]
* [[:File:Second denylisted file.jpeg]]
...
Remember that file links that result in images being added to the page will not work (these files are denylisted for a reason, right?), so don't forget the :
in front of the links.
$wgPageImagesDenylistExpiry determines how long the list will remain cached, in seconds. Default: 15 * 60 (15 minutes).
$wgPageImagesExpandOpenSearchXml if set to true, PageImages will override the image detection in the opensearch
API module with its own, more accurate results.
Default: false.
$wgPageImagesNamespaces is an array of namespaces PageImages will be activated on. Default: NS_MAIN.
After the change, you'll have to run refreshLinks.php to generate the Page image information for those namespaces (hopefully, you can use the --namespace parameter to process only pages on the affected namespaces, since that script is very resource-intensive)
$wgPageImagesOpenGraph enables or disables the OpenGraph meta tags (could be useful if other extensions manage these tags) (1.39+).
Default: true
$wgPageImagesOpenGraphFallbackImage is a URL to fallback image that will be shown when there is no image on a page.
Default:
false
Upgrade to MediaWiki 1.37+ notes
[edit]- Since MediaWiki 1.37,
$wgPageImagesBlacklist
and$wgPageImagesBlacklistExpiry
have been renamed to$wgPageImagesDenylist
and$wgPageImagesDenylistExpiry
respectively. There's no backwards compatibility code added to accept the old variable names, which means you should change the variable names during the upgrade, or define both variables in advance in preparation for the upgrade. - Since MediaWiki 1.37, the default page value for
$wgPageImagesDenylist
has been changed fromMediaWiki:Pageimages-blacklist
toMediaWiki:Pageimages-denylist
. If you've added content toMediaWiki:Pageimages-blacklist
on your wiki, you should rename it during the upgrade. If you want to prepare in advance for the upgrade, you can rename the page to the new name, and also set$wgPageImagesBlacklist
(the old variable name) to the new page name, and the default value will be used when upgrading, which should match your previous change.
API
[edit]The PageImages extension provides image information by adding a prop=pageimages
to the properties API for action=query
.
prop=pageimages (pi)
- This module requires read rights.
- Source: PageImages
- License: WTFPL
Returns information about images on the page, such as thumbnail and presence of photos.
- piprop
Which information to return:
- thumbnail
- URL and dimensions of thumbnail image associated with page, if any.
- name
- Image title.
- original
- URL and original dimensions of image associated with page, if any.
- Values (separate with | or alternative): name, original, thumbnail
- Default: thumbnail|name
- pithumbsize
Maximum width in pixels of thumbnail images.
- Type: integer
- Default: 50
- pilimit
Properties of how many pages to return.
- Type: integer or max
- The value must be between 1 and 50.
- Default: 50
- pilicense
Limit page images to a certain license type:
- free
- Only free images.
- any
- Best image, whether free or non-free.
- One of the following values: any, free
- Default: free
- picontinue
When more results are available, use this to continue. More detailed information on how to continue queries can be found on mediawiki.org.
- Type: integer
- pilangcode
Code for the language the image is going to be rendered in if multiple languages are supported
- Get name and 100-pixel thumbnail of an image on the Albert Einstein page.
- api.php?action=query&prop=pageimages&titles=Albert%20Einstein&pithumbsize=100 [open in sandbox]
Response
[edit]{
// piprop.name (and image exists)
pageimage?: string // Source image filename (basename of original.source).
// piprop.thumbnail (and image exists)
thumbnail?: {
source: string // Thumbnail image URL.
width: number // Thumbnail image width in pixels.
height: number // Thumbnail image height in pixels.
}
// piprop.original (and image exists)
original?: {
source: string // Source image URL.
width: number // Source image width in pixels.
height: number // Source image height in pixels.
}
}
Sample request
[edit]Result |
---|
{
"query": {
"normalized": [
{
"from": "Lightbox_demo",
"to": "Lightbox demo"
}
],
"pages": {
"162510": {
"pageid": 162510,
"ns": 0,
"title": "Lightbox demo",
"thumbnail": {
"source": "https://upload.wikimedia.org/wikipedia/commons/thumb/e/e9/Crystal_Clear_app_korganizer.png/50px-Crystal_Clear_app_korganizer.png",
"width": 50,
"height": 50
},
"pageimage": "Crystal_Clear_app_korganizer.png"
}
}
}
}
|
How it works
[edit]When a page is saved with a local image, the parser runs the hooks ParserMakeImageParams
and LinksUpdate
.
The PageImages extension responds to these (and other hooks) and inserts a new property for the page into the page_props table.
The property name is page_image_free
and its value is the name of the image.
The extension only stores the chosen image name. Other features may display the image, such as Page information, Hovercards, and Mobile search while typing.
Image choice
[edit]How can I check which image is associated with a page?
[edit]Page images will be listed on the ?action=info
page.
How does it select images?
[edit]All images in the page are collected and a score for each image is calculated. The image with the highest score is selected as the page image. If the wiki is configured such that images contain metadata that specifies images are not freely licensed, the image with the best score that is also freely licensed is also stored. If no suitable image is found or all the images score badly (i.e. have a negative score), the page will not have any images.
If $wgPageImagesLeadSectionOnly is true, only images in the lead section will be considered. Currently this is true for only Wikipedia projects; all other projects can pull images from outside the lead.
How are images scored?
[edit]The best possible page image on Wikimedia wikis is one of the first four images in an article which has a width/height between 400-600px and a height/width which is twice the value of the other dimension.
- The algorithm is configurable.
- Scores are calculated by a combination of:
- Image widths as defined in
$wgPageImagesScores['width']
- In Wikimedia wikis, images smaller than 119 pixels are weighted highly negatively. Images with widths between 400px-600px are favoured, with a preference for the lower bound.
- Images inside galleries are scored separately using
$wgPageImagesScores['galleryImageWidth']
- In Wikimedia wikis gallery images which are smaller than 100 are disregarded.
- Position in document is also considered as defined in
$wgPageImagesScores['position']
- On Wikimedia wikis, only the first 4 images that appear in the document are considered.
- The ratio of the image's width to height is considered
$wgPageImagesScores['ratio']
- On Wikimedia wikis a ratio of 0.4 to 3.1 is allowed, with 0.6 to 2.1 preferred.
- The default value is
$wgPageImagesScores['ratio'] = ["3" => -100, "5" => 0, "20" => 5, "30"=> 0, "31"=> -100];
with the key representing the width divided by height, rounded to the tenths place, and the decimal shifted one position to the right. An image 400px wide by 300px high would have a value of 13. The key's value is the scoring multiple associated with that ratio. Keys are selected increasing from zero with a new scoring multiple not taking effect until the key has been met or exceeded its value but not exceeded the next key. Any other images will score negatively and be discarded.
- Image widths as defined in
How are pages images updated?
[edit]Pageimages populates images whenever the LinksUpdate hook runs, e.g. when a page is being edited.
Can I exclude certain page images?
[edit]Yes!
For an entire wiki, there is a page that administrators can edit at MediaWiki:Pageimages-denylist (example). Any images that appear here will not be used as page images for any article.
For specific pages, add |class=notpageimage
to each image you want to exclude. For example, [[File:Example.png|class=notpageimage]]
.
More details are at phab:T301588.
How can I see the page image for a page?
[edit]Using the Page information link in the sidebar (or adding ?action=info
to the URL) you'll be able to see the current image choice.
How can I purge a bad image?
[edit]The pageimage only changes when a link in an article changes. For emergencies, please add/remove links from the page, reverting if necessary. Purging will not work. For larger emergencies please file a Phabricator ticket.
Why is my page image a blank box?
[edit]This likely relates to video content in your article. If a video file begins with a blank screen, that will become the default thumbnail for the video and if used as the page image, it will become the page image. We are currently working on a fix for this, that will allow you to change the default thumbnail of a video. See: phab:T92457 and phab:T22647 for further information.
See also
[edit]![]() | This extension is being used on one or more Wikimedia projects. This probably means that the extension is stable and works well enough to be used by such high-traffic websites. Look for this extension's name in Wikimedia's CommonSettings.php and InitialiseSettings.php configuration files to see where it's installed. A full list of the extensions installed on a particular wiki can be seen on the wiki's Special:Version page. |
![]() | This extension is included in the following wiki farms/hosts and/or packages: This is not an authoritative list. Some wiki farms/hosts and/or packages may contain this extension even if they are not listed here. Always check with your wiki farms/hosts or bundle to confirm. |
- Extensions bundled with MediaWiki 1.34
- Stable extensions
- API extensions
- Parser extensions
- WTFPL licensed extensions
- Extensions in Wikimedia version control
- ApiOpenSearchSuggest extensions
- BeforePageDisplay extensions
- InfoAction extensions
- ParserAfterTidy extensions
- ParserModifyImageHTML extensions
- ParserTestGlobals extensions
- SearchResultProvideThumbnail extensions
- SpecialMobileEditWatchlist::images extensions
- All extensions
- Extensions used on Wikimedia
- Extensions included in BlueSpice
- Extensions included in Canasta
- Extensions available as Debian packages
- Extensions included in Fandom
- Extensions included in Miraheze
- Extensions included in MyWikis
- Extensions included in ProWiki
- Extensions included in ShoutWiki
- Extensions included in WikiForge
- Search engine optimization extensions