phpDocumentor ninko
[ class tree: ninko ] [ index: ninko ] [ all elements ]

Procedural File: hooks.php

Source Location: /include/functions/hooks.php

Page Details

hooks.php

Includes functions for hooking, plugin functions

Author:  Nijiko Yonskai <me@nijikokun.com>
Version:  1.2
Copyright:  (c) 2010 ANIGAIKU
Globals
array   $hooks [line 16]

Initiate hook array

Default value:  array()

[ Top ]


Functions
add_hook  [line 219]

boolean add_hook( string $hook_name, string $added_function, [array $args = null]  )

Create hook instance in specific area

Allow outside functionality without editing main files

Parameters:
string   $hook_name:  area of hook
string   $added_function:  function to be called upon hook load
array   $args:  arguments of function

API Tags:
Global:  array $hooks:


[ Top ]
already_loaded  [line 66]

boolean already_loaded( string $name  )

Is that plugin already loaded?

Parameters:
string   $name:  name of plugin


[ Top ]
get_plugin_data  [line 177]

array get_plugin_data( string $path  )

Gets the plugin data from filename

Parameters:
string   $path:  really just the filename.


[ Top ]
is_loaded  [line 157]

boolean is_loaded( string $name  )

Is the plugin requested loaded?

Parameters:
string   $name:  name of plugin that you want to verify the loading of


[ Top ]
load_hook  [line 239]

mixed load_hook( string $area  )

Initiate hooks set

Parameters:
string   $area:  hooks in this area will be called

API Tags:
Global:  $hooks $hooks:


[ Top ]
load_plugin  [line 23]

boolean|string load_plugin( string $name  )

Turns a plugin on and creates the row to show loading

Parameters:
string   $name:  name of plugin


[ Top ]
plugins  [line 128]

array plugins( )

Grabs data for all plugins in plugin directory.



[ Top ]
plugin_loaded  [line 145]

boolean plugin_loaded( string $name  )

Tells the rest of the site that a plugin is loaded.

Parameters:
string   $name:  name of plugin that just got loaded.


[ Top ]
unload_plugin  [line 89]

boolean|string unload_plugin( string $name  )

Turns a plugin off and deletes the row it was loaded on

Parameters:
string   $name:  name of plugin


[ Top ]


Documentation generated on Sat, 06 Feb 2010 10:46:04 -0500 by phpDocumentor 1.4.3