Reference 〉Function

Helipad.doHooks( str|list[str] place, list[mixed] args )

Executes registered hooks at various places in the model.

WARNING: This is an internal function. Its use in user code is not recommended or supported, and its signature can change in future updates without warning. Use one of the suggested functions above instead, if applicable.

Parameters

  • place str|list[str], required

    The hook to execute. Will execute multiple hooks if a list is passed, all of which must have a function signature matching args.

  • args list[mixed], required

    A list of arguments to pass to the functions being executed. Each separate place will pass a different set of arguments. See the hooks reference for a complete list.

Return Value mixed

Passes the return value of the last function hooked to the place currently being executed. See the hook reference for which hooks expect a return value.

Notes and Examples

  1. Contribute a Note

    Your email address will not be published. Required fields are marked *

    You may use limited HTML for formatting. Please embed blocks of code in <pre><code> </code></pre> tags.