Skip to:
Content

BuddyPress.org


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

Standardizing our @since tags for the Members Component.

See #6576.

File:
1 edited

Legend:

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

    r10026 r10149  
    11<?php
    2 
    32/**
    43 * BuddyPress Members List Classes
     
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
     
    1615 * List table class for signups admin page.
    1716 *
    18  * @since BuddyPress (2.0.0)
     17 * @since 2.0.0
    1918 */
    2019class BP_Members_List_Table extends WP_Users_List_Table {
     
    2322     * Signup counts.
    2423     *
    25      * @since BuddyPress (2.0.0)
     24     * @since 2.0.0
    2625     *
    2726     * @access public
     
    3332     * Constructor.
    3433     *
    35      * @since BuddyPress (2.0.0)
     34     * @since 2.0.0
    3635     */
    3736    public function __construct() {
     
    5049     * manipulation required prior to rendering.
    5150     *
    52      * @since BuddyPress (2.0.0)
     51     * @since 2.0.0
    5352     */
    5453    public function prepare_items() {
     
    8988     * Get the views (the links above the WP List Table).
    9089     *
    91      * @since BuddyPress (2.0.0)
     90     * @since 2.0.0
    9291     *
    9392     * @uses WP_Users_List_Table::get_views() to get the users views
     
    109108     * As we're dealing with signups, we don't need this.
    110109     *
    111      * @since BuddyPress (2.0.0)
     110     * @since 2.0.0
    112111     *
    113112     * @param array $which
     
    120119     * Specific signups columns.
    121120     *
    122      * @since BuddyPress (2.0.0)
     121     * @since 2.0.0
    123122     */
    124123    public function get_columns() {
     
    127126         * Filters the single site Members signup columns.
    128127         *
    129          * @since BuddyPress (2.0.0)
     128         * @since 2.0.0
    130129         *
    131130         * @param array $value Array of columns to display.
     
    145144     * Specific bulk actions for signups.
    146145     *
    147      * @since BuddyPress (2.0.0)
     146     * @since 2.0.0
    148147     */
    149148    public function get_bulk_actions() {
     
    165164     * Nice job, clean sheet!
    166165     *
    167      * @since BuddyPress (2.0.0)
     166     * @since 2.0.0
    168167     */
    169168    public function no_items() {
     
    189188     * The columns signups can be reordered with.
    190189     *
    191      * @since BuddyPress (2.0.0)
     190     * @since 2.0.0
    192191     */
    193192    public function get_sortable_columns() {
     
    202201     * Display signups rows.
    203202     *
    204      * @since BuddyPress (2.0.0)
     203     * @since 2.0.0
    205204     */
    206205    public function display_rows() {
     
    221220     * Display a signup row.
    222221     *
    223      * @since BuddyPress (2.0.0)
     222     * @since 2.0.0
    224223     *
    225224     * @see WP_List_Table::single_row() for explanation of params.
     
    241240     * Markup for the checkbox used to select items for bulk actions.
    242241     *
    243      * @since BuddyPress (2.0.0)
     242     * @since 2.0.0
    244243     *
    245244     * @param object $signup_object The signup data object.
     
    255254     * The row actions (delete/activate/email).
    256255     *
    257      * @since BuddyPress (2.0.0)
     256     * @since 2.0.0
    258257     *
    259258     * @param object $signup_object The signup data object.
     
    306305         * Filters the multisite row actions for each user in list.
    307306         *
    308          * @since BuddyPress (2.0.0)
     307         * @since 2.0.0
    309308         *
    310309         * @param array  $actions       Array of actions and corresponding links.
     
    319318     * Display user name, if any.
    320319     *
    321      * @since BuddyPress (2.0.0)
     320     * @since 2.0.0
    322321     *
    323322     * @param object $signup_object The signup data object.
     
    330329     * Display user email.
    331330     *
    332      * @since BuddyPress (2.0.0)
     331     * @since 2.0.0
    333332     *
    334333     * @param object $signup_object The signup data object.
     
    341340     * Display registration date.
    342341     *
    343      * @since BuddyPress (2.0.0)
     342     * @since 2.0.0
    344343     *
    345344     * @param object $signup_object The signup data object.
     
    352351     * Display the last time an activation email has been sent.
    353352     *
    354      * @since BuddyPress (2.0.0)
     353     * @since 2.0.0
    355354     *
    356355     * @param object $signup_object The signup data object.
     
    363362     * Display number of time an activation email has been sent.
    364363     *
    365      * @since BuddyPress (2.0.0)
     364     * @since 2.0.0
    366365     *
    367366     * @param object $signup_object Signup object instance.
     
    376375     * Allow plugins to add their custom column.
    377376     *
    378      * @since BuddyPress (2.1.0)
     377     * @since 2.1.0
    379378     *
    380379     * @param object|null $signup_object The signup data object.
     
    388387         * Filters the single site custom columns for plugins.
    389388         *
    390          * @since BuddyPress (2.1.0)
     389         * @since 2.1.0
    391390         *
    392391         * @param string $column_name   The column name.
     
    403402 * List table class for signups network admin page.
    404403 *
    405  * @since BuddyPress (2.0.0)
     404 * @since 2.0.0
    406405 */
    407406class BP_Members_MS_List_Table extends WP_MS_Users_List_Table {
     
    410409     * Signup counts.
    411410     *
    412      * @since BuddyPress (2.0.0)
     411     * @since 2.0.0
    413412     *
    414413     * @access public
     
    420419     * Constructor
    421420     *
    422      * @since BuddyPress (2.0.0)
     421     * @since 2.0.0
    423422     */
    424423    public function __construct() {
     
    437436     * manipulation required prior to rendering.
    438437     *
    439      * @since BuddyPress (2.0.0)
     438     * @since 2.0.0
    440439     */
    441440    public function prepare_items() {
     
    477476     * Get the views : the links above the WP List Table.
    478477     *
    479      * @since BuddyPress (2.0.0)
     478     * @since 2.0.0
    480479     *
    481480     * @uses WP_MS_Users_List_Table::get_views() to get the users views.
     
    494493     * Specific signups columns.
    495494     *
    496      * @since BuddyPress (2.0.0)
     495     * @since 2.0.0
    497496     */
    498497    public function get_columns() {
     
    501500         * Filters the multisite Members signup columns.
    502501         *
    503          * @since BuddyPress (2.0.0)
     502         * @since 2.0.0
    504503         *
    505504         * @param array $value Array of columns to display.
     
    519518     * Specific bulk actions for signups.
    520519     *
    521      * @since BuddyPress (2.0.0)
     520     * @since 2.0.0
    522521     */
    523522    public function get_bulk_actions() {
     
    539538     * Nice job, clean sheet!
    540539     *
    541      * @since BuddyPress (2.0.0)
     540     * @since 2.0.0
    542541     */
    543542    public function no_items() {
     
    558557     * The columns signups can be reordered with.
    559558     *
    560      * @since BuddyPress (2.0.0)
     559     * @since 2.0.0
    561560     */
    562561    public function get_sortable_columns() {
     
    571570     * Display signups rows.
    572571     *
    573      * @since BuddyPress (2.0.0)
     572     * @since 2.0.0
    574573     */
    575574    public function display_rows() {
     
    590589     * Display a signup row.
    591590     *
    592      * @since BuddyPress (2.0.0)
     591     * @since 2.0.0
    593592     *
    594593     * @see WP_List_Table::single_row() for explanation of params.
     
    604603
    605604    /**
    606      * Prevents regular users row actions to be output
    607      *
    608      * @since BuddyPress (2.4.0)
     605     * Prevents regular users row actions to be output.
     606     *
     607     * @since 2.4.0
    609608     * @access protected
    610609     *
     
    612611     * @param string $column_name   Current column name.
    613612     * @param string $primary       Primary column name.
     613     *
     614     * @return string
    614615     */
    615616    protected function handle_row_actions( $signup_object = null, $column_name = '', $primary = '' ) {
     
    620621     * Markup for the checkbox used to select items for bulk actions.
    621622     *
    622      * @since BuddyPress (2.0.0)
     623     * @since 2.0.0
    623624     *
    624625     * @param object|null $signup_object The signup data object.
     
    634635     * The row actions (delete/activate/email).
    635636     *
    636      * @since BuddyPress (2.0.0)
     637     * @since 2.0.0
    637638     *
    638639     * @param object $signup_object The signup data object.
     
    691692     * Display user name, if any.
    692693     *
    693      * @since BuddyPress (2.0.0)
     694     * @since 2.0.0
    694695     *
    695696     * @param object $signup_object The signup data object.
     
    702703     * Display user email.
    703704     *
    704      * @since BuddyPress (2.0.0)
     705     * @since 2.0.0
    705706     *
    706707     * @param object $signup_object The signup data object.
     
    713714     * Display registration date.
    714715     *
    715      * @since BuddyPress (2.0.0)
     716     * @since 2.0.0
    716717     *
    717718     * @param object $signup_object The signup data object.
     
    732733     * Display the last time an activation email has been sent.
    733734     *
    734      * @since BuddyPress (2.0.0)
     735     * @since 2.0.0
    735736     *
    736737     * @param object|null $signup_object Signup object instance.
     
    751752     * Display number of time an activation email has been sent.
    752753     *
    753      * @since BuddyPress (2.0.0)
     754     * @since 2.0.0
    754755     *
    755756     * @param object|null $signup_object Signup object instance.
     
    774775         * Filters the multisite custom columns for plugins.
    775776         *
    776          * @since BuddyPress (2.1.0)
     777         * @since 2.1.0
    777778         *
    778779         * @param string $column_name   The column name.
Note: See TracChangeset for help on using the changeset viewer.