Changeset 13461 for trunk/src/bp-core/bp-core-functions.php

Timestamp:

04/24/2023 02:32:27 AM (18 months ago)

Author:

imath

Message:

Make canonical redirection & Ajax requesting BP Rewrites ready

• Introduces bp_core_setup_query_parser() to decide when to postpone some key hooks firing to bp_parse_query.
• Introduces bp_core_get_query_parser() to get the query parser in use. It contains a filter BP Classic will be able to use to force the Legacy URL parser. So far it uses legacy for pretty links and rewrites for plain links.
• Edit bp_redirect_canonical() & bp_get_canonical_url() so that they use the BP Rewrites API.
• Introduces bp_core_set_ajax_uri_globals() to set the BuddyPress URI globales using the BP Rewrites API inside the Ajax context thanks to the updated bp_reset_query() function.
• To avoid using WP() at each Ajax call, introduces a simple Ajax actions registration process thanks to the new bp_ajax_register_action().
• Update Legacy & Nouveau template packs so that they use this logic. As BP Default will require the legacy URL parser and will be moved inside BP Classic, the theme can stay the way it is.
• Improve the bp_rewrites_pre_get_slug filter logic making it depends on the bp_core_get_query_parser() function.
• Make sure to reset the Members navigation to a new BP_Core_Nav based on the displayed user once the user is available in the component's parse_query() method.

Props r-a-y, johnjamesjacoby, boonebgorges

Closes ​https://github.com/buddypress/buddypress/pull/91
See #4954

File:

• trunk/src/bp-core/bp-core-functions.php (modified) (4 diffs)

trunk/src/bp-core/bp-core-functions.php

@@ -141 +141 @@
 
 /** Functions *****************************************************************/
+
+/**
+ * Get the BuddyPress parser in use.
+ *
+ * @since 12.0.0
+ *
+ * @return string The name of the parser in use.
+ */
+function bp_core_get_query_parser() {
+    /**
+     * Which parser is in use? `rewrites` or `legacy`?
+     *
+     * @todo Remove the Pretty URLs check used during BP Rewrites merge process.
+     *
+     * @since 12.0.0
+     *
+     * @param string $parser The parser to use to decide the hook to attach key actions to.
+     *                       Possible values are `rewrites` or `legacy`.
+     */
+    return apply_filters( 'bp_core_get_query_parser', bp_has_pretty_urls() ? 'legacy' : 'rewrites' );
+}
 
 /**
@@ -2588 +2609 @@
     bp_core_redirect( apply_filters( 'bp_core_search_site', home_url( $slug . $query_string . urlencode( $search_terms ) ), $search_terms ) );
 }
-add_action( 'bp_parse_query', 'bp_core_action_search_site', 13, 0 );
 
 /**
@@ -2607 +2627 @@
     remove_action( 'wp_head', 'adjacent_posts_rel_link_wp_head', 10 );
 }
-add_action( 'bp_init', 'bp_remove_adjacent_posts_rel_link' );
 
 /**
@@ -2979 +2998 @@
      */
     return apply_filters( 'bp_core_get_suggestions', $retval, $args );
+}
+
+/**
+ * Register Ajax actions needing the BP URI globals to be set.
+ *
+ * @since 12.0.0
+ *
+ * @param string $ajax_action The ajax action needing the BP URI globals to be set.
+ * @return boolean            True if the ajax action was registered. False otherwise.
+ */
+function bp_ajax_register_action( $ajax_action = '' ) {
+    // Checks the ajax action is registered.
+    if ( bp_ajax_action_is_registered( $ajax_action ) ) {
+        return false;
+    }
+
+    buddypress()->ajax_actions[] = $ajax_action;
+    return true;
+}
+
+/**
+ * Is the requested ajax action registered?
+ *
+ * @since 12.0.0
+ *
+ * @param string $ajax_action The ajax action to check.
+ * @return boolean            True if the ajax action is registered. False otherwise
+ */
+function bp_ajax_action_is_registered( $ajax_action = '' ) {
+    $registered_ajax_actions = buddypress()->ajax_actions;
+
+    return in_array( $ajax_action, $registered_ajax_actions, true );
 }