Changeset 11447 for trunk/src/bp-activity/bp-activity-functions.php

Timestamp:

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

Author:

tw2113

Message:

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

File:

• trunk/src/bp-activity/bp-activity-functions.php (modified) (5 diffs)

trunk/src/bp-activity/bp-activity-functions.php

@@ -1846 +1846 @@
  *     @type string   $error_type        Optional. Error type. Either 'bool' or 'wp_error'. Default: 'bool'.
  * }
- * @return int|bool The ID of the activity on success. False on error.
+ * @return WP_Error|bool|int The ID of the activity on success. False on error.
  */
 function bp_activity_add( $args = '' ) {
@@ -2027 +2027 @@
  * @param WP_Post|null $post    Post object.
  * @param int          $user_id ID of the post author.
- * @return int|bool The ID of the activity on success. False on error.
+ * @return null|WP_Error|bool|int The ID of the activity on success. False on error.
  */
 function bp_activity_post_type_publish( $post_id = 0, $post = null, $user_id = 0 ) {
@@ -2162 +2162 @@
  *
  * @param WP_Post|null $post Post item.
- * @return bool True on success, false on failure.
+ * @return null|WP_Error|bool True on success, false on failure.
  */
 function bp_activity_post_type_update( $post = null ) {
@@ -2284 +2284 @@
  * @param  bool        $is_approved          Whether the comment is approved or not.
  * @param  object|null $activity_post_object The post type tracking args object.
- * @return int|bool The ID of the activity on success. False on error.
+ * @return null|WP_Error|bool|int The ID of the activity on success. False on error.
  */
 function bp_activity_post_type_comment( $comment_id = 0, $is_approved = true, $activity_post_object = null ) {
@@ -2558 +2558 @@
  *     @type string $error_type        Optional. Error type. Either 'bool' or 'wp_error'. Default: 'bool'.
  * }
- * @return int|bool The ID of the comment on success, otherwise false.
+ * @return WP_Error|bool|int The ID of the comment on success, otherwise false.
  */
 function bp_activity_new_comment( $args = '' ) {