Changeset 14048

Timestamp:

10/22/2024 01:11:00 AM (8 months ago)

Author:

espellcaste

Message:

Deprecate bp-api-request properly.

The bp.apiRequest function was deprecated in BuddyPress 10.0.0, but still was being hooked into bp_init.

We are moving the related code to deprecated/10.0.php, and we are encouraging developers to use wp.apiRequest instead in the BP REST API documentation.

Props imath.

See #9145
Closes ​https://github.com/buddypress/buddypress/pull/383

Location:

trunk/src/bp-core

Files:

• bp-core-rest-api.php (modified) (1 diff)
• deprecated/10.0.php (modified) (1 diff)

trunk/src/bp-core/bp-core-rest-api.php

@@ -393 +393 @@
 }
 add_filter( 'rest_pre_dispatch', 'bp_rest_api_v1_dispatch_error', 10, 3 );
-
-/**
- * Register the jQuery.ajax wrapper for BP REST API requests.
- *
- * @since 5.0.0
- * @deprecated 10.0.0
- */
-function bp_rest_api_register_request_script() {
-    if ( ! bp_rest_api_is_available() ) {
-        return;
-    }
-
-    wp_register_script(
-        'bp-api-request',
-        sprintf( '%1$sbp-core/js/bp-api-request%2$s.js', buddypress()->plugin_url, bp_core_get_minified_asset_suffix() ),
-        array( 'jquery', 'wp-api-request' ),
-        bp_get_version(),
-        true
-    );
-
-    wp_localize_script(
-        'bp-api-request',
-        'bpApiSettings',
-        array(
-            'unexpectedError'   => __( 'An unexpected error occurred. Please try again.', 'buddypress' ),
-            'deprecatedWarning' => __( 'The bp.apiRequest function is deprecated since BuddyPress 10.0.0, please use wp.apiRequest instead.', 'buddypress' ),
-        )
-    );
-}
-add_action( 'bp_init', 'bp_rest_api_register_request_script' );

trunk/src/bp-core/deprecated/10.0.php

@@ -59 +59 @@
     return $wp_hook;
 }
+
+/**
+ * Register the jQuery.ajax wrapper for BP REST API requests.
+ *
+ * @since 5.0.0
+ * @deprecated 10.0.0
+ */
+function bp_rest_api_register_request_script() {
+    _deprecated_function( __FUNCTION__, '10.0.0' );
+
+    if ( ! bp_rest_api_is_available() ) {
+        return;
+    }
+
+    wp_register_script(
+        'bp-api-request',
+        sprintf( '%1$sbp-core/js/bp-api-request%2$s.js', buddypress()->plugin_url, bp_core_get_minified_asset_suffix() ),
+        array( 'jquery', 'wp-api-request' ),
+        bp_get_version(),
+        true
+    );
+
+    wp_localize_script(
+        'bp-api-request',
+        'bpApiSettings',
+        array(
+            'unexpectedError'   => __( 'An unexpected error occurred. Please try again.', 'buddypress' ),
+            'deprecatedWarning' => __( 'The bp.apiRequest function is deprecated since BuddyPress 10.0.0, please use wp.apiRequest instead.', 'buddypress' ),
+        )
+    );
+}