<!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>[8755] sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types/inc/rest-api.php: WordCamp Post Types: Add collection parameters to sessions endpoint</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 { white-space: pre-line; 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/8755">8755</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/8755","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>2019-05-08 23:43:13 +0000 (Wed, 08 May 2019)</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'>WordCamp Post Types: Add collection parameters to sessions endpoint
* Enable sessions to be queried by public meta fields.
* Refactor meta registration to use Core's `register_post_meta` function.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordcamporgpublic_htmlwpcontentpluginswcposttypesincrestapiphp">sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types/inc/rest-api.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordcamporgpublic_htmlwpcontentpluginswcposttypesincrestapiphp"></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/wc-post-types/inc/rest-api.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/wc-post-types/inc/rest-api.php 2019-05-08 20:55:46 UTC (rev 8754)
+++ sites/trunk/wordcamp.org/public_html/wp-content/plugins/wc-post-types/inc/rest-api.php 2019-05-08 23:43:13 UTC (rev 8755)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -6,7 +6,7 @@
</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"> namespace WordCamp\Post_Types\REST_API;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-use WP_Rest_Server;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+use WP_Rest_Server, WP_Post_Type;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> defined( 'WPINC' ) || die();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -13,44 +13,27 @@
</span><span class="cx" style="display: block; padding: 0 10px"> require_once( 'favorite-schedule-shortcode.php' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * Add non-sensitive meta fields to the speaker/session REST API endpoints
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Add non-sensitive meta fields to WordCamp post type REST API endpoints.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * If we ever want to register meta for purposes other than exposing it in the API, then this function will
</span><span class="cx" style="display: block; padding: 0 10px"> * probably need to be re-thought and re-factored.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @uses wcorg_register_meta_only_on_endpoint()
- *
</del><span class="cx" style="display: block; padding: 0 10px"> * @return void
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function expose_public_post_meta() {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $public_session_fields = array(
- '_wcpt_session_time' => array(
- 'type' => 'integer',
- 'single' => true,
- ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $meta_defaults = [
+ 'show_in_rest' => true,
+ 'single' => true,
+ ];
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '_wcpt_session_type' => array(
- 'single' => true,
- ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Session.
+ register_post_meta( 'wcb_session', '_wcpt_session_time', wp_parse_args( [ 'type' => 'integer' ], $meta_defaults ) );
+ register_post_meta( 'wcb_session', '_wcpt_session_type', $meta_defaults );
+ register_post_meta( 'wcb_session', '_wcpt_session_slides', $meta_defaults );
+ register_post_meta( 'wcb_session', '_wcpt_session_video', $meta_defaults );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- '_wcpt_session_slides' => array(
- 'single' => true,
- ),
-
- '_wcpt_session_video' => array(
- 'single' => true,
- ),
- );
-
- wcorg_register_meta_only_on_endpoint( 'post', $public_session_fields, '/wp-json/wp/v2/sessions/' );
-
- $public_sponsor_fields = array(
- '_wcpt_sponsor_website' => array(
- 'single' => true,
- ),
- );
-
- wcorg_register_meta_only_on_endpoint( 'post', $public_sponsor_fields, '/wp-json/wp/v2/sponsors/' );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Sponsor.
+ register_post_meta( 'wcb_sponsor', '_wcpt_sponsor_website', $meta_defaults );
</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"> add_action( 'init', __NAMESPACE__ . '\expose_public_post_meta' );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -147,9 +130,66 @@
</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">+
</ins><span class="cx" style="display: block; padding: 0 10px"> add_action( 'rest_api_init', __NAMESPACE__ . '\register_additional_rest_fields' );
</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">+ * Validate simple meta query parameters in an API request and add them to the args passed to WP_Query.
+ *
+ * @param array $args The prepared args for the WP_Query object.
+ * @param array $request The args from the REST API request.
+ *
+ * @return array
+ */
+function prepare_meta_query_args( $args, $request ) {
+ if ( isset( $request['wc_meta_key'], $request['wc_meta_value'] ) ) {
+ $args['meta_key'] = $request['wc_meta_key'];
+ $args['meta_value'] = $request['wc_meta_value'];
+ }
+
+ return $args;
+}
+
+add_filter( 'rest_wcb_session_query', __NAMESPACE__ . '\prepare_meta_query_args', 10, 2 );
+
+/**
+ * Add meta field schemas to Sessions collection parameters.
+ *
+ * This enables and validates simple meta query parameters for the Sessions endpoint. Specific meta keys are
+ * safelisted by filtering for ones that have `show_in_rest` set to `true`.
+ *
+ * TODO: This is necessary because as of version 5.2, WP does not support meta queries on the posts endpoint.
+ * See https://core.trac.wordpress.org/ticket/47194
+ *
+ * The parameters registered here are prefixed with `wc_` because we don't want to have a collision with a
+ * future implementation in Core, if there ever is one.
+ *
+ * @param array $query_params
+ * @param WP_Post_Type $post_type
+ *
+ * @return array
+ */
+function add_meta_collection_params( $query_params, $post_type ) {
+ // Avoid exposing potentially sensitive data.
+ $public_meta_fields = wp_list_filter( get_registered_meta_keys( 'post', $post_type->name ), [ 'show_in_rest' => true ] );
+
+ $query_params['wc_meta_key'] = [
+ 'description' => __( 'Limit result set to posts with a value set for a specific meta key. Use in conjunction with the wc_meta_value parameter.', 'wordcamporg' ),
+ 'type' => 'string',
+ 'enum' => array_keys( $public_meta_fields ),
+ ];
+
+ $query_params['wc_meta_value'] = [
+ 'description' => __( 'Limit result set to posts with a specific meta value. Use in conjunction with the wc_meta_key parameter.', 'wordcamporg' ),
+ 'type' => 'string',
+ ];
+
+ return $query_params;
+}
+
+add_filter( 'rest_wcb_session_collection_params', __NAMESPACE__ . '\add_meta_collection_params', 10, 2 );
+
+/**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Get the URLs for an avatar based on an email address or username.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param array $post
</span></span></pre>
</div>
</div>
</body>
</html>