get-private-thread-detail-view-context-data-hook.md

get_private_thread_detail_view_context_data_hook

This hook wraps the standard function that Misago uses to get the template context data for the private thread detail view.

Location

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

from misago.privatethreads.hooks import get_private_thread_detail_view_context_data_hook

Filter

def custom_get_private_thread_detail_view_context_data_filter(
    action: GetPrivateThreadDetailViewContextDataHookAction,
    request: HttpRequest,
    thread: Thread,
    page: int | None=None,
) -> dict:
    ...

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

Arguments

action: GetPrivateThreadDetailViewContextDataHookAction

Next function registered in this hook, either a custom function or Misago's standard one.

See the action section for details.

request: HttpRequest

The request object.

thread: Thread

A Thread instance.

page: int | None = None

An int with page number or None.

Return value

A Python dict with context data to use to render the private thread detail view.

Action

def get_private_thread_detail_view_context_data_action(
    request: HttpRequest, thread: Thread, page: int | None=None
) -> dict:
    ...

Misago function used to get the template context data for the private thread detail view.

Arguments

request: HttpRequest

The request object.

thread: Thread

A Thread instance.

page: int | None = None

An int with page number or None.

Return value

A Python dict with context data to use to render the private thread detail view.

Example

The code below implements a custom filter function that adds custom context data to the thread detail view:

from django.http import HttpRequest
from misago.privatethreads.hooks import get_private_thread_detail_view_context_data_hook
from misago.threads.models import Thread


@get_private_thread_detail_view_context_data_hook.append_filter
def include_custom_context(
    action,
    request: HttpRequest,
    thread: dict,
    page: int | None = None,
) -> dict:
    context = action(request, thread, page)

    context["plugin_data"] = "..."

    return context