Skip to content

Hooks tags

hypha.core.templatetags.hooks_tags

register module-attribute 

register = Library()

hook_tag 

hook_tag(context, name, *args, **kwargs)

Hook tag to call within templates

:param dict context: This is automatically passed,\ contains the template state/variables :param str name: The hook which will be dispatched :param *args: Positional arguments, will be passed to hook callbacks :param **kwargs: Keyword arguments, will be passed to hook callbacks :return: A concatenation of all callbacks\ responses marked as safe (conditionally) :rtype: str

Source code in hypha/core/templatetags/hooks_tags.py 
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
@register.simple_tag(name="hook", takes_context=True)
def hook_tag(context, name, *args, **kwargs):
    r"""
    Hook tag to call within templates

    :param dict context: This is automatically passed,\
    contains the template state/variables
    :param str name: The hook which will be dispatched
    :param \*args: Positional arguments, will be passed to hook callbacks
    :param \*\*kwargs: Keyword arguments, will be passed to hook callbacks
    :return: A concatenation of all callbacks\
    responses marked as safe (conditionally)
    :rtype: str
    """
    return format_html_join(
        sep="\n",
        format_string="{}",
        args_generator=(
            (response,) for response in hook(name, context, *args, **kwargs)
        ),
    )

template_hook_collect 

template_hook_collect(module, hook_name, *args, **kwargs)

Helper to include in your own templatetag, for static TemplateHooks

Example::

import myhooks
from hooks.templatetags import template_hook_collect

@register.simple_tag(takes_context=True)
def hook(context, name, *args, **kwargs):
    return template_hook_collect(myhooks, name, context, *args, **kwargs)

:param module module: Module containing the template hook definitions :param str hook_name: The hook name to be dispatched :param *args: Positional arguments, will be passed to hook callbacks :param **kwargs: Keyword arguments, will be passed to hook callbacks :return: A concatenation of all callbacks\ responses marked as safe (conditionally) :rtype: str

Source code in hypha/core/templatetags/hooks_tags.py 
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
def template_hook_collect(module, hook_name, *args, **kwargs):
    r"""
    Helper to include in your own templatetag, for static TemplateHooks

    Example::

        import myhooks
        from hooks.templatetags import template_hook_collect

        @register.simple_tag(takes_context=True)
        def hook(context, name, *args, **kwargs):
            return template_hook_collect(myhooks, name, context, *args, **kwargs)

    :param module module: Module containing the template hook definitions
    :param str hook_name: The hook name to be dispatched
    :param \*args: Positional arguments, will be passed to hook callbacks
    :param \*\*kwargs: Keyword arguments, will be passed to hook callbacks
    :return: A concatenation of all callbacks\
    responses marked as safe (conditionally)
    :rtype: str
    """
    try:
        templatehook = getattr(module, hook_name)
    except AttributeError:
        return ""

    return format_html_join(
        sep="\n",
        format_string="{}",
        args_generator=((response,) for response in templatehook(*args, **kwargs)),
    )