This page is part of a static HTML representation of the TiddlyWiki at https://tiddlywiki.com/dev/

HookMechanism

9th February 2017 at 1:08pm

The hook mechanism provides a way for plugins to intercept and modify default functionality. Hooks are added as follows:

$tw.hooks.addHook(name,handler);

Multiple handlers can be assigned to the same name using repeated calls. When a hook is invoked by name all registered functions will be called sequentially in their order of addition.

Though not essential care should be taken to ensure that hooks are added before they are invoked. For example: Hook: tc-opening-default-tiddlers-list should ideally be added before the story startup module is invoked otherwise any hook specified additions to the default tiddlers will not be seen on the initial loading of the page, though will be visible if the user clicks the home button.

Example

A working example of a hook that adds "test" to the default tiddlers.

$tw.hooks.addHook("th-opening-default-tiddlers-list",function(list) { 
    list.push("test");
    return list; 
});