get-private-thread-post-edit-state-hook.md

get_private_thread_post_edit_state_hook

This hook wraps the standard function Misago uses to create a new EditPrivateThreadPostState instance for editing a private thread post.

Location

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

from misago.posting.hooks import get_private_thread_post_edit_state_hook

Filter

def custom_get_private_thread_post_edit_state_filter(
    action: GetEditPrivateThreadPostStateHookAction,
    request: HttpRequest,
    post: Post,
) -> 'EditPrivateThreadPostState':
    ...

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

Arguments

action: GetEditPrivateThreadPostStateHookAction

The next function registered in this hook, either a custom function or Misago's default.

See the action section for details.

request: HttpRequest

The request object.

post: Post

The Post instance.

Return value

A EditPrivateThreadPostState instance to use to edit a post in a private thread in the database.

Action

def get_private_thread_post_edit_state_action(request: HttpRequest, post: Post) -> 'EditPrivateThreadPostState':
    ...

A standard function that Misago uses to create a new EditPrivateThreadPostState instance for editing a private thread post.

Arguments

request: HttpRequest

The request object.

post: Post

The Post instance.

Return value

A EditPrivateThreadPostState instance to use to edit a post in a private thread in the database.

Example

The code below implements a custom filter function that stores the user's IP in the state.

from django.http import HttpRequest
from misago.posting.hooks import get_private_thread_post_edit_state_hook
from misago.posting.state import EditPrivateThreadPostState
from misago.threads.models import Post


@get_private_thread_post_edit_state_hook.append_filter
def set_poster_ip_on_edit_private_thread_post_state(
    action, request: HttpRequest, post: Post
) -> EditPrivateThreadPostState:
    state = action(request, post)
    state.plugin_state["user_id"] = request.user_ip
    return state