<!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>[4484] sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php: Plugin Directory: First pass at adding post meta to REST API.</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/4484">4484</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/4484","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>obenland</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2016-12-04 22:45:34 +0000 (Sun, 04 Dec 2016)</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'>Plugin Directory: First pass at adding post meta to REST API.
We'll need to register our own rest api fields for more complex data
structures, namely objects and arrays of objects.
See <a href="http://meta.trac.wordpress.org/ticket/1576">#1576</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassplugindirectoryphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsplugindirectoryclassplugindirectoryphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php 2016-12-04 22:10:02 UTC (rev 4483)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/plugin-directory/class-plugin-directory.php 2016-12-04 22:45:34 UTC (rev 4484)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1,7 +1,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> <?php
</span><span class="cx" style="display: block; padding: 0 10px"> namespace WordPressdotorg\Plugin_Directory;
</span><span class="cx" style="display: block; padding: 0 10px"> use WordPressdotorg\Plugin_Directory\Admin\Customizations;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-use WordPressdotorg\Plugin_Directory\CLI\Tag_To_Category;
</del><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"> * The main Plugin Directory class, it handles most of the bootstrap and basic operations of the plugin.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -108,9 +107,10 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'edit_item' => is_admin() ? __( 'Editing Plugin: %s', 'wporg-plugins' ) : __( 'Edit Plugin', 'wporg-plugins' ),
</span><span class="cx" style="display: block; padding: 0 10px"> ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'description' => __( 'A Repo Plugin', 'wporg-plugins' ),
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- 'supports' => array( 'comments', 'author' ),
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'supports' => array( 'comments', 'author', 'custom-fields' ),
</ins><span class="cx" style="display: block; padding: 0 10px"> 'public' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'show_ui' => true,
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'show_in_rest' => true,
</ins><span class="cx" style="display: block; padding: 0 10px"> 'has_archive' => true,
</span><span class="cx" style="display: block; padding: 0 10px"> 'rewrite' => false,
</span><span class="cx" style="display: block; padding: 0 10px"> 'menu_icon' => 'dashicons-admin-plugins',
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -289,6 +289,145 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'label_count' => _n_noop( 'Rejected <span class="count">(%s)</span>', 'Rejected <span class="count">(%s)</span>', 'wporg-plugins' ),
</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">+ /**
+ * TODO
+ * Use register_rest_field() to add array and object meta data to the API:
+ * ratings, upgrade_notice, contributors, screenshots, sections, assets_screenshots,
+ * assets_icons, assets_banners,
+ */
+
+ register_meta( 'post', 'rating', array(
+ 'type' => 'number',
+ 'description' => __( 'Overall rating of the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ // todo 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'active_installs', array(
+ 'type' => 'integer',
+ 'description' => __( 'Number of installations.', 'wporg-plugins' ),
+ 'single' => true,
+ 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'downloads', array(
+ 'type' => 'integer',
+ 'description' => __( 'Number of downloads', 'wporg-plugins' ),
+ 'single' => true,
+ 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'tested', array(
+ 'description' => __( 'The version of WordPress the plugin was tested with.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'requires', array(
+ 'description' => __( 'The minimum version of WordPress the plugin needs to run.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'stable_tag', array(
+ 'description' => __( 'Stable version of the plugin', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'donate_link', array(
+ 'description' => __( 'Link to donate to the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'version', array(
+ 'description' => __( 'Current stable version.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'header_name', array(
+ 'description' => __( 'Name of the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'header_plugin_uri', array(
+ 'description' => __( 'URL to the homepage of the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'header_name', array(
+ 'description' => __( 'Name of the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'header_author', array(
+ 'description' => __( 'Name of the plugin author.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'header_author_uri', array(
+ 'description' => __( 'URL to the homepage of the author.', 'wporg-plugins' ),
+ 'single' => true,
+ 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'header_description', array(
+ 'description' => __( 'Description of the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'assets_icons', array(
+ 'type' => 'array',
+ 'description' => __( 'Icon images of the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'assets_banners_color', array(
+ 'description' => __( 'Fallback color for the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ // TODO 'sanitize_callback' => 'esc_url_raw',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'support_threads', array(
+ 'type' => 'integer',
+ 'description' => __( 'Amount of support threads for the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ ) );
+
+ register_meta( 'post', 'support_threads_resolved', array(
+ 'type' => 'integer',
+ 'description' => __( 'Amount of resolved support threads for the plugin.', 'wporg-plugins' ),
+ 'single' => true,
+ 'sanitize_callback' => 'absint',
+ 'show_in_rest' => true,
+ ) );
+
</ins><span class="cx" style="display: block; padding: 0 10px"> // Add the browse/* views.
</span><span class="cx" style="display: block; padding: 0 10px"> add_rewrite_tag( '%browse%', '(featured|popular|beta|new|favorites)' );
</span><span class="cx" style="display: block; padding: 0 10px"> add_permastruct( 'browse', 'browse/%browse%' );
</span></span></pre>
</div>
</div>
</body>
</html>