Changeset 11447 for trunk/src/bp-groups/bp-groups-template.php

Timestamp:

03/04/2017 06:26:55 PM (9 years ago)

Author:

tw2113

Message:

Cleanup from recent Scrutinizer review around documentation and param/return types.

File:

• trunk/src/bp-groups/bp-groups-template.php (modified) (10 diffs)

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

@@ -472 +472 @@
  * @since 1.0.0
  *
- * @param BP_Groups_Group $group Optional. Group object. Default: current group in loop.
+ * @param BP_Groups_Group|null $group Optional. Group object. Default: current group in loop.
  * @return bool
  */
@@ -963 +963 @@
  * @since 1.0.0
  *
- * @param BP_Groups_Group $group Optional. Group object. Default: current group in loop.
+ * @param BP_Groups_Group|null $group Optional. Group object. Default: current group in loop.
  */
 function bp_group_permalink( $group = null ) {
@@ -973 +973 @@
          * @since 1.0.0
          *
-         * @param BP_Groups_Group $group Optional. Group object. Default: current group in loop.
+         * @param BP_Groups_Group|null $group Optional. Group object. Default: current group in loop.
          * @return string
          */
@@ -1452 +1452 @@
  * @since 1.7.0
  *
- * @param BP_Groups_Group $group   Optional. Group object. Default: current group in loop.
- * @param int             $user_id ID of the user.
+ * @param BP_Groups_Group|null $group   Optional. Group object. Default: current group in loop.
+ * @param int                  $user_id ID of the user.
  * @return bool
  */
@@ -3355 +3355 @@
          * @param BP_Groups_Group|bool $group The BP Groups_Group object if
          *                                    passed, boolean false if not passed.
-         * @return string HTML code for the button.
+         * @return false|string HTML code for the button.
          */
         function bp_get_group_new_topic_button( $group = false ) {
@@ -3549 +3549 @@
          * @since 2.0.0
          *
-         * @return string
+         * @return false|string
          */
         function bp_get_group_create_button() {
@@ -3623 +3623 @@
  * @since 2.2.0
  *
- * @return string HTML Output
+ * @return string|null HTML Output
  */
 function bp_group_backcompat_create_nav_item() {
@@ -4192 +4192 @@
  *
  * @param array|string $args {@see bp_get_group_member_joined_since()}
- * @return string
+ * @return string|null
  */
 function bp_group_member_joined_since( $args = array() ) {
@@ -4777 +4777 @@
          * @since 1.1.0
          *
-         * @return mixed|void
+         * @return int
          */
         function bp_get_new_group_id() {
@@ -6192 +6192 @@
  * @param string $query_args
  * @param bool $nonce
- * @return string
+ * @return string|null
  */
 function bp_groups_action_link( $action = '', $query_args = '', $nonce = false ) {