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

Timestamp:

01/19/2023 01:07:13 AM (2 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-functions.php (modified) (12 diffs)

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

@@ -347 +347 @@
  * @param bool $no_activity Optional. Whether to skip recording an activity
  *                          item about this blog creation. Default: false.
- * @return false|null Returns false on failure.
  */
 function bp_blogs_record_blog( $blog_id, $user_id, $no_activity = false ) {
@@ -357 +356 @@
     // If blog is not recordable, do not record the activity.
     if ( ! bp_blogs_is_blog_recordable( $blog_id, $user_id ) ) {
-        return false;
+        return;
     }
 
@@ -721 +720 @@
  * @param  array           $activity_args        Array of activity arguments.
  * @param  object|null     $activity_post_object The post type tracking args object.
- * @return WP_Error|bool|int Returns false if no activity, the activity id otherwise.
  */
 function bp_blogs_comment_sync_activity_comment( &$activity_id, $comment = null, $activity_args = array(), $activity_post_object = null ) {
     if ( empty( $activity_args ) || empty( $comment->post->ID ) || empty( $activity_post_object->comment_action_id ) ) {
-        return false;
+        return;
     }
 
@@ -749 +747 @@
         }
 
-        if ( empty( $activity_post_object ) ) {
-            $activity_post_object = bp_activity_get_post_type_tracking_args( $comment->post->post_type );
-        }
+        $activity_post_object = bp_activity_get_post_type_tracking_args( $comment->post->post_type );
 
         if ( isset( $activity_post_object->action_id ) && isset( $activity_post_object->component_id ) ) {
@@ -831 +827 @@
 
     if ( 'new_blog_comment' === $activity_post_object->comment_action_id ) {
+
         /**
          * Fires after BuddyPress has recorded metadata about a published blog post comment.
@@ -836 +833 @@
          * @since 2.5.0
          *
-         * @param int     $value    Comment ID of the blog post comment being recorded.
-         * @param WP_Post $post  WP_Comment object for the current blog post.
-         * @param string  $value ID of the user associated with the current blog post comment.
+         * @param int        $comment_id Comment ID of the blog post comment being recorded.
+         * @param WP_Comment $post       WP_Comment object for the current blog post.
+         * @param int        $user_id    ID of the user associated with the current blog post comment.
          */
-        do_action( 'bp_blogs_new_blog_comment', $comment->comment_ID, $comment, bp_loggedin_user_id() );
+        do_action( 'bp_blogs_new_blog_comment', (int) $comment->comment_ID, $comment, bp_loggedin_user_id() );
     }
 
@@ -861 +858 @@
  * @param string|bool $role    User's WordPress role for this blog ID.
  * @param int         $blog_id Blog ID user is being added to.
- * @return false|null False on failure.
  */
 function bp_blogs_add_user_to_blog( $user_id, $role = false, $blog_id = 0 ) {
@@ -918 +914 @@
  * @since 2.1.0
  *
- * @return string
+ * @return array
  */
 function bp_blogs_get_allowed_roles() {
@@ -927 +923 @@
      * @since 2.1.0
      *
-     * @param array $value Array of potential roles user needs.
+     * @param array $roles Array of allowed roles.
      */
     return apply_filters( 'bp_blogs_get_allowed_roles', array( 'contributor', 'author', 'editor', 'administrator' ) );
@@ -1045 +1041 @@
  * @param object $activity_post_object The post type tracking args object.
  * @param string $activity_type        The post type comment activity type.
- *
- * @return bool True on success. False on error.
  */
 function bp_blogs_post_type_remove_comment( $deleted, $comment_id, $activity_post_object, $activity_type = '' ) {
@@ -1097 +1091 @@
          * @since 1.0.0
          *
-         * @param int $value      ID for the blog associated with the removed comment.
+         * @param int $blog_id    ID for the blog associated with the removed comment.
          * @param int $comment_id ID of the comment being removed.
-         * @param int $value      ID of the current logged in user.
+         * @param int $user_id    ID of the current logged in user.
          */
         do_action( 'bp_blogs_remove_comment', get_current_blog_id(), $comment_id, bp_loggedin_user_id() );
@@ -1416 +1410 @@
  *
  * @param int $user_id ID whose blog data should be removed.
- * @return bool Returns false on failure.
  */
 function bp_blogs_remove_data( $user_id ) {
-    if ( !is_multisite() )
-        return false;
+    if ( ! is_multisite() ) {
+        return;
+    }
 
     /**