Using Hooks

Hooks are a way of adding functionality to modules without the modules themselves knowing what the functions might be. The operation of hooks are controlled by the site administrator, so the decision as to which pieces of extra functionality to use and which not is in their hands rather than the module developer.

Hooks are called for specific actions that take place in a module. The actions that hooks are currently enabled for are as follows:

• Addition of a category

• Deletion of a category

• Transformation of category data into a standard PostNuke format

• Display of a category

• Addition of an item

• Deletion of an item

• Transformation of item data into a standard PostNuke format

• Display of an item

Note: the terms category and item are quite broad. Category is used to define any database entity that contains other categories or items, whilst item is used to define any database entity that holds content. Due to this definition it is possible for an item to be a category as well, although this is an unlikely state of affairs and it should be obvious to a module developer which parts of the system deal with categories and which with items.

Hooks are the recommended way of extending the functionality of your module, and use of the appropriate pnAPI hook functions as described below is considered mandatory for a compliant module.