Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/19/2015 01:40:26 AM (11 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/bp-members-admin.php

    r9819 r9877  
    208208
    209209        /**
    210          * Get the user ID
     210         * Get the user ID.
    211211         *
    212212         * Look for $_GET['user_id']. If anything else, force the user ID to the
    … …  
    233233
    234234        /**
    235          * Can the current user edit the one displayed
     235         * Can the current user edit the one displayed.
    236236         *
    237237         * self profile editing / or bp_moderate check.
    … …  
    241241         * @access public
    242242         * @since BuddyPress (2.1.0)
     243         *
     244         * @param int $user_id ID of the user being checked for edit ability.
     245         *
     246         * @return bool
    243247         */
    244248        private function member_can_edit( $user_id = 0 ) {
    … …  
    263267
    264268        /**
    265          * Get admin notice when saving a user or member profile
     269         * Get admin notice when saving a user or member profile.
    266270         *
    267271         * @since BuddyPress (2.1.0)
    … …  
    464468
    465469        /**
    466          * Highlight the Users menu if on Edit Profile.
    467          *
    468          * + Check if on the user's admin profile
     470         * Highlight the Users menu if on Edit Profile and check if on the user's admin profile.
    469471         *
    470472         * @access public
    … …  
    599601         * @access public
    600602         * @since BuddyPress (2.0.0)
     603         *
     604         * @param object|null $user   User to create profile navigation for.
     605         * @param string      $active Which profile to highlight.
     606         *
     607         * @return string
    601608         */
    602609        public function profile_nav( $user = null, $active = 'WordPress' ) {
    … …  
    11521159         * @since BuddyPress (2.0.0)
    11531160         *
    1154          * @param array $actions WordPress row actions (edit, delete).
    1155          * @param object $user The object for the user row.
     1161         * @param array|string $actions WordPress row actions (edit, delete).
     1162         * @param object       $user    The object for the user row.
     1163         *
    11561164         * @return array Merged actions.
    11571165         */
    … …  
    12061214
    12071215        /**
    1208          * Add a filter to edit profile url in WP Admin Bar
     1216         * Add a filter to edit profile url in WP Admin Bar.
    12091217         *
    12101218         * @access public
    … …  
    12161224
    12171225        /**
    1218          * Filter the profile url
     1226         * Filter the profile url.
    12191227         *
    12201228         * @access public
    … …  
    12221230         *
    12231231         * @uses  user_admin_url()
     1232         *
     1233         * @param string $profile_link Profile Link for admin bar.
     1234         * @param string $url          Profile URL.
     1235         * @param int    $user_id      User ID.
     1236         *
     1237         * @return string
    12241238         */
    12251239        public function filter_adminbar_profile_link( $profile_link = '', $url = '', $user_id = 0 ) {
    … …  
    12311245
    12321246        /**
    1233          * Remove the filter to edit profile url in WP Admin Bar
     1247         * Remove the filter to edit profile url in WP Admin Bar.
    12341248         *
    12351249         * @access public
    … …  
    12481262         * @since BuddyPress (2.0.0)
    12491263         *
    1250          * @param  int $value
    1251          * @param  string $option
    1252          * @param  int $new_value
    1253          * @return int the pagination preferences
     1264         * @param int    $value
     1265         * @param string $option
     1266         * @param int    $new_value
     1267         *
     1268         * @return int The pagination preferences.
    12541269         */
    12551270        public function signup_screen_options( $value = 0, $option = '', $new_value = 0 ) {
    … …  
    12751290         * @since BuddyPress (2.0.0)
    12761291         *
    1277          * @param  WP_User_Query $query The users query.
     1292         * @param WP_User_Query $query The users query.
     1293         *
    12781294         * @return WP_User_Query The users query without the signups.
    12791295         */
    … …  
    13171333         * @since BuddyPress (2.0.0)
    13181334         *
    1319          * @param  array $views WP List Table views.
     1335         * @param array $views WP List Table views.
     1336         *
    13201337         * @return array The views with the signup view added.
    13211338         */
    … …  
    13441361         * @since BuddyPress (2.0.0)
    13451362         *
    1346          * @param  string $class    The name of the class to use.
    1347          * @param  string $required The parent class.
     1363         * @param string $class    The name of the class to use.
     1364         * @param string $required The parent class.
     1365         *
    13481366         * @return WP_List_Table    The List table.
    13491367         */
    … …  
    15691587
    15701588        /**
    1571          * Get admin notice when viewing the sign-up page
     1589         * Get admin notice when viewing the sign-up page.
    15721590         *
    15731591         * @since BuddyPress (2.1.0)
    … …  
    17201738         *
    17211739         * Depending on the context, display
    1722          * - the list of signups
    1723          * - or the delete confirmation screen
    1724          * - or the activate confirmation screen
    1725          * - or the "resend" email confirmation screen
     1740         * - the list of signups,
     1741         * - or the delete confirmation screen,
     1742         * - or the activate confirmation screen,
     1743         * - or the "resend" email confirmation screen.
    17261744         *
    17271745         * Also prepare the admin notices.
    … …  
    18641882         *
    18651883         * @param string $action Delete, activate, or resend activation link.
     1884         *
     1885         * @return string
    18661886         */
    18671887        public function signups_admin_manage( $action = '' ) {
Note: See TracChangeset for help on using the changeset viewer.