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-admin.php

    r10065 r10077  
    66 * help text, on which this implementation is heavily based.
    77 *
     8 * @since 1.6.0
    89 * @package BuddyPress
    9  * @since BuddyPress (1.6.0)
    10  * @subpackage Activity
     10 * @subpackage ActivityAdmin
    1111 */
    1212
     
    2424 * Register the Activity component admin screen.
    2525 *
    26  * @since BuddyPress (1.6)
     26 * @since 1.6.0
    2727 */
    2828function bp_activity_add_admin_menu() {
     
    5050 * adds the Activity page to the array of these menu items.
    5151 *
    52  * @since BuddyPress (1.7.0)
     52 * @since 1.7.0
    5353 *
    5454 * @param array $custom_menus The list of top-level BP menu items.
     
    6868 * table row.
    6969 *
    70  * @since BuddyPress (1.6.0)
     70 * @since 1.6.0
    7171 */
    7272function bp_activity_admin_reply() {
     
    138138 * Handle save/update of screen options for the Activity component admin screen.
    139139 *
    140  * @since BuddyPress (1.6.0)
     140 * @since 1.6.0
    141141 *
    142142 * @param string $value     Will always be false unless another plugin filters it first.
     
    161161 * Hide the advanced edit meta boxes by default, so we don't clutter the screen.
    162162 *
    163  * @since BuddyPress (1.6.0)
     163 * @since 1.6.0
    164164 *
    165165 * @param array     $hidden Array of items to hide.
     
    178178     * Filters default hidden metaboxes so plugins can alter list.
    179179     *
    180      * @since BuddyPress (1.6.0)
     180     * @since 1.6.0
    181181     *
    182182     * @param array     $hidden Default metaboxes to hide.
     
    195195 *   - Catches POST and GET requests related to Activity.
    196196 *
    197  * @since BuddyPress (1.6.0)
     197 * @since 1.6.0
    198198 *
    199199 * @global object                 $bp                     BuddyPress global settings.
     
    213213     * Fires at top of Activity admin page.
    214214     *
    215      * @since BuddyPress (1.6.0)
     215     * @since 1.6.0
    216216     *
    217217     * @param string $doaction Current $_GET action being performed in admin screen.
     
    321321         * Filters list of IDs being spammed/un-spammed/deleted.
    322322         *
    323          * @since BuddyPress (1.6.0)
     323         * @since 1.6.0
    324324         *
    325325         * @param array $activity_ids Activity IDs to spam/un-spam/delete.
     
    413413         * Passes an activity array counts how many were spam, not spam, deleted, and IDs that were errors.
    414414         *
    415          * @since BuddyPress (1.6.0)
     415         * @since 1.6.0
    416416         *
    417417         * @param array  $value        Array holding spam, not spam, deleted counts, error IDs.
     
    438438         * Filters redirect URL after activity spamming/un-spamming/deletion occurs.
    439439         *
    440          * @since BuddyPress (1.6.0)
     440         * @since 1.6.0
    441441         *
    442442         * @param string $redirect_to URL to redirect to.
     
    555555         * Fires before redirect so plugins can do something first on save action.
    556556         *
    557          * @since BuddyPress (1.6.0)
     557         * @since 1.6.0
    558558         *
    559559         * @param array Array holding activity object and ID that holds error.
     
    570570         * Filters URL to redirect to after saving.
    571571         *
    572          * @since BuddyPress (1.6.0)
     572         * @since 1.6.0
    573573         *
    574574         * @param string $redirect_to URL to redirect to.
     
    588588 * Output the Activity component admin screens.
    589589 *
    590  * @since BuddyPress (1.6.0)
     590 * @since 1.6.0
    591591 */
    592592function bp_activity_admin() {
     
    606606 * Display the single activity edit screen.
    607607 *
    608  * @since BuddyPress (1.6.0)
     608 * @since 1.6.0
    609609 */
    610610function bp_activity_admin_edit() {
     
    641641     * Fires before activity edit form is displays so plugins can modify the activity.
    642642     *
    643      * @since BuddyPress (1.6.0)
     643     * @since 1.6.0
    644644     *
    645645     * @param array $value Array holding single activity object that was passed by reference.
     
    703703 * Status metabox for the Activity admin edit screen.
    704704 *
    705  * @since BuddyPress (1.6.0)
     705 * @since 1.6.0
    706706 *
    707707 * @param object $item Activity item.
     
    759759 * Primary link metabox for the Activity admin edit screen.
    760760 *
    761  * @since BuddyPress (1.6.0)
     761 * @since 1.6.0
    762762 *
    763763 * @param object $item Activity item.
     
    776776 * User ID metabox for the Activity admin edit screen.
    777777 *
    778  * @since BuddyPress (1.6.0)
     778 * @since 1.6.0
    779779 *
    780780 * @param object $item Activity item.
     
    794794 * Format is [activity_type] => Pretty name for activity type.
    795795 *
    796  * @since BuddyPress (2.0.0)
     796 * @since 2.0.0
    797797 *
    798798 * @return array
     
    822822 * Activity type metabox for the Activity admin edit screen.
    823823 *
    824  * @since BuddyPress (1.6.0)
     824 * @since 1.6.0
    825825 *
    826826 * @param object $item Activity item.
     
    868868 * Primary item ID/Secondary item ID metabox for the Activity admin edit screen.
    869869 *
    870  * @since BuddyPress (1.6.0)
     870 * @since 1.6.0
    871871 *
    872872 * @param object $item Activity item.
     
    890890 * Display the Activity admin index screen, which contains a list of all the activities.
    891891 *
    892  * @since BuddyPress (1.6.0)
     892 * @since 1.6.0
    893893 *
    894894 * @global BP_Activity_List_Table $bp_activity_list_table Activity screen list table.
     
    958958     * Fires before edit form is displayed so plugins can modify the activity messages.
    959959     *
    960      * @since BuddyPress (1.6.0)
     960     * @since 1.6.0
    961961     *
    962962     * @param array $messages Array of messages to display at top of page.
     
    10241024 * List table class for the Activity component admin page.
    10251025 *
    1026  * @since BuddyPress (1.6.0)
     1026 * @since 1.6.0
    10271027 */
    10281028class BP_Activity_List_Table extends WP_List_Table {
     
    10331033     * e.g. "all", "pending", "approved", "spam"...
    10341034     *
    1035      * @since BuddyPress (1.6.0)
     1035     * @since 1.6.0
    10361036     * @var string
    10371037     */
     
    10411041     * How many activity items have been marked as spam.
    10421042     *
    1043      * @since BuddyPress (1.6.0)
     1043     * @since 1.6.0
    10441044     * @var int
    10451045     */
     
    10491049     * Store activity-to-user-ID mappings for use in the In Response To column.
    10501050     *
    1051      * @since BuddyPress (1.6.0)
     1051     * @since 1.6.0
    10521052     * @var array
    10531053     */
     
    10571057     * If users can comment on blog & forum activity items.
    10581058     *
    1059      * @since BuddyPress (2.2.2)
     1059     * @since 2.2.2
    10601060     *
    10611061     * @link https://buddypress.trac.wordpress.org/ticket/6277
     
    10681068     * Constructor.
    10691069     *
    1070      * @since BuddyPress (1.6.0)
     1070     * @since 1.6.0
    10711071     */
    10721072    public function __construct() {
     
    10871087     * Handle filtering of data, sorting, pagination, and any other data manipulation prior to rendering.
    10881088     *
    1089      * @since BuddyPress (1.6.0)
     1089     * @since 1.6.0
    10901090     */
    10911091    function prepare_items() {
     
    11891189     * Get an array of all the columns on the page.
    11901190     *
    1191      * @since BuddyPress (1.6.0)
     1191     * @since 1.6.0
    11921192     *
    11931193     * @return array Column headers.
     
    12071207     * Get name of default primary column
    12081208     *
    1209      * @since BuddyPress (2.3.3)
     1209     * @since 2.3.3
    12101210     * @access protected
    12111211     *
     
    12191219     * Display a message on screen when no items are found (e.g. no search matches).
    12201220     *
    1221      * @since BuddyPress (1.6.0)
     1221     * @since 1.6.0
    12221222     */
    12231223    function no_items() {
     
    12281228     * Output the Activity data table.
    12291229     *
    1230      * @since BuddyPress (1.6.0)
     1230     * @since 1.6.0
    12311231    */
    12321232    function display() {
     
    12581258     * Generate content for a single row of the table.
    12591259     *
    1260      * @since BuddyPress (1.6.0)
     1260     * @since 1.6.0
    12611261     *
    12621262     * @param object $item The current item.
     
    12871287     * Get the list of views available on this table (e.g. "all", "spam").
    12881288     *
    1289      * @since BuddyPress (1.6.0)
     1289     * @since 1.6.0
    12901290     */
    12911291    function get_views() {
     
    13011301             * Fires inside listing of views so plugins can add their own.
    13021302             *
    1303              * @since BuddyPress (1.6.0)
     1303             * @since 1.6.0
    13041304             *
    13051305             * @param string $url_base Current URL base for view.
     
    13141314     * Get bulk actions.
    13151315     *
    1316      * @since BuddyPress (1.6.0)
     1316     * @since 1.6.0
    13171317     *
    13181318     * @return array Key/value pairs for the bulk actions dropdown.
     
    13271327         * Filters the default bulk actions so plugins can add custom actions.
    13281328         *
    1329          * @since BuddyPress (1.6.0)
     1329         * @since 1.6.0
    13301330         *
    13311331         * @param array $actions Default available actions for bulk operations.
     
    13371337     * Get the table column titles.
    13381338     *
    1339      * @since BuddyPress (1.6.0)
     1339     * @since 1.6.0
    13401340     *
    13411341     * @see WP_List_Table::single_row_columns()
     
    13581358     * Currently, returns an empty array (no columns are sortable).
    13591359     *
    1360      * @since BuddyPress (1.6.0)
     1360     * @since 1.6.0
    13611361     * @todo For this to work, BP_Activity_Activity::get() needs updating
    13621362     *       to support ordering by specific fields.
     
    13751375     * Markup for the "filter" part of the form (i.e. which activity type to display).
    13761376     *
    1377      * @since BuddyPress (1.6.0)
     1377     * @since 1.6.0
    13781378     *
    13791379     * @param string $which 'top' or 'bottom'.
     
    14591459     * Checkbox column markup.
    14601460     *
    1461      * @since BuddyPress (1.6.0)
     1461     * @since 1.6.0
    14621462     *
    14631463     * @see WP_List_Table::single_row_columns()
     
    14721472     * Author column markup.
    14731473     *
    1474      * @since BuddyPress (1.6.0)
     1474     * @since 1.6.0
    14751475     *
    14761476     * @see WP_List_Table::single_row_columns()
     
    14851485     * Action column markup.
    14861486     *
    1487      * @since BuddyPress (2.0.0)
     1487     * @since 2.0.0
    14881488     *
    14891489     * @see WP_List_Table::single_row_columns()
     
    15061506     * Called "comment" in the CSS so we can re-use some WP core CSS.
    15071507     *
    1508      * @since BuddyPress (1.6.0)
     1508     * @since 1.6.0
    15091509     *
    15101510     * @see WP_List_Table::single_row_columns()
     
    15651565         * Filters available actions for plugins to alter.
    15661566         *
    1567          * @since BuddyPress (1.6.0)
     1567         * @since 1.6.0
    15681568         *
    15691569         * @param array $actions Array of available actions user could use.
     
    15841584             * Filters current activity item content.
    15851585             *
    1586              * @since BuddyPress (1.2.0)
     1586             * @since 1.2.0
    15871587             *
    15881588             * @param array $item Array index holding current activity item content.
     
    15931593             * Filters current activity item action.
    15941594             *
    1595              * @since BuddyPress (1.2.0)
     1595             * @since 1.2.0
    15961596             *
    15971597             * @var array $item Array index holding current activity item action.
     
    16061606     * "In response to" column markup.
    16071607     *
    1608      * @since BuddyPress (1.6.0)
     1608     * @since 1.6.0
    16091609     *
    16101610     * @see WP_List_Table::single_row_columns()
     
    16181618         * Filters default list of default root activity types.
    16191619         *
    1620          * @since BuddyPress (1.6.0)
     1620         * @since 1.6.0
    16211621         *
    16221622         * @param array $value Array of default activity types.
     
    16491649     * avoiding duplicate queries.
    16501650     *
    1651      * @since BuddyPress (1.6.0)
     1651     * @since 1.6.0
    16521652     *
    16531653     * @param int $activity_id Activity ID to retrieve User ID for.
     
    16901690     * functions from working as intended.
    16911691     *
    1692      * @since BuddyPress (2.0.0)
     1692     * @since 2.0.0
    16931693     *
    16941694     * @param array $item An array version of the BP_Activity_Activity object.
     
    17421742         * Filters if an activity item can be commented on or not.
    17431743         *
    1744          * @since BuddyPress (2.0.0)
     1744         * @since 2.0.0
    17451745         *
    17461746         * @param bool $can_comment Whether an activity item can be commented on or not.
     
    17551755     * items plus their comments. This method converts it to a flat array.
    17561756     *
    1757      * @since BuddyPress (1.6.0)
     1757     * @since 1.6.0
    17581758     *
    17591759     * @param array $tree Source array.
Note: See TracChangeset for help on using the changeset viewer.