<!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>[13854] sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/rest-api/class-theme-preview.php: Theme Directory: Add a rest api endpoint to set the blueprint for previews.</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/13854">13854</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/13854","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>dd32</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2024-06-24 06:49:23 +0000 (Mon, 24 Jun 2024)</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'>Theme Directory: Add a rest api endpoint to set the blueprint for previews.
See <a href="http://meta.trac.wordpress.org/changeset/13851">r13851</a>.
See https://github.com/WordPress/wporg-theme-directory/pull/118.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentpluginsthemedirectoryrestapiclassthemepreviewphp">sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/rest-api/class-theme-preview.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentpluginsthemedirectoryrestapiclassthemepreviewphp"></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/theme-directory/rest-api/class-theme-preview.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/theme-directory/rest-api/class-theme-preview.php 2024-06-21 05:18:44 UTC (rev 13853)
+++ sites/trunk/wordpress.org/public_html/wp-content/plugins/theme-directory/rest-api/class-theme-preview.php 2024-06-24 06:49:23 UTC (rev 13854)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -12,6 +12,24 @@
</span><span class="cx" style="display: block; padding: 0 10px"> 'callback' => array( $this, 'preview' ),
</span><span class="cx" style="display: block; padding: 0 10px"> 'permission_callback' => '__return_true',
</span><span class="cx" style="display: block; padding: 0 10px"> ) );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ register_rest_route( 'themes/v1', 'preview-blueprint/(?<slug>[^/]+)', array(
+ 'methods' => WP_REST_Server::CREATABLE,
+ 'callback' => array( $this, 'set_blueprint' ),
+ 'permission_callback' => function( $request ) {
+ $theme_data = wporg_themes_theme_information( $request['slug'] );
+ $theme_package = new WPORG_Themes_Repo_Package( $theme_data->slug );
+
+ if ( ! empty( $theme_data->error ) || ! $theme_package->post_author ) {
+ return false;
+ }
+
+ return (
+ get_current_user_id() === $theme_package->post_author ||
+ current_user_can( 'edit_post', $theme_package->ID )
+ );
+ },
+ ) );
</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">@@ -18,10 +36,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Generate a Blueprint for a theme preview.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function preview( $request ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $theme_data = wporg_themes_query_api(
- 'theme_information',
- [ 'slug' => $request->get_param( 'slug' ) ]
- );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_data = wporg_themes_theme_information( $request->get_param( 'slug' ) );
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! empty( $theme_data->error ) ) {
</span><span class="cx" style="display: block; padding: 0 10px"> return new WP_Error( 'error', $theme_data->error );
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,12 +46,39 @@
</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">+ * Set a Blueprint for a theme preview.
+ */
+ function set_blueprint( $request ) {
+ $theme_data = wporg_themes_theme_information( $request['slug'] );
+ $theme_package = new WPORG_Themes_Repo_Package( $theme_data->slug );
+
+ if ( ! empty( $theme_data->error ) ) {
+ return new WP_Error( 'error', $theme_data->error );
+ }
+
+ // Validate the blueprint, TODO expand upon this.
+ if (
+ empty( $request['blueprint'] ) ||
+ ! is_string( $request['blueprint'] ) ||
+ ! ( $decoded_blueprint = json_decode( $request['blueprint'], true) ) ||
+ empty( $decoded_blueprint['steps'] )
+ ) {
+ return new WP_Error( 'error', 'Invalid Blueprint provided, verify the JSON validates.' );
+ }
+
+ // Save the blueprint.
+ update_post_meta( $theme_package->ID, 'preview_blueprint', $decoded_blueprint );
+
+ return $this->build_blueprint( $theme_data );
+ }
+
+ /**
</ins><span class="cx" style="display: block; padding: 0 10px"> * Generate a blueprint for previewing a theme.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> function build_blueprint( $theme_data ) {
</span><span class="cx" style="display: block; padding: 0 10px"> $theme_package = new WPORG_Themes_Repo_Package( $theme_data->slug );
</span><span class="cx" style="display: block; padding: 0 10px"> $parent_package = $theme_data->template ? new WPORG_Themes_Repo_Package( $theme_data->template ) : false;
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- $theme_blueprint = $theme_package->blueprint;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ $theme_blueprint = $theme_package->preview_blueprint;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Base blueprint.
</span><span class="cx" style="display: block; padding: 0 10px"> $blueprint = [
</span></span></pre>
</div>
</div>
</body>
</html>