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

Timestamp:

06/12/2015 02:55:33 PM (9 years ago)

Author:

johnjamesjacoby

Message:

Groups: Add $step parameter to bp_is_last_group_creation_step() & bp_is_first_group_creation_step() to allow comparing any step to first & last. Retains default behavior if no step is passed.

This change improves group creation step calculations by enabling simpler comparisons in circumstances where the creation step in question may not be the current one.

File:

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

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

@@ -4778 +4778 @@
  * @since BuddyPress (1.1.0)
  *
- * @return bool True if yes, False if no
- */
-function bp_is_last_group_creation_step() {
+ * @param  string $step Step to compare
+ * @return bool         True if yes, False if no
+ */
+function bp_is_last_group_creation_step( $step = '' ) {
+
+    // Use current step, if no step passed
+    if ( empty( $step ) ) {
+        $step = bp_get_groups_current_create_step();
+    }
+
+    // Get the last step
     $bp     = buddypress();
     $steps  = array_keys( $bp->groups->group_creation_steps );
-    $step   = array_pop( $steps );
-    $retval = ( $step === bp_get_groups_current_create_step() );
+    $l_step = array_pop( $steps );
+
+    // Compare last step to step
+    $retval = ( $l_step === $step );
 
     return (bool) apply_filters( 'bp_is_last_group_creation_step', $retval, $steps, $step );
@@ -4794 +4804 @@
  * @since BuddyPress (1.1.0)
  *
- * @return bool True if yes, False if no
- */
-function bp_is_first_group_creation_step() {
+ * @param  string $step Step to compare
+ * @return bool         True if yes, False if no
+ */
+function bp_is_first_group_creation_step( $step = '' ) {
+
+    // Use current step, if no step passed
+    if ( empty( $step ) ) {
+        $step = bp_get_groups_current_create_step();
+    }
+
+    // Get the first step
     $bp     = buddypress();
     $steps  = array_keys( $bp->groups->group_creation_steps );
-    $step   = array_shift( $steps );
-    $retval = ( $step === bp_get_groups_current_create_step() );
+    $f_step = array_shift( $steps );
+
+    // Compare first step to step
+    $retval = ( $f_step === $step );
 
     return (bool) apply_filters( 'bp_is_first_group_creation_step', $retval, $steps, $step );
@@ -4866 +4886 @@
          *
          * @param array $items Array of friends.
-         */     
+         */
         $invitable_friends = apply_filters( 'bp_get_new_group_invite_friend_list', $items, $r, $args );