Namespaces
	Elgg\Core
	Activate a plugin or plugins.

Functions
	elgg_get_widgets ($owner_guid, $context)
	Get widgets for a particular context. More...

	elgg_create_widget ($owner_guid, $handler, $context, $access_id=null)
	Create a new widget instance. More...

	elgg_can_edit_widget_layout ($context, $user_guid=0)
	Can the user edit the widget layout. More...

	elgg_register_widget_type ($handler, $name=null, $description=null, $context=array('all'), $multiple=false)
	Register a widget type. More...

	elgg_unregister_widget_type ($handler)
	Remove a widget type. More...

	elgg_is_widget_type ($handler, $context=null,\ElggEntity $container=null)
	Has a widget type with the specified handler been registered. More...

	elgg_get_widget_types ($context="", $exact=false)
	Get the widget types for a context. More...

	_elgg_widgets_set_ajax_title ($hook, $type, $results, $params)
	Set the widget title on ajax return from save action. More...

	_elgg_widgets_init ()
	Function to initialize widgets functionality. More...

	_elgg_default_widgets_init ()
	Gets a list of events to create default widgets for and register menu items for default widgets with the admin section. More...

	_elgg_create_default_widgets ($event, $type, $entity)
	Creates default widgets. More...

	_elgg_default_widgets_permissions_override ($hook, $type, $return, $params)
	Overrides permissions checks when creating widgets for logged out users. More...

Variables
return	function (\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks)

Function Documentation

_elgg_create_default_widgets	(	$event,
		$type,
		$entity
	)

Creates default widgets.

This plugin hook handler is registered for events based on what kinds of default widgets have been registered. See elgg_default_widgets_init() for information on registering new default widget contexts.

Parameters

string	$event	The event
string	$type	The type of object
\ElggEntity	$entity	The entity being created

Returns: void private

Definition at line 258 of file widgets.php.

_elgg_default_widgets_init ( )

Gets a list of events to create default widgets for and register menu items for default widgets with the admin section.

A plugin that wants to register a new context for default widgets should register for the plugin hook 'get_list', 'default_widgets'. The handler can register the new type of default widgets by adding an associate array to the return value array like this: array( 'name' => elgg_echo('profile'), 'widget_context' => 'profile', 'widget_columns' => 3,

'event' => 'create', 'entity_type' => 'user', 'entity_subtype' => ELGG_ENTITIES_ANY_VALUE, );

The first set of keys define information about the new type of default widgets and the second set determine what event triggers the creation of the new widgets.

Returns: void private

Definition at line 214 of file widgets.php.

_elgg_default_widgets_permissions_override	(	$hook,
		$type,
		$return,
		$params
	)

Overrides permissions checks when creating widgets for logged out users.

Parameters

string	$hook	The permissions hook.
string	$type	The type of entity being created.
string	$return	Value
mixed	$params	Params

Returns: true|null private

Definition at line 325 of file widgets.php.

_elgg_widgets_init ( )

Function to initialize widgets functionality.

Returns: void private

Definition at line 180 of file widgets.php.

_elgg_widgets_set_ajax_title	(	$hook,
		$type,
		$results,
		$params
	)

Set the widget title on ajax return from save action.

Parameters

string	$hook	Hook name
string	$type	Hook type
array	$results	Array to be encoded as json
array	$params	Parameters about the request

Returns: array|null private

Definition at line 163 of file widgets.php.

elgg_can_edit_widget_layout	(	$context,
		$user_guid = `0`
	)

Can the user edit the widget layout.

Triggers a 'permissions_check', 'widget_layout' plugin hook

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 54 of file widgets.php.

elgg_create_widget	(	$owner_guid,
		$handler,
		$context,
		$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
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 39 of file widgets.php.

elgg_get_widget_types	(	$context = `""`,
		$exact = `false`
	)

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' => (defaults to null) ) The contents of the array will be passed to the handlers:widgets hook.

Parameters

array \| string	$context	An associative array of options or the widget context
bool	$exact	Only return widgets registered for this context (false)

Returns: []

Since: 1.8.0

Definition at line 140 of file widgets.php.

elgg_get_widgets	(	$owner_guid,
		$context
	)

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 objects

Since: 1.8.0

Definition at line 24 of file widgets.php.

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

Has a widget type with the specified handler been registered.

Parameters

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

Returns: bool Whether or not that widget type exists

Since: 1.8.0

Definition at line 119 of file widgets.php.

elgg_register_widget_type	(	$handler,
		$name = `null`,
		$description = `null`,
		$context = `array('all')`,
		$multiple = `false`
	)

Register a widget type.

This should be called by plugins in their init function.

Parameters

string \| array	$handler	An array of options or the identifier for the widget handler
string	$name	The name of the widget type
string	$description	A description for the widget type
array	$context	An array of contexts where this widget is allowed (default: array('all'))
bool	$multiple	Whether or not multiple instances of this widget are allowed in a single layout (default: false)

Returns: bool

Since: 1.8.0

Definition at line 74 of file widgets.php.

elgg_unregister_widget_type ( $handler )

Remove a widget type.

Parameters

string $handler The identifier for the widget

Returns: bool true if handler was found as unregistered

Since: 1.8.0

Definition at line 105 of file widgets.php.

Variable Documentation

return function(\Elgg\EventsService $events,\Elgg\HooksRegistrationService $hooks)

Definition at line 333 of file widgets.php.

Namespaces

Functions

Variables

Function Documentation

Variable Documentation