replace-rich-text-tokens-hook.md

replace_rich_text_tokens_hook

This hook wraps the standard function that Misago uses to replace rich-text tokens in pre-rendered HTML or the next filter from another plugin.

Tokens are pseudo-HTML elements like <misago-attachment=".."> that are replaced with real HTML markup instead.

Location

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

from misago.parser.hooks import replace_rich_text_tokens_hook

Filter

def custom_replace_rich_text_tokens_filter(
    action: ReplaceRichTextTokensHookAction,
    html: str,
    context: Context,
    data: dict,
    thread: Thread | None,
) -> str:
    ...

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

Arguments

action: ReplaceRichTextTokensHookAction

Misago function used to replace rich-text tokens in pre-rendered HTML or the next filter from another plugin.

See the action section for details.

html: str

An HTML string in which tokens will be replaced.

context: Context

Current template context.

data: dict

Data that can be embedded in HTML.

thread: Thread | None

Current Thread instance of None.

Return value

A str with HTML that has its tokens replaced.

Action

def replace_rich_text_tokens_action(
    html: str, context: Context, data: dict, thread: Thread | None
) -> str:
    ...

Misago function used to replace rich-text tokens in pre-rendered HTML or the next filter from another plugin.

Arguments

html: str

An HTML string in which tokens will be replaced.

context: Context

Current template context.

data: dict

Data that can be embedded in HTML.

thread: Thread | None

Current Thread instance of None.

Return value

A str with HTML that has its tokens replaced.

Example

The code below implements a custom filter function that replaces <you> pseudo-HTML element with current user's username.

from django.template import Context
from misago.parser.hooks import replace_rich_text_tokens_hook


@replace_rich_text_tokens_hook.append_filter
def replace_rich_text_user_name(
    action,
    html: str,
    context: Context,
    data: dict,
    thread: Thread | None,
) -> str:
    if "<you>" in html:
        username = user.username if user and user.is_authenticated else "Guest"
        html = html.replace("<you>", username)

    # Call the next function in chain
    return action(html, context, data, thread)