Changeset 7276 for trunk/src/includes/common/template.php

Timestamp:

07/02/2024 04:11:29 PM (2 years ago)

Author:

johnjamesjacoby

Message:

Posts: strip "Protected/Private" for bbPress post types

This change prevents post title hints from being prepended to titles of Forums, Topics, or Replies, which was happening as a consequence of calling get_the_title() which assumes every protected/private post title needs it.

It does this by including the following code changes:

• introduce the bbp_no_title_status_hints() filter function, which hooks into 2 WordPress filters and maybe overrides the return value
• replace a few get_the_title() calls with get_post_field( 'post_title' ) to bypass the above filters when they would never be desirable

Committer note: this could be considered a small back-compat break (because it alters long-standing theme-side output) but ultimately it is a design decision to output all of the forum content as it was saved by the community members. Forums that prefer the old behavior can unhook bbp_no_title_status_hints and continue to customize child template parts to insert custom forum status hints.

Fixes #3602.

File:

• trunk/src/includes/common/template.php (modified) (1 diff)

trunk/src/includes/common/template.php

@@ -2845 +2845 @@
     return apply_filters( 'bbp_title', $new_title, $sep, $seplocation );
 }
+
+/**
+ * Removes Protected/Private post title hints.
+ *
+ * This function is hooked to 2 WordPress filters that are responsible for
+ * prepending hints to the beginning of Protected & Private post titles.
+ *
+ * These hints are a bit unsightly when used in functions like
+ * bbp_get_breadcrumb(), so we strip them back out for bbPress post types.
+ *
+ * @since 2.7.0
+ *
+ * @param string      $prepend Text displayed before a post title.
+ * @param int|WP_Post $post    Current post object.
+ *
+ * @return string
+ */
+function bbp_no_title_status_hints( $prepend = '', $post = 0 ) {
+
+    // Bail if empty
+    if ( empty( $prepend ) || empty( $post ) ) {
+        return $prepend;
+    }
+
+    // Get post type
+    $post_type = get_post_type( $post );
+
+    // Maybe override return value
+    $retval = in_array( $post_type, bbp_get_post_types(), true )
+        ? '%s'
+        : $prepend;
+
+    // Filter & return
+    return (string) apply_filters( 'bbp_no_special_title_formatting', $retval, $prepend, $post );
+}