Skip to content

An ExpressionEngine 2.X Add-on for SEO and Open Graph Meta

Notifications You must be signed in to change notification settings

vynsynt/modl_meta.ee_addon

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

81 Commits
 
 
 
 
 
 
 
 

Repository files navigation

MODL Meta

Overview

An ExpressionEngine 2.x module MODL Meta allows for default site-wide meta, template meta overrides, and per entry meta through custom MODL Meta fields. In addition to basic SEO metadata, MODL Meta includes basic Open Graph tags to work with Social Network shares such as Facebook Likes and Google +1.

Continuing Development By: Minds On Design Lab – http://mod-lab.com
Original Development By: SEO Lite – bjornbjorn
Version: 1.0.2
Copyright: Modifications Copyright © 2011 Minds On Design Lab
License: http://creativecommons.org/licenses/by/3.0/

This add-on is based on the SEO Lite add-on. Please refer the “About SEO Lite & Credit” section below for details.

Installation

Install in system/expressionengine/third_party/modl_meta

Updating from SEO Lite

To update a site using SEO Lite to MODL Meta, you need to update the version of SEO Lite to between 1.2.4 – 1.3.4. and then follow the following steps:

  • Backup the exp_seolite_config and exp_seolite_content tables.
  • Through CP, remove the SEO Lite Module
  • Import backed up exp_seolite_config and exp_seolite_content tables into your EE database manually.
  • Install MODL Meta. Install will update table names and field names as needed maintaining all previous data at time of backup.
  • Update default config.
  • Update template tags.

Usage

MODL Meta has a variety of ways to populate both SEO and Open Graph related metadata.

  • Configuration Defaults: Add-on defaults can be set.
  • Dynamic Entry Data: In addition to channel titles used for page titles, MODL Meta adds a custom tab to all channel publish forms that include fully customizable SEO and Open Graph metadata. This allows for per entry metadata which is great for dynamic content such as news, blogs, and such.
  • Template Tags: Through use of parameters you can pass metadata directly through the MODL Meta tag. This great for static templates such as a home page or blog list view for example.

Priorities are generally given in this order if all data is present:

Entry Meta > Default Config > Tag Parameter

Configuration

Module settings including defaults for select basic meta and appropriate open graph tags can be accessed at Addons → Modules → MODL Meta.

Setting Description
Template This is the code snippet that is added to your ExpressionEngine template where your MODL Meta tags are rendered. Current Default
Default title postfix This setting defines what should follow the default title value.
Default page keywords Basic meta keywords for SEO.
Default page description Basic description for SEO.
Default Open Graph description Default description for open graph tags. Can be left blank if you woudl prefer to set these on per entry and/or if there is no per entry allow Open Graph Consumers (Facebook, Google +1) to scrape the page dynamically for description copy.
Default Open Graph image Provide a full (absolute) URL to an image to use by default for Open Graph meta.

Core Template Tag

There is one core template tag added to your site’s header: {exp:modl_meta}

Key Usage Examples

Description Tag Usage Example
By segment {exp:modl_meta url_title="{segment_3}"}
By entry_id {exp:modl_meta entry_id="{entry_id}"}
Dynamic segment {exp:modl_meta use_last_segment="yes"}
Static – will either use config default or parameters {exp:modl_meta default_title="Hello World"}

Parameters

Parameter Options Description
entry_id The id of the entry you wish to get metadata about.
url_title The url title of the entry you wish to get metadata about (perfect for segments)
use_last_segment y/n Use this if you want to fetch metadata based on the last segment (Note; this will work w/pagination as well)
category_url_title Optional, use if you wish to fetch a category (title will be category title, description will be category description — or defaults)
site_id Used for MSM installs and optional, if you are getting content from another site then the current use this
default_title Override the default title in the template
default_keywords Override the default keywords in the template
default_description Override the default description in the template
default_og_title Override the default Open Graph title
default_og_description Override the default Open Graph description
default_og_image Override the default Open Graph image. Provide a full (absolute) URL
default_og_type Override the default Open Graph type
title_prefix A string to prefix the title with
title_postfix A string to postfix the title with
title_override Complete overrides title and any default configurations and template settings
ignore_last_segments Specify the number of segments to ignore at the end – e.g. 2 (ie. if you have an url that includes /sort/asc at the end you don’t want to include those in the canonical url + when searching for the url entry in conjuction with the “use_last_segment” parameter)
friendly_segments y/n (default is n) if {segment_x} is used in the SEO Lite template make it friendly (ie. ‘this_is_some_url_title_segment’ will be ‘This is some url title segment’)
tag_prefix if you want to prefix the MODL Meta tags, use this (ie. the {meta_description} will be {seo_meta_description} if you add a tag_prefix=“seo_”

Change Log

1.0.4

  • Remove encoding from title and og-title tag output. EE encodes the title by default

1.0.3

  • Fix FB Admin install error
  • Fix SEO Lite table conversion on install

1.0.2

  • Added a parse_globals call for the default_og_image so it can be used with global variables (esp. {site_url}) when entered on a template.

1.0.1

  • Added an EE version check when overriding the default OG Image to see wether or not {filedir_#} needs to be appended to the image path before saving in the db.
  • Fix tested on 2.3.1, 2.4, 2.5.2, & 2.5.3

1.0

  • Added Open Graph title, image, description, type tags, site name, admin/app_id tags. Changes made to publish tab, add-on settings, and template tags.
  • Revised add-on settings layout
  • Install includes data conversion from SEO Lite v1.3.4 to MODL Meta v1.0. See installation instructions for details.

About SEO Lite & Credit

As noted above, MODL Meta was forked from SEO Lite at v1.3.4 to explore adding Open Graph tags to the solution. Our approach was specific to our needs and was not in line with the direction of SEO Lite at the time. As such, we decided to build off of v1.3.4’s core of functionality that we had grown to be great fans of, and evolve it and maintain it as MODL Meta. We would encourage any EE developers interested in a great, simple and powerful SEO solution to check out SEO Lite. The following are links shared out of respect and courtesy to SEO Lite.

About

An ExpressionEngine 2.X Add-on for SEO and Open Graph Meta

Resources

Stars

Watchers

Forks

Packages

No packages published

Languages

  • PHP 100.0%