phpBB API Documentation
Class

acp_modules

class acp_modules

Properties

$module_class
$parent_id
$u_action

Methods

main($id, $mode)

get_module_row($module_id)

Get row for specified module
array get_module_infos(string $module = '', bool|string $module_class = false, bool $use_all_available = false)

Get available module information from module files
make_module_select($select_id = false, $ignore_id = false, $ignore_acl = false, $ignore_nonpost = false, $ignore_emptycat = true, $ignore_noncat = false)

Simple version of jumpbox, just lists modules
get_module_branch($module_id, $type = 'all', $order = 'descending', $include_module = true)

Get module branch
remove_cache_file()

Remove modules cache file
lang_name($module_langname)

Return correct language name
update_module_data(array $module_data, bool $run_inline = false)

Update/Add module
move_module($from_module_id, $to_parent_id)

Move module around the tree
delete_module($module_id)

Remove module from tree
move_module_by($module_row, $action = 'move_up', $steps = 1)

Move module position by $steps up/down

Details

at line 38
public main($id, $mode)

Parameters

$id
$mode

at line 544
public get_module_row($module_id)

Get row for specified module

Parameters

$module_id

at line 573
public array get_module_infos(string $module = '', bool|string $module_class = false, bool $use_all_available = false)

Get available module information from module files

Parameters

string $module
bool|string $module_class
bool $use_all_available Use all available instead of just all enabled extensions

Return Value

array

at line 642
public make_module_select($select_id = false, $ignore_id = false, $ignore_acl = false, $ignore_nonpost = false, $ignore_emptycat = true, $ignore_noncat = false)

Simple version of jumpbox, just lists modules

Parameters

$select_id
$ignore_id
$ignore_acl
$ignore_nonpost
$ignore_emptycat
$ignore_noncat

at line 714
public get_module_branch($module_id, $type = 'all', $order = 'descending', $include_module = true)

Get module branch

Parameters

$module_id
$type
$order
$include_module

at line 761
public remove_cache_file()

Remove modules cache file

at line 777
public lang_name($module_langname)

Return correct language name

Parameters

$module_langname

at line 790
public update_module_data(array $module_data, bool $run_inline = false)

Update/Add module

Parameters

array $module_data The module data
bool $run_inline if set to true errors will be returned and no logs being written

at line 900
public move_module($from_module_id, $to_parent_id)

Move module around the tree

Parameters

$from_module_id
$to_parent_id

at line 983
public delete_module($module_id)

Remove module from tree

Parameters

$module_id

at line 1028
public move_module_by($module_row, $action = 'move_up', $steps = 1)

Move module position by $steps up/down

Parameters

$module_row
$action
$steps