Skip to content

Latest commit

 

History

History
72 lines (59 loc) · 2.82 KB

readme.md

File metadata and controls

72 lines (59 loc) · 2.82 KB
Raw

Open Graph Link Data for Statamic

Requirement: Statamic v2.6.x, php-xml Version: 1.0.6

What is this?

A field type and tag for obtaining and presenting meta tags, open graph tags, and twitter cards sourced from your templates.

Installation

  • Rename the folder LinkOgData and copy it to your site/addons folder

Note: The specific meta data available depends on what the website supplies. When using this data, you should take into account that it may not exist.

Field Type

  • Add the field type to one of your fieldsets
  • Save the page or entry from CP
  • Use the data in one of your templates

Data Storage

The data is stored (and thus not dynamic or real time). If title, description, author, and keywords are available, they are stored at the top level. Open Graph and Twitter cards are stored within og and twitter fields respectively. All available Open Graph and Twitter tags are saved, replacing any addtional :'s with _'s.

Sample:

link:
  url: https://wondereur.com
  title: Your access to cutting-edge international artists • Wondereur
  description: |
    Wondereur is a ground-breaking cultural platform reinventing how we relate to art. Discover, experience, invest. Worldwide.
  og:
    title: Your access to cutting-edge international artists • Wondereur
    description: |
      Wondereur is a ground-breaking cultural platform reinventing how we relate to art. Discover, experience, invest. Worldwide.
    site_name: Wondereur
    url: https://www.wondereur.com/
    image: >
      https://d3d8q6fdip3x5i.cloudfront.net/artists/header_images/000/000/048/small/IMG_7567_2.jpg?1491336221
    image_type: image/jpeg
    image_width: "576"
    image_height: "342"
  twitter:
    site: @wondereur

Tag

When you need more real time meta data, you can use the tag to fetch meta data in real time.

Note: If you do not use any additional caching a request for the meta data will be made on each page request. This could slow down your website and may be frowned upon by the remote site.

It would be good practice to at least wrap your tag in a {{ cache }} tag pair.

Sample:

{{ link_og_data :url='link:url' }}
    {{ title }}<br />
    {{ description }}<br />
    {{ og:title }}<br />
    {{ og:description }}<br />
    {{ twitter:site }}<br />
    <img src="{{ og:image }}" />
{{ /link_og_data }}

Version Log

  • 1.0.6 Fix for really tall images 🖼
  • 1.0.5 Fix for pages that forgot their <title> tag 😱
  • 1.0.4 Make sure the link exists before adding a protocol on save (if missing)
  • 1.0.3 Fix for servers that return error codes, add protocol if missing and support interal links (starting with /).
  • 1.0.2 Fix for Statamic 2.6.x addon / route changes
  • 1.0.1 Slight refactor & better handeling of lookup errors
  • 1.0.0 Initial release

Made with ❤️ by JRC9 Design Studio