Custom Wagtail StreamField Blocks: Development and Examples

Content editors in Wagtail often hit the limits of standard blocks: you can't make a product card with a rating, a three-column pricing table, or a video-and-text block in three rows. In our practice, we've encountered such requests dozens of times. Over more than five years of work, we've developed over 50 sets of custom blocks for projects ranging from corporate sites to headless solutions on Wagtail. Custom StreamField blocks are the only way to give editors flexibility without losing control over structure. According to Wagtail documentation, StreamField allows creating arbitrary content types. In this material, we'll show using real examples how to design, validate, and integrate custom blocks with the API.

What Problems We Solve

Standard RichTextBlock and ImageBlock don't allow controlling data structure. According to our data, 80% of content errors arise from unstructured input. Custom blocks fix the structure, validate data on the CMS side, and reduce editing time by 40%. Additionally, they enable business logic not available in standard blocks: for example, dynamically displaying blocks based on user role or A/B testing components.

How to Create a Custom Block with Nested Elements?

The basic element is a class inheriting from StructBlock. Here's an example of a feature card and a section with cards:

from wagtail.blocks import StructBlock, CharBlock, RichTextBlock, ImageChooserBlock, ListBlock, ChoiceBlock

class FeatureCardBlock(StructBlock):
    icon = ImageChooserBlock(required=False)
    heading = CharBlock(max_length=80)
    body = RichTextBlock(features=['bold', 'italic', 'link'])
    cta_text = CharBlock(max_length=40, required=False)
    cta_url = URLBlock(required=False)

    class Meta:
        template = 'blocks/feature_card.html'

class FeatureSectionBlock(StructBlock):
    section_title = CharBlock(max_length=120)
    layout = ChoiceBlock(choices=[('grid-2', '2 columns'), ('grid-3', '3 columns'), ('grid-4', '4 columns')], default='grid-3')
    cards = ListBlock(FeatureCardBlock())

    class Meta:
        template = 'blocks/feature_section.html'

The template feature_card.html receives the value variable—a dictionary with block data. The editor can dynamically add and remove cards in the section without restrictions. For deep nesting (e.g., blocks inside cards inside sections), configure the admin form template—this improves editing convenience.

StreamField in Page Model

Connect blocks to the model:

from wagtail.models import Page
from wagtail.fields import StreamField
from wagtail.admin.panels import FieldPanel
from .blocks import FeatureSectionBlock, HeroBlock, TestimonialBlock, VideoEmbedBlock

class ServicePage(Page):
    body = StreamField([
        ('hero', HeroBlock()),
        ('features', FeatureSectionBlock()),
        ('testimonials', TestimonialBlock()),
        ('video', VideoEmbedBlock()),
    ], use_json_field=True)
    content_panels = Page.content_panels + [FieldPanel('body')]

The parameter use_json_field=True is mandatory for Wagtail 3.0+. Data is stored in a JSONB column in PostgreSQL, which allows queries via ORM. This speeds up fetching pages by block content, for example, for search.

How to Implement Complex Block Validation?

Note: when simple checks (required, length) are not enough—override clean(). For example, for a pricing plan block:

def clean(self, value):
    cleaned = super().clean(value)
    errors = {}
    if cleaned['annual_price'] >= cleaned['monthly_price'] * 12:
        errors['annual_price'] = ValidationError('Annual price must be less than sum of 12 months')
    if len(cleaned['features']) == 0:
        errors['features'] = ValidationError('Specify at least one feature for the plan')
    if errors:
        raise StructBlockValidationError(block_errors=errors)
    return cleaned

This allows implementing business logic of any complexity. Our engineers with over 5 years of experience guarantee that validation will work flawlessly, and the editor will receive clear prompts when filling the form.

Serializing Custom Blocks for API

If you're using Wagtail as a headless CMS, override get_api_representation():

def get_api_representation(self, value, context=None):
    representation = super().get_api_representation(value, context)
    if value.get('icon'):
        img = value['icon']
        representation['icon_url'] = img.file.url
        representation['icon_srcset'] = img.get_rendition('width-128').url
    return representation

