Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
08/31/2015 06:51:35 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Activity component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-activity/bp-activity-akismet.php

    r9843 r10077  
    33 * Akismet support for BuddyPress' Activity Stream.
    44 *
     5 * @since 1.6.0
    56 * @package BuddyPress
    6  * @since BuddyPress (1.6.0)
    7  * @subpackage Activity
     7 * @subpackage ActivityAkismet
    88 */
    99
     
    1414 * Akismet support for the Activity component.
    1515 *
    16  * @since BuddyPress (1.6.0)
    17  * @since BuddyPress (2.3.0) We only support Akismet 3+.
     16 * @since 1.6.0
     17 * @since 2.3.0 We only support Akismet 3+.
    1818 */
    1919class BP_Akismet {
     
    2323     * @access protected
    2424     * @var BP_Activity_Activity
    25      * @since BuddyPress (1.6.0)
     25     * @since 1.6.0
    2626     */
    2727    protected $last_activity = null;
     
    3030     * Constructor.
    3131     *
    32      * @since BuddyPress (1.6.0)
     32     * @since 1.6.0
    3333     */
    3434    public function __construct() {
     
    3939     * Hook Akismet into the activity stream.
    4040     *
    41      * @since BuddyPress (1.6.0)
     41     * @since 1.6.0
    4242     */
    4343    protected function setup_actions() {
     
    7171     * akismet_comment_row_action() function. Thanks!
    7272     *
    73      * @since BuddyPress (1.6.0)
     73     * @since 1.6.0
    7474     *
    7575     * @param array $actions  The hover links.
     
    118118         * Filters the list of actions for the current activity's row.
    119119         *
    120          * @since BuddyPress (1.6.0)
     120         * @since 1.6.0
    121121         *
    122122         * @param array $actions Array of available actions for the current activity item's row.
     
    132132     * by Akismet to help detect spam activity.
    133133     *
    134      * @since BuddyPress (1.6.0)
     134     * @since 1.6.0
    135135     *
    136136     * @see https://plugins.trac.wordpress.org/ticket/1232
     
    161161     * default AJAX implementation; see bp_dtheme_post_update().
    162162     *
    163      * @since BuddyPress (1.6.0)
     163     * @since 1.6.0
    164164     *
    165165     * @see bp_dtheme_post_update()
     
    187187     * This function is intended to be used inside the activity stream loop.
    188188     *
    189      * @since BuddyPress (1.6.0)
     189     * @since 1.6.0
    190190     */
    191191    public function add_activity_spam_button() {
     
    215215     * This function is intended to be used inside the activity stream loop.
    216216     *
    217      * @since BuddyPress (1.6.0)
     217     * @since 1.6.0
    218218     */
    219219    public function add_activity_comment_spam_button() {
     
    242242     * Get a filterable list of activity types that Akismet should automatically check for spam.
    243243     *
    244      * @since BuddyPress (1.6.0)
     244     * @since 1.6.0
    245245     *
    246246     * @static
     
    253253         * Filters the list of activity types that Akismet should automatically check for spam.
    254254         *
    255          * @since BuddyPress (1.6.0)
     255         * @since 1.6.0
    256256         *
    257257         * @param array Array of default activity types for Akismet to check.
     
    263263     * Mark activity item as spam.
    264264     *
    265      * @since BuddyPress (1.6.0)
     265     * @since 1.6.0
    266266     *
    267267     * @param BP_Activity_Activity $activity Activity item being spammed.
     
    277277         * Fires after marking an activity item has been marked as spam.
    278278         *
    279          * @since BuddyPress (1.6.0)
     279         * @since 1.6.0
    280280         *
    281281         * @param BP_Activity_Activity $activity Activity object being marked as spam.
     
    291291     * Mark activity item as ham.
    292292     *
    293      * @since BuddyPress (1.6.0)
     293     * @since 1.6.0
    294294     *
    295295     * @param BP_Activity_Activity $activity Activity item being hammed.
     
    306306         * Fires after marking an activity item has been marked as ham.
    307307         *
    308          * @since BuddyPress (1.6.0)
     308         * @since 1.6.0
    309309         *
    310310         * @param BP_Activity_Activity $activity Activity object being marked as ham.
     
    320320     * Build a data package for the Akismet service to inspect.
    321321     *
    322      * @since BuddyPress (1.6.0)
     322     * @since 1.6.0
    323323     *
    324324     * @see http://akismet.com/development/api/#comment-check
     
    360360         * Filters activity data before being sent to Akismet to inspect.
    361361         *
    362          * @since BuddyPress (1.6.0)
     362         * @since 1.6.0
    363363         *
    364364         * @param array                $activity_data Array of activity data for Akismet to inspect.
     
    371371     * Check if the activity item is spam or ham.
    372372     *
    373      * @since BuddyPress (1.6.0)
     373     * @since 1.6.0
    374374     *
    375375     * @see http://akismet.com/development/api/
     
    404404             * Fires after an activity item has been proven to be spam, but before officially being marked as spam.
    405405             *
    406              * @since BuddyPress (1.6.0)
     406             * @since 1.6.0
    407407             *
    408408             * @param BP_Activity_Activity $activity      The activity item proven to be spam.
     
    423423     * Update activity meta after a manual spam change (user-initiated).
    424424     *
    425      * @since BuddyPress (1.6.0)
     425     * @since 1.6.0
    426426     *
    427427     * @param BP_Activity_Activity $activity The activity to check.
     
    440440     * Update activity meta after a manual ham change (user-initiated).
    441441     *
    442      * @since BuddyPress (1.6.0)
     442     * @since 1.6.0
    443443     *
    444444     * @param BP_Activity_Activity $activity The activity to check.
     
    457457     * Update activity meta after an automatic spam check (not user-initiated).
    458458     *
    459      * @since BuddyPress (1.6.0)
     459     * @since 1.6.0
    460460     *
    461461     * @param BP_Activity_Activity $activity The activity to check.
     
    495495     * Props to WordPress core Akismet plugin for a lot of this.
    496496     *
    497      * @since BuddyPress (1.6.0)
     497     * @since 1.6.0
    498498     *
    499499     * @param array  $activity_data Packet of information to submit to Akismet.
     
    566566     * Filters user agent when sending to Akismet to add BuddyPress info.
    567567     *
    568      * @since BuddyPress (1.6.0)
     568     * @since 1.6.0
    569569     *
    570570     * @param string $user_agent User agent string, as generated by Akismet.
     
    580580     * Adds a "History" meta box to the activity edit screen.
    581581     *
    582      * @since BuddyPress (1.6.0)
     582     * @since 1.6.0
    583583     *
    584584     * @param string $screen_action The type of screen that has been requested.
     
    596596     * History meta box for the Activity admin edit screen.
    597597     *
    598      * @since BuddyPress (1.6.0)
     598     * @since 1.6.0
    599599     *
    600600     * @see https://buddypress.trac.wordpress.org/ticket/3907
     
    617617     * Update an activity item's Akismet history.
    618618     *
    619      * @since BuddyPress (1.6.0)
     619     * @since 1.6.0
    620620     *
    621621     * @param int    $activity_id Activity item ID.
     
    638638     * Get an activity item's Akismet history.
    639639     *
    640      * @since BuddyPress (1.6.0)
     640     * @since 1.6.0
    641641     *
    642642     * @param int $activity_id Activity item ID.
     
    662662 * grow to be quite large.
    663663 *
    664  * @since BuddyPress (1.6.0)
     664 * @since 1.6.0
    665665 *
    666666 * @global wpdb $wpdb WordPress database object.
     
    674674     * Filters the threshold for how many days old Akismet metadata needs to be before being automatically deleted.
    675675     *
    676      * @since BuddyPress (1.6.0)
     676     * @since 1.6.0
    677677     *
    678678     * @param integer 15 How many days old metadata needs to be.
Note: See TracChangeset for help on using the changeset viewer.