categories.md

Categories

• Categories
  • Configuration
  • Example Category model
  • Example Page model

The package can handle the import of categories. Categories are imported as a ManyToMany relationship on a Page model.

Configuration

It is disabled by default but you can enable the plugin by adding the following to your settings file.

WAGTAIL_WORDPRESS_IMPORT_CATEGORY_PLUGIN_ENABLED = True

The plugin will also need to know which model in you app is used for the categories so add the following to your settings file.

WAGTAIL_WORDPRESS_IMPORT_CATEGORY_PLUGIN_MODEL = "pages.models.Category"

Name field minimum length: Some WordPress sites can have categories just a single character in length. If these are not useful, they can be skipped using this setting.

You can alter the minimum length to suit your needs by adding the following to your settings file.

WAGTAIL_WORDPRESS_IMPORT_CATEGORY_PLUGIN_MIN_NAME_LENGTH = 3  # for example

The example here uses a Category model inside the pages app but you can use any name for the model.

Example Category model

# The imports below assume you are using Wagtail v3.0+

from wagtail.snippets import register_snippet

# Wagtail < 3.0
# from wagtail.admin.edit_handlers import FieldPanel
from wagtail.admin.panels import FieldPanel


@register_snippet
class Category(models.Model):
    name = models.CharField(max_length=255)

    panels = [FieldPanel("name")]

    def __str__(self):
        return self.name

    class Meta:
        verbose_name = "category"
        verbose_name_plural = "categories"

@register_snippet is used here but you could use the Wagtail Model Admin if you prefer. The name field is required.

Example Page model

To link the categories to your Page model you need to use the ParentalManyToManyField in your Page model. The wagtail docs has a good example of it implementation.

# The imports below assume you are using Wagtail v3.0+

from modelcluster.fields import ParentalManyToManyField

# Wagtail < 3.0
# from wagtail.admin.edit_handlers import FieldPanel
from wagtail.admin.panels import FieldPanel


class MyPage(Page):
    categories = ParentalManyToManyField(Category, blank=True)
    # ... your own extra fields can also be included.

    content_panels = Page.content_panels + [
        FieldPanel("categories", widget=forms.CheckboxSelectMultiple),
    ]

The above example uses the CheckboxSelectMultiple forms widget which simplifies selecting multiple categories.

You will need to run python manage.py makemigrations && python manage.py migrate to updated the database.