Jump to content

Extension:GoogleRichCards

From mediawiki.org
MediaWiki extensions manual
GoogleRichCards
Release status: beta
Implementation User interface
Description MediaWiki extension for automated Google Rich Cards generation
Author(s) IgorShishkintalk
Latest version 0.2 (2025-07-28)
MediaWiki 1.43+
PHP 8.1+
seo, meta, google rich cards
Licence GNU General Public License 2.0 only
Download
Readme

The GoogleRichCards extension automatically generates Google Rich Cards in JSON+LD format for MediaWiki article pages.

Installation

[edit]
  • Download and place the file(s) in a directory called GoogleRichCards in your extensions/ folder.
  • Add the following code at the bottom of your LocalSettings.php file:
    wfLoadExtension( 'GoogleRichCards' );
    
  • Clear the cache of your browser
  • Clear MediaWiki page cache (if enabled)
  • Reload any MediaWiki article page
  • Check the HTML source and confirm the presence of following lines before </head> (values could differ according to the page content):
<script type="application/ld+json">
{
	"@context": "http://schema.org",
	"@type": "Article",
	"mainEntityOfPage": {
		"@type": "WebPage",
		"@id": "<current page URL>"
	},
	"author": {
		"@type": "Person",
		"name": "<first revision author>"
	},
	"headline": "<current page title>",
	"dateCreated": "2016-05-04T08:20:51+00:00",
	"datePublished": "2016-05-04T08:20:51+00:00",
	"discussionUrl": "<current page talk link>",
	"dateModified": "2016-06-05T01:12:10+00:00",
	"image": {
		"@type": "ImageObject",
		"url": "<first image on the article or $wgLogo>",
		"height": <height>,
		"width": <width>
	},
	"publisher": {
		"@type": "Organization",
		"name": "<wiki name>",
		"logo": {
			"@type": "ImageObject",
			"url": "<logo URL made of $wgServer + $wgLogo>"
		}
	},
	"description": "<page title>"
}
</script>
  • Yes Done – Navigate to Special:Version on your wiki to verify that the extension is successfully installed.

Configuration

[edit]

This extension has three configuration variables which control what (if anything) the extension does. By default annotations are enabled for pages in content namespaces and the WebSite annotations are also enabled, but event annotations and the <event> parser tag are not enabled.

Name Description Default
$wgGoogleRichCardsAnnotateArticles Enable annotations for articles (content pages)? true
$wgGoogleRichCardsAnnotateEvents Enable annotations for events + enable the <event> parser hook? false
$wgGoogleRichCardsAnnotateWebSite Enable WebSite annotations? true