Changeset 11350

Timestamp:

12/28/2016 09:54:03 PM (7 years ago)

Author:

slaffik

Message:

Profile: Improve bp-xprofile-template.php PHPDoc comments.

Added some proper casting for (int) and fixed @return statements, where we previously had mixed|void for some reason.

See #7306.

Location:

trunk/src/bp-xprofile

Files:

• bp-xprofile-template.php (modified) (25 diffs)
• classes/class-bp-xprofile-user-admin.php (modified) (1 diff)

trunk/src/bp-xprofile/bp-xprofile-template.php

@@ -257 +257 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return int
      */
     function bp_get_the_profile_group_id() {
@@ -269 +269 @@
          * @param int $id ID for the profile group.
          */
-        return apply_filters( 'bp_get_the_profile_group_id', $group->id );
+        return (int) apply_filters( 'bp_get_the_profile_group_id', $group->id );
     }
 
@@ -286 +286 @@
      * @since 1.0.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_group_name() {
@@ -315 +315 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_group_slug() {
@@ -344 +344 @@
      * @since 1.0.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_group_description() {
@@ -373 +373 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_group_edit_form_action() {
@@ -497 +497 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return int
      */
     function bp_get_the_profile_field_id() {
@@ -509 +509 @@
          * @param int $id ID for the profile field.
          */
-        return apply_filters( 'bp_get_the_profile_field_id', $field->id );
+        return (int) apply_filters( 'bp_get_the_profile_field_id', $field->id );
     }
 
@@ -526 +526 @@
      * @since 1.0.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_field_name() {
@@ -555 +555 @@
      * @since 1.0.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_field_value() {
@@ -588 +588 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_field_edit_value() {
@@ -641 +641 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_field_type() {
@@ -670 +670 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_field_description() {
@@ -699 +699 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_field_input_name() {
@@ -805 +805 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return bool
      */
     function bp_get_the_profile_field_is_required() {
@@ -823 +823 @@
          * @param bool $retval Whether or not the field is required.
          */
-        return apply_filters( 'bp_get_the_profile_field_is_required', (bool) $retval );
+        return (bool) apply_filters( 'bp_get_the_profile_field_is_required', $retval );
     }
 
@@ -840 +840 @@
      * @since 1.6.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_field_visibility_level() {
@@ -878 +878 @@
      * @since 1.6.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_the_profile_field_visibility_level_label() {
@@ -946 +946 @@
      *    @type int             $user_id ID of the user to get field data for.
      * }
-     * @return mixed|void
+     * @return mixed
      */
     function bp_get_profile_field_data( $args = '' ) {
@@ -1089 +1089 @@
  *
  * @param bool $deprecated Deprecated boolean parameter.
- * @return mixed|void
+ *
+ * @return string|mixed
  */
 function bp_profile_group_name( $deprecated = true ) {
-    if ( !$deprecated ) {
+    if ( ! $deprecated ) {
         return bp_get_profile_group_name();
     } else {
@@ -1104 +1105 @@
      * @since 1.0.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_profile_group_name() {
@@ -1150 +1151 @@
      * @since 1.0.0
      *
-     * @return bool|mixed|void
+     * @return bool|string
      */
     function bp_get_profile_last_updated() {
@@ -1185 +1186 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return int
      */
     function bp_get_current_profile_group_id() {
@@ -1200 +1201 @@
          * @since 1.1.0
          *
-         * @param string $profile_group_id Current profile group ID.
-         */
-        return apply_filters( 'bp_get_current_profile_group_id', $profile_group_id );
+         * @param int $profile_group_id Current profile group ID.
+         */
+        return (int) apply_filters( 'bp_get_current_profile_group_id', $profile_group_id );
     }
 
@@ -1219 +1220 @@
      * @since 1.1.0
      *
-     * @return mixed|void
+     * @return string
      */
     function bp_get_avatar_delete_link() {

trunk/src/bp-xprofile/classes/class-bp-xprofile-user-admin.php

@@ -139 +139 @@
                     'normal',
                     'core',
-                    array( 'profile_group_id' => absint( bp_get_the_profile_group_id() ) )
+                    array( 'profile_group_id' => bp_get_the_profile_group_id() )
                 );
             endwhile;