Changeset 9942

Timestamp:

06/12/2015 03:09:17 PM (9 years ago)

Author:

johnjamesjacoby

Message:

Groups: bp_get_group_creation_previous_link() improvements

• Add documentation
• Use modern coding standards
• Move URL creation out of apply_filters() call to improve readability
• Escape output of bp_group_creation_previous_link() with esc_url()

This change improves the readibility of the code used to generate the URL to the previous group creation step, and also ensures the URL is properly escaped when output (in the event the return value is intercepted with otherwise unpredictable results.)

File:

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

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

@@ -4711 +4711 @@
     }
 
+/**
+ * Escape & output the URL to the previous group creation step
+ *
+ * @since BuddyPress (1.1.0)
+ */
 function bp_group_creation_previous_link() {
-    echo bp_get_group_creation_previous_link();
-}
+    echo esc_url( bp_get_group_creation_previous_link() );
+}
+    /**
+     * Return the URL to the previous group creation step
+     *
+     * @since BuddyPress (1.1.0)
+     *
+     * @return string
+     */
     function bp_get_group_creation_previous_link() {
-        $bp = buddypress();
-
-        foreach ( (array) $bp->groups->group_creation_steps as $slug => $name ) {
+        $bp    = buddypress();
+        $steps = array_keys( $bp->groups->group_creation_steps );
+
+        // Loop through steps
+        foreach ( $steps as $slug ) {
+
+            // Break when the current step is found
             if ( bp_is_action_variable( $slug ) ) {
                 break;
             }
 
+            // Add slug to previous steps
             $previous_steps[] = $slug;
         }
 
+        // Generate the URL for the previous step
+        $group_directory = bp_get_groups_directory_permalink();
+        $create_step     = 'create/step/';
+        $previous_step   = array_pop( $previous_steps );
+        $url             = trailingslashit( $group_directory . $create_step . $previous_step );
+
         /**
          * Filters the permalink for the previous step with the group creation process.
@@ -4732 +4755 @@
          * @param string $value Permalink for the previous step.
          */
-        return apply_filters( 'bp_get_group_creation_previous_link', trailingslashit( bp_get_groups_directory_permalink() . 'create/step/' . array_pop( $previous_steps ) ) );
+        return apply_filters( 'bp_get_group_creation_previous_link', $url );
     }