MarkupJsonLDSchema Module

General information

This module is all about arrays, either PHP or JSON-LD. JSON-LD schema arrays give your web pages a vastly improved chance of high visibility in SERPs and, at Google's whim, deliver more engaging results than simply a title, link and brief description.

While the inherent structure of a schema is predefined, there are thousands of combinations.

This module helps you dynamically create schemas from within your templates. Each schema can be configured to meet your requirements. You can even add your own ProcessWire schema classes to the module.

Some useful resources for learning more about JSON-LD schemas:

There are also several informative posts in the ProcessWire forums.

Installation

Download or clone the module into:

/site/modules/MarkupJsonLDSchema/

Login to ProcessWire and go to:

Modules → Refresh

Install MarkupJsonLDSchema
Optionally install ProcessJsonLDSchemaConfig — this adds a Setup → Json-LD Schema page that allows non-superuser roles to edit the module configuration. Assign the jsonld-schema-config permission to any role that needs access.

Configuration is optional. The configuration fields simply provide convenient defaults for organization/business schema data.

Usage

Basic usage

In your template:

<?php $jsonld = $modules->get('MarkupJsonLDSchema'); ?>

<script type="application/ld+json">
<?= $jsonld->render('LocalBusiness'); ?>
</script>

This will output a LocalBusiness schema based on the data saved in the module configuration.

Overriding schema elements

A more complex example using the $options array:

<?php
$jsonld = $modules->get('MarkupJsonLDSchema');

$options = [
    'logo' => $pages->get(1)->images->first->width(200)
];
?>

<script type="application/ld+json">
<?php
switch ($page->template) {
    case 'home':
        echo $jsonld->render('WebSite', $options);
        echo $jsonld->render('LocalBusiness', $options);
        break;

    case 'blog-post':
        echo $jsonld->render('Article');
        echo $jsonld->render('BreadcrumbList');
        break;

    default:
        echo $jsonld->render('WebPage', $options);
        echo $jsonld->render('LocalBusiness', $options);
        echo $jsonld->render('BreadcrumbList');
        break;
}
?>
</script>

Any value in the default schema may be overridden using $options, for example:

<?php
$jsonld = $modules->get('MarkupJsonLDSchema');

$options["@type"] = "RealEstateAgent";
?>

<script type="application/ld+json">
<?= $jsonld->render('LocalBusiness', $options); ?>
</script>

This would render "@type": "RealEstateAgent" instead of "LocalBusiness".

Custom schema elements

You can extend the predefined schema arrays using the custom key in $options.

<?php
$jsonld = $modules->get("MarkupJsonLDSchema");

$options["custom"] = [
    "foundingDate" => "2013",
    "areaServed" => "Worldwide",
    "taxID" => "ABN 99 999 999 123"
];
?>

<script type="application/ld+json">
<?= $jsonld->render('LocalBusiness', $options); ?>
</script>

The module will append these properties to the generated schema.

Notes

Custom fields must be simple text key/value pairs.

Keys and values are sanitized as text before being added to the schema.

Complex objects or nested structures (such as ImageObject, PostalAddress, or additional Person/Organization structures) are not supported through custom.

If you need more complex schema structures, copy the closest schema class and adapt it for your use case.

Optional: caching schema output

Schema generation is lightweight and caching is not required. However, on high‑traffic sites you may wish to cache the rendered JSON‑LD.

Caching is intentionally left to the template developer, as caching strategy varies between projects.

Example using ProcessWire's $cache API:

<?php
$jsonld = $modules->get("MarkupJsonLDSchema");

$options = [
    'logo' => $pages->get('template=bizinfo')->images('tags=logo')->last->width(200)
];

$cacheName = "jsonld-website-" . $page->id;
$schema = $cache->get($cacheName);

if(!$schema) {
    $schema = $jsonld->render('WebSite', $options);
    $cache->save($cacheName, $schema, 86400); // cache for 1 day
}
?>

<script type="application/ld+json">
<?= $schema ?>
</script>

Possible caching strategies include:

clearing cache on page save
caching per language
caching different schema types separately

The module itself does not enforce caching so developers remain free to implement whatever strategy suits their project.

ProcessJsonLDSchemaConfig (Admin UI)

The module includes ProcessJsonLDSchemaConfig, a Process module that exposes the MarkupJsonLDSchema configuration under Setup → Json-LD Schema in the admin.

Purpose

By default, only superusers can access module configuration screens. ProcessJsonLDSchemaConfig provides a dedicated admin page with its own permission, so content editors or site managers can update organization data (name, address, phone, social links, etc.) without needing superuser access.

Files

Both files live inside the main module directory:

site/modules/MarkupJsonLDSchema/
├── ProcessJsonLDSchemaConfig.info.php    ← module metadata, permission, admin page
└── ProcessJsonLDSchemaConfig.module      ← Process class with form builder

Permission

The module registers the permission jsonld-schema-config. To grant access:

Go to Access → Roles
Edit the desired role
Check jsonld-schema-config
Save

How it works

Reads and writes the same configuration data as MarkupJsonLDSchema ($modules->getConfig / $modules->saveConfig)
All fields mirror the module's config screen (organization, address, phone, social URLs, search settings, etc.)
Changes made from either location (Modules → Configure or Setup → Json-LD Schema) are reflected in both

Requirements

MarkupJsonLDSchema must be installed first (declared as dependency)

Schemas included in the module

Default config fields

address_locality
description
address_region
postcode
street_address
organization
logo
telephone
opening_hours
latitude
longitude
has_map
same_as
search_results_page
search_get_var

Article

