docs/api.mdwn
changeset 138 832ded5b44c9
parent 134 d7ab555b9766
child 142 7e8f523b66af
equal deleted inserted replaced
137:4fda19d05965 138:832ded5b44c9
   280 Function to be called, when hook will be processsed.
   280 Function to be called, when hook will be processsed.
   281 XXX: we can provide object as argument, but is this necessary?  
   281 XXX: we can provide object as argument, but is this necessary?  
   282 **Arguments:** table (arguments hash)    
   282 **Arguments:** table (arguments hash)    
   283 **Return values:** [hook handler result](#hook.handler.result)  
   283 **Return values:** [hook handler result](#hook.handler.result)  
   284 
   284 
       
   285 <a name="main.hook.run"></a>
       
   286 ### main.hook_run
       
   287 Runs handlers for given hook with supplied arguments.  
       
   288 **Arguments:** string (hook name), table (hook arguments)    
       
   289 **Return values:** [return enum field](#return.enum.field) ([hook handler result](#hook.handler.result))  
       
   290 
   285 <a name="main.hook"></a>
   291 <a name="main.hook"></a>
   286 ### main.hook
   292 ### main.hook
   287 Installs hook handler, returns an object, that you need to keep until
   293 Installs hook handler, returns an object, that you need to keep until
   288 hook handling is no more needed.  
   294 hook handling is no more needed.  
   289 **Arguments:** string (hook name), [hook function](#hook.function), integer (priority, optional)    
   295 **Arguments:** string (hook name), [hook function](#hook.function), integer (priority, optional)