Changeset 9265

Timestamp:

12/24/2014 02:26:30 AM (10 years ago)

Author:

tw2113

Message:

Add hook documentation in admin/bp-memmbers-classes.php.

Props tw2113.
See #5944.

File:

• trunk/src/bp-members/admin/bp-members-classes.php (modified) (7 diffs)

trunk/src/bp-members/admin/bp-members-classes.php

@@ -121 +121 @@
      */
     public function get_columns() {
+
+        /**
+         * Filters the single site Members signup columns.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param array $value Array of columns to display.
+         */
         return apply_filters( 'bp_members_signup_columns', array(
             'cb'         => '<input type="checkbox" />',
@@ -278 +286 @@
         }
 
+        /**
+         * Filters the multisite row actions for each user in list.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param array  $actions       Array of actions and corresponding links.
+         * @param object $signup_object The signup data object.
+         */
         $actions = apply_filters( 'bp_members_ms_signup_row_actions', $actions, $signup_object );
 
@@ -337 +353 @@
 
     /**
-     * Allow plugins to add their costum column.
-     *
-     * @since BuddyPress 2.1.0
+     * Allow plugins to add their custom column.
+     *
+     * @since BuddyPress (2.1.0)
      *
      * @param object $signup_object The signup data object.
@@ -345 +361 @@
      */
     function column_default( $signup_object = null, $column_name = '' ) {
+
+        /**
+         * Filters the single site custom columns for plugins.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param string $column_name   The column name.
+         * @param object $signup_object The signup data object.
+         */
         return apply_filters( 'bp_members_signup_custom_column', '', $column_name, $signup_object );
     }
@@ -449 +474 @@
      */
     public function get_columns() {
+
+        /**
+         * Filters the multisite Members signup columns.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param array $value Array of columns to display.
+         */
         return apply_filters( 'bp_members_ms_signup_columns', array(
             'cb'         => '<input type="checkbox" />',
@@ -601 +634 @@
         }
 
+        /** This filter is documented in bp-members/admin/bp-members-classes.php */
         $actions = apply_filters( 'bp_members_ms_signup_row_actions', $actions, $signup_object );
 
@@ -682 +716 @@
      */
     function column_default( $signup_object = null, $column_name = '' ) {
+
+        /**
+         * Filters the multisite custom columns for plugins.
+         *
+         * @since BuddyPress (2.1.0)
+         *
+         * @param string $column_name   The column name.
+         * @param object $signup_object The signup data object.
+         */
         return apply_filters( 'bp_members_ms_signup_custom_column', '', $column_name, $signup_object );
     }