Contents

Code Reference Functions bp_get_group_description_excerpt()

bp_get_group_description_excerpt( object|bool $group = false, int $length = 225 )

Get an excerpt of a group description.

Description

Parameters

$group

(Optional) The group being referenced. Defaults to the group currently being iterated on in the groups loop.

Default value: false

$length

(Optional) Length of returned string, including ellipsis. Default: 225.

Default value: 225

Return

(string) Excerpt.

Source

File: bp-groups/bp-groups-template.php 

	function bp_get_group_description_excerpt( $group = false, $length = 225 ) {
		global $groups_template;

		if ( empty( $group ) ) {
			$group =& $groups_template->group;
		}

		/**
		 * Filters the excerpt of a group description.
		 *
		 * @since BuddyPress 1.0.0
		 *
		 * @param string $value Excerpt of a group description.
		 * @param object $group Object for group whose description is made into an excerpt.
		 */
		return apply_filters( 'bp_get_group_description_excerpt', bp_create_excerpt( $group->description, $length ), $group );
	}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 1.0.0 Introduced.

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.