Changeset 12454 for trunk/src/bp-core/bp-core-rest-api.php

Timestamp:

09/07/2019 05:26:24 PM (6 years ago)

Author:

imath

Message:

Improve the bp.apiRequest() JS function and some PHP code indentation

bp.apiRequest() will make sure to return the JSON response object in case of an error. In case this JSON response object is not available a default error object will be used.

When WordPress version is lower than 4.9, the same function will make sure to override the url option with the REST API root URL only if this option is not already set. Moreover the Nonce header is now only added for REST API requests made on the current site domain.

The PHP code indentation of bp-core/bp-core-rest-api.php file has been improved.

Fixes #8131

File:

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

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

@@ -19 +19 @@
  */
 function bp_rest_is_plugin_active() {
-    return (bool) has_action( 'bp_rest_api_init', 'bp_rest', 5 );
+    return (bool) has_action( 'bp_rest_api_init', 'bp_rest', 5 );
 }
 
@@ -34 +34 @@
  */
 function bp_rest_in_buddypress() {
-    $is_src = defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src';
-
-    return ! $is_src && ! bp_rest_is_plugin_active();
+    $is_src = defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src';
+
+    return ! $is_src && ! bp_rest_is_plugin_active();
 }
 
@@ -48 +48 @@
 function bp_rest_api_is_available() {
 
-    /**
-     * Filter here to disable the BP REST API.
-     *
-     * The BP REST API requires at least WordPress 4.7.0
-     *
-     * @since 5.0.0
-     *
-     * @param boolean $value True if the BP REST API is available. False otherwise.
-     */
-    return apply_filters( 'bp_rest_api_is_available', function_exists( 'create_initial_rest_routes' ) && bp_rest_in_buddypress() ) || bp_rest_is_plugin_active();
+    /**
+     * Filter here to disable the BP REST API.
+     *
+     * The BP REST API requires at least WordPress 4.7.0
+     *
+     * @since 5.0.0
+     *
+     * @param boolean $value True if the BP REST API is available. False otherwise.
+     */
+    return apply_filters( 'bp_rest_api_is_available', function_exists( 'create_initial_rest_routes' ) && bp_rest_in_buddypress() ) || bp_rest_is_plugin_active();
 }
 
@@ -66 +66 @@
  */
 function bp_rest_api_register_request_script() {
-    if ( ! bp_rest_api_is_available() ) {
-        return;
-    }
-
-    $dependencies = array( 'jquery' );
-
-    // The wrapper for WP REST API requests was introduced in WordPress 4.9.0
-    if ( wp_script_is( 'wp-api-request', 'registered' ) ) {
-        $dependencies = array( 'wp-api-request' );
-    }
-
-    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() ),
-        $dependencies,
-        bp_get_version(),
-        true
-    );
-    wp_localize_script(
-        'bp-api-request',
-        'bpApiSettings',
-        array(
-            'root'  => esc_url_raw( get_rest_url() ),
-            'nonce' => wp_create_nonce( 'wp_rest' ),
-        )
-    );
+    if ( ! bp_rest_api_is_available() ) {
+        return;
+    }
+
+    $dependencies = array( 'jquery' );
+
+    // The wrapper for WP REST API requests was introduced in WordPress 4.9.0.
+    if ( wp_script_is( 'wp-api-request', 'registered' ) ) {
+        $dependencies = array( 'wp-api-request' );
+    }
+
+    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() ),
+        $dependencies,
+        bp_get_version(),
+        true
+    );
+
+    wp_localize_script(
+        'bp-api-request',
+        'bpApiSettings',
+        array(
+            'root'            => esc_url_raw( get_rest_url() ),
+            'nonce'           => wp_create_nonce( 'wp_rest' ),
+            'unexpectedError' => __( 'An unexpected error occured. Please try again.', 'buddypress' ),
+        )
+    );
 }
 add_action( 'bp_init', 'bp_rest_api_register_request_script' );