Name: Wagtail: both way relation between models
Rating: 3.1 (1726 reviews)
Author: ordigital

Wagtail: both way relation between models

Adam Mateusz Brożyński - Dec 1 '23 -

- Dev Community

This example uses wagtail-autocomplete panel (follow install notes there) and works with Wagtail 5.2.1 (latest stable).

Create a relation model:

from django.db import models
from modelcluster.fields import ParentalKey

class NewsPageCalendarPageRelation(models.Model):
    news = ParentalKey('pages.NewsPage', on_delete=models.CASCADE, related_name='news')
    calendar = ParentalKey('pages.CalendarPage', on_delete=models.CASCADE, related_name='calendar')

    # This ensures that relations are not doubled
    class Meta:
        unique_together = ('news', 'calendar')

And now two models using this relation:

from wagtailautocomplete.edit_handlers import AutocompletePanel
from modelcluster.fields import ParentalManyToManyField

class CalendarPage(Page):
    news = ParentalManyToManyField(
        'pages.NewsPage', 
        through=NewsPageCalendarPageRelation,
        blank=True,
        )

    # ...

    content_panels = [
    # ...
        AutocompletePanel('news', target_model='pages.CalendarPage'),
    ]

from wagtailautocomplete.edit_handlers import AutocompletePanel
from modelcluster.fields import ParentalManyToManyField

class NewsPage(Page):
    calendar = ParentalManyToManyField(
        'pages.CalendarPage', 
        through=NewsPageCalendarPageRelation,
        blank=True,
        )

    # ...

    content_panels = [
    # ...        
        AutocompletePanel('calendar',target_model='pages.NewsPage'),
    ]