Changeset 5164 for sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-json-api.php

Timestamp:

03/22/2017 11:18:25 PM (7 years ago)

Author:

iandunn

Message:

WordCamp JSON API: Add a deprecation notice to V1 endpoints

The endpoints will be deactivated after 2018-04-01.

File:

• sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-json-api.php (modified) (2 diffs)

sites/trunk/wordcamp.org/public_html/wp-content/mu-plugins/wcorg-json-api.php

@@ -18 +18 @@
 add_filter( 'json_prepare_post',           'wcorg_json_embed_related_posts',             999, 3 );   // after `wcorg_json_expose_additional_post_data()`
 add_action( 'wp_json_server_before_serve', 'wcorg_json_avoid_nested_callback_conflicts', 11     );    // after the default endpoints are added in `json_api_default_filters()`
+
+add_filter( 'json_prepare_post',        'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_page',        'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_attachment',  'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_revision',    'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_wcb_speaker', 'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_wcb_session', 'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_wcb_sponsor', 'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_mes',         'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_taxonomy',    'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_term',        'deprecate_v1_endpoints' );
+add_filter( 'json_prepare_user',        'deprecate_v1_endpoints' );
 
 // Allow some routes to skip the JSON REST API v1 plugin.
@@ -378 +390 @@
     }
 }
+
+/**
+ * Add a deprecation notice to objects in the response
+ *
+ * @param array $response_data
+ *
+ * @return array
+ */
+function deprecate_v1_endpoints( $response_data ) {
+    $response_data = array_merge(
+        array( '_WARNING_DEPRECATED' => 'All v1 endpoints have been deprecated, and will be deactivated after 2018-04-01. Please switch to the v2 endpoints by then, in order to ensure that your application continues to function. If you have any questions, join the #meta-wordcamp channel on Slack or email ' . EMAIL_CENTRAL_SUPPORT ),
+        $response_data
+    );
+
+    return $response_data;
+}