post-needs-content-upgrade-hook.md

post_needs_content_upgrade_hook

This hook wraps a standard Misago function used to check if post content needs an upgrade.

If True is returned, a Celery task will be scheduled to upgrade the post content.

Location

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

from misago.posting.hooks import post_needs_content_upgrade_hook

Filter

def custom_post_needs_content_upgrade_filter(
    action: PostNeedsContentUpgradeHookAction, post: Post
) -> bool:
    ...

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

Arguments

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

See the action section for details.

post: Post

The Post instance to update.

Return value

Returns bool with True if post content needs upgrade.

Action

def post_needs_content_upgrade_action(post: Post) -> bool:
    ...

Misago function used to check if post content needs an upgrade.

Arguments

post: Post

The Post instance to check.

Return value

Returns bool with True if post content needs upgrade.

Example

The code below implements a custom filter function that returns True if the post contains HTML markup that requires an upgrade.

from misago.posting.hooks import post_needs_content_upgrade_hook
from misago.threads.models import Post


@post_needs_content_upgrade_hook.append_filter
def post_needs_plugin_content_upgrade(action, post: Post) -> bool:
    if "<plugin-html" in post.parsed:
        return True

    return action(post)