Changeset 7348

Timestamp:

08/01/2025 04:12:03 PM (12 months ago)

Author:

johnjamesjacoby

Message:

Core - Canonical: Convert bbp_redirect_canonical() into a sub-action.

This change abstracts the existing internal canonical redirect logic into new dedicated functions so that they can be individually improved or customized in the future.

Pagination and Editing theme-side require intercepting and preventing the core redirection when requesting certain URLs, and there are likely to be new conditions in the future.

In trunk, for 2.7.

Fixes #3648.

Location:

trunk/src/includes

Files:

• core/filters.php (modified) (2 diffs)
• core/sub-actions.php (modified) (1 diff)
• core/theme-compat.php (modified) (1 diff)
• forums/functions.php (modified) (2 diffs)

trunk/src/includes/core/filters.php

@@ -45 +45 @@
 add_filter( 'map_meta_cap',            'bbp_map_meta_caps',      10, 4 );
 add_filter( 'allowed_themes',          'bbp_allowed_themes',     10    );
-add_filter( 'redirect_canonical',      'bbp_redirect_canonical', 10    );
+add_filter( 'redirect_canonical',      'bbp_redirect_canonical', 10, 2 );
 add_filter( 'login_redirect',          'bbp_redirect_login',     2,  3 );
 add_filter( 'logout_url',              'bbp_logout_url',         2,  2 );
@@ -105 +105 @@
 add_filter( 'bbp_template_include', 'bbp_template_include_theme_compat',   4, 2 );
 
+/**
+ * Canonical Redirection
+ *
+ * bbPress needs to tweak the way that the default canonical redirect behavior
+ * works for a number of reasons, and they are individually hooked to a
+ * dedicated sub-action to make them easier to customize.
+ */
+add_filter( 'bbp_redirect_canonical', 'bbp_do_not_redirect_edits',       10, 2 );
+add_filter( 'bbp_redirect_canonical', 'bbp_do_not_redirect_paginations', 10, 2 );
+        
 // Filter bbPress template locations
 add_filter( 'bbp_get_template_stack', 'bbp_add_template_stack_locations' );

trunk/src/includes/core/sub-actions.php

@@ -552 +552 @@
         return (array) apply_filters( 'bbp_mail', $args );
 }
+
+/**
+ * Redirects incoming links to the proper URL based on the site URL.
+ *
+ * @see redirect_canonical()
+ *
+ * @since 2.0.0 bbPress (r2628)
+ * @since 2.7.0 bbPress {r7345) Converted to a sub-action.
+ *
+ * @param string $redirect_url  The redirect URL.
+ * @param string $requested_url The requested URL.
+ *
+ * @return string Empty string if a topic/forum and their first page,
+ *                 otherwise the redirect URL.
+ */
+function bbp_redirect_canonical( $redirect_url = '', $requested_url = '' ) {
+
+        // Filter & return
+        return (string) apply_filters( 'bbp_redirect_canonical', $redirect_url, $requested_url );
+}

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

@@ -851 +851 @@
 }
 
-/** Helpers *******************************************************************/
-
-/**
- * Remove the canonical redirect to allow pretty pagination
- *
- * @since 2.0.0 bbPress (r2628)
- *
- * @param string $redirect_url Redirect url
- *
- * @return bool|string False if it's a topic/forum and their first page,
- *                      otherwise the redirect url
- */
-function bbp_redirect_canonical( $redirect_url ) {
-
-        // Canonical is for the beautiful
-        if ( bbp_use_pretty_urls() ) {
-
-                // If viewing beyond page 1 of several
-                if ( 1 < bbp_get_paged() ) {
-
-                        // Only on single topics...
-                        if ( bbp_is_single_topic() ) {
-                                $redirect_url = false;
-
-                        // ...and single forums...
-                        } elseif ( bbp_is_single_forum() ) {
-                                $redirect_url = false;
-
-                        // ...and single replies...
-                        } elseif ( bbp_is_single_reply() ) {
-                                $redirect_url = false;
-
-                        // ...and any single anything else...
-                        //
-                        // @todo - Find a more accurate way to disable paged canonicals for
-                        //          paged shortcode usage within other posts.
-                        } elseif ( is_page() || is_singular() ) {
-                                $redirect_url = false;
-                        }
-
-                // If editing a topic
-                } elseif ( bbp_is_topic_edit() ) {
-                        $redirect_url = false;
-
-                // If editing a reply
-                } elseif ( bbp_is_reply_edit() ) {
-                        $redirect_url = false;
+/** Redirection ***************************************************************/
+
+/**
+ * Prevent canonical redirection when editing forums, topics, topic-tags,
+ * replies, and users.
+ *
+ * @since 2.7.0 bbPress (r7345)
+ *
+ * @param string $redirect_url The redirect URL.
+ *
+ * @return string Empty string if cancelling redirection.
+ */
+function bbp_do_not_redirect_edits( $redirect_url = '' ) {
+
+        // Default return value
+        $retval = $redirect_url;
+
+        // Pretty URLs only
+        if ( ! bbp_use_pretty_urls() ) {
+                return $retval;
+        }
+
+        // If editing a forum, topic, topic-tag, reply, or user
+        if ( bbp_is_edit() ) {
+                $retval = '';
+        }
+
+        // Return
+        return $retval;
+}
+
+/**
+ * Prevent canonical redirection to allow pretty pagination of forums & topics.
+ *
+ * @since 2.7.0 bbPress (r7345)
+ *
+ * @param string $redirect_url The redirect URL.
+ *
+ * @return string Empty string if cancelling redirection.
+ */
+function bbp_do_not_redirect_paginations( $redirect_url = '' ) {
+
+        // Default return value
+        $retval = $redirect_url;
+
+        // Pretty URLs only
+        if ( ! bbp_use_pretty_urls() ) {
+                return $retval;
+        }
+
+        // If viewing beyond page 1 of several
+        if ( 1 < bbp_get_paged() ) {
+
+                // Only on single topics...
+                if ( bbp_is_single_topic() ) {
+                        $retval = '';
+
+                // ...and single forums...
+                } elseif ( bbp_is_single_forum() ) {
+                        $retval = '';
+
+                // ...and single replies...
+                } elseif ( bbp_is_single_reply() ) {
+                        $retval = '';
+
+                // ...and any single anything else...
+                //
+                // @todo - Find a more accurate way to disable paged canonicals for
+                //          paged shortcode usage within other posts.
+                } elseif ( is_page() || is_singular() ) {
+                        $retval = '';
                 }
         }
 
-        return $redirect_url;
+        // Return
+        return $retval;
 }
 

trunk/src/includes/forums/functions.php

@@ -2486 +2486 @@
         }
 
-        // If forum is explicitly hidden and user not capable, set 404
+        // If forum is explicitly hidden and user not capable...
         if ( ! empty( $forum_id ) && bbp_is_forum_hidden( $forum_id ) && ! current_user_can( 'read_forum', $forum_id ) ) {
+
+                // Set 404 status
                 bbp_set_404( $wp_query );
         }
@@ -2531 +2533 @@
         }
 
-        // If forum is explicitly hidden and user not capable, set 404
+        // If forum is explicitly private and user not capable
         if ( ! empty( $forum_id ) && bbp_is_forum_private( $forum_id ) && ! current_user_can( 'read_forum', $forum_id ) ) {
+
+                // Set 404 status
                 bbp_set_404( $wp_query );
         }