get-private-thread-list-context-data-hook.md

get_private_thread_list_context_data_hook

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

Location

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

from misago.privatethreads.hooks import get_private_thread_list_context_data_hook

Filter

def custom_get_private_thread_list_context_data_filter(
    action: GetPrivateThreadListContextDataHookAction,
    request: HttpRequest,
    kwargs: dict,
) -> dict:
    ...

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

Arguments

action: GetPrivateThreadListContextDataHookAction

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.

kwargs: dict

A Python dict with view's keyword arguments.

Return value

A Python dict with context data to use to render the private threads page.

Action

def get_private_thread_list_context_data_action(request: HttpRequest, kwargs: dict) -> dict:
    ...

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

Arguments

request: HttpRequest

The request object.

kwargs: dict

A Python dict with view's keyword arguments.

Return value

A Python dict with context data to use to render the private threads page.

Example

The code below implements a custom filter function that adds extra values to the template context data:

from django.http import HttpRequest
from misago.privatethreads.hooks import get_private_thread_list_context_data_hook


@get_private_thread_list_context_data_hook.append_filter
def include_custom_context(action, request: HttpRequest, : dict) -> dict:
    context = action(request, kwargs)

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

    return context