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

Get an excerpt of a group description.


Parameters Parameters

$group

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

Default value: false

$length

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

Default value: 225


Top ↑

Return Return

(string) Excerpt.


Source 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 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 );
	}


Top ↑

Changelog Changelog

Changelog
Version Description
1.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

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