Changeset 13405 for trunk/src/bp-blogs/bp-blogs-activity.php

Timestamp:

01/19/2023 01:07:13 AM (3 years ago)

Author:

espellcaste

Message:

Adding PHPDoc Improvements to the Blogs (component) files.

Props imath

Closes ​https://github.com/buddypress/buddypress/pull/56
See #8553

File:

• trunk/src/bp-blogs/bp-blogs-activity.php (modified) (7 diffs)

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

@@ -15 +15 @@
  *
  * @since 1.0.0
- *
- * @return bool|null Returns false if activity component is not active.
  */
 function bp_blogs_register_activity_actions() {
@@ -241 +239 @@
         restore_current_blog();
 
-        if ( ! empty( $post ) && ! is_wp_error( $post ) ) {
+        if ( ! empty( $post ) && $post instanceof WP_Post ) {
             $post_url = add_query_arg( 'p', $post->ID, trailingslashit( get_home_url( $activity->item_id ) ) );
             $action   = apply_filters_deprecated( 'bp_blogs_activity_new_post_action', array( $action, $post, $post_url ), '2.0.0', 'bp_blogs_format_activity_action_new_blog_post' );
@@ -353 +351 @@
         restore_current_blog();
 
-        if ( ! empty( $comment ) && ! is_wp_error( $comment ) ) {
+        if ( ! empty( $comment ) && $comment instanceof WP_Comment ) {
             $action = apply_filters_deprecated( 'bp_blogs_activity_new_comment_action', array( $action, $comment, $post_url . '#' . $activity->secondary_item_id ), '2.0.0', 'bp_blogs_format_activity_action_new_blog_comment' );
         }
@@ -454 +452 @@
          * @since 1.2.0
          *
-         * @param string $value Generated summary from content for the activity stream.
-         * @param string $value Content for the activity stream.
-         * @param array  $r     Array of arguments used for the activity stream item.
+         * @param string $summary Generated summary from content for the activity stream.
+         * @param string $content Content for the activity stream.
+         * @param array  $r       Array of arguments used for the activity stream item.
          */
         $r['content'] = apply_filters( 'bp_blogs_record_activity_content', bp_activity_create_summary( $r['content'], $r ), $r['content'], $r );
@@ -500 +498 @@
     );
 
-    bp_activity_delete_by_item_id( $r );
+    return bp_activity_delete_by_item_id( $r );
 }
 
@@ -615 +613 @@
              * @since 1.1.0
              *
-             * @param string $value Blog primary link.
-             * @param int    $value Blog ID.
+             * @param string $link    Blog primary link.
+             * @param int    $blog_id Blog ID.
              */
             'primary_link' => apply_filters( 'bp_blogs_activity_created_blog_primary_link', bp_blogs_get_blogmeta( $recorded_blog->blog_id, 'url' ), $recorded_blog->blog_id ),
@@ -678 +676 @@
  * @param int $user_id Optional. Defaults to the logged-in user ID. This param
  *                     is currently unused in the function (but is passed to hooks).
- * @return bool
  */
 function bp_blogs_remove_post( $post_id, $blog_id = 0, $user_id = 0 ) {