widgets.php

Go to the documentation of this file.

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

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

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

function elgg_register_widget_type(array $options): void {
    $definition = \Elgg\WidgetDefinition::factory($options);

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

function elgg_unregister_widget_type(string $handler): void {
    _elgg_services()->widgets->unregisterType($handler);
}

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

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