OpenGraph Tags - Functional specification
This documentation provides technical information about which OpenGraph tags Yoast SEO generates and outputs.
We output a variety of OpenGraph tags in the <head> of each page, in order to better inform data consumers about the content of the page in question. OpenGraph is consumed by Facebook, but also by Pinterest, LinkedIn, WhatsApp and even Google.
OpenGraph metadata
Assuming that the respective admin settings are not disabled, these tags are output on all pages (except for error templates, which are described separately).
| Tag | Description |
|---|---|
og:locale | The page's language. |
og:type | The type of page/resource. website on the homepage. profile on user profile pages. article on all pages/posts and other templates. |
og:title | The title of the page. |
og:url | The canonical URL of the page. |
og:site_name | The name of the site. |
Conditional tags
The following tags are only output when their conditions are met:
| Tag | Description | Notes |
|---|---|---|
og:description | The description of the page. | Outputs a value based on the following hierarchy:
|
article:publisher | The Facebook page URL of the publishing organization. | Only populated when a value has been provided by the user. Only populated on post and page types. |
article:author | The URL of the profile page of the author. | Only populated when the user has a valid profile URL. Only populated on post types. |
article:modified_time | A timestamp of when the page was last modified. | Only populated on post and page types. |
article:published_time | A timestamp of when the page was published. | Only populated on post and page types. |
og:image | The URL of the primary image of the page. | Only populated when the page contains a valid image, based on the following hierarchy:
|
og:image:width | The width in pixels of the og:image. | Only populated when an og:image is set, and its width and height are known. |
og:image:height | The height in pixels of the og:image. | Only populated when an og:image is set, and its width and height are known. |
Error templates
Only output the following tags are output:
| Tag | Value |
|---|---|
og:locale | The page's language. |
og:title | The site's error title template. |
og:site_name | The name of the site. |
Deprecated tags
The following tags used to be output by Yoast SEO, but have been removed in recent updates.
| Tag | Description | Reason | Deprecation |
|---|---|---|---|
article:section | Legacy Facebook / Open Graph tag. | No longer appears to be supported. | Yoast SEO v14.0 (Apr 2020) |
og:updated_time | Legacy Facebook / Open Graph tag. | No longer appears to be supported. | Yoast SEO v14.0 (Apr 2020) |
og:image:secure_url | Defines a (separate) URL for the featured image, available over HTTPS. | Unnecessarily duplicates the og:image tag when a site is on HTTPS, and, unnecessary/omitted when the site is not. | Yoast SEO v14.0 (Apr 2020) |
og:video:secure_url | Legacy Facebook / Open Graph tag. | As per og:image:secure_url, but for the featured video (in our Video SEO for WordPress plugin). | Yoast SEO v14.0 (Apr 2020) |
og:image:type | Defines the image format. | Poor value/performance trade-off; especially as we ping Facebook on post publish, at which point they determine and cache this information themselves. | Yoast SEO v14.0 (Apr 2020) |