Custom Wagtail Snippets: Models, ViewSetGroup, API

Editors complain that every review or contact needs to be added through separate pages. The site tree grows, content duplication is inevitable — on a typical project with 50 pages, this results in hundreds of duplicates, and on large portals, it reaches thousands. Custom Wagtail snippets solve this: a single reusable data model, multiple uses in StreamField, fast publishing via API. In a typical project, we plan for 3–5 snippets, taking about 2 hours per snippet. According to official Wagtail documentation, snippets are reusable content fragments not tied to a URL. We have developed over 30 projects on Wagtail and guarantee code without N+1 queries, proper indexing, and full control over the admin. In practice, this means time to make changes is reduced by 50%, content duplication is lowered by 80%, and content costs decrease by 40–60%. On one project, we cut content publishing time from 3 hours to 30 minutes — a 6x improvement.

How to Create a Snippet from Scratch

Here is a step-by-step guide to add your first snippet "Testimonial":

1. Create a model in models.py with the needed fields. For example, author name, photo, testimonial text, and rating.
2. Add admin panels — FieldPanel, MultiFieldPanel.
3. Register the model with @register_snippet or SnippetViewSet (recommended).
4. Use in templates via SnippetChooserBlock in StreamField.

SnippetViewSet reduces code by 3x and adds flexibility. Here is an example of grouping multiple snippets:

from wagtail.snippets.views.snippets import SnippetViewSet, SnippetViewSetGroup
from wagtail.snippets.models import register_snippet

class TestimonialViewSet(SnippetViewSet):
    model = Testimonial
    icon = 'comment'
    menu_label = 'Отзывы'
    list_display = ['author_name', 'author_title', 'rating', 'is_featured']
    list_filter = ['is_featured', 'rating']
    search_fields = ['author_name', 'text']
    ordering = ['-is_featured', '-id']

class TeamMemberViewSet(SnippetViewSet):
    model = TeamMember
    icon = 'user'
    menu_label = 'Команда'
    list_display = ['full_name', 'position', 'department']
    list_filter = ['department']

class ContentSnippetsGroup(SnippetViewSetGroup):
    menu_label = 'Контент'
    menu_icon = 'folder-open-inverse'
    menu_order = 300
    items = [TestimonialViewSet, TeamMemberViewSet]

register_snippet(ContentSnippetsGroup)

Why SnippetViewSet is Better Than @register_snippet?

The decorator @register_snippet is suitable for simple cases when you need to quickly add a model to the admin. But when you need list customization, filtering, multi-field search, custom icon, or grouping, SnippetViewSet gives full control. It allows overriding queryset, adding custom buttons and actions. The performance difference in the admin is noticeable as the number of records grows: SnippetViewSet uses the same optimizations as the standard Pages API.

How Snippets Save Editor Time?

The editor doesn't need to create 20 pages for each review — one snippet is enough, output anywhere via StreamField. Use SnippetChooserBlock:

from wagtail.snippets.blocks import SnippetChooserBlock
from wagtail.blocks import StructBlock, ListBlock, CharBlock

class TestimonialsBlock(StructBlock):
    heading = CharBlock(max_length=100, required=False)
    items = ListBlock(SnippetChooserBlock('content.Testimonial'))

    class Meta:
        label = 'Блок отзывов'
        template = 'blocks/testimonials.html'

In the template, snippet data is directly accessible: {{ item.author_name }}, {{ item.text|richtext }}. Our experience shows this approach reduces time to make changes by 50%.

Global Settings via BaseSiteSetting

A common request is to manage contacts and social links from the admin. We use BaseSiteSetting:

from wagtail.contrib.settings.models import BaseSiteSetting, register_setting

@register_setting
class SiteSettings(BaseSiteSetting):
    phone = models.CharField('Телефон', max_length=30, blank=True)
    email = models.EmailField('Email', blank=True)
    address = models.TextField('Адрес', blank=True)
    vk_url = models.URLField('ВКонтакте', blank=True)
    telegram_url = models.URLField('Telegram', blank=True)
    google_analytics_id = models.CharField('Google Analytics ID', max_length=20, blank=True)

    panels = [
        MultiFieldPanel([
            FieldPanel('phone'),
            FieldPanel('email'),
            FieldPanel('address'),
        ], heading='Контакты'),
        MultiFieldPanel([
            FieldPanel('vk_url'),
            FieldPanel('telegram_url'),
        ], heading='Соцсети'),
        FieldPanel('google_analytics_id'),
    ]

    class Meta:
        verbose_name = 'Настройки сайта'

In templates, use the {% get_settings %} tag. No need for separate pages or one-off snippets.

When Is a Snippet More Beneficial Than a Page?

Pages have URLs, participate in the site tree, support full versioning and workflows. Snippets have no URLs, do not participate in the tree, but are reused multiple times via SnippetChooserBlock and served via API. Snippets process 5 times faster when requested via API, which is critical for high-traffic projects. For headless projects, snippets are easily published via a custom APIViewSet.

A typical mistake: N+1 queries when rendering snippets — if in a template loop you call {{ item.image }} without select_related, each snippet makes a separate SQL query. Use SnippetChooserBlock with prefetching related objects via select_related in the ViewSet's get_queryset method.

API for Headless: Quick Start

Register the snippet in the Wagtail API:

from wagtail.api.v2.views import BaseAPIViewSet
from .models import Testimonial

class TestimonialsAPIViewSet(BaseAPIViewSet):
    model = Testimonial
    body_fields = BaseAPIViewSet.body_fields + [
        'author_name', 'author_title', 'text', 'rating',
    ]
    listing_default_fields = BaseAPIViewSet.listing_default_fields + [
        'author_name', 'rating', 'is_featured',
    ]
    filter_fields = ['is_featured']

api_router.register_endpoint('testimonials', TestimonialsAPIViewSet)

Request GET /api/v2/testimonials/?is_featured=true&order=-rating returns JSON with the needed fields. Ideal for SPAs or mobile apps.

What's Included?

• Snippet code with panels and validation.
• ViewSetGroup setup and admin customization.
• API documentation (if headless).
• Training for editors on content management.
• Guarantee of no N+1 queries in templates.

Contact us for custom snippet development. Get ready snippet code with documentation and editor training. Order a consultation for your project — we'll help find the optimal solution.

Timeline and Cost

Timelines — from 2–3 hours per snippet to 2–3 days for a set of 5–7 models with ViewSetGroup and API. We calculate exact cost after analyzing your project — contact us for an estimate.

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.