Changeset 6438 for trunk/src/includes/core/theme-compat.php

Timestamp:

05/27/2017 05:04:31 PM (7 years ago)

Author:

johnjamesjacoby

Message:

Tools: Add //Filter & return note for future discovery of missing filter documentation.

Also adjust some type-casting on filtered results.

File:

• trunk/src/includes/core/theme-compat.php (modified) (6 diffs)

trunk/src/includes/core/theme-compat.php

@@ -126 +126 @@
  */
 function bbp_get_theme_compat_id() {
+
+    // Filter & return
     return apply_filters( 'bbp_get_theme_compat_id', bbpress()->theme_compat->theme->id );
 }
@@ -141 +143 @@
  */
 function bbp_get_theme_compat_name() {
+
+    // Filter & return
     return apply_filters( 'bbp_get_theme_compat_name', bbpress()->theme_compat->theme->name );
 }
 
 /**
- * Gets the version of the bbPress compatable theme used, in the event the
+ * Gets the version of the bbPress compatible theme used, in the event the
  * currently active WordPress theme does not explicitly support bbPress.
  * This can be filtered or set manually. Tricky theme authors can override the
@@ -156 +160 @@
  */
 function bbp_get_theme_compat_version() {
+
+    // Filter & return
     return apply_filters( 'bbp_get_theme_compat_version', bbpress()->theme_compat->theme->version );
+}
+
+/**
+ * Gets the bbPress compatible theme used in the event the currently active
+ * WordPress theme does not explicitly support bbPress. This can be filtered,
+ * or set manually. Tricky theme authors can override the default and include
+ * their own bbPress compatibility layers for their themes.
+ *
+ * @since 2.0.0 bbPress (r3032)
+ *
+ * @uses apply_filters()
+ * @return string
+ */
+function bbp_get_theme_compat_dir() {
+
+    // Filter & return
+    return apply_filters( 'bbp_get_theme_compat_dir', bbpress()->theme_compat->theme->dir );
 }
 
@@ -170 +193 @@
  * @return string
  */
-function bbp_get_theme_compat_dir() {
-    return apply_filters( 'bbp_get_theme_compat_dir', bbpress()->theme_compat->theme->dir );
-}
-
-/**
- * Gets the bbPress compatable theme used in the event the currently active
- * WordPress theme does not explicitly support bbPress. This can be filtered,
- * or set manually. Tricky theme authors can override the default and include
- * their own bbPress compatibility layers for their themes.
- *
- * @since 2.0.0 bbPress (r3032)
- *
- * @uses apply_filters()
- * @return string
- */
 function bbp_get_theme_compat_url() {
+
+    // Filter & return
     return apply_filters( 'bbp_get_theme_compat_url', bbpress()->theme_compat->theme->url );
 }
@@ -823 +833 @@
     }
 
+    // Filter & return
     return apply_filters( 'bbp_template_include_theme_compat', $template );
 }
@@ -1017 +1028 @@
     }
 
-    // Allow override of the override
+    // Filter & return
     return (bool) apply_filters( 'bbp_force_comment_status', $retval, $open, $post_id, $post_type );
 }