Elgg
Version 3.0
|
Go to the source code of this file.
Functions | |
_elgg_generate_plugin_entities () | |
Elgg plugins library Contains functions for managing plugins. More... | |
elgg_get_plugin_from_id ($plugin_id) | |
Returns an object with the path $path. More... | |
elgg_plugin_exists ($id) | |
Returns if a plugin exists in the system. More... | |
_elgg_get_max_plugin_priority () | |
Returns the highest priority of the plugins. More... | |
elgg_is_active_plugin ($plugin_id) | |
Returns if a plugin is active for a current site. More... | |
elgg_get_plugins ($status= 'active') | |
Returns an ordered list of plugins. More... | |
elgg_get_all_plugin_user_settings ($user_guid=0, $plugin_id=null, $return_obj=false) | |
Returns an array of all plugin user settings for a user. More... | |
elgg_set_plugin_user_setting ($name, $value, $user_guid=0, $plugin_id=null) | |
Set a user specific setting for a plugin. More... | |
elgg_unset_plugin_user_setting ($name, $user_guid=0, $plugin_id=null) | |
Unsets a user-specific plugin setting. More... | |
elgg_get_plugin_user_setting ($name, $user_guid=0, $plugin_id=null, $default=null) | |
Get a user specific setting for a plugin. More... | |
elgg_set_plugin_setting ($name, $value, $plugin_id) | |
Set a setting for a plugin. More... | |
elgg_get_plugin_setting ($name, $plugin_id, $default=null) | |
Get setting for a plugin. More... | |
elgg_unset_plugin_setting ($name, $plugin_id) | |
Unsets a plugin setting. More... | |
elgg_unset_all_plugin_settings ($plugin_id) | |
Unsets all plugin settings for a plugin. More... | |
elgg_get_entities_from_plugin_user_settings (array $options=[]) | |
Returns entities based upon plugin user settings. More... | |
_elgg_plugins_test ($hook, $type, $value, $params) | |
Runs unit tests for plugin API. More... | |
_elgg_plugins_init () | |
Initialize the plugin system. More... | |
Variables | |
return | function (\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks) |
_elgg_generate_plugin_entities | ( | ) |
Elgg plugins library Contains functions for managing plugins.
Discovers plugins in the plugins_path setting and creates entities for them if they don't exist. If there are plugins with entities but not actual files, will disable the entities and mark as inactive. The object holds config data, so don't delete.
Definition at line 17 of file plugins.php.
_elgg_get_max_plugin_priority | ( | ) |
Returns the highest priority of the plugins.
Definition at line 54 of file plugins.php.
_elgg_plugins_init | ( | ) |
_elgg_plugins_test | ( | $hook, | |
$type, | |||
$value, | |||
$params | |||
) |
Runs unit tests for plugin API.
string | $hook | unit_test |
string | $type | system |
mixed | $value | Array of tests |
mixed | $params | Params |
Definition at line 251 of file plugins.php.
elgg_get_all_plugin_user_settings | ( | $user_guid = 0 , |
|
$plugin_id = null , |
|||
$return_obj = false |
|||
) |
Returns an array of all plugin user settings for a user.
int | $user_guid | The user GUID or 0 for the currently logged in user. |
string | $plugin_id | The plugin ID (Required) |
bool | $return_obj | Return settings as an object? This can be used to in reusable views where the settings are passed as $vars['entity']. |
Definition at line 92 of file plugins.php.
elgg_get_entities_from_plugin_user_settings | ( | array | $options = [] | ) |
Returns entities based upon plugin user settings.
Takes all the options for elgg_get_entities_from_private_settings() in addition to the ones below.
array | $options | Array in the format: plugin_id => STR The plugin id. Required. plugin_user_setting_names => null|ARR private setting names plugin_user_setting_values => null|ARR metadata values plugin_user_setting_name_value_pairs => null|ARR ( name => 'name', value => 'value', 'operand' => '=', ) Currently if multiple values are sent via an array (value => array('value1', 'value2') the pair's operand will be forced to "IN". plugin_user_setting_name_value_pairs_operator => null|STR The operator to use for combining (name = value) OPERATOR (name = value); default AND |
Definition at line 235 of file plugins.php.
elgg_get_plugin_from_id | ( | $plugin_id | ) |
Returns an object with the path $path.
string | $plugin_id | The id (dir name) of the plugin. NOT the guid. |
Definition at line 28 of file plugins.php.
elgg_get_plugin_setting | ( | $name, | |
$plugin_id, | |||
$default = null |
|||
) |
Get setting for a plugin.
string | $name | The name of the setting. |
string | $plugin_id | The plugin ID (Required) |
mixed | $default | The default value to return if none is set |
Definition at line 176 of file plugins.php.
elgg_get_plugin_user_setting | ( | $name, | |
$user_guid = 0 , |
|||
$plugin_id = null , |
|||
$default = null |
|||
) |
Get a user specific setting for a plugin.
string | $name | The name of the setting. |
int | $user_guid | The user GUID or 0 for the currently logged in user. |
string | $plugin_id | The plugin ID (Required) |
mixed | $default | The default value to return if none is set |
Definition at line 146 of file plugins.php.
elgg_get_plugins | ( | $status = 'active' | ) |
Returns an ordered list of plugins.
string | $status | The status of the plugins. active, inactive, or all. |
Definition at line 76 of file plugins.php.
elgg_is_active_plugin | ( | $plugin_id | ) |
Returns if a plugin is active for a current site.
string | $plugin_id | The plugin ID |
Definition at line 65 of file plugins.php.
elgg_plugin_exists | ( | $id | ) |
Returns if a plugin exists in the system.
string | $id | The plugin ID. |
Definition at line 43 of file plugins.php.
elgg_set_plugin_setting | ( | $name, | |
$value, | |||
$plugin_id | |||
) |
Set a setting for a plugin.
string | $name | The name of the setting - note, can't be "title". |
mixed | $value | The value. |
string | $plugin_id | The plugin ID (Required) |
Definition at line 161 of file plugins.php.
elgg_set_plugin_user_setting | ( | $name, | |
$value, | |||
$user_guid = 0 , |
|||
$plugin_id = null |
|||
) |
Set a user specific setting for a plugin.
string | $name | The name. Note: cannot be "title". |
mixed | $value | The value. |
int | $user_guid | The user GUID or 0 for the currently logged in user. |
string | $plugin_id | The plugin ID (Required) |
Definition at line 115 of file plugins.php.
elgg_unset_all_plugin_settings | ( | $plugin_id | ) |
Unsets all plugin settings for a plugin.
string | $plugin_id | The plugin ID (Required) |
Definition at line 203 of file plugins.php.
elgg_unset_plugin_setting | ( | $name, | |
$plugin_id | |||
) |
Unsets a plugin setting.
string | $name | The name of the setting. |
string | $plugin_id | The plugin ID (Required) |
Definition at line 190 of file plugins.php.
elgg_unset_plugin_user_setting | ( | $name, | |
$user_guid = 0 , |
|||
$plugin_id = null |
|||
) |
Unsets a user-specific plugin setting.
string | $name | Name of the setting |
int | $user_guid | The user GUID or 0 for the currently logged in user. |
string | $plugin_id | The plugin ID (Required) |
Definition at line 130 of file plugins.php.
return function(\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks) |
Definition at line 275 of file plugins.php.