Changeset 13105 for trunk/src/bp-members/classes/class-bp-core-members-template.php

Timestamp:

09/11/2021 05:26:17 PM (5 years ago)

Author:

espellcaste

Message:

Making PHPDoc Improvements to the BP Members (component) files.

Also, adding several minor PHP changes.

See #8553

File:

• trunk/src/bp-members/classes/class-bp-core-members-template.php (modified) (7 diffs)

trunk/src/bp-members/classes/class-bp-core-members-template.php

@@ -111 +111 @@
          *
          * @since 1.5.0
-         * @since 7.0.0 Added $xprofile_query parameter. Added $user_ids parameter.
+         * @since 7.0.0 Added `$xprofile_query` parameter. Added `$user_ids` parameter.
          *
          * @see BP_User_Query for an in-depth description of parameters.
          *
-         * @param array $args {
+         * @param array ...$args {
          *     Array of arguments. Supports all arguments of BP_User_Query. Additional
          *     arguments, or those with different defaults, are described below.
@@ -268 +268 @@
          * @return bool True if there are items in the loop, otherwise false.
          */
-        function has_members() {
-                if ( $this->member_count )
-                        return true;
-
-                return false;
+        public function has_members() {
+                return ! empty( $this->member_count );
         }
 
@@ -282 +279 @@
          * @return object The next member to iterate over.
          */
-        function next_member() {
+        public function next_member() {
                 $this->current_member++;
-                $this->member = $this->members[$this->current_member];
+                $this->member = $this->members[ $this->current_member ];
 
                 return $this->member;
@@ -294 +291 @@
          * @since 1.0.0
          */
-        function rewind_members() {
+        public function rewind_members() {
                 $this->current_member = -1;
                 if ( $this->member_count > 0 ) {
@@ -314 +311 @@
          * @return bool True if there are more members to show, otherwise false.
          */
-        function members() {
+        public function members() {
                 if ( $this->current_member + 1 < $this->member_count ) {
                         return true;
-                } elseif ( $this->current_member + 1 == $this->member_count ) {
+                } elseif ( $this->current_member + 1 === $this->member_count ) {
 
                         /**
@@ -344 +341 @@
          * @see bp_the_member()
          */
-        function the_member() {
-
+        public function the_member() {
                 $this->in_the_loop = true;
                 $this->member      = $this->next_member();
 
                 // Loop has just started.
-                if ( 0 == $this->current_member ) {
+                if ( 0 === $this->current_member ) {
 
                         /**
@@ -359 +355 @@
                         do_action( 'member_loop_start' );
                 }
-
         }
 }