hide-thread-update-hook.md

hide_thread_update_hook

This hook wraps a standard Misago function used to hide a ThreadUpdate object.

Location

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

from misago.threadupdates.hooks import hide_thread_update_hook

Filter

def custom_hide_thread_update_filter(
    action: HideThreadUpdateHookAction,
    thread_update: 'ThreadUpdate',
    request: HttpRequest | None=None,
) -> bool:
    ...

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

Arguments

action: HideThreadUpdateHookAction

Misago function used to hide a ThreadUpdate object.

thread_update: ThreadUpdate

A ThreadUpdate instance to hide.

request: HttpRequest | None = None

The request object or None if not available.

Return value

True if the thread update was hidden, False otherwise.

Action

def hide_thread_update_action(
    thread_update: 'ThreadUpdate', request: HttpRequest | None=None
) -> bool:
    ...

Misago function used to hide a ThreadUpdate object.

Arguments

thread_update: ThreadUpdate

A ThreadUpdate instance to hide.

request: HttpRequest | None = None

The request object or None if not available.

Return value

True if the thread update was hidden, False otherwise.

Example

The code below implements a custom filter function that stores the client's IP address when a thread update is hidden:

from django.http import HttpRequest
from misago.threads.hooks import hide_thread_update_hook
from misago.threads.models import ThreadUpdate


@hide_thread_update_hook.append_filter
def save_client_ip_on_thread_update_hide(
    action,
    thread_update: ThreadUpdate,
    request: HttpRequest | None = None,
) -> bool:
    if not request:
        return action(thread_update)

    thread_update.plugin_data["last_ip"] = request.client_ip

    return action(thread_update, request)