Namespaces
	Elgg\Core
	Activate a plugin or plugins.

Functions
	elgg_get_entities_from_private_settings (array $options=array())
	Returns entities based upon private settings. More...

	elgg_get_entity_private_settings_where_sql ($table, $names=null, $values=null, $pairs=null, $pair_operator='AND', $name_prefix='')
	Returns private setting name and value SQL where/join clauses for entities. More...

	get_private_setting ($entity_guid, $name)
	Gets a private setting for an entity. More...

	get_all_private_settings ($entity_guid)
	Return an array of all private settings. More...

	set_private_setting ($entity_guid, $name, $value)
	Sets a private setting for an entity. More...

	remove_private_setting ($entity_guid, $name)
	Deletes a private setting for an entity. More...

	remove_all_private_settings ($entity_guid)
	Deletes all private settings for an entity. More...

Function Documentation

◆ elgg_get_entities_from_private_settings()

elgg_get_entities_from_private_settings ( array $options = array() )

Returns entities based upon private settings.

Also accepts all options available to elgg_get_entities(). Supports the singular option shortcut.

See also: elgg_get_entities

Parameters

array

$options

Array in format:

private_setting_names => null|ARR private setting names

private_setting_values => null|ARR metadata values

private_setting_name_value_pairs => null|ARR (
                                    name => 'name',
                                    value => 'value',
                                    'operand' => '=',
                                   )
                             Currently if multiple values are sent via
                          an array (value => array('value1', 'value2')
                          the pair's operand will be forced to "IN".

private_setting_name_value_pairs_operator => null|STR The operator to use for combining
                                   (name = value) OPERATOR (name = value); default AND

private_setting_name_prefix => STR A prefix to apply to all private settings. Used to namespace plugin user settings or by plugins to namespace their own settings.

Returns: mixed int If count, int. If not count, array. false on errors.

Since: 1.8.0

Definition at line 44 of file private_settings.php.

◆ elgg_get_entity_private_settings_where_sql()

elgg_get_entity_private_settings_where_sql	(	$table,
		$names = `null`,
		$values = `null`,
		$pairs = `null`,
		$pair_operator = `'AND'`,
		$name_prefix = `''`
	)

Returns private setting name and value SQL where/join clauses for entities.

Parameters

string	$table	Entities table name
array \| null	$names	Array of names
array \| null	$values	Array of values
array \| null	$pairs	Array of names / values / operands
string	$pair_operator	Operator for joining pairs where clauses
string	$name_prefix	A string to prefix all names with

Returns: array

Since: 1.8.0 @access private

Definition at line 100 of file private_settings.php.

◆ get_all_private_settings()

get_all_private_settings ( $entity_guid )

Return an array of all private settings.

Parameters

int $entity_guid The entity GUID

Returns: array|empty array if no settings

See also: set_private_setting(); get_private_settings(); remove_private_setting(); remove_all_private_settings()

Definition at line 306 of file private_settings.php.

◆ get_private_setting()

get_private_setting	(	$entity_guid,
		$name
	)

Gets a private setting for an entity.

Plugin authors can set private data on entities. By default private data will not be searched or exported.

Definition at line 275 of file private_settings.php.

◆ remove_all_private_settings()

remove_all_private_settings ( $entity_guid )

Deletes all private settings for an entity.

Parameters

int $entity_guid The Entity GUID

Returns: bool

See also: get_private_setting(); get_all_private_settings(); set_private_setting(); remove_private_settings()

Definition at line 397 of file private_settings.php.

◆ remove_private_setting()

remove_private_setting	(	$entity_guid,
		$name
	)

Deletes a private setting for an entity.

Parameters

int	$entity_guid	The Entity GUID
string	$name	The name of the setting

Returns: bool

See also: get_private_setting(); get_all_private_settings(); set_private_setting(); remove_all_private_settings()

Definition at line 369 of file private_settings.php.

◆ set_private_setting()

set_private_setting	(	$entity_guid,
		$name,
		$value
	)

Sets a private setting for an entity.

Parameters

int	$entity_guid	The entity GUID
string	$name	The name of the setting
string	$value	The value of the setting

Returns: bool

See also: get_private_setting(); get_all_private_settings(); remove_private_setting(); remove_all_private_settings()

Definition at line 342 of file private_settings.php.

Namespaces

Functions

Function Documentation

◆ elgg_get_entities_from_private_settings()

◆ elgg_get_entity_private_settings_where_sql()

◆ get_all_private_settings()

◆ get_private_setting()

◆ remove_all_private_settings()

◆ remove_private_setting()

◆ set_private_setting()