Schema.org markup

Schema type per section

In the Schema.org section of the plugin, you can set a Schema type for each of the sections defined in your site.

The fields from the SEO field (meta title, meta description, facebook image) will be used to populated the Schema and it will be added to the page in JSON-LD format.

Custom markup & template overrides

In case you want to specify the schema type yourself, overwrite the values or set additional properties, you can do so by following these steps.

1) Disable to plugin from rendering the schema data.

This can be done with the following snippet:

{# make sure you add this line above any layout you're extending #}
{% do entry.setShouldRenderSchema(false) %}
{% extend 'layout.twig' %}

2) Add you own schema tag

You can create a new Schema object through the seoFields variable in your template.

{# @var schema \Spatie\SchemaOrg\Schema #}
{% set schema = seoFields.schema %}

When using PHPStorm, it's recommended that you use the Symfony Plugin, to get proper autocompletion on the created object Doing that will make it easier to add a script like the example below:

{# @var schema \Spatie\SchemaOrg\Schema #}
{% set schema = craft.schema %}
{{ schema.organization
    .name("Studio Espresso")
    .email("info@studioespresso.co")
|raw }}

Add your own types through settings

Out of the box, you can set a section to one of the following types:

• WebPage
• Article
• CreativeWork
• Review
• Organisation
• Recipe
• Person

You can extend this list by setting the schemaOptions attribute in the seo-fields.php settings file. You can find the syntax here