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

Timestamp:

06/02/2024 01:06:10 AM (6 months ago)

Author:

espellcaste

Message:

PHPDoc: remove superfluous comments from boolean returns.

See #9164

File:

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

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

@@ -1082 +1082 @@
  * @param int $activity_id ID of the activity item being favorited.
  * @param int $user_id     ID of the user favoriting the activity item.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function bp_activity_add_user_favorite( $activity_id, $user_id = 0 ) {
@@ -1163 +1163 @@
  * @param int $activity_id ID of the activity item being unfavorited.
  * @param int $user_id     ID of the user unfavoriting the activity item.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function bp_activity_remove_user_favorite( $activity_id, $user_id = 0 ) {
@@ -1297 +1297 @@
  *                            only delete matching metadata entries for the specified
  *                            activity item. Default: false.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function bp_activity_delete_meta( $activity_id, $meta_key = '', $meta_value = '', $delete_all = false ) {
@@ -2465 +2465 @@
  * @param int          $post_id ID of the post being unpublished.
  * @param WP_Post|null $post    Post object.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function bp_activity_post_type_unpublish( $post_id = 0, $post = null ) {
@@ -2707 +2707 @@
  * @param  int         $comment_id           ID of the comment.
  * @param  object|null $activity_post_object The post type tracking args object.
- * @return bool True on success. False on error.
+ * @return bool
  */
 function bp_activity_post_type_remove_comment( $comment_id = 0, $activity_post_object = null ) {
@@ -2713 +2713 @@
         $comment = get_comment( $comment_id );
         if ( ! $comment ) {
-            return;
+            return false;
         }
 
         $post_type = get_post_type( $comment->comment_post_ID );
         if ( ! $post_type ) {
-            return;
+            return false;
         }
 
@@ -3004 +3004 @@
  *                           the same as BP_Activity_Activity::get().
  *                           See that method for a description.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function bp_activity_delete( $args = '' ) {
@@ -3088 +3088 @@
      * @param array|string $args See BP_Activity_Activity::get for a
      *                           description of accepted arguments.
-     * @return bool True on success, false on failure.
+     * @return bool
      */
     function bp_activity_delete_by_item_id( $args = '' ) {
@@ -3113 +3113 @@
      *
      * @param int $activity_id ID of the activity item to be deleted.
-     * @return bool True on success, false on failure.
+     * @return bool
      */
     function bp_activity_delete_by_activity_id( $activity_id ) {
@@ -3132 +3132 @@
      * @param string $component The activity component.
      * @param string $type      The activity type.
-     * @return bool True on success, false on failure.
+     * @return bool
      */
     function bp_activity_delete_by_content( $user_id, $content, $component, $type ) {
@@ -3154 +3154 @@
      * @param int    $user_id   The user id.
      * @param string $component The activity component.
-     * @return bool True on success, false on failure.
+     * @return bool
      */
     function bp_activity_delete_for_user_by_component( $user_id, $component ) {
@@ -3176 +3176 @@
  *                         oldest ancestor.
  * @param int $comment_id  The ID of the comment to be deleted.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function bp_activity_delete_comment( $activity_id, $comment_id ) {
@@ -3340 +3340 @@
  * @param  BP_Activity_Activity $activity Activity object.
  * @param  integer              $user_id  User ID.
- * @return boolean True on success, false on failure.
+ * @return bool
  */
 function bp_activity_user_can_read( $activity, $user_id = 0 ) {
@@ -3401 +3401 @@
  *
  * @param int $user_id The ID of the user whose activity is being hidden.
- * @return bool True on success, false on failure.
+ * @return bool
  */
 function bp_activity_hide_user_activity( $user_id ) {