Extending Wagtail

The Wagtail admin interface is a suite of Django apps, and so the familiar concepts from Django development - views, templates, URL routes and so on - can be used to add new functionality to Wagtail. Numerous third-party packages can be installed to extend Wagtail’s capabilities.

This section describes the various mechanisms that can be used to integrate your own code into Wagtail’s admin interface.

• Creating admin views
  • Defining a view
  • Registering a URL route
  • Adding a template
  • Adding a menu item
  • Adding a group of menu items
• Generic views
  • ModelViewSet
  • ChooserViewSet
  • Chooser viewsets for non-model datasources
• Template components
  • render_html()
  • media
  • Creating components
  • Passing context to the template
  • Adding media definitions
  • Using components on your own templates
• Using forms in admin views
  • Defining admin form widgets
  • Panels
• Adding reports
  • Defining your report
  • Spreadsheet exports
  • Customising templates
  • Adding a menu item and admin URL
  • The full code
• Adding new Task types
  • Task models
  • Custom TaskState models
  • Customising behaviour
  • Adding notifications
• Audit log
  • log()
  • Log actions provided by Wagtail
  • Log context
  • Log models
• Customising the user account settings form
  • Adding new panels
  • Operating on the UserProfile model
  • Creating new tabs
  • Customising the template
• Customising group edit/create views
  • Custom edit/create forms
• Rich text internals
  • Data format
  • The feature registry
  • Rewrite handlers
  • Editor widgets
  • Editor plugins
  • Format converters
• Extending the Draftail Editor
  • Creating new inline styles
  • Creating new blocks
  • Creating new entities
  • Integration of the Draftail widgets
• Adding custom bulk actions
  • Registering a custom bulk action
  • Adding bulk actions to the page explorer
  • Adding bulk actions to the Images listing
  • Adding bulk actions to the documents listing
  • Adding bulk actions to the user listing
  • Adding bulk actions to the snippets listing