Changeset 9086

Timestamp:

10/18/2014 11:33:26 AM (10 years ago)

Author:

boonebgorges

Message:

Hook documentation for bp-activity-akismet.php and bp-activity-cssjs.php.

Props tw2113.
See #5938.

Location:

trunk/src/bp-activity

Files:

• bp-activity-akismet.php (modified) (7 diffs)
• bp-activity-cssjs.php (modified) (1 diff)

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

@@ -113 +113 @@
             echo '<span class="akismet-status"><a href="' . esc_url( bp_get_admin_url( 'admin.php?page=bp-activity&amp;action=edit&aid=' . $activity['id'] ) ) . '#bp_activity_history">' . htmlspecialchars( $desc ) . '</a></span>';
 
+        /**
+         * Filters the list of actions for the current activity's row.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array $actions Array of available actions for the current activity item's row.
+         */
         return apply_filters( 'bp_akismet_comment_row_action', $actions );
     }
@@ -240 +247 @@
      */
     public static function get_activity_types() {
+
+        /**
+         * Filters the list of activity types that Akismet should automatically check for spam.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array Array of default activity types for Akismet to check.
+         */
         return apply_filters( 'bp_akismet_get_activity_types', array( 'activity_comment', 'activity_update' ) );
     }
@@ -255 +270 @@
         $this->last_activity = $activity;
 
+        /**
+         * Fires after marking an activity item has been marked as spam.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param BP_Activity_Activity $activity Activity object being marked as spam.
+         * @param string $source Source of the whom marked as spam. Either "by_a_person" (e.g. a person has manually marked the activity as spam) or "by_akismet".
+         */
         do_action( 'bp_activity_akismet_mark_as_spam', $activity, $source );
     }
@@ -271 +294 @@
             $activity->content = bp_activity_at_name_filter( $activity->content, $activity->id );
 
+        /**
+         * Fires after marking an activity item has been marked as ham.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param BP_Activity_Activity $activity Activity object being marked as ham.
+         * @param string $source Source of the whom marked as ham. Either "by_a_person" (e.g. a person has manually marked the activity as ham) or "by_akismet" (automatically hammed).
+         */
         do_action( 'bp_activity_akismet_mark_as_ham', $activity, $source );
     }
@@ -312 +343 @@
             $activity_data['akismet_comment_nonce'] = wp_verify_nonce( $_POST["_bp_as_nonce_{$activity->secondary_item_id}"], "_bp_as_nonce_{$userdata->ID}_{$activity->secondary_item_id}" ) ? 'passed' : 'failed';
 
+        /**
+         * Filters activity data before being sent to Akismet to inspect.
+         *
+         * @since BuddyPress (1.6.0)
+         *
+         * @param array $activity_data Array of activity data for Akismet to inspect.
+         * @param BP_Activity_Activity $activity Activity item data.
+         */
         return apply_filters( 'bp_akismet_build_akismet_data_package', $activity_data, $activity );
     }
@@ -348 +387 @@
         // Spam
         if ( 'true' == $activity_data['bp_as_result'] ) {
-            // Action for plugin authors
+            /**
+             * Fires after an activity item has been proven to be spam, but before officially being marked as spam.
+             *
+             * @since BuddyPress (1.6.0)
+             *
+             * @param BP_Activity_Activity $activity The activity item proven to be spam.
+             * @param array $activity_data Array of activity data for item including Akismet check results data.
+             */
             do_action_ref_array( 'bp_activity_akismet_spam_caught', array( &$activity, $activity_data ) );
 
@@ -615 +661 @@
     global $bp, $wpdb;
 
+    /**
+     * Filters the threshold for how many days old Akismet metadata needs to be before being automatically deleted.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param integer 15 How many days old metadata needs to be.
+     */
     $interval = apply_filters( 'bp_activity_akismet_delete_meta_interval', 15 );
 

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

@@ -42 +42 @@
     }
 
-    // Print a list of the current user's friends to the page for quicker @mentions lookups.
+    /**
+     * Fires at the end of the Activity Mentions script.
+     *
+     * This is the hook where BP components can add their own prefetched results
+     * friends to the page for quicker @mentions lookups.
+     *
+     * @since BuddyPress (2.1.0)
+     */
     do_action( 'bp_activity_mentions_prime_results' );
 }