get-private-thread-post-edits-view-context-data-hook.md

get_private_thread_post_edits_view_context_data_hook

This hook wraps a standard Misago function used to get the template context data for the private thread post edits page.

Location

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

from misago.edits.hooks import get_private_thread_post_edits_view_context_data_hook

Filter

def custom_get_private_thread_post_edits_view_context_data_filter(
    action: GetPrivateThreadPostEditsViewContextDataHookAction,
    request: HttpRequest,
    post: Post,
    page: Page,
) -> dict:
    ...

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

Arguments

action: GetPrivateThreadPostEditsViewContextDataHookAction

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.

post: Post

A Post instance whose edits are being displayed.

page: Page

A Page instance that may or may not include a PostEdit instance in its object_list attribute.

Returns

A Python dict with context data to use to render the post edits page.

Action

def get_private_thread_post_edits_view_context_data_action(request: HttpRequest, post: Post, page: Page) -> dict:
    ...

Misago function used to get the template context data for the private thread post edits page.

Arguments

request: HttpRequest

The request object.

post: Post

A Post instance whose edits are being displayed.

page: Page

A Page instance that may or may not include a PostEdit instance in its object_list attribute.

Returns

A Python dict with context data to use to render the post edits page.

Example

The code below implements a custom filter function that displays a template with the editor's IP address in the post_edit_diff_plugins_top plugin outlet.

from django.core.paginator import Page
from django.http import HttpRequest
from misago.edits.hooks import get_private_thread_post_edits_view_context_data_hook
from misago.edits.models import PostEdit
from misago.threads.models import Post

@get_private_thread_post_edits_view_context_data_hook.append_filter
def set_thread_post_edits_view_editor_ip_address(
    action,
    request: HttpRequest,
    post: Post,
    page: Page,
) -> dict:
    context = action(request, post, page)

    if not page.object_list:
        return context

    post_edit = page.object_list[0]
    context["post_edit_diff_plugins_top"].append({
        "template_name": "my_plugin/post_edit_diff.html",
        "user_ip": post_edit.plugin_data.get("user_ip"),
    })

    return context