makary/phpbb
1
0
Fork 0
mirror of https://github.com/phpbb/phpbb.git synced 2025-06-28 06:08:52 +00:00
Code Issues Projects Releases Packages Wiki Activity

[ticket/10477] Document parameters to p_master#load.

Browse source 
PHPBB3-10477
This commit is contained in:
Oleg Pudeyev 2012-01-12 22:13:28 -05:00 • committed by Nils Adermann
parent ffde8c8e06
commit 3f754d118d
1 changed files with 8 additions and 1 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

9
phpBB/includes/functions_module.php
View file

@ -438,6 +438,8 @@ class p_master
* Loads currently active module * Loads currently active module
* *
* This method loads a given module, passing it the relevant id and mode. * 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) 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 * 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) function load($class, $name, $mode = false)
{ {
// new modules use the full class names, old ones are always called <class>_<name>, e.g. acp_board // 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 . '_') if (!class_exists($name) && substr($name, 0, strlen($class) + 1) !== $class . '_')
{ {
$name = $class . '_' . $name; $name = $class . '_' . $name;