Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/27/2015 05:25:02 AM (9 years ago)
Author:
tw2113
Message:

Standardizing our @since tags for the Groups Component.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-groups/bp-groups-admin.php

    r10131 r10148  
    66 * help text, on which this implementation is heavily based.
    77 *
     8 * @since 1.7.0
     9 *
    810 * @package BuddyPress
    9  * @since BuddyPress (1.7.0)
    1011 * @subpackage Groups
    1112 */
    1213
    13 // Exit if accessed directly
     14// Exit if accessed directly.
    1415defined( 'ABSPATH' ) || exit;
    1516
    16 // Include WP's list table class
     17// Include WP's list table class.
    1718if ( !class_exists( 'WP_List_Table' ) ) require( ABSPATH . 'wp-admin/includes/class-wp-list-table.php' );
    1819
     
    2425 * Register the Groups component admin screen.
    2526 *
    26  * @since BuddyPress (1.7.0)
     27 * @since 1.7.0
    2728 */
    2829function bp_groups_add_admin_menu() {
     
    4950 * main Dashboard menu.
    5051 *
    51  * @since BuddyPress (1.7.0)
     52 * @since 1.7.0
    5253 *
    5354 * @param array $custom_menus Array of BP top-level menu items.
     
    6869 * setting up screen options.
    6970 *
    70  * @since BuddyPress (1.7.0)
     71 * @since 1.7.0
    7172 *
    7273 * @global BP_Groups_List_Table $bp_groups_list_table Groups screen list table.
     
    8687     * Fires at top of groups admin page.
    8788     *
    88      * @since BuddyPress (1.7.0)
     89     * @since 1.7.0
    8990     *
    9091     * @param string $doaction Current $_GET action being performed in admin screen.
     
    137138         * Fires after the registration of all of the default group meta boxes.
    138139         *
    139          * @since BuddyPress (1.7.0)
     140         * @since 1.7.0
    140141         */
    141142        do_action( 'bp_groups_admin_meta_boxes' );
     
    241242         * Filters the allowed status values for the group.
    242243         *
    243          * @since BuddyPress (1.0.2)
     244         * @since 1.0.2
    244245         *
    245246         * @param array $value Array of allowed group statuses.
     
    251252         * Filters the allowed invite status values for the group.
    252253         *
    253          * @since BuddyPress (1.5.0)
     254         * @since 1.5.0
    254255         *
    255256         * @param array $value Array of allowed invite statuses.
     
    375376         * Fires before redirect so plugins can do something first on save action.
    376377         *
    377          * @since BuddyPress (1.6.0)
     378         * @since 1.6.0
    378379         *
    379380         * @param int $group_id ID of the group being edited.
     
    414415         * Filters the URL to redirect to after successfully editing a group.
    415416         *
    416          * @since BuddyPress (1.7.0)
     417         * @since 1.7.0
    417418         *
    418419         * @param string $redirect_to URL to redirect user to.
     
    432433 * Handle save/update of screen options for the Groups component admin screen.
    433434 *
    434  * @since BuddyPress (1.7.0)
     435 * @since 1.7.0
    435436 *
    436437 * @param string $value     Will always be false unless another plugin filters it first.
     
    455456 * Select the appropriate Groups admin screen, and output it.
    456457 *
    457  * @since BuddyPress (1.7.0)
     458 * @since 1.7.0
    458459 */
    459460function bp_groups_admin() {
     
    478479 * Display the single groups edit screen.
    479480 *
    480  * @since BuddyPress (1.7.0)
     481 * @since 1.7.0
    481482 */
    482483function bp_groups_admin_edit() {
     
    560561     * Useful for plugins to modify the group before display.
    561562     *
    562      * @since BuddyPress (1.7.0)
     563     * @since 1.7.0
    563564     *
    564565     * @param BP_Groups_Group $this Instance of the current group being edited. Passed by reference.
     
    636637 * irreversible.
    637638 *
    638  * @since BuddyPress (1.7.0)
     639 * @since 1.7.0
    639640 */
    640641function bp_groups_admin_delete() {
     
    688689 * This screen contains a list of all BuddyPress groups.
    689690 *
    690  * @since BuddyPress (1.7.0)
     691 * @since 1.7.0
    691692 *
    692693 * @global BP_Groups_List_Table $bp_groups_list_table Group screen list table.
     
    715716     * Useful for plugins to modify the messages before display.
    716717     *
    717      * @since BuddyPress (1.7.0)
     718     * @since 1.7.0
    718719     *
    719720     * @param array $messages Array of messages to be displayed.
     
    757758 * Markup for the single group's Settings metabox.
    758759 *
    759  * @since BuddyPress (1.7.0)
     760 * @since 1.7.0
    760761 *
    761762 * @param object $item Information about the current group.
     
    801802 * Output the markup for a single group's Add New Members metabox.
    802803 *
    803  * @since BuddyPress (1.7.0)
     804 * @since 1.7.0
    804805 */
    805806function bp_groups_admin_edit_metabox_add_new_members( $item ) {
     
    815816 * Renders the Members metabox on single group pages.
    816817 *
    817  * @since BuddyPress (1.7.0)
     818 * @since 1.7.0
    818819 *
    819820 * @param BP_Groups_Group $item The BP_Groups_Group object for the current group.
     
    938939                                 * Fires after the listing of a single row for members in a group on the group edit screen.
    939940                                 *
    940                                  * @since BuddyPress (1.8.0)
     941                                 * @since 1.8.0
    941942                                 *
    942943                                 * @param int             $ID   ID of the user being rendered.
     
    971972 * Renders the Status metabox for the Groups admin edit screen.
    972973 *
    973  * @since BuddyPress (1.7.0)
     974 * @since 1.7.0
    974975 *
    975976 * @param object $item Information about the currently displayed group.
     
    10061007 * deprecated soon.
    10071008 *
    1008  * @since BuddyPress (1.8.0)
     1009 * @since 1.8.0
    10091010 *
    10101011 * @param BP_Group_Member_Query $query       A BP_Group_Member_Query object.
     
    10641065 * Get a set of usernames corresponding to a set of user IDs.
    10651066 *
    1066  * @since BuddyPress (1.7.0)
     1067 * @since 1.7.0
    10671068 *
    10681069 * @param array $user_ids Array of user IDs.
     
    10851086 * AJAX handler for group member autocomplete requests.
    10861087 *
    1087  * @since BuddyPress (1.7.0)
     1088 * @since 1.7.0
    10881089 */
    10891090function bp_groups_admin_autocomplete_handler() {
     
    11281129 * List table class for the Groups component admin page.
    11291130 *
    1130  * @since BuddyPress (1.7.0)
     1131 * @since 1.7.0
    11311132 */
    11321133class BP_Groups_List_Table extends WP_List_Table {
     
    11371138     * e.g. "All", "Pending", "Approved", "Spam"...
    11381139     *
    1139      * @since BuddyPress (1.7.0)
     1140     * @since 1.7.0
    11401141     *
    11411142     * @access public
     
    11471148     * Group counts for each group type.
    11481149     *
    1149      * @since BuddyPress (1.7.0)
     1150     * @since 1.7.0
    11501151     *
    11511152     * @access public
     
    11651166     * Constructor
    11661167     *
    1167      * @since BuddyPress (1.7.0)
     1168     * @since 1.7.0
    11681169     */
    11691170    public function __construct() {
     
    11831184     * manipulation required prior to rendering.
    11841185     *
    1185      * @since BuddyPress (1.7.0)
     1186     * @since 1.7.0
    11861187     */
    11871188    public function prepare_items() {
     
    12881289     * Get an array of all the columns on the page.
    12891290     *
    1290      * @since BuddyPress (1.7.0)
     1291     * @since 1.7.0
    12911292     *
    12921293     * @return array Array of column headers.
     
    13061307     * Get name of default primary column
    13071308     *
    1308      * @since BuddyPress (2.3.3)
     1309     * @since 2.3.3
    13091310     * @access protected
    13101311     *
     
    13191320     * Display a message on screen when no items are found ("No groups found").
    13201321     *
    1321      * @since BuddyPress (1.7.0)
     1322     * @since 1.7.0
    13221323     */
    13231324    public function no_items() {
     
    13281329     * Output the Groups data table.
    13291330     *
    1330      * @since BuddyPress (1.7.0)
     1331     * @since 1.7.0
    13311332    */
    13321333    public function display() {
     
    13581359     * Generate content for a single row of the table.
    13591360     *
    1360      * @since BuddyPress (1.7.0)
     1361     * @since 1.7.0
    13611362     *
    13621363     * @param object|array $item The current group item in the loop.
     
    13761377         * Filters the classes applied to a single row in the groups list table.
    13771378         *
    1378          * @since BuddyPress (1.9.0)
     1379         * @since 1.9.0
    13791380         *
    13801381         * @param array  $row_classes Array of classes to apply to the row.
     
    13941395     * Get the list of views available on this table (e.g. "all", "public").
    13951396     *
    1396      * @since BuddyPress (1.7.0)
     1397     * @since 1.7.0
    13971398     */
    13981399    public function get_views() {
     
    14101411             * Fires inside listing of views so plugins can add their own.
    14111412             *
    1412              * @since BuddyPress (1.7.0)
     1413             * @since 1.7.0
    14131414             *
    14141415             * @param string $url_base Current URL base for view.
     
    14231424     * Get bulk actions for single group row.
    14241425     *
    1425      * @since BuddyPress (1.7.0)
     1426     * @since 1.7.0
    14261427     *
    14271428     * @return array Key/value pairs for the bulk actions dropdown.
     
    14321433         * Filters the list of bulk actions to display on a single group row.
    14331434         *
    1434          * @since BuddyPress (1.7.0)
     1435         * @since 1.7.0
    14351436         *
    14361437         * @param array $value Array of bulk actions to display.
     
    14441445     * Get the table column titles.
    14451446     *
    1446      * @since BuddyPress (1.7.0)
     1447     * @since 1.7.0
    14471448     *
    14481449     * @see WP_List_Table::single_row_columns()
     
    14551456         * Filters the titles for the columns for the groups list table.
    14561457         *
    1457          * @since BuddyPress (2.0.0)
     1458         * @since 2.0.0
    14581459         *
    14591460         * @param array $value Array of slugs and titles for the columns.
     
    14811482     * $desc_first = false.
    14821483     *
    1483      * @since BuddyPress (1.7.0)
     1484     * @since 1.7.0
    14841485     *
    14851486     * @return array Array of sortable column names.
     
    15281529     * Markup for the Checkbox column.
    15291530     *
    1530      * @since BuddyPress (1.7.0)
     1531     * @since 1.7.0
    15311532     *
    15321533     * @see WP_List_Table::single_row_columns()
     
    15411542     * Markup for the Group ID column.
    15421543     *
    1543      * @since BuddyPress (1.7.0)
     1544     * @since 1.7.0
    15441545     *
    15451546     * @see WP_List_Table::single_row_columns()
     
    15561557     * Called "comment" in the CSS so we can re-use some WP core CSS.
    15571558     *
    1558      * @since BuddyPress (1.7.0)
     1559     * @since 1.7.0
    15591560     *
    15601561     * @see WP_List_Table::single_row_columns()
     
    15831584         * Filters the group name for a group's column content.
    15841585         *
    1585          * @since BuddyPress (1.7.0)
     1586         * @since 1.7.0
    15861587         *
    15871588         * @param string $value Name of the group being rendered.
     
    16041605         * Filters the actions that will be shown for the column content.
    16051606         *
    1606          * @since BuddyPress (1.7.0)
     1607         * @since 1.7.0
    16071608         *
    16081609         * @param array $value Array of actions to be displayed for the column content.
     
    16351636     * Markup for the Description column.
    16361637     *
    1637      * @since BuddyPress (1.7.0)
     1638     * @since 1.7.0
    16381639     *
    16391640     * @param array $item Information about the current row.
     
    16441645         * Filters the markup for the Description column.
    16451646         *
    1646          * @since BuddyPress (1.0.0)
     1647         * @since 1.0.0
    16471648         *
    16481649         * @param string $value Markup for the Description column.
     
    16551656     * Markup for the Status column.
    16561657     *
    1657      * @since BuddyPress (1.7.0)
     1658     * @since 1.7.0
    16581659     *
    16591660     * @param array $item Information about the current row.
     
    16801681         * Filters the markup for the Status column.
    16811682         *
    1682          * @since BuddyPress (1.7.0)
     1683         * @since 1.7.0
    16831684         *
    16841685         * @param string $status_desc Markup for the Status column.
     
    16911692     * Markup for the Number of Members column.
    16921693     *
    1693      * @since BuddyPress (1.7.0)
     1694     * @since 1.7.0
    16941695     *
    16951696     * @param array $item Information about the current row.
     
    17011702         * Filters the markup for the number of Members column.
    17021703         *
    1703          * @since BuddyPress (1.7.0)
     1704         * @since 1.7.0
    17041705         *
    17051706         * @param int   $count Markup for the number of Members column.
     
    17121713     * Markup for the Last Active column.
    17131714     *
    1714      * @since BuddyPress (1.7.0)
     1715     * @since 1.7.0
    17151716     *
    17161717     * @param array $item Information about the current row.
     
    17221723         * Filters the markup for the Last Active column.
    17231724         *
    1724          * @since BuddyPress (1.7.0)
     1725         * @since 1.7.0
    17251726         *
    17261727         * @param string $last_active Markup for the Last Active column.
     
    17331734     * Allow plugins to add their custom column.
    17341735     *
    1735      * @since BuddyPress (2.0.0)
     1736     * @since 2.0.0
    17361737     *
    17371738     * @param array  $item        Information about the current row.
     
    17451746         * Filters a string to allow plugins to add custom column content.
    17461747         *
    1747          * @since BuddyPress (2.0.0)
     1748         * @since 2.0.0
    17481749         *
    17491750         * @param string $value       Empty string.
Note: See TracChangeset for help on using the changeset viewer.