Outputs an Article schema for the current page. Defaults come from the page, including headline, publish and modified dates, description, body content, author, and URL. You can override the output with $options keys such as @type, headline, description, articleBody, and image.

BreadcrumbList

Outputs a BreadcrumbList schema using the current page's parents. The module skips this schema on the home page. Useful for standard site navigation trails.

Based on the ProcessWire forum post by AndZyk:

https://processwire.com/talk/topic/13417-structured-data/

Thanks also to Macrura and others who contributed.

Custom

A dummy schema with no defaults. Build the entire schema using $options["custom"].

Event

Outputs an Event schema for the current page. Defaults come from the page and module config where appropriate, with organizer pointing to the configured organization. Common overrides include name, url, description, start_date, end_date, location, and offers.

LocalBusiness

Outputs a LocalBusiness schema using the module configuration as the primary data source. Useful for business name, address, telephone, opening hours, geo coordinates, map URL, and social profile links. Any of these values may be overridden in $options.

NewsArticle

Outputs a NewsArticle schema for the current page. Defaults come from the page, including headline, dates, description, body, author, publisher reference, and URL. You can override the output with $options keys such as @type, headline, description, articleBody, and image.

Organization

Outputs an Organization schema using the module configuration as the primary data source. Includes a canonical @id of /#organization, plus name, URL, description, logo, address, telephone, opening hours, social links, and optional geo coordinates.

Person

The Person schema is primarily driven by the $options array.

The module config may still provide shared defaults such as organization, though personal contact and identity fields are not inherited automatically. These must be explicitly passed when rendering the schema.

If you pass worksFor as an array, it should follow an Organization-like structure. The schema supports nested values such as @id, url, and sameAs.

Important

The following fields are only included when explicitly provided in $options:

email
telephone
same_as
street_address
address_locality
address_region
postcode
address_country
image
logo

This prevents business-level defaults such as company phone, address, or social links from being incorrectly applied to a person.

Address fields are optional and processed individually. Only the values provided will be included in the final PostalAddress.

Example

<?php
$jsonld = $modules->get('MarkupJsonLDSchema');

$options = [
    'name' => 'Jane Doe',
    'jobTitle' => 'Founder',
    'email' => 'jane@example.com',
    'same_as' => [
        'https://www.linkedin.com/in/janedoe/',
        'https://github.com/janedoe',
    ],
    'address_locality' => 'Sydney',
    'address_region' => 'NSW',

    'worksFor' => [
        '@type' => 'Organization',
        '@id' => 'https://example.com/#organization',
        'name' => 'Acme Studio',
        'url' => 'https://example.com',
        'sameAs' => [
            'https://linkedin.com/company/acme',
            'https://github.com/acme',
        ],
    ],
    'description' => 'Founder of Acme Studio and specialist in ...',
    'url' => $page->httpUrl,
];
?>

<script type="application/ld+json">
<?= $jsonld->render('Person', $options); ?>
</script>

Product

Outputs a Product schema for the current page. Defaults come from page fields for brand, name, and description, while the publisher points to the configured organization. Optional overrides include brand, name, description, image, rating_value, review_count, offers, price, and priceCurrency.

offers may be a single Offer array or a list of Offer arrays. Common supported offer keys are @type, url, price, priceCurrency, availability, itemCondition, priceValidUntil, and seller. For simple products, passing price and optional priceCurrency creates one Offer using the current page URL.

WebPage

Outputs a WebPage schema for the current page.

Key	Default
@type	WebPage
url	`$page->httpUrl` or flat URL from `page_url`
name	`$page->get('seo_title
description	`$page->get('seo_description
image	supplied via `$options["image"]`
potentialAction	SearchAction if search page config is present

WebSite

Outputs a WebSite schema for the site home page. Defaults come from the home page and module config, including name, description, logo, publisher reference, and optional SearchAction using search_results_page and search_get_var.

Creating your own schema classes

Developers can add new schema types.

Requirements:

Location

/site/modules/MarkupJsonLDSchema/schemas/

File naming convention

jsonld.SchemaName.php

Example:

jsonld.FAQPage.php

Class naming convention

ProcessWire\JsonLDSchemaName

Example:

<?php namespace ProcessWire;

class JsonLDFAQPage {

    public static function getSchema(array $data = null, Page $page = null) {

        return [
            "@context" => "https://schema.org",
            "@type" => "FAQPage"
        ];

    }

}

Once created, it can be rendered normally:

echo $jsonld->render('FAQPage');

Name		Name	Last commit message	Last commit date
Latest commit History 40 Commits
schemas		schemas
CHANGELOG.md		CHANGELOG.md
MarkupJsonLDSchema.config.php		MarkupJsonLDSchema.config.php
MarkupJsonLDSchema.info.php		MarkupJsonLDSchema.info.php
MarkupJsonLDSchema.module		MarkupJsonLDSchema.module
ProcessJsonLDSchemaConfig.info.php		ProcessJsonLDSchemaConfig.info.php
ProcessJsonLDSchemaConfig.module		ProcessJsonLDSchemaConfig.module
README.md		README.md

Folders and files

Latest commit

History

Repository files navigation

MarkupJsonLDSchema Module

General information

Installation

Usage

Basic usage

Overriding schema elements

Custom schema elements

Optional: caching schema output

ProcessJsonLDSchemaConfig (Admin UI)

Purpose

Files

Permission

How it works

Requirements

Schemas included in the module

Default config fields

Article

BreadcrumbList

Custom

Event

LocalBusiness

NewsArticle

Organization

Person

Important

Example

Product

WebPage

WebSite

Creating your own schema classes

About

Resources

Uh oh!

Stars

Watchers

Forks

Releases

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages