Changeset 9596

Timestamp:

03/05/2015 05:01:29 AM (11 years ago)

Author:

tw2113

Message:

Adds hooks documentation for bp-core-theme-compatibility.php.

See #5940.

File:

• trunk/src/bp-core/bp-core-theme-compatibility.php (modified) (11 diffs)

trunk/src/bp-core/bp-core-theme-compatibility.php

@@ -165 +165 @@
  */
 function bp_get_theme_compat_id() {
+
+    /**
+     * Filters the ID of the theme package being used.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $id ID of the theme package in use.
+     */
     return apply_filters( 'bp_get_theme_compat_id', buddypress()->theme_compat->theme->id );
 }
@@ -181 +189 @@
  */
 function bp_get_theme_compat_name() {
+
+    /**
+     * Filters the name of the theme package being used.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $name Name of the theme package in use.
+     */
     return apply_filters( 'bp_get_theme_compat_name', buddypress()->theme_compat->theme->name );
 }
@@ -197 +213 @@
  */
 function bp_get_theme_compat_version() {
+
+    /**
+     * Filters the version of the theme package being used.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $version The version string of the theme package in use.
+     */
     return apply_filters( 'bp_get_theme_compat_version', buddypress()->theme_compat->theme->version );
 }
@@ -213 +237 @@
  */
 function bp_get_theme_compat_dir() {
+
+    /**
+     * Filters the absolute path of the theme package being used.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $dir The absolute path of the theme package in use.
+     */
     return apply_filters( 'bp_get_theme_compat_dir', buddypress()->theme_compat->theme->dir );
 }
@@ -230 +262 @@
  */
 function bp_get_theme_compat_url() {
+
+    /**
+     * Filters the URL of the theme package being used.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $url URL of the theme package in use.
+     */
     return apply_filters( 'bp_get_theme_compat_url', buddypress()->theme_compat->theme->url );
 }
@@ -250 +290 @@
     }
 
+    /**
+     * Filters whether or not to use theme compat for the active theme.
+     *
+     * @since BuddyPress (1.9.0)
+     *
+     * @param bool $use_with_current_theme True if the current theme needs theme compatibility.
+     */
     return apply_filters( 'bp_use_theme_compat_with_current_theme', buddypress()->theme_compat->use_with_current_theme );
 }
@@ -407 +454 @@
  * {@link BuddyPress::register_theme_packages()}.
  *
- * @since BuddyPress (1.7)
+ * @since BuddyPress (1.7.0)
  *
  * @see BP_Theme_Compat for a description of the $theme parameter arguments.
@@ -598 +645 @@
 
     /**
+     * Fires when resetting main query vars and filtering 'the_content' to output BuddyPress template parts.
+     *
      * Use this action to execute code that will communicate to BuddyPress's
      * theme compatibility layer whether or not we're replacing the_content()
      * with some other template part.
+     *
+     * @since BuddyPress (1.7.0)
      */
     do_action( 'bp_template_include_reset_dummy_post_data' );
@@ -637 +688 @@
     }
 
+    /**
+     * Filters the template name to include.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $template Template name.
+     */
     return apply_filters( 'bp_template_include_theme_compat', $template );
 }
@@ -663 +721 @@
     bp_set_theme_compat_active( false );
 
-    // Do we have new content to replace the old content?
+    /**
+     * Filters the content to replace in the post.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param string $content Original post content.
+     */
     $new_content = apply_filters( 'bp_replace_the_content', $content );
 
@@ -824 +888 @@
     $retval = is_buddypress() ? false : $open;
 
-    // Allow override of the override
+    /**
+     * Filters whether or not to force comments_status to closed for BuddyPress post types.
+     *
+     * @since BuddyPress (1.7.0)
+     *
+     * @param bool $retval  Whether or not we are on a BuddyPress post type.
+     * @param bool $open    True if comments open, false if closed.
+     * @param int  $post_id Post ID for the checked post.
+     */
     return apply_filters( 'bp_force_comment_status', $retval, $open, $post_id );
 }