Manual:$wgLogos

Translate this page

Server URLs and file paths: $wgLogos
The URL path to various wiki logos.
Introduced in version:	1.35.0 (Gerrit change 562588; git #8cd2e133)
Removed in version:	Still in use
Allowed values:	(array of factors and relative paths or urls)
Default value:	`false` (Note: The default value of this variable depends on other variables, such as the values set in Setup.php , after LocalSettings.php is executed)
Other settings: Alphabetical \| By function

Details

Caution: Do not simply overwrite the default logo installed within MediaWiki (/resources/assets/wiki.png); this file will be overwritten when you upgrade the software.

A larger size can be used by modifying the site’s CSS, but MediaWiki will not resize a logo that is too large. Instead, only part of the image (specifically the upper left-hand corner) will be displayed, and if this corner is white, it may seem like the image is not displaying.

The recommended size for a square logo is 135 × 135px, though the logo doesn’t have to be square, especially if it includes text below an image. The maximum logo size in the Vector skin is ~160 × 160px, while in MonoBook it’s ~155 × 155px.

An array with factors and their associated relative paths or URL paths to the different versions of the wiki logo. (i.e., the image displayed in the upper-left corner of the page in most MediaWiki installations).

Supported keys

The icon version: it should be a square and should be nominally 50 × 50 pixels if SVG, or 100 × 100 pixels if raster in order to support HiDPI. SVG however is recommended. Current support for this key is limited to Skin:Vector , Skin:Timeless , Skin:Refreshed , Skin:Citizen , but this is recommended for all new skins. Note that other skins typically require a larger icon if they support this, so using an SVG instead is recommended as it will scale correctly across all of them.

The 1× version: it should be 135px wide by up to ~155px tall. This is because the 1.5× and 2× versions assume a nominal width of 135px, and up to 155px tall will fit without issues in standard skins. This supports older skins and in the long-term future will be deprecated. We recommend skins support the preferred `icon`.

The 1.5× version: it should 202px wide, matching the aspect ratio of the 1×. (so up to 232px tall, for 155px nominal height.) The key will be deprecated in future and its use is not recommended.

The 2× version: it should be 270px wide, matching the aspect ratio of the 1×. (so up to 310px tall, for 155px nominal height.) The key will be deprecated in future and its use is not recommended.

The svg version: it replaces the need for a 1x, 1.5x, and 2x version, but should follow the same nominal size guidelines, fitting within 135px wide and 155px tall when resized to 135px wide. The key will be deprecated in future and its use is not recommended.

There are also two optional fields for additional assets to show next to the logo:

wordmark

it should be a landscape logo, with maximum set width or height, as these are specified under the width and height keys. The width shouldn't exceed 124 and the height shouldn't exceed 32px. Typically this is the graphic version of $wgSitename. This is used in Skin:Vector (1.36), Skin:Timeless, Skin:Minerva, Skin:Citizen

tagline

the same is true for the tagline, which typically corresponds to the non-sitename part of MediaWiki:Tagline. The combined height of the tagline and wordmark should not exceed 50px.

All values (except width and height) can either be a fully-qualified URL or a relative path from DOCUMENT_ROOT. If it's a relative path, it has to start with a slash (a file in DOCUMENT_ROOT is /file.png, not file.png). Instead, the image will be cut off so that only part of it (the upper left-hand corner to be precise) will be visible. If this corner is completely white, it might look like the image would not display, although in fact it does.

Example images

Example

$wgLogos = [
	'1x' => "path/to/1x_version.png",		// path to 1x version
	'1.5x' => "path/to/1.5x_version.png",	// path to 1.5x version
	'2x' => "path/to/2x_version.png",		// path to 2x version
	'svg' => "path/to/svg_version.svg",		// path to svg version
	'icon' => "path/to/icon.png",			// A version of the logo without wordmark and tagline
	'wordmark' => [
		'src' => "path/to/wordmark_version.png",	// path to wordmark version
		'1x' => "path/to/wordmark_version.svg",		// optional if you want to support browsers with SVG support with an SVG logo.
		'width' => 135,
		'height' => 20,
	],
	'tagline' => [
		'src' => "path/to/tagline_version.png",		// path to tagline version
		'width' => 135,
		'height' => 15,
	],
];

Simple example

$wgLogos = [
	'icon' => "$wgScriptPath/lol.png",			// path to icon, the primary logo for Vector
	'1x' => "$wgScriptPath/myCustomLogo.png",			// path to 1x version
	'2x' => "$wgResourceBasePath/hiResLogo.png",		// path to 2x version
];

Example paths

$wgLogos = [
	'1x' => "/lol.png",												// relative path to file in logo folder, 1x version
	'1.5x' => "https://mywiki.org/w/resources/assets/lol.png",	// fully qualified URL path to 1.5x version
	'2x' => "/lol.png",												// relative path to 2x version, which always starts with a slash
	//  'svg' => "",													// no svg (deprecated by MW)
	'icon' => "lol.png",												// Limited support, either 50x50 svg or 100x100 png
	'wordmark' =>  [
		'src' => "/wordmark_sitename.png",								// 135px wide image of sitename text, limited support
		'width' => 135,
		'height' => 20,
   ],
	'tagline' => [
        'src' => "/tagline_subtitle.png",								// 135px image to tagline text without sitename
		'width' => 135,
		'height' => 15,
	],
];

Adding logos for language variants

The functionality to override logos for different language variants was introduced in version 1.36.0 (Gerrit change 627939, git #8cd2e133). See T261153.

When defining variants, any language key can be used, for example it is possible to provide a German variant of an English logo.

This was extended to apply to all logo keys in 1.39.0.

$wgLogos = [
	'1x' => "path/to/1x_version.png",		// path to 1x version
	'1.5x' => "path/to/1.5x_version.png",	// path to 1.5x version
	'2x' => "path/to/2x_version.png",		// path to 2x version
	'svg' => "path/to/svg_version.svg",		// path to svg version
	'icon' => "path/to/icon.png",			// A version of the logo without wordmark and tagline
	'wordmark' => [
		'src' => "path/to/wordmark_version.png",	// path to wordmark version
		'1x' => "path/to/wordmark_version.svg",		// optional if you want to support browsers with SVG support with an SVG logo.
		'width' => 135,
		'height' => 20,
	],
	'tagline' => [
		'src' => "path/to/tagline_version.png",		// path to tagline version
		'width' => 135,
		'height' => 15,
	],
	'variants' => [
		'variant-code' => [
			'1x' => "path/to/language_variant_1x_version.png",		// path to 1x version in language variant
			'1.5x' => "path/to/language_variant_1.5x_version.png",	// path to 1.5x version in language variant
			'2x' => "path/to/language_variant_2x_version.png",		// path to 2x version in language variant
			'svg' => "path/to/language_variant_svg_version.svg",	// path to svg version in language variant
			'icon' => "path/to/language_variant_icon.png",			// A version of the logo without wordmark and tagline in language variant
			'wordmark' => [
				'src' => "path/to/language_variant_wordmark_version.png",	// path to wordmark version in language variant
				'1x' => "path/to/language_variant_wordmark_version.svg",	// optional if you want to support browsers with SVG support with an SVG logo in language variant.
				'width' => 135,
				'height' => 20,
			],
		],
	],
];