Comparison of Custom vs Standard Blocks

Custom blocks pay off already by the second project due to reuse. They reduce content errors by 60% and cut acceptance testing time in half. Compared to column-based editors, custom blocks provide 3 times more control over structure.

Process and What's Included

1. Requirements analysis—collect layouts and content plan.
2. Design—determine field types and validation.
3. Implementation—write block classes and templates (BEM, responsive).
4. Testing—check saving, rendering, responsiveness.
5. Deployment—push to staging and production.

As a result, you receive from 1 to 12 ready-made blocks with documentation. We also conduct editor training. All blocks come with a 12-month warranty. Contact us for a precise estimate—we'll prepare a proposal for your project.

Estimated Timelines

Development of a set of 8–12 blocks for a corporate website—3–5 working days. Complex cases are discussed separately. Order custom block development today and get a consultation from one of our leading engineers.

Typical Mistakes and How to Avoid Them

We guarantee that after our development you won't face these issues.

Headless CMS: Strapi, Directus, Sanity, Contentful, Drupal

Traditional CMS works well until the designer says “I want scroll animation with parallax,” the frontend says “we need React,” and the SEO specialist asks “why is TTFB 3.4 seconds?” At that point, monolithic architecture starts to hinder everyone. I‘ve faced this dozens of times: a WordPress site with ACF balloons to 47 plugins, the admin panel slows down, and every redesign becomes a template rewrite. Headless CMS separates content management from presentation. Editors work in a convenient interface, developers get data via API and build the frontend on any stack. Sounds simple. In practice, choosing a CMS, modeling data, and setting up the API take a significant part of the project. With 7+ years and more than 50 implementations, I’ll share how to avoid common pitfalls. Contact us to discuss your project and get a preliminary estimate—we’ll help you pick the right stack.

What are the key benefits of headless CMS over monolithic?

Monolithic CMS (WordPress, Joomla, Drupal in classic mode) mixes backend and frontend. Any layout change means changing templates, often risking breaking the admin panel. Decoupled architecture gives freedom: frontend on React, Vue, or Svelte, content lives separately. Result: improved load speed (LCP often drops from 4–6 s to 1–1.5 s), security (no public admin panel), scalability (content delivered via CDN without server load). Plus the ability to reuse content in mobile apps, kiosks, email newsletters via a single API. A client we recently helped saw LCP improve from 6.2 s to 1.1 s — a 5.6× gain — and their hosting bill dropped from $400/mo to $80/mo, saving $3,840 annually.

How to choose a headless CMS for your project?

No universal tool exists. The choice depends on team, content complexity, and infrastructure. Let’s break down the key options.

Strapi — open-source, self-hosted, Node.js. Suitable for teams needing data control and API customization. Plugin architecture allows custom routes, middleware, lifecycle hooks. REST and GraphQL out of the box. Deploys in about an hour — three times faster than Drupal. Weakness: versions v4 and v5 are incompatible, migration is painful. Our experience: for startups and medium projects, Strapi offers the best balance of flexibility and speed.

Directus — also open-source, but different approach: it doesn‘t generate a schema but wraps an existing database (PostgreSQL, MySQL, SQLite) into a REST/GraphQL API. If you already have a database, Directus connects without migrations. Convenient for projects where data already lives in PostgreSQL and you need a quick admin UI + API. Saves up to 30% integration time.

Sanity — cloud CMS with real-time editor. Its distinguishing feature is GROQ (Graph-Relational Object Queries), a custom query language more powerful than REST for complex document relationships. Portable Text for structured content. Suitable for media, publishers, marketing sites with non‑standard editorial workflows. Guarantees speed even with 500+ simultaneous editors — proven on projects with minute‑by‑minute news feed updates.

Contentful — enterprise cloud CMS. Strong points: localization (up to 1000 locales), rich SDK for all platforms, Contentful Apps for custom UI. Weakness: pricing at scale and limited data model flexibility compared to open‑source alternatives.

