<!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>[7580] sites/trunk/wordpress.org/public_html/wp-content/themes/pub/gutenberg/functions.php: Gutenberg: Preload some REST API endpoints with mock/static data to avoid REST API failure errors.</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/7580">7580</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/7580","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>2018-08-02 00:55:50 +0000 (Thu, 02 Aug 2018)</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'>Gutenberg: Preload some REST API endpoints with mock/static data to avoid REST API failure errors.
See <a href="http://meta.trac.wordpress.org/ticket/3703">#3703</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#sitestrunkwordpressorgpublic_htmlwpcontentthemespubgutenbergfunctionsphp">sites/trunk/wordpress.org/public_html/wp-content/themes/pub/gutenberg/functions.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="sitestrunkwordpressorgpublic_htmlwpcontentthemespubgutenbergfunctionsphp"></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/themes/pub/gutenberg/functions.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/themes/pub/gutenberg/functions.php 2018-08-02 00:36:58 UTC (rev 7579)
+++ sites/trunk/wordpress.org/public_html/wp-content/themes/pub/gutenberg/functions.php 2018-08-02 00:55:50 UTC (rev 7580)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -31,6 +31,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_style( 'nav-menus' );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_style( 'l10n' );
</span><span class="cx" style="display: block; padding: 0 10px"> wp_enqueue_style( 'buttons' );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Use a middleware provider to intercept and modify API calls. Short-circuit POST requests, bound queries, allow media, etc.
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_add_inline_script( 'wp-api-fetch',
</span><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><span class="cx" style="display: block; padding: 0 10px"> 'wp.apiFetch.use( function( options, next ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -39,18 +41,77 @@
</span><span class="cx" style="display: block; padding: 0 10px"> lodash.startsWith( options.path, "/gutenberg/v1/block-renderer" )
</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">+ // Prevent non-whitelisted non-GET requests (ie. POST) to prevent errors
</ins><span class="cx" style="display: block; padding: 0 10px"> if ( options.method && options.method !== "GET" && ! isWhitelistedEndpoint ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- return Promise.resolve( options.data ); // This works in enough cases to be the default return value.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // This works in enough cases to be the default return value.
+ return Promise.resolve( options.data );
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Add limits to all GET queries which attempt unbound queries
</ins><span class="cx" style="display: block; padding: 0 10px"> options.path = options.path.replace( "per_page=-1", "per_page=10" );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Load images with the view context, seems to work
+ if ( lodash.startsWith( options.path, "/wp/v2/media/" ) ) {
+ options.path = options.path.replace( "context=edit", "context=view" );
+ }
+
</ins><span class="cx" style="display: block; padding: 0 10px"> return next( options );
</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"> 'after'
</span><span class="cx" style="display: block; padding: 0 10px"> );
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+
+ // Use a middleware preloader to handle the "types" API endpoints with minimal data needed
</ins><span class="cx" style="display: block; padding: 0 10px"> wp_add_inline_script( 'wp-api-fetch',
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp.apiFetch.use( wp.apiFetch.createPreloadingMiddleware( {
+ "/wp/v2/types?context=edit": { "body": {
+ "page": {
+ "rest_base": "pages",
+ "supports": {}
+ },
+ "wp_block": {
+ "rest_base": "blocks",
+ "supports": {}
+ }
+ } },
+ "/wp/v2/types/page?context=edit": { "body": {
+ "rest_base": "pages",
+ "supports": {}
+ } },
+ "/wp/v2/types/wp_block?context=edit": { "body": {
+ "rest_base": "blocks",
+ "supports": {}
+ } }
+ } ) );',
+ 'after'
+ );
+
+ // Use a middleware preloader to load the custom post content:
+ $frontendburg_content = include __DIR__ . '/gutenfront-content.php';
+ wp_add_inline_script( 'wp-api-fetch',
</ins><span class="cx" style="display: block; padding: 0 10px"> sprintf(
</span><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ 'wp.apiFetch.use( wp.apiFetch.createPreloadingMiddleware( %s ) );',
+ wp_json_encode( array(
+ "/wp/v2/pages/" . get_post()->ID . "?context=edit" => [ 'body' => [
+ 'id' => get_post()->ID,
+ 'title' => [ 'raw' => $frontendburg_content['title'] ],
+ 'content' => [ 'block_format' => 1, 'raw' => $frontendburg_content['content'] ],
+ 'excerpt' => [ 'raw' => '' ],
+ 'date' => '', 'date_gmt' => '', 'modified' => '', 'modified_gmt' => '',
+ 'link' => home_url('/'), 'guid' => [],
+ 'parent' => 0, 'menu_order' => 0, 'author' => 0, 'featured_media' => 0,
+ 'comment_status' => 'closed', 'ping_status' => 'closed', 'template' => '', 'meta' => [], '_links' => [],
+ 'type' => 'page', 'status' => 'draft',
+ 'slug' => '', 'generated_slug' => '', 'permalink_template' => home_url('/'),
+ ] ]
+ ) )
+ ),
+ 'after'
+ );
+
+ // Add a middleware provider which intercepts all uploads and stores them within the browser
+ wp_add_inline_script( 'wp-api-fetch',
+ sprintf(
</ins><span class="cx" style="display: block; padding: 0 10px"> 'wp.apiFetch.use( function( options, next ) {
</span><span class="cx" style="display: block; padding: 0 10px"> if ( options.method == "POST" && options.path == "/wp/v2/media" ) {
</span><span class="cx" style="display: block; padding: 0 10px"> var file = options.body.get("file");
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -200,49 +261,6 @@
</span><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> add_action( 'wp_ajax_nopriv_query-attachments', 'frontenberg_wp_ajax_nopriv_query_attachments' );
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">-// Override the WP API to give Gutenberg the REST API responses it wants.
-function frontenberg_override_rest_api( $null, $wp_rest_server, $request ) {
- if ( is_admin() || preg_match( '!/wp-json/!', $_SERVER['REQUEST_URI'] ) ) {
- return $null; // Don't modify an actual API responses..
- }
-
- if ( '/wp/v2/types' == $request->get_route() ) {
- // Minimal data required by Gutenberg for pages.
- return new WP_REST_Response( array(
- 'page' => array(
- 'rest_base' => 'pages',
- )
- ), 200 );
- }
-
- if ( preg_match( '!^/wp/v2/pages/(\d+)$!', $request->get_route(), $m ) ) {
- $content = include __DIR__ . '/gutenfront-content.php';
-
- return new WP_REST_Response( array(
- 'id' => $m[1],
- 'date' => gmdate( 'c' ), 'date_gmt' => gmdate( 'c' ),
- 'modified' => gmdate( 'c' ), 'modified_gmt' => gmdate( 'c' ),
- 'link' => 'https://wordpress.org/gutenberg/', 'guid' => array(),
- 'parent' => 0, 'menu_order' => 0, 'author' => 0, 'featured_media' => 0,
- 'comment_status' => 'closed', 'ping_status' => 'closed', 'template' => '', 'meta' => [], '_links' => [],
- 'type' => 'page', 'status' => 'draft',
- 'slug' => '', 'generated_slug' => '', 'permalink_template' => home_url('/'),
- 'excerpt' => array( 'raw' => '' ),
- 'title' => array(
- 'raw' => $content['title'],
- ),
- 'content' => array(
- 'block_format' => 1,
- 'raw' => $content['content'],
- ),
- ), 200 );
- }
-
- return $null;
-}
-add_filter( 'rest_pre_dispatch', 'frontenberg_override_rest_api', 10, 3 );
-
-
</del><span class="cx" style="display: block; padding: 0 10px"> if ( ! function_exists( 'gutenbergtheme_setup' ) ) :
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Sets up theme defaults and registers support for various WordPress features.
</span></span></pre>
</div>
</div>
</body>
</html>