pnModRegisterHook

register a hook function

Synopsis

bool pnModRegisterHook(hookobject, hookaction, hookarea, hookmodule, hooktype, hookfunc);

Description

pnModRegisterHook() registers a hook function.

Parameters

hookobject

The hook object - either 'item' or 'category'

hookaction

The action the hook is called for - one of 'create', 'delete', 'transform', or 'display'

hookarea

The area of the hook (either 'GUI' or 'API')

hookmodule

The name of the hook module

hooktype

The name of the hook type ('user' or 'admin')

hookfunc

The name of the hook function

Return Values

This function returns true on success. This function returns void if an exception was raised.

Exceptions

This function raises DATABASE_ERROR if an error occurs while querying data.

Notes

The list of hook actions is constantly being refined. Check the source code for a current list. TODO: Have an official online hook action registry.

Examples

    // Set up module hooks
    if (!pnModRegisterHook('item',
                           'display',
                           'GUI',
                           'Ratings',
                           'user',
                           'display')) {
        return false;
    }
       

See Also

pnModUnregisterHook()