Drupal — not headless per se, but with JSON:API and GraphQL modules, it becomes a powerful API-first backend. Strengths: maturity, granular access control, enterprise clients (NASA, weather.com). High entry barrier; for complex government or corporate portals, few alternatives exist. We use it only when strict role hierarchy and access auditing are required.

Consequences of poor content modeling

Content modeling is critical. Mistakes at this stage are costly. A typical problem: a body field of type rich text for everything. Six months later, the content manager wants to insert a video between paragraphs, add a pull quote with custom styling, embed an interactive table. Rich text can‘t handle that. Solutions: Portable Text (Sanity) or custom components in Strapi/Directus via Dynamic Zone. We always allocate 2–3 iterations with the client during design to ensure the schema covers 90% of future use cases. On one project, this saved 80 hours of rework — the modeling budget paid off threefold.

How we build projects on headless CMS

Frontend for headless CMS almost always uses Next.js (App Router) or Nuxt. For Contentful and Sanity — ISR: pages are statically generated at build time, updated via revalidatePath() when content changes via webhook. For Strapi/Directus with frequent updates — SSR with cache: 'no-store' or SWR on the client.

Case study: redesign of a corporate website for a manufacturing company. Previous site: WordPress with ACF, 200+ pages, 4 languages. Problems: TTFB 3.8 s, editors complained about slow admin. Migrated to Strapi (self-hosted, PostgreSQL), Next.js App Router. Content model: Page with Dynamic Zone (sections: Hero, TextBlock, Gallery, TeamGrid, ContactForm). Localization via Strapi i18n plugin + next-intl on frontend. Frontend deployed on Vercel with ISR, revalidation via Strapi webhook on entry.publish. According to the client: TTFB dropped from 3.8 s to 180 ms (static with CDN) — a 21× improvement. Editors got a clean interface without 47 plugins. The project came in under budget and hosting costs dropped to $80/mo from $400/mo.

Implementation process broken into stages:

1. Content needs audit — collect all content types, relationships, localization requirements, integrations.
2. Data schema design — create models, fields, validation, access roles. Document in Swagger/OpenAPI.
3. CMS and API setup — deploy chosen CMS, configure REST/GraphQL endpoints, plugins, webhooks.
4. Frontend development — connect Next.js/Nuxt, configure ISR/SSR, section components, routing.
5. Content migration (if legacy) — automated loading via API or scripts.
6. Testing — check API endpoints, regression, load testing, Core Web Vitals.
7. Deployment — configure CDN, SSL, CI/CD, monitoring.

How long does implementation take?

The standard path includes all stages. Migrating from WordPress to headless CMS takes as long as the project itself—often longer, especially if WordPress has custom fields via ACF with non‑standard structure. Our typical timelines:

Cost is calculated individually after a brief. Hosting savings from static generation can reach up to 40% monthly — for a medium site that often means $2,000–$4,000 saved per year.

Non‑obvious considerations when choosing a headless CMS

• Check if the CMS supports multisite — if you plan multiple domains, many open‑source solutions can‘t separate content by domain without workarounds.
• Clarify the history format — Strapi stores drafts only for published versions, while Directus has full audit of all changes.
• Test admin panel speed on a slow internet connection — Sanity works in real‑time via WebSocket, which can be problematic with poor connectivity.
• Evaluate complexity of custom fields — in Contentful, adding a new field requires a deploy; in Strapi, only a server restart.
• Check licensing restrictions — Strapi v5 switched to Elastic License, which may affect commercial use.

What is included

• Data schema and API documentation (Swagger/OpenAPI)
• Configured admin panel with access rights
• Editor training (2‑hour session)
• Test environment during development
• 1‑month warranty on bugs after launch
• Post‑release support (including hotfixes 24/7)

Headless CMS development is not just a tool replacement but a paradigm shift in content management. We help make this transition without downtime or data loss. Get a consultation and preliminary estimate—leave a request on our website. Order headless CMS implementation with guaranteed results.