get-threads-page-threads-hook.md

get_threads_page_threads_hook

This hook wraps the standard function that Misago uses to get complete threads data for the threads page.

Location

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

from misago.threads.hooks import get_threads_page_threads_hook

Filter

def custom_get_threads_page_threads_filter(
    action: GetThreadsPageThreadsHookAction,
    request: HttpRequest,
    kwargs: dict,
) -> dict:
    ...

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

Arguments

action: GetThreadsPageThreadsHookAction

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 dict with kwargs this view was called with.

Return value

A dict with the template context.

Action

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

Misago function used to get the complete threads data for the threads page. Returns a dict that is included in the template context under the threads key.

Arguments

request: HttpRequest

The request object.

kwargs: dict

A dict with kwargs this view was called with.

Return value

A dict with the template context.

Example

The code below implements a custom filter function makes view use a different threads list template instead of the default one.

from django.http import HttpRequest
from misago.threads.hooks import get_threads_page_threads_hook


@get_threads_page_threads_hook.append_filter
def replace_threads_list_template(
    action, request: HttpRequest, kwargs: dict
) -> dict:
    data = action(request, kwargs)
    data["template_name"] = "plugin/threads_list.html"
    return data