Changeset 10322 for trunk/src/bp-members/admin/bp-members-admin-classes.php

Timestamp:

11/02/2015 01:58:52 AM (10 years ago)

Author:

tw2113

Message:

More documentation cleanup for the Members component.

See #6402.

File:

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

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

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress Members List Classes
+ * BuddyPress Members List Classes.
  *
  * @package BuddyPress
@@ -89 +89 @@
      * @since 2.0.0
      *
-     * @uses WP_Users_List_Table::get_views() to get the users views
+     * @uses WP_Users_List_Table::get_views() to get the users views.
      */
     public function get_views() {
         $views = parent::get_views();
 
-        // Remove the 'current' class from the 'All' link
+        // Remove the 'current' class from the 'All' link.
         $views['all']        = str_replace( 'class="current"', '', $views['all'] );
         $views['registered'] = sprintf( '<a href="%1$s" class="current">%2$s</a>', esc_url( add_query_arg( 'page', 'bp-signups', bp_get_admin_url( 'users.php' ) ) ), sprintf( _x( 'Pending %s', 'signup users', 'buddypress' ), '<span class="count">(' . number_format_i18n( $this->signup_counts ) . ')</span>' ) );
@@ -109 +109 @@
      * @since 2.0.0
      *
-     * @param array $which
+     * @param array $which Current table nav item.
      */
     public function extra_tablenav( $which ) {
@@ -172 +172 @@
             $link = false;
 
-            // Specific case when BuddyPress is not network activated
+            // Specific case when BuddyPress is not network activated.
             if ( is_multisite() && current_user_can( 'manage_network_users') ) {
                 $link = sprintf( '<a href="%1$s">%2$s</a>', esc_url( network_admin_url( 'settings.php'       ) ), esc_html__( 'Edit settings', 'buddypress' ) );
@@ -206 +206 @@
         foreach ( $this->items as $userid => $signup_object ) {
 
-            // Avoid a notice error appearing since 4.3.0
+            // Avoid a notice error appearing since 4.3.0.
             if ( isset( $signup_object->id ) ) {
                 $signup_object->ID = $signup_object->id;
@@ -227 +227 @@
      * @param string      $role          Role to be assigned to user.
      * @param int         $numposts      Numper of posts.
-     *
-     * @return string
+     * @return void
      */
     public function single_row( $signup_object = null, $style = '', $role = '', $numposts = 0 ) {
@@ -260 +259 @@
         $avatar = get_avatar( $signup_object->user_email, 32 );
 
-        // Activation email link
+        // Activation email link.
         $email_link = add_query_arg(
             array(
@@ -270 +269 @@
         );
 
-        // Activate link
+        // Activate link.
         $activate_link = add_query_arg(
             array(
@@ -280 +279 @@
         );
 
-        // Delete link
+        // Delete link.
         $delete_link = add_query_arg(
             array(
@@ -364 +363 @@
      *
      * @param object $signup_object Signup object instance.
-     *
-     * @return int
      */
     public function column_count_sent( $signup_object = null ) {
@@ -378 +375 @@
      * @param object|null $signup_object The signup data object.
      * @param string      $column_name   The column name.
-     *
      * @return string
      */
@@ -398 +394 @@
 
 if ( class_exists( 'WP_MS_Users_List_Table' ) ) :
+
 /**
  * List table class for signups network admin page.
@@ -415 +412 @@
 
     /**
-     * Constructor
+     * Constructor.
      *
      * @since 2.0.0
@@ -481 +478 @@
         $views = parent::get_views();
 
-        // Remove the 'current' class from the 'All' link
+        // Remove the 'current' class from the 'All' link.
         $views['all']        = str_replace( 'class="current"', '', $views['all'] );
         $views['registered'] = sprintf( '<a href="%1$s" class="current">%2$s</a>', esc_url( add_query_arg( 'page', 'bp-signups', bp_get_admin_url( 'users.php' ) ) ), sprintf( _x( 'Pending %s', 'signup users', 'buddypress' ), '<span class="count">(' . number_format_i18n( $this->signup_counts ) . ')</span>' ) );
@@ -574 +571 @@
         foreach ( $this->items as $userid => $signup_object ) {
 
-            // Avoid a notice error appearing since 4.3.0
+            // Avoid a notice error appearing since 4.3.0.
             if ( isset( $signup_object->id ) ) {
                 $signup_object->ID = $signup_object->id;
@@ -608 +605 @@
      * @param string $column_name   Current column name.
      * @param string $primary       Primary column name.
-     *
      * @return string
      */
@@ -639 +635 @@
         $avatar = get_avatar( $signup_object->user_email, 32 );
 
-        // Activation email link
+        // Activation email link.
         $email_link = add_query_arg(
             array(
@@ -649 +645 @@
         );
 
-        // Activate link
+        // Activate link.
         $activate_link = add_query_arg(
             array(
@@ -659 +655 @@
         );
 
-        // Delete link
+        // Delete link.
         $delete_link = add_query_arg(
             array(
@@ -764 +760 @@
      * @param object|null $signup_object The signup data object.
      * @param string      $column_name   The column name.
-     *
      * @return string
      */