How can I extend Serializer to handle a custom field type?

I’m trying to extend Serialization to get the JSON Field module to return a JSON object instead of stringified JSON.

Goal: When I access an entity that contains a JSON field using JSON:API, I want a JSON object for the field value (currently, the stringified JSON is returned).

I think what I need to do is to extend one of the core normalizers and use it to add a json_decode() step.

There is some documentation on how Serializer handles entities but it is out-of-date (last updated in 2017 before JSON:API was part of core, and the current code looks nothing like what is shown.)

I tried extending FieldNormalizer in /json_field/src/Normalizer/JsonFieldNormalizer.php.
However, I’m not confident that this is the correct approach, as there is also a FieldItemNormalizer and TypedDataNormalizer. To change how a field is output in JSON:API, which class should I extend?

<?php  namespace Drupaljson_fieldNormalizer;  use DrupalCoreFieldFieldDefinitionInterface; use Drupaljson_fieldPluginFieldFieldTypeNativeJSONItem; use DrupaljsonapiJsonApiResourceResourceObject; use DrupaljsonapiNormalizerFieldNormalizer; use DrupaljsonapiNormalizerValueCacheableNormalization; use DrupaljsonapiResourceTypeResourceType;  class JsonFieldNormalizer extends FieldNormalizer {    /**    * {@inheritdoc}    */   protected $supportedInterfaceOrClass = NativeJSONItem::class;    /**    * {@inheritdoc}    */   public function normalize($field, $format = NULL, array $context = []) {     $field_name = $field->getName();     Drupal::logger('json_field')->info("Field has name $field_name");     assert($field instanceof NativeJSONItem);     /** @var DrupalCoreFieldFieldItemListInterface $field */ $normalized_items = $this->normalizeFieldItems($field, $format, $context);     assert($context['resource_object'] instanceof ResourceObject);     return $context['resource_object']->getResourceType()->getFieldByInternalName($field->getName())->hasOne()       ? array_shift($normalized_items) ?: CacheableNormalization::permanent(NULL)       : CacheableNormalization::aggregate($normalized_items);   } 

And I added the class to json_field.services.yml:

services:   json_field.views:     class: Drupaljson_fieldJSONViews   json_field.normalizer.field.json_field:     class: Drupaljson_fieldNormalizerJsonFieldNormalizer     tags:       - { name: normalizer, priority: 1 } 

However, after rebuilding the cache and accessing some JSON fields via JSON:API, I don’t see anything in the logs, so it seems like the class is not being picked up.

This article was republished from its original source.
Call Us: 1(800)730-2416

Pixeldust is a 20-year-old web development agency specializing in Drupal and WordPress and working with clients all over the country. With our best in class capabilities, we work with small businesses and fortune 500 companies alike. Give us a call at 1(800)730-2416 and let’s talk about your project.

FREE Drupal SEO Audit

Test your site below to see which issues need to be fixed. We will fix them and optimize your Drupal site 100% for Google and Bing. (Allow 30-60 seconds to gather data.)

Powered by

How can I extend Serializer to handle a custom field type?

On-Site Drupal SEO Master Setup

We make sure your site is 100% optimized (and stays that way) for the best SEO results.

With Pixeldust On-site (or On-page) SEO we make changes to your site’s structure and performance to make it easier for search engines to see and understand your site’s content. Search engines use algorithms to rank sites by degrees of relevance. Our on-site optimization ensures your site is configured to provide information in a way that meets Google and Bing standards for optimal indexing.

This service includes:

  • Pathauto install and configuration for SEO-friendly URLs.
  • Meta Tags install and configuration with dynamic tokens for meta titles and descriptions for all content types.
  • Install and fix all issues on the SEO checklist module.
  • Install and configure XML sitemap module and submit sitemaps.
  • Install and configure Google Analytics Module.
  • Install and configure Yoast.
  • Install and configure the Advanced Aggregation module to improve performance by minifying and merging CSS and JS.
  • Install and configure Schema.org Metatag.
  • Configure robots.txt.
  • Google Search Console setup snd configuration.
  • Find & Fix H1 tags.
  • Find and fix duplicate/missing meta descriptions.
  • Find and fix duplicate title tags.
  • Improve title, meta tags, and site descriptions.
  • Optimize images for better search engine optimization. Automate where possible.
  • Find and fix the missing alt and title tag for all images. Automate where possible.
  • The project takes 1 week to complete.