vdlp/oc-schemaorg-plugin

Provides the rendering of structured data.

Installs: 244

Dependents: 0

Suggesters: 0

Security: 0

Stars: 1

Watchers: 8

Forks: 1

Open Issues: 0

Type:october-plugin

1.2.0 2021-07-13 12:06 UTC

This package is auto-updated.

Last update: 2021-07-13 12:07:48 UTC


README

Provides the rendering of structured data on your October CMS powered website.

What is structured data?

Structured data is code in a specific format, written in such a way that search engines understand it. Search engines read the code and use it to display search results in a specific and much richer way. You can easily put this piece of code on your website.

There are all kinds of structured data. Structured data is always a code format. There’s structured data for books, for reviews, for movies, and for products in your online store, for instance. In all cases, structured data adds more details to your snippet in the search results.

Browse Google’s Search Gallery to see which rich results are powered by structured data.

Source: yoast.com

Requirements

  • PHP 7.3 or higher
  • October CMS (preferably the latest version).

Installation

composer require vdlp/oc-schemaorg-plugin

Usage

To render structured data from a component you can listen to the Vdlp\SchemaOrg\Classes\Events\FetchStructuredData event.

Example:

/** @var \Illuminate\Contracts\Events\Dispatcher $eventDispatcher */
$eventDispatcher = resolve(\Illuminate\Contracts\Events\Dispatcher::class);

$eventDispatcher->listen(\Vdlp\SchemaOrg\Classes\Events\FetchStructuredData::class, static function () {
    return \Spatie\SchemaOrg\Schema::localBusiness()
        ->name('VDLP')
        ->email('octobercms@vdlp.nl')
        ->contactPoint(\Spatie\SchemaOrg\Schema::contactPoint()->areaServed('Worldwide'));
});

Add the vdlpStructuredData component to your page or layout to render the structured data.

Issues

If you have issues using this plugin. Please create an issue on GitHub or contact us at octobercms@vdlp.nl.