chrometoaster/silverstripe-metadescription-fallback

An extension providing a mechanism to populate meta description header from content fields when MetaDescription is empty

2.2.0 2024-04-07 12:57 UTC

Requires

• silverstripe/cms: ^4.0 || ^5.0

BSD-3-Clause

• Doug McKechie
• Michal Kleiner

• cms
• seo
• silverstripe
• meta

README

Requirements

• SilverStripe 4.0 and above
• PHP 5.6 and above

Maintainers

• [e-mail]
• [e-mail]

Description

This module applies a data extension to SiteTree providing a mechanism to populate meta description header from a defined set of content fields when the default MetaDescription is empty.

The list can use names of fields, names of methods or leverage the the dot notation to reference relations or methods, as outlined in the configuration example below.

Use with Dataobjects

The extension this module provides can also be applied to dataobjects, for example if you are outputting them as pages and need meta tags included in the source of the page.

In this case the MetadataTagsTrait also needs to be used by those dataobjects.

Installation with Composer

composer require "chrometoaster/silverstripe-metadescription-fallback"

Example configuration

In your config.yml, define the list of fields:

Chrometoaster\SEO\DataExtensions\MetaDescriptionFallbackExtension:
  fallback_fields:
    - Description
    - Introduction
    - Content.Summary
    - RelatedPages.First.MetaDescription

Run dev/build either via opening the url http://<your-host>/dev/build in a browser or by running the dev/build task using CLI.

Reporting Issues

Please create an issue for any bugs you've found, or features you're missing.

Changelog

For details of updates, bugfixes, and features, please see the changelog.

TODO

• Add unit tests for fallback mechanism.