relationships.php File Reference

Go to the source code of this file.

Functions
	elgg_get_relationship (int $id)
	Get a relationship by its ID. More...
	elgg_get_entities_from_relationship_count (array $options=[])
	Gets the number of entities by a the number of entities related to them in a particular way. More...
	elgg_list_entities_from_relationship_count (array $options)
	Returns a list of entities by relationship count. More...
	elgg_get_relationships (array $options=[])
	Fetch relationships or perform a calculation on them. More...
	elgg_count_relationships (array $options=[])
	Returns a count of relationships. More...
	elgg_list_relationships (array $options)
	Returns a rendered list of relationships with pagination. More...

Function Documentation

elgg_count_relationships()

elgg_count_relationships

(

array

$options = []

)

Returns a count of relationships.

Parameters

array

$options

the same options as elgg_get_relationships() but forces 'count' to true

Returns

int

See also

elgg_get_relationships()

Since

6.1

Definition at line 76 of file relationships.php.

elgg_get_entities_from_relationship_count()

elgg_get_entities_from_relationship_count

(

array

$options = []

)

Gets the number of entities by a the number of entities related to them in a particular way.

This is a good way to get out the users with the most friends, or the groups with the most members.

Parameters

array

$options

An options array compatible with elgg_get_entities_from_relationship()

Returns

\ElggEntity[]|int|boolean If count, int. If not count, array. false on errors.

Since

1.8.0

Definition at line 30 of file relationships.php.

elgg_get_relationship()

elgg_get_relationship

(

int

$id

)

Get a relationship by its ID.

Parameters

int

$id

The relationship ID

Returns

\ElggRelationship|null

Since

4.3

Definition at line 16 of file relationships.php.

elgg_get_relationships()

elgg_get_relationships

(

array

$options = []

)

Fetch relationships or perform a calculation on them.

Accepts all options supported by elgg_get_entities()

The default 'order_by' is 'er.time_created, er.id' DESC

Parameters

array

$options

Options

Returns

\ElggRelationship[]|mixed

See also

elgg_get_entities()

Since

3.2.0

Definition at line 62 of file relationships.php.

elgg_list_entities_from_relationship_count()

elgg_list_entities_from_relationship_count

(

array

$options

)

Returns a list of entities by relationship count.

See also

elgg_get_entities_from_relationship_count()

Parameters

array

$options

Options array

Returns

string

Since

1.8.0

Definition at line 44 of file relationships.php.

elgg_list_relationships()

elgg_list_relationships

(

array

$options

)

Returns a rendered list of relationships with pagination.

Parameters

array

$options

Relationship getter and display options. elgg_get_relationships() and elgg_list_entities().

Returns

string The list of relationships

Since

3.2.0

Definition at line 91 of file relationships.php.