Extension:FlickrAPI

MediaWiki extensions manual

File:OOjs UI icon advanced-invert.svg FlickrAPI Release status: unmaintained
Implementation	Tag
Description	Embeds Flickr images
Author(s)	Ike Hecht (Tosfostalk)
Latest version	2.0.2 (July 2021)
Compatibility policy	For every MediaWiki release that is a Long Term Support release there is a corresponding branch in the extension.
MediaWiki	1.35
Database changes	No
License	GNU General Public License 2.0 or later
Download	<translate> Download extension</translate> <translate> Git</translate> [?]: <translate> Download Git master</translate> <translate> browse repository</translate> (GitHub) <translate> commit history</translate> <translate> repository contributors (GitHub)</translate> <translate> code review</translate>
Parameters $wgFlickrAPIDefaults $wgFlickrAPIKey $wgFlickrAPISecret
Hooks used ParserFirstCallInit
Quarterly downloads
Public wikis using
Translate the FlickrAPI extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The FlickrAPI allows you to embed Flickr images into your wiki. It is intended as a replacement for Extension:Flickr and is mostly backwards-compatible, but note that the configuration variables have changed. It uses the phpFlickr library.

This extension was created for WikiWorks.

Installation

• <translate> [[<tvar name=2>Special:ExtensionDistributor/FlickrAPI</tvar>|Download]] and move the extracted <tvar name=name>FlickrAPI</tvar> folder to your <tvar name=ext>extensions/</tvar> directory.</translate>
  <translate> Developers and code contributors should install the extension [[<tvar name=git>Special:MyLanguage/Download from Git</tvar>|from Git]] instead, using:</translate>cd extensions/
git clone https://gerrit.wikimedia.org/r/mediawiki/extensions/FlickrAPI
• <translate> Only when installing from Git, run <tvar name=composer>Composer</tvar> to install PHP dependencies, by issuing <tvar name=code>composer install --no-dev</tvar> in the extension directory.</translate> <translate> (See <tvar name=phab><translate> task <tvar name=1>T173141</tvar></translate></tvar> for potential complications.)</translate>
• <translate> Add the following code at the bottom of your <tvar name=1>LocalSettings.php </tvar> file:</translate>

  wfLoadExtension( 'FlickrAPI' );
  $wgFlickrAPIKey = ' /*FLICKR API KEY HERE*/ ';
  

• File:OOjs UI icon check-constructive.svg <translate> Done</translate> – <translate> Navigate to <tvar name=special>Special:Version</tvar> on your wiki to verify that the extension is successfully installed.</translate>

File:OOjs UI icon lightbulb-yellow.svg <translate> Note:</translate> You'll need an API key from Flickr. Get it here.

When installing from Git, please note that this extension requires Composer.

So, after installation from git, add the line "extensions/FlickrAPI/composer.json" to the "composer.local.json" file in the root directory of your wiki like e.g.

{
	"extra": {
		"merge-plugin": {
			"include": [
				"extensions/FlickrAPI/composer.json"
			]
		}
	}
}

Now run composer update --no-dev from the top level of your MediaWiki installation.

Configuration

• $wgFlickrAPIKey - Required. Your Flickr API key goes here.
• $wgFlickrAPISecret - The API secret from Flickr. This is optional and right now it probably doesn't do anything.
• $wgFlickrAPIDefaults - Array that contains the default values for the extension for when the <flickr> call does not specify certain options. Defaults to: [ 'type' => 'frameless', 'location' => 'right', 'size' => '-' ];

Usage

Embed a Flickr image using the tag: <flickr>id|type|location|size|caption</flickr>

The only mandatory parameter is id. The others can be omitted and the defaults will be applied from $wgFlickrAPIDefaults.

id

The Flickr ID of this photo.

type

The display type. This can be set to: thumb, frame or frameless.

location

The horizontal alignment. This can be set to: right, left, center or none.

size

The size to use for the image. This can be set to: s, t, m, - or b. See this page for more info.

caption

The caption to display for the image. If omitted, the default caption will be the photo's title in Flickr. Note that no caption is ever displayed if type is set to frameless.

See also

• Extension:FlickrImporter
• Extension:CloudImage