spatie/schema-org

A Graph is a collection of multiple Schema.org entities that can be linked together. It is useful for generating a single @graph JSON-LD block. You can use overloaded methods on the Graph instance to create or retrieve existing entities within the graph. You can also use hide() to prevent specific types from being rendered in the final script tag.

use Spatie\SchemaOrg\Graph;
use Spatie\SchemaOrg\Organization;

$graph = new Graph();

$graph
    ->product()
    ->name('My cool Product')
    ->brand($graph->organization());

// Hide the organization from the created script tag
$graph->hide(Organization::class);

// Somewhere else fill out the organization
$graph
    ->organization()
    ->name('My awesome Company');

echo $graph;

You can instantiate Schema.org types using the Spatie\SchemaOrg\Schema factory class or by using the new keyword. The library provides a fluent interface for setting properties. Most properties accept either a single value or an array of values.

use Spatie\
SchemaOrg\Schema;

$localBusiness = Schema::localBusiness()
    ->name('Spatie')
    ->email('info@spatie.be')
    ->contactPoint(Schema::contactPoint()->areaServed('Worldwide'));

echo $localBusiness->toScript();

Install the package using Composer to start building Schema.org structured data in your PHP applications.

composer require spatie/schema-org

To avoid breaking a fluent method chain when setting properties conditionally, use the if() method. It accepts a boolean and a closure that receives the schema instance.

use Spatie\SchemaOrg\LocalBusiness;
use Spatie\SchemaOrg\Schema;

$business = ['name' => 'Spatie'];

$localBusiness = Schema::localBusiness()
    ->name($business['name'])
    ->if(isset($business['email']), function (LocalBusiness $schema) use ($business) {
        $schema->email($business['email']);
    });

If the fluent API is insufficient, you can use these methods for manual property management:

• setProperty(string $name, mixed $value): Sets a custom property.
• getProperty(string $name, mixed $default = null): Retrieves a property value.
• getProperties(): Returns all properties as an array.
• addProperties(array $properties): Sets multiple properties at once.
• getContext(): Returns the @context (usually https://schema.org).
• getType(): Returns the @type of the entity.

$localBusiness->setProperty('foo', 'bar');
$localBusiness->getProperty('name'); // 'Spatie'
$localBusiness->getProperty('bar', 'baz'); // 'baz'
$localBusiness->getProperties(); // ['name' => 'Spatie', ...]
$localBusiness->addProperties(['name' => 'value', 'foo' => 'bar']);
$localBusiness->getContext(); // 'https://schema.org'
$localBusiness->getType(); // 'LocalBusiness'

Once you have built your schema object, you can export it in several formats:

• toScript(): Returns a <script type="application/ld+json"> string.
• toArray(): Returns the schema as a PHP array.
• json_encode($object): Converts the object to a plain JSON string.
• echo $object: Casting the object to a string produces the same output as toScript().

$localBusiness->toArray();

echo $localBusiness->toScript();

echo $localBusiness; // Same output as `toScript()`

echo json_encode($localBusiness);