widgets.php

Go to the documentation of this file.

<?php
function elgg_get_widgets($owner_guid, $context) {
    return _elgg_services()->widgets->getWidgets($owner_guid, $context);
}

function elgg_create_widget($owner_guid, $handler, $context, $access_id = null) {
    return _elgg_services()->widgets->createWidget($owner_guid, $handler, $context, $access_id);
}

function elgg_can_edit_widget_layout($context, $user_guid = 0) {
    return _elgg_services()->widgets->canEditLayout($context, $user_guid);
}

function elgg_register_widget_type($handler, $name = null, $description = null, $context = [], $multiple = false) {
    if (is_array($handler)) {
        $definition = \Elgg\WidgetDefinition::factory($handler);
    } else {
        $definition = \Elgg\WidgetDefinition::factory([
            'id' => $handler,
            'name' => $name,
            'description' => $description,
            'context' => $context,
            'multiple' => $multiple,
        ]);
    }

    return _elgg_services()->widgets->registerType($definition);
}

function elgg_unregister_widget_type($handler) {
    return _elgg_services()->widgets->unregisterType($handler);
}

function elgg_is_widget_type($handler, $context = null, \ElggEntity $container = null) {
    return _elgg_services()->widgets->validateType($handler, $context, $container);
}

function elgg_get_widget_types($context = "") {
    if (is_array($context)) {
        $params = $context;
    } else {
        $params = [
            'context' => $context,
            'container' => null,
        ];
    }
    return _elgg_services()->widgets->getTypes($params);
}