Changeset 9078

Timestamp:

10/11/2014 01:08:07 AM (10 years ago)

Author:

boonebgorges

Message:

Add hook documentation to bp-activity-admin.php.

Props tw2113.
See #5938.

File:

• trunk/src/bp-activity/bp-activity-admin.php (modified) (15 diffs)

trunk/src/bp-activity/bp-activity-admin.php

@@ -172 +172 @@
     $hidden  = array_merge( (array) $hidden, array( 'bp_activity_itemids', 'bp_activity_link', 'bp_activity_type', 'bp_activity_userid', ) );
 
+    /**
+     * Filters default hidden metaboxes so plugins can alter list.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param array     $hidden Default metaboxes to hide.
+     * @param WP_Screen $screen Screen identifier.
+     */
     return apply_filters( 'bp_hide_meta_boxes', array_unique( $hidden ), $screen );
 }
@@ -199 +207 @@
     $doaction = bp_admin_list_table_current_bulk_action();
 
-    // Call an action for plugins to hook in early
+    /**
+     * Fires at top of Activity admin page.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param string $doaction Current $_GET action being performed in admin screen.
+     */
     do_action( 'bp_activity_admin_load', $doaction );
 
@@ -301 +315 @@
         $activity_ids = array_map( 'absint', (array) $_REQUEST['aid'] );
 
-        // Call a filter for plugins to modify the requested activities to load
+        /**
+         * Filters list of IDs being spammed/un-spammed/deleted.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array $activity_ids Activity IDs to spam/un-spam/delete.
+         */
         $activity_ids = apply_filters( 'bp_activity_admin_action_activity_ids', $activity_ids );
 
@@ -385 +405 @@
         }
 
-        // Call actions for plugins to do something before we redirect
+        /**
+         * Fires before redirect for plugins to do something with activity.
+         *
+         * Passes an activity array counts how many were spam, not spam, deleted, and IDs that were errors.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array  Array holding spam, not spam, deleted counts, error IDs.
+         * @param string $redirect_to URL to redirect to.
+         * @param array  $activity_ids Original array of activity IDs.
+         */
         do_action( 'bp_activity_admin_action_after', array( $spammed, $unspammed, $deleted, $errors ), $redirect_to, $activity_ids );
 
@@ -402 +432 @@
             $redirect_to = add_query_arg( 'error', implode ( ',', array_map( 'absint', $errors ) ), $redirect_to );
 
-        // Redirect
+        /**
+         * Filters redirect URL after activty spamming/un-spamming/deletion occurs.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param string $redirect_to URL to redirect to.
+         */
         wp_redirect( apply_filters( 'bp_activity_admin_action_redirect', $redirect_to ) );
         exit;
@@ -513 +549 @@
             $error = $activity->id;
 
-        // Call actions for plugins to do something before we redirect
+        /**
+         * Fires before redirect so plugins can do something first on save action.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array Array holding activity object and ID that holds error.
+         */
         do_action_ref_array( 'bp_activity_admin_edit_after', array( &$activity, $error ) );
 
@@ -522 +564 @@
             $redirect_to = add_query_arg( 'updated', (int) $activity->id, $redirect_to );
 
-        // Redirect
+        /**
+         * Filters URL to redirect to after saving.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param string $redirect_to URL to redirect to.
+         */
         wp_redirect( apply_filters( 'bp_activity_admin_edit_redirect', $redirect_to ) );
         exit;
@@ -587 +635 @@
     $form_url = add_query_arg( 'action', 'save', $form_url );
 
-    // Call an action for plugins to modify the activity before we display the edit form
+    /**
+     * Fires before activity edit form is displays so plugins can modify the activity.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param array Array holding single activity object.
+     */
     do_action_ref_array( 'bp_activity_admin_edit', array( &$activity ) ); ?>
 
@@ -901 +955 @@
     $bp_activity_list_table->prepare_items();
 
-    // Call an action for plugins to modify the activity before we display the edit form
+    /**
+     * Fires before edit form is displayed so plugins can modify the activity messages.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param array $messages Array of messages to display at top of page.
+     */
     do_action( 'bp_activity_admin_index', $messages ); ?>
 
@@ -1212 +1272 @@
             <li class="spam"><a href="<?php echo esc_attr( esc_url( add_query_arg( 'activity_status', 'spam', $url_base ) ) ); ?>" class="<?php if ( 'spam' == $this->view ) echo 'current'; ?>"><?php printf( __( 'Spam <span class="count">(%s)</span>', 'buddypress' ), number_format_i18n( $this->spam_count ) ); ?></a></li>
 
-            <?php do_action( 'bp_activity_list_table_get_views', $url_base, $this->view ); ?>
+            <?php
+
+            /**
+             * Fires inside listing of views so plugins can add their own.
+             *
+             * @since BuddyPress (1.6.0)
+             *
+             * @param string $url_base Current URL base for view.
+             * @param string $view Current view being displayed.
+             */
+            do_action( 'bp_activity_list_table_get_views', $url_base, $this->view ); ?>
         </ul>
     <?php
@@ -1230 +1300 @@
         $actions['bulk_delete'] = __( 'Delete Permanently', 'buddypress' );
 
+        /**
+         * Filters the default bulk actions so plugins can add custom actions.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array $actions Default available actions for bulk operations.
+         */
         return apply_filters( 'bp_activity_list_table_get_bulk_actions', $actions );
     }
@@ -1430 +1507 @@
         echo '<div class="submitted-on">';
 
-        // Other plugins can filter which actions are shown
+        /**
+         * Filters available actions for plugins to alter.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array $actions Array of available actions user could use.
+         * @param array $item Current item being added to page.
+         */
         $actions = apply_filters( 'bp_activity_admin_comment_row_actions', array_filter( $actions ), $item );
 
@@ -1441 +1525 @@
         // Get activity content - if not set, use the action
         if ( ! empty( $item['content'] ) ) {
+
+            /**
+             * Filters current activity item content.
+             *
+             * @since BuddyPress (1.2.0)
+             *
+             * @param array $item Array index holding current activity item content.
+             */
             $content = apply_filters_ref_array( 'bp_get_activity_content_body', array( $item['content'] ) );
         } else {
+            /**
+             * Filters current activity item action.
+             *
+             * @since BuddyPress (1.2.0)
+             *
+             * @var array $item Array index holding current activity item action.
+             */
             $content = apply_filters_ref_array( 'bp_get_activity_action', array( $item['action'] ) );
         }
@@ -1460 +1559 @@
     function column_response( $item ) {
         // Is $item is a root activity?
+
+        /**
+         * Filters default list of default root activity types.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array Array of default activity types.
+         * @param array $item Current item being displayed.
+         */
         if ( empty( $item['item_id'] ) || ! in_array( $item['type'], apply_filters( 'bp_activity_admin_root_activity_types', array( 'activity_comment' ), $item ) ) ) {
             $comment_count     = !empty( $item['children'] ) ? bp_activity_recurse_comment_count( (object) $item ) : 0;
@@ -1574 +1682 @@
         }
 
+        /**
+         * Filters if an activity item can be commented on or not.
+         *
+         * @since BuddyPress (2.0.0)
+         *
+         * @param bool $can_comment Whether an activity item can be commented on or not.
+         */
         return apply_filters( 'bp_activity_list_table_can_comment', $can_comment );
     }