<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" />
<title>[4804] sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp: WCPT: Enable a v2 REST endpoint for the WordCamp CPT</title>
</head>
<body>
<style type="text/css"><!--
#msg dl.meta { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dl.meta dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer, #logmsg { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fa0 solid; padding: 6px; }
#logmsg { background: #ffc; border: 1px #fa0 solid; padding: 1em 1em 0 1em; }
#logmsg p, #logmsg pre, #logmsg blockquote { margin: 0 0 1em 0; }
#logmsg p, #logmsg li, #logmsg dt, #logmsg dd { line-height: 14pt; }
#logmsg h1, #logmsg h2, #logmsg h3, #logmsg h4, #logmsg h5, #logmsg h6 { margin: .5em 0; }
#logmsg h1:first-child, #logmsg h2:first-child, #logmsg h3:first-child, #logmsg h4:first-child, #logmsg h5:first-child, #logmsg h6:first-child { margin-top: 0; }
#logmsg ul, #logmsg ol { padding: 0; list-style-position: inside; margin: 0 0 0 1em; }
#logmsg ul { text-indent: -1em; padding-left: 1em; }#logmsg ol { text-indent: -1.5em; padding-left: 1.5em; }
#logmsg > ul, #logmsg > ol { margin: 0 0 1em 0; }
#logmsg pre { background: #eee; padding: 1em; }
#logmsg blockquote { border: 1px solid #fa0; border-left-width: 10px; padding: 1em 1em 0 1em; background: white;}
#logmsg dl { margin: 0; }
#logmsg dt { font-weight: bold; }
#logmsg dd { margin: 0; padding: 0 0 0.5em 0; }
#logmsg dd:before { content:'\00bb';}
#logmsg table { border-spacing: 0px; border-collapse: collapse; border-top: 4px solid #fa0; border-bottom: 1px solid #fa0; background: #fff; }
#logmsg table th { text-align: left; font-weight: normal; padding: 0.2em 0.5em; border-top: 1px dotted #fa0; }
#logmsg table td { text-align: right; border-top: 1px dotted #fa0; padding: 0.2em 0.5em; }
#logmsg table thead th { text-align: center; border-bottom: 1px solid #fa0; }
#logmsg table th.Corner { text-align: left; }
#logmsg hr { border: none 0; border-top: 2px dashed #fa0; height: 1px; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<div id="msg">
<dl class="meta" style="font-size: 105%">
<dt style="float: left; width: 6em; font-weight: bold">Revision</dt> <dd><a style="font-weight: bold" href="http://meta.trac.wordpress.org/changeset/4804">4804</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"http://meta.trac.wordpress.org/changeset/4804","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>coreymckrill</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2017-01-26 23:29:48 +0000 (Thu, 26 Jan 2017)</dd>
</dl>
<pre style='padding-left: 1em; margin: 2em 0; border-left: 2px solid #ccc; line-height: 1.25; font-size: 105%; font-family: sans-serif'>WCPT: Enable a v2 REST endpoint for the WordCamp CPT
This endpoint mimics the `posts` endpoint, except with the following
modifications:
* WCPT uses custom post statuses, more than one of which is considered
public. The default REST response includes all posts with a public
post status.
* Since a response may contain posts of more than one post status, that
property is exposed in the `view` context.
* Several post meta fields are exposed in the `view` context.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginswcptwcptwordcampwordcamploaderphp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/wordcamp-loader.php</a></li>
</ul>
<h3>Added Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginswcptwcptwordcampclasswprestwordcampscontrollerphp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/class-wp-rest-wordcamps-controller.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginswcptwcptwordcampclasswprestwordcampscontrollerphp"></a>
<div class="addfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Added: sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/class-wp-rest-wordcamps-controller.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/class-wp-rest-wordcamps-controller.php (rev 0)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/class-wp-rest-wordcamps-controller.php 2017-01-26 23:29:48 UTC (rev 4804)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -0,0 +1,67 @@
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+<?php
+
+/**
+ * Class to access WordCamp CPT posts via the v2 REST API.
+ *
+ * @see WP_REST_Posts_Controller
+ */
+class WordCamp_REST_WordCamps_Controller extends WP_REST_Posts_Controller {
+ /**
+ * Retrieves the WordCamp post's schema, conforming to JSON Schema.
+ *
+ * WordCamp-specific modifications to the standard post schema.
+ *
+ * @access public
+ *
+ * @return array Item schema data.
+ */
+ public function get_item_schema() {
+ $schema = parent::get_item_schema();
+
+ // Since there is more than one public post status, show it in REST response
+ if ( false === array_search( 'view', $schema['properties']['status']['context'] ) ) {
+ $schema['properties']['status']['context'][] = 'view';
+ }
+
+ return $this->add_additional_fields_schema( $schema );
+ }
+
+ /**
+ * Sanitizes and validates the list of post statuses, including whether the
+ * user can query private statuses.
+ *
+ * Based on the method in WP_REST_Posts_Controller, but takes into account that
+ * there are multiple public statuses for the WordCamp CPT.
+ *
+ * @access public
+ *
+ * @param string|array $statuses One or more post statuses.
+ * @param WP_REST_Request $request Full details about the request.
+ * @param string $parameter Additional parameter to pass to validation.
+ * @return array|WP_Error A list of valid statuses, otherwise WP_Error object.
+ */
+ public function sanitize_post_statuses( $statuses, $request, $parameter ) {
+ $statuses = wp_parse_slug_list( $statuses );
+
+ $public_statuses = WordCamp_Loader::get_public_post_statuses();
+
+ foreach ( $statuses as $status ) {
+ if ( in_array( $status, $public_statuses ) ) {
+ continue;
+ }
+
+ $post_type_obj = get_post_type_object( $this->post_type );
+
+ if ( current_user_can( $post_type_obj->cap->edit_posts ) ) {
+ $result = rest_validate_request_arg( $status, $request, $parameter );
+ if ( is_wp_error( $result ) ) {
+ return $result;
+ }
+ } else {
+ return new WP_Error( 'rest_forbidden_status', __( 'Status is forbidden.' ), array( 'status' => rest_authorization_required_code() ) );
+ }
+ }
+
+ return $statuses;
+ }
+}
</ins><span class="cx" style="display: block; padding: 0 10px">\ No newline at end of file
</span></span></pre></div>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginswcptwcptwordcampwordcamploaderphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/wordcamp-loader.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/wordcamp-loader.php 2017-01-26 23:29:43 UTC (rev 4803)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/wcpt/wcpt-wordcamp/wordcamp-loader.php 2017-01-26 23:29:48 UTC (rev 4804)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -21,13 +21,15 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * The main WordCamp Post Type loader
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function __construct() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- add_action( 'plugins_loaded', array( $this, 'includes' ) );
- add_action( 'init', array( $this, 'register_post_types' ) );
- add_action( 'init', array( $this, 'register_post_statuses' ) );
- add_filter( 'pre_get_posts', array( $this, 'query_public_statuses_on_archives' ) );
- add_action( 'wp_insert_post_data', array( $this, 'set_scheduled_date' ) );
- add_filter( 'wordcamp_rewrite_rules', array( $this, 'wordcamp_rewrite_rules' ) );
- add_filter( 'query_vars', array( $this, 'query_vars' ) );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ add_action( 'plugins_loaded', array( $this, 'includes' ) );
+ add_action( 'init', array( $this, 'register_post_types' ) );
+ add_action( 'init', array( $this, 'register_post_statuses' ) );
+ add_filter( 'pre_get_posts', array( $this, 'query_public_statuses_on_archives' ) );
+ add_action( 'wp_insert_post_data', array( $this, 'set_scheduled_date' ) );
+ add_filter( 'wordcamp_rewrite_rules', array( $this, 'wordcamp_rewrite_rules' ) );
+ add_filter( 'query_vars', array( $this, 'query_vars' ) );
+ add_filter( 'rest_wordcamp_collection_params', array( $this, 'set_rest_post_status_default' ) );
+ add_action( 'rest_api_init', array( $this, 'register_rest_public_fields' ) );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,6 +41,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function includes () {
</span><span class="cx" style="display: block; padding: 0 10px"> // Load the files
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ require_once ( WCPT_DIR . 'wcpt-wordcamp/class-wp-rest-wordcamps-controller.php' );
</ins><span class="cx" style="display: block; padding: 0 10px"> require_once ( WCPT_DIR . 'wcpt-wordcamp/wordcamp-template.php' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Quick admin check and load if needed
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -92,18 +95,21 @@
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Register WordCamp post type
</span><span class="cx" style="display: block; padding: 0 10px"> register_post_type( WCPT_POST_TYPE_ID, array(
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'labels' => $wcpt_labels,
- 'rewrite' => $wcpt_rewrite,
- 'supports' => $wcpt_supports,
- 'menu_position' => '100',
- 'public' => true,
- 'show_ui' => true,
- 'can_export' => true,
- 'capability_type' => 'post',
- 'hierarchical' => false,
- 'has_archive' => true,
- 'query_var' => true,
- 'menu_icon' => 'dashicons-wordpress',
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'labels' => $wcpt_labels,
+ 'rewrite' => $wcpt_rewrite,
+ 'supports' => $wcpt_supports,
+ 'menu_position' => '100',
+ 'public' => true,
+ 'show_ui' => true,
+ 'can_export' => true,
+ 'capability_type' => 'post',
+ 'hierarchical' => false,
+ 'has_archive' => true,
+ 'query_var' => true,
+ 'menu_icon' => 'dashicons-wordpress',
+ 'show_in_rest' => true,
+ 'rest_base' => 'wordcamps',
+ 'rest_controller_class' => 'WordCamp_REST_WordCamps_Controller',
</ins><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -354,6 +360,79 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Meta field keys to publicly expose in the v2 REST API
+ *
+ * @see wcorg_json_expose_whitelisted_meta_data() in mu-plugins/wcorg-json-api.php
+ *
+ * @return array
+ */
+ public static function get_public_meta_keys() {
+ return array(
+ // Sourced from wcorg_json_expose_whitelisted_meta_data()
+ 'Start Date (YYYY-mm-dd)',
+ 'End Date (YYYY-mm-dd)',
+ 'Location',
+ 'URL',
+ 'Twitter',
+ 'WordCamp Hashtag',
+ 'Number of Anticipated Attendees',
+ 'Organizer Name',
+ 'WordPress.org Username',
+ 'Venue Name',
+ 'Physical Address',
+ 'Maximum Capacity',
+ 'Available Rooms',
+ 'Website URL',
+ 'Exhibition Space Available',
+ // Additional venue data
+ '_venue_coordinates',
+ '_venue_city',
+ '_venue_state',
+ '_venue_country_code',
+ '_venue_country_name',
+ '_venue_zip',
+ );
+ }
+
+ /**
+ * Register fields to publicly expose in the v2 REST API
+ *
+ * @hooked action rest_api_init
+ */
+ public function register_rest_public_fields() {
+ $keys = self::get_public_meta_keys();
+
+ foreach ( $keys as $key ) {
+ register_rest_field(
+ 'wordcamp',
+ $key,
+ array(
+ 'get_callback' => function( $object, $field_name ) {
+ return get_post_meta( $object['id'], $field_name, true );
+ }
+ )
+ );
+ }
+ }
+
+ /**
+ * Change the default status used for the WordCamp CPT in the v2 REST API.
+ *
+ * @hooked filter rest_wordcamp_collection_params
+ *
+ * @param array $query_params
+ *
+ * @return array
+ */
+ public function set_rest_post_status_default( $query_params ) {
+ if ( isset( $query_params['status'] ) ) {
+ $query_params['status']['default'] = WordCamp_Loader::get_public_post_statuses();
+ }
+
+ return $query_params;
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Additional rules for the WordCamp post type.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $rules Rewrite rules.
</span></span></pre>
</div>
</div>
</body>
</html>