widgets.php File Reference

Go to the source code of this file.

Functions
	elgg_get_widgets (int $owner_guid, string $context)
	Elgg widgets library. More...
	elgg_create_widget (int $owner_guid, string $handler, string $context, ?int $access_id=null)
	Create a new widget instance. More...
	elgg_can_edit_widget_layout (string $context, int $user_guid=0)
	Can the user edit the widget layout. More...
	elgg_register_widget_type (array $options)
	Register a widget type. More...
	elgg_unregister_widget_type (string $handler)
	Remove a widget type. More...
	elgg_is_widget_type (string $handler, ?string $context=null, ?\ElggEntity $container=null)
	Has a widget type with the specified handler been registered. More...
	elgg_get_widget_types (string|array $context='')
	Get the widget types for a context. More...

Function Documentation

elgg_can_edit_widget_layout()

elgg_can_edit_widget_layout	(	string	$context,
		int	$user_guid = 0
	)

Can the user edit the widget layout.

Triggers a 'permissions_check', 'widget_layout' event

Parameters

string	$context	The widget context
int	$user_guid	The GUID of the user (0 for logged in user)

Returns

bool

Since

1.8.0

Definition at line 50 of file widgets.php.

elgg_create_widget()

elgg_create_widget	(	int	$owner_guid,
		string	$handler,
		string	$context,
		?int	$access_id = null
	)

Create a new widget instance.

Parameters

int	$owner_guid	GUID of entity that owns this widget
string	$handler	The handler for this widget
string	$context	The context for this widget
null | int	$access_id	If not specified, it is set to the default access level

Returns

int|false Widget GUID or false on failure

Since

1.8.0

Definition at line 35 of file widgets.php.

elgg_get_widget_types()

elgg_get_widget_types

(

string|array

$context = ''

)

Get the widget types for a context.

If passing $context as an associative array you the following can be used: array ( 'context' => string (defaults to ''), 'exact' => bool (defaults to false), 'container' => \ElggEntity (defaults to null) ) The contents of the array will be passed to the 'handlers:widgets' event.

Parameters

array | string

$context

An associative array of options or the widget context

Returns

\Elgg\WidgetDefinition[]

Since

1.8.0

Definition at line 112 of file widgets.php.

elgg_get_widgets()

elgg_get_widgets	(	int	$owner_guid,
		string	$context
	)

Elgg widgets library.

Contains code for handling widgets. Get widgets for a particular context

The widgets are ordered for display and grouped in columns. $widgets = elgg_get_widgets(elgg_get_logged_in_user_guid(), 'dashboard'); $first_column_widgets = $widgets[1];

Parameters

int	$owner_guid	The owner GUID of the layout
string	$context	The context (profile, dashboard, etc)

Returns

array An 2D array of \ElggWidget objects

Since

1.8.0

Definition at line 20 of file widgets.php.

elgg_is_widget_type()

elgg_is_widget_type	(	string	$handler,
		?string	$context = null,
		?\ElggEntity	$container = null
	)

Has a widget type with the specified handler been registered.

Parameters

string	$handler	The widget handler identifying string
null | string	$context	Optional context to check
null | \ElggEntity	$container	Optional limit widget definitions to a container

Returns

bool Whether that widget type exists

Since

1.8.0

Definition at line 92 of file widgets.php.

elgg_register_widget_type()

elgg_register_widget_type

(

array

$options

)

Register a widget type.

This should be called by plugins in their init function.

Parameters

array

$options

An array of options

Returns

void

Since

1.8.0

Definition at line 64 of file widgets.php.

elgg_unregister_widget_type()

elgg_unregister_widget_type

(

string

$handler

)

Remove a widget type.

Parameters

string

$handler

The identifier for the widget

Returns

void

Since

1.8.0

Definition at line 78 of file widgets.php.