Changeset 9218 for trunk/src/bp-blogs/bp-blogs-filters.php

Timestamp:

12/09/2014 12:54:33 AM (10 years ago)

Author:

tw2113

Message:

Add hook documentation for the Blogs component

Fixes #5939

File:

• trunk/src/bp-blogs/bp-blogs-filters.php (modified) (2 diffs)

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

@@ -34 +34 @@
  */
 function bp_blogs_creation_location( $url ) {
+
+    /**
+     * Filters the 'Create a new site' link URL.
+     *
+     * @since BuddyPress (1.6.0)
+     *
+     * @param string $value URL for the 'Create a new site' signup page.
+     */
     return apply_filters( 'bp_blogs_creation_location', trailingslashit( bp_get_root_domain() . '/' . bp_get_blogs_root_slug() . '/create', $url ) );
 }
@@ -86 +94 @@
     }
 
+    /**
+     * Filters whether or not BuddyPress should block sitewide tags activity.
+     *
+     * @since BuddyPress (2.2.0)
+     *
+     * @param bool $value Current status of the sitewide tags activity.
+     */
     if ( (int) $blog_id == $tags_blog_id && apply_filters( 'bp_blogs_block_sitewide_tags_activity', true ) ) {
         return false;
     }
 
+    /**
+     * Filters whether or not the current blog is public.
+     *
+     * @since BuddyPress (2.2.0)
+     *
+     * @param int $value Value from the blog_public option for the current blog.
+     */
     $is_blog_public = apply_filters( 'bp_is_blog_public', (int) get_blog_option( $blog_id, 'blog_public' ) );