Changeset 10020

Timestamp:

07/19/2015 09:09:05 PM (9 years ago)

Author:

tw2113

Message:

Adds hooks documentation to new hooks for BuddyPress 2.4.0.

See #5943.

File:

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

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

@@ -4791 +4791 @@
          * @since BuddyPress (1.1.0)
          *
-         * @param string $value Permalink for the previous step.
+         * @param string $url Permalink for the previous step.
          */
         return apply_filters( 'bp_get_group_creation_previous_link', $url );
@@ -4835 +4835 @@
 
 /**
- * Is the user looking at the last step in the group creation process
+ * Is the user looking at the last step in the group creation process.
  *
  * @since BuddyPress (1.1.0)
@@ -4857 +4857 @@
     $retval = ( $l_step === $step );
 
+    /**
+     * Filters whether or not user is looking at last step in group creation process.
+     *
+     * @since BuddyPress (2.4.0)
+     *
+     * @param bool   $retval Whether or not we are looking at last step.
+     * @param array  $steps  Array of steps from the group creation process.
+     * @param string $step   Step to compare.
+     */
     return (bool) apply_filters( 'bp_is_last_group_creation_step', $retval, $steps, $step );
 }
@@ -4883 +4892 @@
     $retval = ( $f_step === $step );
 
+    /**
+     * Filters whether or not user is looking at first step in group creation process.
+     *
+     * @since BuddyPress (2.4.0)
+     *
+     * @param bool   $retval Whether or not we are looking at first step.
+     * @param array  $steps  Array of steps from the group creation process.
+     * @param string $step   Step to compare.
+     */
     return (bool) apply_filters( 'bp_is_first_group_creation_step', $retval, $steps, $step );
 }