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

Timestamp:

11/05/2016 12:13:46 AM (10 years ago)

Author:

tw2113

Message:

Adds PHPDocs to missed filters in the blogs component.

File:

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

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

@@ -66 +66 @@
         );
 
-        // Filter and return.
+        /**
+         * Filters a set of blogs.
+         *
+         * @since 1.2.0
+         *
+         * @param array $blogs Array of blog data.
+         * @param array $r     Parsed query arguments.
+         */
         return apply_filters( 'bp_blogs_get_blogs', $blogs, $r );
 }
@@ -247 +254 @@
 function bp_blogs_is_blog_recordable( $blog_id, $user_id = 0 ) {
 
+        /**
+         * Filters whether or not a blog is globally activity stream recordable.
+         *
+         * @since 1.7.0
+         *
+         * @param bool $value   Whether or not recordable. Default true.
+         * @param int  $blog_id Current blog ID.
+         */
         $recordable_globally = apply_filters( 'bp_blogs_is_blog_recordable', true, $blog_id );
 
         if ( !empty( $user_id ) ) {
+                /**
+                 * Filters whether or not a blog is globally activity stream recordable for user.
+                 *
+                 * @since 1.7.0
+                 *
+                 * @param bool $recordable_globally Whether or not recordable.
+                 * @param int  $blog_id             Current blog ID.
+                 * @param int  $user_id             Current user ID.
+                 */
                 $recordable_for_user = apply_filters( 'bp_blogs_is_blog_recordable_for_user', $recordable_globally, $blog_id, $user_id );
         } else {
@@ -276 +300 @@
 function bp_blogs_is_blog_trackable( $blog_id, $user_id = 0 ) {
 
+        /**
+         * Filters whether or not a blog is globally trackable.
+         *
+         * @since 1.7.0
+         *
+         * @param bool $value Whether or not trackable.
+         * @param int  $blog_id Current blog ID.
+         */
         $trackable_globally = apply_filters( 'bp_blogs_is_blog_trackable', bp_blogs_is_blog_recordable( $blog_id, $user_id ), $blog_id );
 
         if ( !empty( $user_id ) ) {
+
+                /**
+                 * Filters whether or not a blog is globally trackable for user.
+                 *
+                 * @since 1.7.0
+                 *
+                 * @param bool $value   Whether or not trackable.
+                 * @param int  $blog_id Current blog ID.
+                 * @param int  $user_id Current user ID.
+                 */
                 $trackable_for_user = apply_filters( 'bp_blogs_is_blog_trackable_for_user', $trackable_globally, $blog_id, $user_id );
         } else {
@@ -345 +387 @@
 
         $is_private = !empty( $_POST['blog_public'] ) && (int) $_POST['blog_public'] ? false : true;
+
+        /**
+         * Filters whether or not a new blog is public.
+         *
+         * @since 1.5.0
+         *
+         * @param bool $is_private Whether or not blog is public.
+         */
         $is_private = !apply_filters( 'bp_is_new_blog_public', !$is_private );
 
@@ -845 +895 @@
  */
 function bp_blogs_get_allowed_roles() {
+
+        /**
+         * Filters the allowed roles a member must have to be recorded into bp_user_blogs pointer table.
+         *
+         * @since 2.1.0
+         *
+         * @param array $value Array of potential roles user needs.
+         */
         return apply_filters( 'bp_blogs_get_allowed_roles', array( 'contributor', 'author', 'editor', 'administrator' ) );
 }