metadata.php File Reference

Go to the source code of this file.

Functions
	elgg_get_metadata_from_id (int $id)
	Elgg metadata Functions to manage entity metadata. More...
	elgg_get_metadata (array $options=[])
	Fetch metadata or perform a calculation on them. More...
	elgg_delete_metadata (array $options)
	Deletes metadata based on $options. More...
	elgg_get_tags (array $options=[])
	Get popular tags and their frequencies. More...

Function Documentation

elgg_delete_metadata

(

array

$options

)

Deletes metadata based on $options.

Warning

Unlike elgg_get_metadata() this will not accept an empty options array! This requires at least one constraint: metadata_name(s), metadata_value(s), or guid(s) must be set.

Parameters

array

$options

An options array. elgg_get_metadata()

Returns

bool

Exceptions

Definition at line 49 of file metadata.php.

elgg_get_metadata

(

array

$options = []

)

Fetch metadata or perform a calculation on them.

Accepts all options supported by elgg_get_entities()

See also

elgg_get_entities()

Parameters

array

$options

Options

Returns

[]|mixed

Since

1.8.0

Definition at line 32 of file metadata.php.

elgg_get_metadata_from_id

(

int

$id

)

Elgg metadata Functions to manage entity metadata.

Get a specific metadata object by its id. If you want multiple metadata objects, use elgg_get_metadata().

Parameters

int

$id

The id of the metadata object being retrieved.

Returns

|null

Definition at line 16 of file metadata.php.

elgg_get_tags

(

array

$options = []

)

Get popular tags and their frequencies.

Accepts all options supported by {

See also

elgg_get_metadata()}

Returns an array of objects that include "tag" and "total" properties

Parameters

array

$options

Options

int $threshold Minimum number of tag occurrences string[] $tag_names Names of tag names to include in search

Returns

stdClass[]|false

Since

1.7.1

Examples:

/root/Elgg/engine/lib/views.php.

Definition at line 68 of file metadata.php.