Changeset 49075

Timestamp:

09/30/2020 01:52:24 PM (4 years ago)

Author:

SergeyBiryukov

Message:

Docs: Fix typos in some DocBlocks in js/_enqueues/wp/api.js.

Additionally, rename a variable for clarity.

Props mukesh27.
Fixes #51420.

Location:

trunk/src

Files:

• js/_enqueues/wp/api.js (modified) (9 diffs)
• wp-includes/rest-api/class-wp-rest-server.php (modified) (2 diffs)

trunk/src/js/_enqueues/wp/api.js

@@ -364 +364 @@
              * @param {number} modelId          The model ID if the object to request
              * @param {string} modelName        The model name to use when constructing the model.
-             * @param {string} embedSourcePoint Where to check the embedds object for _embed data.
+             * @param {string} embedSourcePoint Where to check the embedded object for _embed data.
              * @param {string} embedCheckField  Which model field to check to see if the model has data.
              *
@@ -370 +370 @@
              */
             buildModelGetter = function( parentModel, modelId, modelName, embedSourcePoint, embedCheckField ) {
-                var getModel, embeddeds, attributes, deferred;
-
-                deferred  = jQuery.Deferred();
-                embeddeds = parentModel.get( '_embedded' ) || {};
+                var getModel, embeddedObjects, attributes, deferred;
+
+                deferred        = jQuery.Deferred();
+                embeddedObjects = parentModel.get( '_embedded' ) || {};
 
                 // Verify that we have a valid object id.
@@ -382 +382 @@
 
                 // If we have embedded object data, use that when constructing the getModel.
-                if ( embeddeds[ embedSourcePoint ] ) {
-                    attributes = _.findWhere( embeddeds[ embedSourcePoint ], { id: modelId } );
+                if ( embeddedObjects[ embedSourcePoint ] ) {
+                    attributes = _.findWhere( embeddedObjects[ embedSourcePoint ], { id: modelId } );
                 }
 
@@ -417 +417 @@
              * @param {string} parentModel      The parent model.
              * @param {string} collectionName   The name to use when constructing the collection.
-             * @param {string} embedSourcePoint Where to check the embedds object for _embed data.
-             * @param {string} embedIndex       An addiitonal optional index for the _embed data.
+             * @param {string} embedSourcePoint Where to check the embedded object for _embed data.
+             * @param {string} embedIndex       An additional optional index for the _embed data.
              *
              * @return {Deferred.promise} A promise which resolves to the constructed collection.
@@ -426 +426 @@
                  * Returns a promise that resolves to the requested collection
                  *
-                 * Uses the embedded data if available, otherwises fetches the
+                 * Uses the embedded data if available, otherwise fetches the
                  * data from the server.
                  *
@@ -432 +432 @@
                  * collection.
                  */
-                var postId, embeddeds, getObjects,
+                var postId, embeddedObjects, getObjects,
                     classProperties = '',
                     properties      = '',
                     deferred        = jQuery.Deferred();
 
-                postId    = parentModel.get( 'id' );
-                embeddeds = parentModel.get( '_embedded' ) || {};
+                postId          = parentModel.get( 'id' );
+                embeddedObjects = parentModel.get( '_embedded' ) || {};
 
                 // Verify that we have a valid post ID.
@@ -447 +447 @@
 
                 // If we have embedded getObjects data, use that when constructing the getObjects.
-                if ( ! _.isUndefined( embedSourcePoint ) && ! _.isUndefined( embeddeds[ embedSourcePoint ] ) ) {
+                if ( ! _.isUndefined( embedSourcePoint ) && ! _.isUndefined( embeddedObjects[ embedSourcePoint ] ) ) {
 
                     // Some embeds also include an index offset, check for that.
@@ -453 +453 @@
 
                         // Use the embed source point directly.
-                        properties = embeddeds[ embedSourcePoint ];
+                        properties = embeddedObjects[ embedSourcePoint ];
                     } else {
 
                         // Add the index to the embed source point.
-                        properties = embeddeds[ embedSourcePoint ][ embedIndex ];
+                        properties = embeddedObjects[ embedSourcePoint ][ embedIndex ];
                     }
                 } else {
@@ -1058 +1058 @@
                 }
 
-                // Continue by calling Bacckbone's sync.
+                // Continue by calling Backbone's sync.
                 return Backbone.sync( method, model, options );
             },

trunk/src/wp-includes/rest-api/class-wp-rest-server.php

@@ -494 +494 @@
      *
      *     @type array $_links    Links.
-     *     @type array $_embedded Embeddeds.
+     *     @type array $_embedded Embedded objects.
      * }
      */
@@ -618 +618 @@
      *
      *     @type array $_links    Links.
-     *     @type array $_embedded Embeddeds.
+     *     @type array $_embedded Embedded objects.
      * }
      */