Changeset 9877 for trunk/src/bp-members/bp-members-admin.php

Timestamp:

05/19/2015 01:40:26 AM (9 years ago)

Author:

tw2113

Message:

First pass at members component docs cleanup.

See #6402.

File:

• trunk/src/bp-members/bp-members-admin.php (modified) (18 diffs)

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

@@ -208 +208 @@
 
     /**
-     * Get the user ID
+     * Get the user ID.
      *
      * Look for $_GET['user_id']. If anything else, force the user ID to the
@@ -233 +233 @@
 
     /**
-     * Can the current user edit the one displayed
+     * Can the current user edit the one displayed.
      *
      * self profile editing / or bp_moderate check.
@@ -241 +241 @@
      * @access public
      * @since BuddyPress (2.1.0)
+     *
+     * @param int $user_id ID of the user being checked for edit ability.
+     *
+     * @return bool
      */
     private function member_can_edit( $user_id = 0 ) {
@@ -263 +267 @@
 
     /**
-     * Get admin notice when saving a user or member profile
+     * Get admin notice when saving a user or member profile.
      *
      * @since BuddyPress (2.1.0)
@@ -464 +468 @@
 
     /**
-     * Highlight the Users menu if on Edit Profile.
-     *
-     * + Check if on the user's admin profile
+     * Highlight the Users menu if on Edit Profile and check if on the user's admin profile.
      *
      * @access public
@@ -599 +601 @@
      * @access public
      * @since BuddyPress (2.0.0)
+     *
+     * @param object|null $user   User to create profile navigation for.
+     * @param string      $active Which profile to highlight.
+     *
+     * @return string
      */
     public function profile_nav( $user = null, $active = 'WordPress' ) {
@@ -1152 +1159 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param array $actions WordPress row actions (edit, delete).
-     * @param object $user The object for the user row.
+     * @param array|string $actions WordPress row actions (edit, delete).
+     * @param object       $user    The object for the user row.
+     *
      * @return array Merged actions.
      */
@@ -1206 +1214 @@
 
     /**
-     * Add a filter to edit profile url in WP Admin Bar
+     * Add a filter to edit profile url in WP Admin Bar.
      *
      * @access public
@@ -1216 +1224 @@
 
     /**
-     * Filter the profile url
+     * Filter the profile url.
      *
      * @access public
@@ -1222 +1230 @@
      *
      * @uses  user_admin_url()
+     *
+     * @param string $profile_link Profile Link for admin bar.
+     * @param string $url          Profile URL.
+     * @param int    $user_id      User ID.
+     *
+     * @return string
      */
     public function filter_adminbar_profile_link( $profile_link = '', $url = '', $user_id = 0 ) {
@@ -1231 +1245 @@
 
     /**
-     * Remove the filter to edit profile url in WP Admin Bar
+     * Remove the filter to edit profile url in WP Admin Bar.
      *
      * @access public
@@ -1248 +1262 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param  int $value
-     * @param  string $option
-     * @param  int $new_value
-     * @return int the pagination preferences
+     * @param int    $value
+     * @param string $option
+     * @param int    $new_value
+     *
+     * @return int The pagination preferences.
      */
     public function signup_screen_options( $value = 0, $option = '', $new_value = 0 ) {
@@ -1275 +1290 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param  WP_User_Query $query The users query.
+     * @param WP_User_Query $query The users query.
+     *
      * @return WP_User_Query The users query without the signups.
      */
@@ -1317 +1333 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param  array $views WP List Table views.
+     * @param array $views WP List Table views.
+     *
      * @return array The views with the signup view added.
      */
@@ -1344 +1361 @@
      * @since BuddyPress (2.0.0)
      *
-     * @param  string $class    The name of the class to use.
-     * @param  string $required The parent class.
+     * @param string $class    The name of the class to use.
+     * @param string $required The parent class.
+     *
      * @return WP_List_Table    The List table.
      */
@@ -1569 +1587 @@
 
     /**
-     * Get admin notice when viewing the sign-up page
+     * Get admin notice when viewing the sign-up page.
      *
      * @since BuddyPress (2.1.0)
@@ -1720 +1738 @@
      *
      * Depending on the context, display
-     * - the list of signups
-     * - or the delete confirmation screen
-     * - or the activate confirmation screen
-     * - or the "resend" email confirmation screen
+     * - the list of signups,
+     * - or the delete confirmation screen,
+     * - or the activate confirmation screen,
+     * - or the "resend" email confirmation screen.
      *
      * Also prepare the admin notices.
@@ -1864 +1882 @@
      *
      * @param string $action Delete, activate, or resend activation link.
+     *
+     * @return string
      */
     public function signups_admin_manage( $action = '' ) {