bp_activity_get_meta( int $activity_id, string $meta_key = '', bool $single = true )

Get metadata for a given activity item.

Parameters Parameters


(int) (Required) ID of the activity item whose metadata is being requested.


(string) (Optional) If present, only the metadata matching that meta key will be returned. Otherwise, all metadata for the activity item will be fetched.

Default value: ''


(bool) (Optional) If true, return only the first value of the specified meta_key. This parameter has no effect if meta_key is not specified. Default: true.

Default value: true

Top ↑

Return Return

(mixed) The meta value(s) being requested.

Source Source

File: bp-activity/bp-activity-functions.php

function bp_activity_get_meta( $activity_id = 0, $meta_key = '', $single = true ) {
	add_filter( 'query', 'bp_filter_metaid_column_name' );
	$retval = get_metadata( 'activity', $activity_id, $meta_key, $single );
	remove_filter( 'query', 'bp_filter_metaid_column_name' );

	 * Filters the metadata for a specified activity item.
	 * @since 1.5.0
	 * @param mixed  $retval      The meta values for the activity item.
	 * @param int    $activity_id ID of the activity item.
	 * @param string $meta_key    Meta key for the value being requested.
	 * @param bool   $single      Whether to return one matched meta key row or all.
	return apply_filters( 'bp_activity_get_meta', $retval, $activity_id, $meta_key, $single );

Top ↑

Changelog Changelog

Version Description
1.2.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.