Entity Plugin

Entity plugins is attached for specific entity type and their bundle\view-mode combinations.

It's used when you need to add JSON-LD on pages where specific entity is presented.

Annotation example

/**
 * @JsldEntity(
 *   id = "node_news",
 *   entity_type = "node",
 *   entity_limit = {"news|*", "page|full"}
 * )
 */

• id: Machine name for plugin.
• entity_type: Entity type ID on which this plugin is fired.
• entity_limit: An array of limitation inside entity type. Have structure BUNDLE|VIEW_MODE. Supports for wildcard * in both parts. If you set *|*, that plugin will be attached to all entities of this type, on every view mode.

This plugins is stored in /src/Plugin/jsld/entity/ path.

Generate plugin

drush generate plugin-jsld-entity

Example of plugin

<?php

namespace Drupal\MODULENAME\Plugin\jsld\entity;

use Drupal\Core\Config\ImmutableConfig;
use Drupal\Core\Datetime\DateFormatterInterface;
use Drupal\Core\Plugin\ContainerFactoryPluginInterface;
use Drupal\Component\Utility\UrlHelper;
use Drupal\image\Entity\ImageStyle;
use Drupal\jsld\Plugin\jsld\JsldEntityPluginBase;
use Symfony\Component\DependencyInjection\ContainerInterface;
use Symfony\Component\HttpFoundation\Request;

/**
 * @JsldEntity(
 *   id = "node_news",
 *   entity_type = "node",
 *   entity_limit = {"news|*"}
 * )
 */
class NodeNews extends JsldEntityPluginBase implements ContainerFactoryPluginInterface {

  /**
   * The current request.
   */
  protected Request $request;

  /**
   * The config system site.
   */
  protected ImmutableConfig $configSystemSite;

  /**
   * The date formatter service.
   */
  protected ?DateFormatterInterface $dateFormatter;

  /**
   * {@inheritdoc}
   */
  public static function create(ContainerInterface $container,array $configuration,$plugin_id,$plugin_definition){
    $instance = new static($configuration, $plugin_id, $plugin_definition);
    $instance->request = $container->get('request_stack')->getCurrentRequest();
    $instance->configSystemSite = $container->get('config.factory')->get('system.site');
    $instance->dateFormatter = $container->get('date.formatter');

    return $instance;
  }

  /**
   * {@inheritdoc}
   */
  public function build() {
    $host = $this->request->getSchemeAndHttpHost();
    $result = [
      '@context' => 'https://schema.org',
      '@type' => 'Article',
      'name' => $this->entity->label(),
      'headline' => $this->entity->label(),
      'url' => $this->entity->toUrl('canonical', ['absolute' => TRUE]),
      'mainEntityOfPage' => $this->entity->toUrl('canonical', ['absolute' => TRUE]),
      'datePublished' => $this->dateFormatter->format($this->entity->created->value),
      'dateModified' => $this->dateFormatter->format($this->entity->changed->value),
      'author' => [
        '@context' => 'https://schema.org',
        '@type' => 'Organization',
        'name' => $this->configSystemSite->get('name'),
        'sameAs' => $host,
        'url' => $host,
      ],
      'publisher' => [
        '@context' => 'https://schema.org',
        '@type' => 'Organization',
        'name' => $this->configSystemSite->get('name'),
        'sameAs' => $host,
        'url' => $host,
      ],
    ];

    if (!$this->entity->field_news_promo->isEmpty()) {
      $image_url = ImageStyle::load('medium')
        ->buildUrl($this->entity->field_news_promo->entity->uri->value);
      $url = new UrlHelper();
      // This helps to use URL without query parameters.
      $url_parts = $url->parse($image_url);
      $result['image'] = [
        '@type' => 'ImageObject',
        'url' => $url_parts['path'],
      ];
    }
    return $result;
  }

}