Changeset 11531 for trunk/src/bp-groups/bp-groups-template.php

Timestamp:

04/15/2017 09:12:41 AM (7 years ago)

Author:

hnla

Message:

Update bp_group_description_excerpt() to take a $length param

bp_create_excerpt() excepts a $length param however the group desc excerpt function does not pass this param only $group.

Commit adds the $length param to function, ensuring passed order is preserved (this param will be used in Nouveau for group grid layouts).

Fixes #7493
Props hnla, dcavins

File:

• trunk/src/bp-groups/bp-groups-template.php (modified) (3 diffs)

trunk/src/bp-groups/bp-groups-template.php

@@ -1209 +1209 @@
  * @since 1.0.0
  *
- * @param object|bool $group Optional. The group being referenced.
- *                           Defaults to the group currently being
- *                           iterated on in the groups loop.
- */
-function bp_group_description_excerpt( $group = false ) {
-    echo bp_get_group_description_excerpt( $group );
+ * @param object|bool $group  Optional. The group being referenced.
+ *                            Defaults to the group currently being
+ *                            iterated on in the groups loop.
+ * @param int         $length Optional. Length of returned string, including ellipsis.
+ *                            Default: 225.
+ */
+function bp_group_description_excerpt( $group = false, $length = false ) {
+    echo bp_get_group_description_excerpt( $group, $length );
 }
     /**
@@ -1221 +1223 @@
      * @since 1.0.0
      *
-     * @param object|bool $group Optional. The group being referenced.
-     *                           Defaults to the group currently being
-     *                           iterated on in the groups loop.
+     * @param object|bool $group  Optional. The group being referenced.
+     *                            Defaults to the group currently being
+     *                            iterated on in the groups loop.
+     * @param int         $length Optional. Length of returned string, including ellipsis.
+     *                            Default: 225.
      * @return string Excerpt.
      */
-    function bp_get_group_description_excerpt( $group = false ) {
+    function bp_get_group_description_excerpt( $group = false, $length = false ) {
         global $groups_template;
 
@@ -1241 +1245 @@
          * @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 ), $group );
+        return apply_filters( 'bp_get_group_description_excerpt', bp_create_excerpt( $group->description, $length ), $group );
     }