Changeset 9940

Timestamp:

06/12/2015 02:44:08 PM (9 years ago)

Author:

johnjamesjacoby

Message:

Groups: bp_is_last_group_creation_step() & bp_is_first_group_creation_step() improvements:

• Add documentation
• Update to modern coding standards
• Add filters, and pass relevant data through them

File:

• trunk/src/bp-groups/bp-groups-template.php (modified) (1 diff)

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

@@ -4773 +4773 @@
     }
 
+/**
+ * Is the user looking at the last step in the group creation process
+ *
+ * @since BuddyPress (1.1.0)
+ *
+ * @return bool True if yes, False if no
+ */
 function bp_is_last_group_creation_step() {
-    $bp = buddypress();
-
-    $keys      = array_keys( $bp->groups->group_creation_steps );
-    $last_step = array_pop( $keys );
-
-    if ( $last_step == bp_get_groups_current_create_step() ) {
-        return true;
-    }
-
-    return false;
-}
-
+    $bp     = buddypress();
+    $steps  = array_keys( $bp->groups->group_creation_steps );
+    $step   = array_pop( $steps );
+    $retval = ( $step === bp_get_groups_current_create_step() );
+
+    return (bool) apply_filters( 'bp_is_last_group_creation_step', $retval, $steps, $step );
+}
+
+/**
+ * Is the user looking at the first step in the group creation process
+ *
+ * @since BuddyPress (1.1.0)
+ *
+ * @return bool True if yes, False if no
+ */
 function bp_is_first_group_creation_step() {
-    $bp = buddypress();
-
-    $keys       = array_keys( $bp->groups->group_creation_steps );
-    $first_step = array_shift( $keys );
-
-    if ( $first_step == bp_get_groups_current_create_step() ) {
-        return true;
-    }
-
-    return false;
+    $bp     = buddypress();
+    $steps  = array_keys( $bp->groups->group_creation_steps );
+    $step   = array_shift( $steps );
+    $retval = ( $step === bp_get_groups_current_create_step() );
+
+    return (bool) apply_filters( 'bp_is_first_group_creation_step', $retval, $steps, $step );
 }