silverstripers/seo

SEO for SilverStripe websites

Maintainers

Details

github.com/HelloBetterLTD/seo

Source

Issues

Installs: 35 324

Dependents: 1

Suggesters: 0

Security: 0

Stars: 11

Watchers: 3

Forks: 12

Open Issues: 8

Type:silverstripe-vendormodule

1.2.4 2023-07-03 23:38 UTC

Requires

BSD-3-Clause d089e72e6a46818cfc99b5f4ac5fc9e67d880cce

  • Nivanka Fonseka <nivanka.woop@silverstripers.com>

moduleseosilverstripe

This package is auto-updated.

Last update: 2024-10-26 10:07:21 UTC

README

This module enables advanced SEO functions for Silverstripe. It providers an SEO editor with

  1. Instant Previews for Google, Facebook, Twitter
  2. Editor for Open Graph Data
  3. Editor for Twitter Cards
  4. Save taxonomies
  5. Various meta title templates for pages
  6. Robots.txt controller
  7. Canonical URL management
  8. Flexibility on extending

Maintainers

nivanka@silverstripers.com

Installation

Use composer to install on your SilverStripe 4 website.

composer require silverstripers/seo dev-master

Requirements

  1. SilverStripe 4+
  2. SilverStripe Reports
  3. SilverStripe Assets

Basic usage

Require the package via composer and run dev build. http://mysite.com/dev/build?flush=all The module will create additional SEO fields for the SiteTree (page) objects and will add in an interface for set up the SEO data.

Add the following instead of the SilverStripe's default meta tag in the <head> section of your template.

$GenerateMetaTags.RAW

DataObjects as pages

If you are using data objects as pages then you may need to add in SEO fields for those data objects to do that it needs to decorate the data object with SEODataExtension

MyDataObject:
    extensions:
        SilverStripers\SEO\Extension\SEODataExtension

This will create the db fields and add the seo editor on to the CMS.

Within the controller you need to call override_seo_from function, and pass your data record for the module to grab the SEO details

use SilverStripers\SEO\Extension\SEODataExtension
...

class MyController extension Controller {

    ...

    public function view()
    {
        ...
        SEODataExtension::override_seo_from($record);
        ...
    }

}

Variables / Taxonomies

If you login to the CMS and go to Settings -> SEO -> Variables, there is a grid field where you can enter name value pair objects. These can have any names and any values and for any text field within the meta editor you can use these.

The variables will have respective buttons to click which will add them automatically on to the editors fields.

You can also type them in like this. {MyVariableName}

Meta Title Templates

For various websites there are different types of web pages which needs various types of meta titles.

eg: A product page will have a meta title like: ABC Product - Create the best value for money | XYZ Company

Meta titles templates lets you define these as

{MetaTitle} - Create the best value for money | {SiteTitle}

This then get the meta title from the page's meta title variable, and site title from the Site Config title. You can also use any of the variables you defined in the variables sections.

Structured Data

The module supports structured data and enabling takes only a few yml configurations.

E.G: The following makes a Page a Thing and maps the fields on to the Database fields.

Page:
  schema_type: 'Thing'
  schema:
    'name': 'MetaTitle'
    'description': 'MetaDescription'
    'Image': 'FacebookImage'

Supported Types

  • Article
  • Beach
  • BlogPosting
  • BreadcrumbList
  • ContactPoint
  • Corporation
  • CreativeWork
  • Duration
  • Event
  • GeoCoordinates
  • ImageObject
  • Invoice
  • ListItem
  • LocalBusiness
  • MusicAlbum
  • MusicGroup
  • MusicPlaylist
  • MusicRecording
  • NewsArticle
  • Offer
  • Order
  • Organization
  • Person
  • Place
  • PostalAddress
  • PriceSpeficication
  • Product
  • Rating
  • Review
  • SearchBox
  • Thing
  • VideoObject
  • WebPage

To view the config options for any type visit the page with adding ?structureddata_help=1 to the end of the URL

Enjoy!!