plugins.php

Go to the documentation of this file.

<?php
function _elgg_generate_plugin_entities() {
    return _elgg_services()->plugins->generateEntities();
}

function elgg_get_plugin_from_id($plugin_id) {
    return _elgg_services()->plugins->get($plugin_id);
}

function elgg_plugin_exists($id) {
    return _elgg_services()->plugins->exists($id);
}

function _elgg_get_max_plugin_priority() {
    return _elgg_services()->plugins->getMaxPriority();
}

function elgg_is_active_plugin($plugin_id) {
    return _elgg_services()->plugins->isActive($plugin_id);
}

function elgg_get_plugins($status = 'active') {
    return _elgg_services()->plugins->find($status);
}

function elgg_get_all_plugin_user_settings($user_guid = 0, $plugin_id = null, $return_obj = false) {
    $plugin = elgg_get_plugin_from_id($plugin_id);
    if (!$plugin) {
        return [];
    }

    $settings = $plugin->getAllUserSettings($user_guid);

    return $return_obj ? (object) $settings : $settings;
}

function elgg_set_plugin_user_setting($name, $value, $user_guid = 0, $plugin_id = null) {
    return _elgg_services()->plugins->setUserSetting($name, $value, $user_guid, $plugin_id);
}

function elgg_unset_plugin_user_setting($name, $user_guid = 0, $plugin_id = null) {
    return _elgg_services()->plugins->unsetUserSetting($name, $user_guid, $plugin_id);
}

function elgg_get_plugin_user_setting($name, $user_guid = 0, $plugin_id = null, $default = null) {
    return _elgg_services()->plugins->getUserSetting($name, $user_guid, $plugin_id, $default);
}

function elgg_set_plugin_setting($name, $value, $plugin_id) {
    return _elgg_services()->plugins->setSetting($name, $value, $plugin_id);
}

function elgg_get_plugin_setting($name, $plugin_id, $default = null) {
    return _elgg_services()->plugins->getSetting($name, $plugin_id, $default);
}

function elgg_unset_plugin_setting($name, $plugin_id) {
    return _elgg_services()->plugins->unsetSetting($name, $plugin_id);
}

function elgg_unset_all_plugin_settings($plugin_id) {
    return _elgg_services()->plugins->unsetAllSettings($plugin_id);
}

function elgg_get_entities_from_plugin_user_settings(array $options = []) {
    return _elgg_services()->plugins->getEntitiesFromUserSettings($options);
}

function _elgg_plugins_test($hook, $type, $value, $params) {
    $value[] = ElggCorePluginsAPITest::class;
    return $value;
}

function _elgg_plugins_init() {

    if (elgg_is_admin_logged_in()) {
        elgg_register_ajax_view('object/plugin/full');
        elgg_register_ajax_view('object/plugin/details');
    }

    elgg_register_plugin_hook_handler('unit_test', 'system', '_elgg_plugins_test');
}

return function(\Elgg\EventsService $events, \Elgg\HooksRegistrationService $hooks) {
    $events->registerHandler('init', 'system', '_elgg_plugins_init');
};