[ Index ]

PHP Cross Reference of MyBB 1.6.5

title

Body

[close]

/inc/ -> class_plugins.php (summary)

(no description)

File Size: 214 lines (5 kb)
Included or required: 2 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

pluginSystem:: (6 methods):
  load()
  add_hook()
  run_hooks()
  run_hooks_by_ref()
  remove_hook()
  is_compatible()


Class: pluginSystem  - X-Ref

MyBB 1.6
Copyright 2010 MyBB Group, All Rights Reserved

Website: http://mybb.com
License: http://mybb.com/about/license

$Id: class_plugins.php 5624 2011-10-02 19:07:56Z ralgith $
load()   X-Ref
Load all plugins.


add_hook($hook, $function, $priority=10, $file="")   X-Ref
Add a hook onto which a plugin can be attached.

param: string The hook name.
param: string The function of this hook.
param: int The priority this hook has.
param: string The optional file belonging to this hook.
return: boolean Always true.

run_hooks($hook, $arguments="")   X-Ref
Run the hooks that have plugins.

param: string The name of the hook that is run.
param: string The argument for the hook that is run. The passed value MUST be a variable
return: string The arguments for the hook.

run_hooks_by_ref($hook, &$arguments)   X-Ref
Run the hooks that have plugins but passes REQUIRED argument that is received by reference.
This argument must be received by reference in the plugin file!
This is a separate function to allow by reference calls for things you cannot use the $var = $plugins->run_hooks("hook_name", $var) syntax.

param: string The name of the hook that is run.
param: string The argument for the hook that is run - passed by reference. The passed value MUST be a variable

remove_hook($hook, $function, $file="", $priority=10)   X-Ref
Remove a specific hook.

param: string The name of the hook.
param: string The function of the hook.
param: string The filename of the plugin.
param: int The priority of the hook.

is_compatible($plugin)   X-Ref
Establishes if a particular plugin is compatible with this version of MyBB.

param: string The name of the plugin.
return: boolean TRUE if compatible, FALSE if incompatible.



Generated: Sun Dec 11 14:16:27 2011 Cross-referenced by PHPXref 0.7.1