Creating custom views

This page describes how to provide a custom view from within your plugin. Before you start reading this page, please read and understand how URL handling works in pretalx.

Organiser panel views

If you want to add a custom view to the organiser area of an event, register an URL in your that lives in the /orga/ subpath:

 1from django.urls import re_path
 3from pretalx.event.models.event import SLUG_REGEX
 5from . import views
 7urlpatterns = [
 8    re_path(
 9        rf"^orga/event/(?P<event>{SLUG_REGEX})/p/myplugin/$",
10        views.admin_view,
11        name="backend",
12    ),
13    re_path(
14        rf"^(?P<event>{SLUG_REGEX})/p/myplugin/$",
15        views.frontend_view,
16        name="frontend",
17    ),
18    re_path(
19        rf"^p/myplugin/$",
20        views.global_view,
21        name="global-frontend",
22    ),

If you just created your file and you already had the dev-server running, you’ll now have to restart it for the new file to be recognized.

If your view is event-specific, you have to name one parameter in your URL event. By convention, all plugin URLs except for backend URLs start with a /p/ to avoid namespace collisions with event names and reserved URLs.

You can then write a regular view. Our middleware will automatically detect the /orga/ subpath and will ensure the following points if this is an URL with the event parameter:

  • The user has logged in

  • The request.event attribute contains the current event

  • The user has permission to view the current event

If you want to require specific permission types, we provide you with a decorator or a mixin for your views:

from pretalx.common.mixins.views import PermissionRequired

class AdminView(PermissionRequired, View):
    permission_required = "orga.view_submissions"

There is also a signal that allows you to add the view to the event sidebar navigation like this:

 1from django.dispatch import receiver
 2from django.urls import resolve, reverse
 3from django.utils.translation import ugettext_lazy as _
 5from pretalx.orga.signals import nav_event
 8@receiver(nav_event, dispatch_uid="friends_tickets_nav")
 9def navbar_info(sender, request, **kwargs):
10    url = resolve(request.path_info)
11    if not request.user.has_perm("orga.view_orga_area", request.event):
12        return []
13    return [{
14        "label": _("My plugin view"),
15        "icon": "heart",
16        "url": reverse("plugins:myplugin:index", kwargs={
17            "event": request.event.slug,
18        }),
19        "active": url.namespace == "plugins:myplugin" and url.url_name == "view",
20    }]

Frontend views

Frontend views work pretty much like organiser area views. Take care that your URL starts with fr"^(?P<event>[{SLUG_REGEX}]+)/p/mypluginname" for event related urls or f"^p/mypluginname" for global views. You can then write a regular view. It will be automatically ensured that:

  • The requested event exists

  • The requested event is visible (either by being public, or if an organiser looks at it)

  • The request involves the correct domain for the event

  • The request.event attribute contains the correct Event object

  • The organiser has enabled the plugin

  • The locale middleware has processed the request