get-private-thread-start-formset-hook.md

get_private_thread_start_formset_hook

This hook wraps the standard function that Misago uses to create a new PrivateThreadStartFormset instance with forms for starting a new private thread.

Location

This hook can be imported from misago.posting.hooks:

from misago.posting.hooks import get_private_thread_start_formset_hook

Filter

def custom_get_private_thread_start_formset_filter(
    action: GetPrivateThreadStartFormsetHookAction,
    request: HttpRequest,
    category: Category,
) -> 'PrivateThreadStartFormset':
    ...

A function implemented by a plugin that can be registered in this hook.

Arguments

action: GetPrivateThreadStartFormsetHookAction

The next function registered in this hook, either a custom function or Misago's default.

See the action section for details.

request: HttpRequest

The request object.

category: Category

The Category instance.

Return value

A PrivateThreadStartFormset instance with forms for posting a new private thread.

Action

def get_private_thread_start_formset_action(request: HttpRequest, category: Category) -> 'PrivateThreadStartFormset':
    ...

A standard function that Misago uses to create a new PrivateThreadStartFormset instance with forms for starting a new private thread.

Arguments

request: HttpRequest

The request object.

category: Category

The Category instance.

Return value

A PrivateThreadStartFormset instance with forms for posting a new private thread.

Example

The code below implements a custom filter function that adds custom form to the start new private thread formset:

from django.http import HttpRequest
from misago.categories.models import Category
from misago.posting.formsets import PrivateThreadStartFormset
from misago.posting.hooks import get_private_thread_start_formset_hook

from .forms import SelectUserForm


@get_private_thread_start_formset_hook.append_filter
def add_select_user_form(
    action, request: HttpRequest, category: Category
) -> PrivateThreadStartFormset:
    formset = action(request, category)

    if request.method == "POST":
        form = SelectUserForm(request.POST, prefix="select-user")
    else:
        form = SelectUserForm(prefix="select-user")

    formset.add_form(form, before="posting=title")
    return formset