diff options
| author | Oleg Pudeyev <oleg@bsdpower.com> | 2012-01-12 22:13:28 -0500 |
|---|---|---|
| committer | Nils Adermann <naderman@naderman.de> | 2012-01-13 04:25:22 +0100 |
| commit | 3f754d118d8fbd36dcefbeea470ecb267e87ace6 (patch) | |
| tree | 8d8fe35412e391f6d6a0058f35968b5c2e39e84e /phpBB/includes/functions_module.php | |
| parent | ffde8c8e06c4d37bef5cde280d520c0791ed2c67 (diff) | |
| download | forums-3f754d118d8fbd36dcefbeea470ecb267e87ace6.tar forums-3f754d118d8fbd36dcefbeea470ecb267e87ace6.tar.gz forums-3f754d118d8fbd36dcefbeea470ecb267e87ace6.tar.bz2 forums-3f754d118d8fbd36dcefbeea470ecb267e87ace6.tar.xz forums-3f754d118d8fbd36dcefbeea470ecb267e87ace6.zip | |
[ticket/10477] Document parameters to p_master#load.
PHPBB3-10477
Diffstat (limited to 'phpBB/includes/functions_module.php')
| -rw-r--r-- | phpBB/includes/functions_module.php | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/phpBB/includes/functions_module.php b/phpBB/includes/functions_module.php index a6015b1eac..653623a336 100644 --- a/phpBB/includes/functions_module.php +++ b/phpBB/includes/functions_module.php @@ -438,6 +438,8 @@ class p_master * Loads currently active module * * This method loads a given module, passing it the relevant id and mode. + * + * @param string $mode mode, as passed through to the module */ function load_active($mode = false, $module_url = false, $execute_module = true) { @@ -801,11 +803,16 @@ class p_master /** * Load module as the current active one without the need for registering it + * + * @param string $class module class (acp/mcp/ucp) + * @param string $name module name (e.g. zebra for the ucp_zebra module) + * @param string $mode mode, as passed through to the module + * */ function load($class, $name, $mode = false) { // new modules use the full class names, old ones are always called <class>_<name>, e.g. acp_board - // in the latter case this function may be called as load(acp, board) + // in the latter case this function may be called as load('acp', 'board') if (!class_exists($name) && substr($name, 0, strlen($class) + 1) !== $class . '_') { $name = $class . '_' . $name; |