Extension:OpenGraphMeta

MediaWiki extensions manual

OpenGraphMeta Release status: beta
Implementation	Data extraction, Parser function
Description	Provides OpenGraph meta tags providing data for 3rd parties like Facebook to extract
Author(s)	Daniel Friesen (Dantmantalk)
Latest version	0.5.6
Compatibility policy	Master maintains backward compatibility.
MediaWiki	1.39+
Database changes	No
License	GNU General Public License 2.0 or later
Download	Download extension Git [?]: Download Git master browse repository (GitHub) commit history repository contributors (GitHub) code review
Hooks used OutputPageParserOutput ParserFirstCallInit
Quarterly downloads	50 (Ranked 127th)
Public wikis using	5,841 (Ranked 42nd)
Translate the OpenGraphMeta extension if it is available at translatewiki.net
Issues	Open tasks · Report a bug

The OpenGraphMeta extension provides OpenGraph protocol metadata for articles on the wiki for 3rd parties like Facebook to extract. The primary use for this extension is for any wiki that provides its users a button to "Like" pages on the wiki, especially if the wiki uses a custom default skin. As sometimes Facebook can extract undesirable parts from the page (known on some custom skins to potentially extract random images irrelevant to the content) providing this data gives Facebook clean data to display in likes, and cleans up the long title into a pair of clean site and page titles. A parser function {{#setmainimage:Filename.ext}} which also exports what it is passed so you can use it easily in a [[File:{{#setmainimage:Filename.ext}}|thumb|right|...]] format can be used to set the image in the article which you prefer Facebook to use when displaying information about the page on your wiki (hint: This works very nicely when you incorporate it into an infobox template making the infobox image the preferred image for 3rd parties to use).

This extension can also be paired with Extension:Description2 which extracts description information from articles, when both are installed OpenGraphMeta will make use of the information Description2 extracts.

We need to provide the ability to maximize the amount of information available of the shared content so that it is more descriptive, while still in compliance with our policy.

Installation

Try the development version, or choose the version that matches your version of MediaWiki if the trunk version breaks.

• Download and place the file(s) in a directory called OpenGraphMeta in your extensions/ folder.
• Add the following code at the bottom of your LocalSettings.php :

  wfLoadExtension( 'OpenGraphMeta' );
  

•  Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

To users running MediaWiki 1.29 or earlier:

The instructions above describe the new way of installing this extension using wfLoadExtension(). If you need to install this extension on these earlier versions (MediaWiki 1.29 and earlier), instead of wfLoadExtension( 'OpenGraphMeta' );, you need to use:

require_once "$IP/extensions/OpenGraphMeta/OpenGraphMeta.php";

Configuration

In order to use Facebook Insights you must add the app ID to your page. Insights lets you view analytics for traffic to your site from Facebook. Find the app ID in your App Dashboard.

$egFacebookAppId = 'YOUR_FACEBOOK_APP_ID_HERE'; // Optional
$egFacebookAdmins = 'FACEBOOK_ADMINS'; // Optional

The site name exposed in OpenGraphMeta metadata can be adjusted with the Opengraphmeta-site-name system message, if editing $wgSitename is undesired.

See also

• Extension:Description2 – Provides page description information. When installed OpenGraphMeta will use the information it extracts from articles.
• Extension:Semantic Meta Tags – Provides HTML ‎<meta> tags generated from semantic annotations including OpenGraph tags.
• Extension:TextExtracts – Provides an API to retrieve plain-text or limited HTML extracts of page content.
• Extension:PageImages – Automatically chooses the best image for the page.
• https://developers.facebook.com/tools/debug – Simple tool that enables preview of what Facebook will display based on Open Graph meta tags.
• pageterms API query module – Provides an API to retrieve the Wikidata description of any page.
• Another very simple OpenGraph extension based on Extension:TextExtracts .