Changeset 7276

Timestamp:

07/02/2024 04:11:29 PM (9 months 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.

Location:

trunk/src/includes

Files:

• common/template.php (modified) (1 diff)
• core/filters.php (modified) (1 diff)
• forums/template.php (modified) (1 diff)
• replies/template.php (modified) (2 diffs)
• topics/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 );
+}

trunk/src/includes/core/filters.php

@@ -64 +64 @@
 // Reply title fallback
 add_filter( 'the_title', 'bbp_get_reply_title_fallback', 2, 2 );
+
+// Special title formatting
+add_filter( 'protected_title_format', 'bbp_no_title_status_hints', 10, 2 );
+add_filter( 'private_title_format',   'bbp_no_title_status_hints', 10, 2 );
 
 // Avoid queries & 404s

trunk/src/includes/forums/template.php

@@ -373 +373 @@
     function bbp_get_forum_title( $forum_id = 0 ) {
         $forum_id = bbp_get_forum_id( $forum_id );
-        $title    = get_the_title( $forum_id );
+        $title    = get_post_field( 'post_title', $forum_id );
+        $title    = apply_filters( 'the_title', $title, $forum_id );
 
         // Filter & return

trunk/src/includes/replies/template.php

@@ -524 +524 @@
     function bbp_get_reply_title( $reply_id = 0 ) {
         $reply_id = bbp_get_reply_id( $reply_id );
-        $title    = get_the_title( $reply_id );
+        $title    = get_post_field( 'post_title', $reply_id );
+        $title    = apply_filters( 'the_title', $title, $reply_id );
 
         // Filter & return
@@ -1401 +1402 @@
         $reply_id = bbp_get_reply_id( $reply_id );
         $topic_id = bbp_get_reply_topic_id( $reply_id );
-
-        // Filter & return
-        return apply_filters( 'bbp_get_reply_topic_title', bbp_get_topic_title( $topic_id ), $reply_id );
+        $title    = bbp_get_topic_title( $topic_id );
+
+        // Filter & return
+        return apply_filters( 'bbp_get_reply_topic_title', $title, $reply_id );
     }
 

trunk/src/includes/topics/template.php

@@ -601 +601 @@
     function bbp_get_topic_title( $topic_id = 0 ) {
         $topic_id = bbp_get_topic_id( $topic_id );
-        $title    = get_the_title( $topic_id );
+        $title    = get_post_field( 'post_title', $topic_id );
+        $title    = apply_filters( 'the_title', $title, $topic_id );
 
         // Filter & return