<!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>[49075] trunk/src: Docs: Fix typos in some DocBlocks in `js/_enqueues/wp/api.js`.</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="https://core.trac.wordpress.org/changeset/49075">49075</a><script type="application/ld+json">{"@context":"http://schema.org","@type":"EmailMessage","description":"Review this Commit","action":{"@type":"ViewAction","url":"https://core.trac.wordpress.org/changeset/49075","name":"Review Commit"}}</script></dd>
<dt style="float: left; width: 6em; font-weight: bold">Author</dt> <dd>SergeyBiryukov</dd>
<dt style="float: left; width: 6em; font-weight: bold">Date</dt> <dd>2020-09-30 13:52:24 +0000 (Wed, 30 Sep 2020)</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'>Docs: Fix typos in some DocBlocks in `js/_enqueues/wp/api.js`.
Additionally, rename a variable for clarity.
Props mukesh27.
Fixes <a href="https://core.trac.wordpress.org/ticket/51420">#51420</a>.</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunksrcjs_enqueueswpapijs">trunk/src/js/_enqueues/wp/api.js</a></li>
<li><a href="#trunksrcwpincludesrestapiclasswprestserverphp">trunk/src/wp-includes/rest-api/class-wp-rest-server.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunksrcjs_enqueueswpapijs"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/js/_enqueues/wp/api.js</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/js/_enqueues/wp/api.js 2020-09-30 13:12:03 UTC (rev 49074)
+++ trunk/src/js/_enqueues/wp/api.js 2020-09-30 13:52:24 UTC (rev 49075)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -363,16 +363,16 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {string} parentModel The parent model.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {number} modelId The model ID if the object to request
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {string} modelName The model name to use when constructing the model.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param {string} embedSourcePoint Where to check the embedds object for _embed data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param {string} embedSourcePoint Where to check the embedded object for _embed data.
</ins><span class="cx" style="display: block; padding: 0 10px"> * @param {string} embedCheckField Which model field to check to see if the model has data.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return {Deferred.promise} A promise which resolves to the constructed model.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="cx" style="display: block; padding: 0 10px"> buildModelGetter = function( parentModel, modelId, modelName, embedSourcePoint, embedCheckField ) {
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var getModel, embeddeds, attributes, deferred;
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var getModel, embeddedObjects, attributes, deferred;
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- deferred = jQuery.Deferred();
- embeddeds = parentModel.get( '_embedded' ) || {};
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ deferred = jQuery.Deferred();
+ embeddedObjects = parentModel.get( '_embedded' ) || {};
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Verify that we have a valid object id.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! _.isNumber( modelId ) || 0 === modelId ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -381,8 +381,8 @@
</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"> // If we have embedded object data, use that when constructing the getModel.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( embeddeds[ embedSourcePoint ] ) {
- attributes = _.findWhere( embeddeds[ embedSourcePoint ], { id: modelId } );
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( embeddedObjects[ embedSourcePoint ] ) {
+ attributes = _.findWhere( embeddedObjects[ embedSourcePoint ], { id: modelId } );
</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"> // Otherwise use the modelId.
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -416,8 +416,8 @@
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {string} parentModel The parent model.
</span><span class="cx" style="display: block; padding: 0 10px"> * @param {string} collectionName The name to use when constructing the collection.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @param {string} embedSourcePoint Where to check the embedds object for _embed data.
- * @param {string} embedIndex An addiitonal optional index for the _embed data.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @param {string} embedSourcePoint Where to check the embedded object for _embed data.
+ * @param {string} embedIndex An additional optional index for the _embed data.
</ins><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return {Deferred.promise} A promise which resolves to the constructed collection.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -425,19 +425,19 @@
</span><span class="cx" style="display: block; padding: 0 10px"> /**
</span><span class="cx" style="display: block; padding: 0 10px"> * Returns a promise that resolves to the requested collection
</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 the embedded data if available, otherwises fetches the
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * Uses the embedded data if available, otherwise fetches the
</ins><span class="cx" style="display: block; padding: 0 10px"> * data from the server.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @return {Deferred.promise} promise Resolves to a wp.api.collections[ collectionName ]
</span><span class="cx" style="display: block; padding: 0 10px"> * collection.
</span><span class="cx" style="display: block; padding: 0 10px"> */
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- var postId, embeddeds, getObjects,
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ var postId, embeddedObjects, getObjects,
</ins><span class="cx" style="display: block; padding: 0 10px"> classProperties = '',
</span><span class="cx" style="display: block; padding: 0 10px"> properties = '',
</span><span class="cx" style="display: block; padding: 0 10px"> deferred = jQuery.Deferred();
</span><span class="cx" style="display: block; padding: 0 10px">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- postId = parentModel.get( 'id' );
- embeddeds = parentModel.get( '_embedded' ) || {};
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ postId = parentModel.get( 'id' );
+ embeddedObjects = parentModel.get( '_embedded' ) || {};
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Verify that we have a valid post ID.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( ! _.isNumber( postId ) || 0 === postId ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -446,17 +446,17 @@
</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"> // If we have embedded getObjects data, use that when constructing the getObjects.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- if ( ! _.isUndefined( embedSourcePoint ) && ! _.isUndefined( embeddeds[ embedSourcePoint ] ) ) {
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ if ( ! _.isUndefined( embedSourcePoint ) && ! _.isUndefined( embeddedObjects[ embedSourcePoint ] ) ) {
</ins><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Some embeds also include an index offset, check for that.
</span><span class="cx" style="display: block; padding: 0 10px"> if ( _.isUndefined( embedIndex ) ) {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Use the embed source point directly.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- properties = embeddeds[ embedSourcePoint ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ properties = embeddedObjects[ embedSourcePoint ];
</ins><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="cx" style="display: block; padding: 0 10px"> // Add the index to the embed source point.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- properties = embeddeds[ embedSourcePoint ][ embedIndex ];
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ properties = embeddedObjects[ embedSourcePoint ][ embedIndex ];
</ins><span class="cx" style="display: block; padding: 0 10px"> }
</span><span class="cx" style="display: block; padding: 0 10px"> } else {
</span><span class="cx" style="display: block; padding: 0 10px">
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -1057,7 +1057,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">
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- // Continue by calling Bacckbone's sync.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ // Continue by calling Backbone's sync.
</ins><span class="cx" style="display: block; padding: 0 10px"> return Backbone.sync( method, model, options );
</span><span class="cx" style="display: block; padding: 0 10px"> },
</span><span class="cx" style="display: block; padding: 0 10px">
</span></span></pre></div>
<a id="trunksrcwpincludesrestapiclasswprestserverphp"></a>
<div class="modfile"><h4 style="background-color: #eee; color: inherit; margin: 1em 0; padding: 1.3em; font-size: 115%">Modified: trunk/src/wp-includes/rest-api/class-wp-rest-server.php</h4>
<pre class="diff"><span>
<span class="info" style="display: block; padding: 0 10px; color: #888">--- trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2020-09-30 13:12:03 UTC (rev 49074)
+++ trunk/src/wp-includes/rest-api/class-wp-rest-server.php 2020-09-30 13:52:24 UTC (rev 49075)
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -493,7 +493,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Data with sub-requests embedded.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $_links Links.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array $_embedded Embeddeds.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $_embedded Embedded objects.
</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"> public function response_to_data( $response, $embed ) {
</span><span class="lines" style="display: block; padding: 0 10px; color: #888">@@ -617,7 +617,7 @@
</span><span class="cx" style="display: block; padding: 0 10px"> * Data with sub-requests embedded.
</span><span class="cx" style="display: block; padding: 0 10px"> *
</span><span class="cx" style="display: block; padding: 0 10px"> * @type array $_links Links.
</span><del style="background-color: #fdd; text-decoration:none; display:block; padding: 0 10px">- * @type array $_embedded Embeddeds.
</del><ins style="background-color: #dfd; text-decoration:none; display:block; padding: 0 10px">+ * @type array $_embedded Embedded objects.
</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"> protected function embed_links( $data, $embed = true ) {
</span></span></pre>
</div>
</div>
</body>
</html>