close-thread-poll-hook.md

close_thread_poll_hook

This hook allows plugins to replace or extend the standard logic for closing a thread poll.

Location

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

from misago.polls.hooks import close_thread_poll_hook

Filter

def custom_close_thread_poll_filter(
    action: CloseThreadPollHookAction,
    thread: Thread,
    poll: Poll,
    user: 'User',
    request: HttpRequest | None,
) -> ThreadUpdate | None:
    ...

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

Arguments

action: CloseThreadPollHookAction

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

See the action section for details.

thread: Thread

The thread to which the poll belongs.

poll: Poll

The poll to close.

user: User

The user who closed the poll, recorded as the actor of the thread update.

request: HttpRequest | None

The request object, or None if not provided.

Return value

A ThreadUpdate instance if the poll was closed, None if it wasn't.

Action

def close_thread_poll_action(
    thread: Thread, poll: Poll, user: 'User', request: HttpRequest | None
) -> ThreadUpdate | None:
    ...

Misago function that closes a thread's poll, updates the thread instance, and creates a new thread update object.

Arguments

thread: Thread

The thread to which the poll belongs.

poll: Poll

The poll to close.

user: User

The user who closed the poll, recorded as the actor of the thread update.

request: HttpRequest | None

The request object, or None if not provided.

Return value

A ThreadUpdate instance if the poll was closed, None if it wasn't.

Example

This plugin automatically hides newly created thread update.

from django.http import HttpRequest
from misago.polls.hooks import close_thread_poll_hook
from misago.polls.models import Poll
from misago.threads.models import Thread
from misago.threadupdates.hide import hide_thread_update
from misago.threadupdates.models import ThreadUpdate
from misago.users.models import User

@close_thread_poll_hook.append_filter
def hide_closed_poll_update(
    action,
    thread: Thread,
    poll: Poll,
    user: User,
    request: HttpRequest | None,
) -> ThreadUpdate | None:
    thread_update = action(thread, poll, user, request)

    if thread_update:
        hide_thread_update(thread_update, request)

    return thread_update