Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/19/2015 01:40:26 AM (9 years ago)
Author:
tw2113
Message:

First pass at members component docs cleanup.

See #6402.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-members/admin/bp-members-admin-classes.php

    r9819 r9877  
    110110     *
    111111     * @since BuddyPress (2.0.0)
     112     *
     113     * @param array $which
    112114     */
    113115    public function extra_tablenav( $which ) {
    … …  
    116118
    117119    /**
    118      * Specific signups columns
     120     * Specific signups columns.
    119121     *
    120122     * @since BuddyPress (2.0.0)
    … …  
    216218     *
    217219     * @see WP_List_Table::single_row() for explanation of params.
     220     *
     221     * @param object|null $signup_object Signup user object.
     222     * @param string      $style         Styles for the row.
     223     * @param string      $role          Role to be assigned to user.
     224     * @param int         $numposts      Numper of posts.
     225     *
     226     * @return string
    218227     */
    219228    public function single_row( $signup_object = null, $style = '', $role = '', $numposts = 0 ) {
    … …  
    349358     *
    350359     * @since BuddyPress (2.0.0)
     360     *
     361     * @param object $signup_object Signup object instance.
     362     *
     363     * @return int
    351364     */
    352365    public function column_count_sent( $signup_object = null ) {
    … …  
    359372     * @since BuddyPress (2.1.0)
    360373     *
    361      * @param object $signup_object The signup data object.
    362      * @param string the column name.
     374     * @param object|null $signup_object The signup data object.
     375     * @param string      $column_name   The column name.
     376     *
     377     * @return string
    363378     */
    364379    function column_default( $signup_object = null, $column_name = '' ) {
    … …  
    458473     * @since BuddyPress (2.0.0)
    459474     *
    460      * @uses WP_MS_Users_List_Table::get_views() to get the users views
     475     * @uses WP_MS_Users_List_Table::get_views() to get the users views.
    461476     */
    462477    public function get_views() {
    … …  
    471486
    472487    /**
    473      * Specific signups columns
     488     * Specific signups columns.
    474489     *
    475490     * @since BuddyPress (2.0.0)
    … …  
    496511
    497512    /**
    498      * Specific bulk actions for signups
     513     * Specific bulk actions for signups.
    499514     *
    500515     * @since BuddyPress (2.0.0)
    … …  
    535550
    536551    /**
    537      * The columns signups can be reordered with
     552     * The columns signups can be reordered with.
    538553     *
    539554     * @since BuddyPress (2.0.0)
    … …  
    566581     *
    567582     * @see WP_List_Table::single_row() for explanation of params.
     583     *
     584     * @param object|null $signup_object Signup user object.
     585     * @param string      $style         Styles for the row.
    568586     */
    569587    public function single_row( $signup_object = null, $style = '' ) {
    … …  
    578596     * @since BuddyPress (2.0.0)
    579597     *
    580      * @param object $signup_object The signup data object.
     598     * @param object|null $signup_object The signup data object.
    581599     */
    582600    public function column_cb( $signup_object = null ) {
    … …  
    667685
    668686    /**
    669      * Display registration date
     687     * Display registration date.
    670688     *
    671689     * @since BuddyPress (2.0.0)
    … …  
    689707     *
    690708     * @since BuddyPress (2.0.0)
     709     *
     710     * @param object|null $signup_object Signup object instance.
    691711     */
    692712    public function column_date_sent( $signup_object = null ) {
    … …  
    706726     *
    707727     * @since BuddyPress (2.0.0)
     728     *
     729     * @param object|null $signup_object Signup object instance.
    708730     */
    709731    public function column_count_sent( $signup_object = null ) {
    … …  
    716738     * @since BuddyPress 2.1.0
    717739     *
    718      * @param object $signup_object The signup data object.
    719      * @param string the column name.
     740     * @param object|null $signup_object The signup data object.
     741     * @param string      $column_name   The column name.
     742     *
     743     * @return string
    720744     */
    721745    function column_default( $signup_object = null, $column_name = '' ) {
Note: See TracChangeset for help on using the changeset viewer.