Contents

Code Reference Functions friends_record_activity()

friends_record_activity( array|string $args = '' )

Record an activity item related to the Connections component.

Description

A wrapper for bp_activity_add() that provides some Connections-specific defaults.

See also

Parameters

$args

(array|string) (Optional) An array of arguments for the new activity item. Accepts all parameters of bp_activity_add(). The one difference is the following argument, which has a different default here:

  • 'component'
    (string) Default: the id of your Connections component (usually 'friends').

Default value: ''

Return

(WP_Error|bool|int) See bp_activity_add().

Source

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

function friends_record_activity( $args = '' ) {

	if ( ! bp_is_active( 'activity' ) ) {
		return false;
	}

	$r = wp_parse_args( $args, array(
		'user_id'           => bp_loggedin_user_id(),
		'action'            => '',
		'content'           => '',
		'primary_link'      => '',
		'component'         => buddypress()->friends->id,
		'type'              => false,
		'item_id'           => false,
		'secondary_item_id' => false,
		'recorded_time'     => bp_core_current_time(),
		'hide_sitewide'     => false
	) );

	return bp_activity_add( $r );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.0 Introduced.

Uses

Uses
Uses Description
bp-loader.php: buddypress()

The main function responsible for returning the one true BuddyBoss Instance to functions everywhere.
bp-core/bp-core-template.php: bp_is_active()

Check whether a given component (or feature of a component) is active.
bp-core/bp-core-template.php: bp_loggedin_user_id()

Get the ID of the currently logged-in user.
bp-core/bp-core-functions.php: bp_core_current_time()

Get the current GMT time to save into the DB.
bp-activity/bp-activity-functions.php: bp_activity_add()

Add an activity item.

Questions?

We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.