Changeset 51000 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

Timestamp:

05/25/2021 01:11:55 PM (5 years ago)

Author:

SergeyBiryukov

Message:

REST API: Update “object” strings to use the appropriate nouns.

This updates route arguments and schema descriptions to use more specific object types for clarity.

Follow-up to [39342].

Props lephleg, jnylen0.
Fixes #40720.

File:

• trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php (modified) (18 diffs)

trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

@@ -38 +38 @@
 
     /**
-     * Registers the routes for the objects of the controller.
+     * Registers the routes for comments.
      *
      * @since 4.7.0
@@ -72 +72 @@
                 'args'   => array(
                     'id' => array(
-                        'description' => __( 'Unique identifier for the object.' ),
+                        'description' => __( 'Unique identifier for the comment.' ),
                         'type'        => 'integer',
                     ),
@@ -1382 +1382 @@
             'properties' => array(
                 'id'                => array(
-                    'description' => __( 'Unique identifier for the object.' ),
+                    'description' => __( 'Unique identifier for the comment.' ),
                     'type'        => 'integer',
                     'context'     => array( 'view', 'edit', 'embed' ),
@@ -1393 +1393 @@
                 ),
                 'author_email'      => array(
-                    'description' => __( 'Email address for the object author.' ),
+                    'description' => __( 'Email address for the comment author.' ),
                     'type'        => 'string',
                     'format'      => 'email',
@@ -1403 +1403 @@
                 ),
                 'author_ip'         => array(
-                    'description' => __( 'IP address for the object author.' ),
+                    'description' => __( 'IP address for the comment author.' ),
                     'type'        => 'string',
                     'format'      => 'ip',
@@ -1409 +1409 @@
                 ),
                 'author_name'       => array(
-                    'description' => __( 'Display name for the object author.' ),
+                    'description' => __( 'Display name for the comment author.' ),
                     'type'        => 'string',
                     'context'     => array( 'view', 'edit', 'embed' ),
@@ -1417 +1417 @@
                 ),
                 'author_url'        => array(
-                    'description' => __( 'URL for the object author.' ),
+                    'description' => __( 'URL for the comment author.' ),
                     'type'        => 'string',
                     'format'      => 'uri',
@@ -1423 +1423 @@
                 ),
                 'author_user_agent' => array(
-                    'description' => __( 'User agent for the object author.' ),
+                    'description' => __( 'User agent for the comment author.' ),
                     'type'        => 'string',
                     'context'     => array( 'edit' ),
@@ -1431 +1431 @@
                 ),
                 'content'           => array(
-                    'description' => __( 'The content for the object.' ),
+                    'description' => __( 'The content for the comment.' ),
                     'type'        => 'object',
                     'context'     => array( 'view', 'edit', 'embed' ),
@@ -1440 +1440 @@
                     'properties'  => array(
                         'raw'      => array(
-                            'description' => __( 'Content for the object, as it exists in the database.' ),
+                            'description' => __( 'Content for the comment, as it exists in the database.' ),
                             'type'        => 'string',
                             'context'     => array( 'edit' ),
                         ),
                         'rendered' => array(
-                            'description' => __( 'HTML content for the object, transformed for display.' ),
+                            'description' => __( 'HTML content for the comment, transformed for display.' ),
                             'type'        => 'string',
                             'context'     => array( 'view', 'edit', 'embed' ),
@@ -1453 +1453 @@
                 ),
                 'date'              => array(
-                    'description' => __( "The date the object was published, in the site's timezone." ),
+                    'description' => __( "The date the comment was published, in the site's timezone." ),
                     'type'        => 'string',
                     'format'      => 'date-time',
@@ -1459 +1459 @@
                 ),
                 'date_gmt'          => array(
-                    'description' => __( 'The date the object was published, as GMT.' ),
+                    'description' => __( 'The date the comment was published, as GMT.' ),
                     'type'        => 'string',
                     'format'      => 'date-time',
@@ -1465 +1465 @@
                 ),
                 'link'              => array(
-                    'description' => __( 'URL to the object.' ),
+                    'description' => __( 'URL to the comment.' ),
                     'type'        => 'string',
                     'format'      => 'uri',
@@ -1472 +1472 @@
                 ),
                 'parent'            => array(
-                    'description' => __( 'The ID for the parent of the object.' ),
+                    'description' => __( 'The ID for the parent of the comment.' ),
                     'type'        => 'integer',
                     'context'     => array( 'view', 'edit', 'embed' ),
@@ -1484 +1484 @@
                 ),
                 'status'            => array(
-                    'description' => __( 'State of the object.' ),
+                    'description' => __( 'State of the comment.' ),
                     'type'        => 'string',
                     'context'     => array( 'view', 'edit' ),
@@ -1492 +1492 @@
                 ),
                 'type'              => array(
-                    'description' => __( 'Type of Comment for the object.' ),
+                    'description' => __( 'Type of the comment.' ),
                     'type'        => 'string',
                     'context'     => array( 'view', 'edit', 'embed' ),
@@ -1516 +1516 @@
 
             $schema['properties']['author_avatar_urls'] = array(
-                'description' => __( 'Avatar URLs for the object author.' ),
+                'description' => __( 'Avatar URLs for the comment author.' ),
                 'type'        => 'object',
                 'context'     => array( 'view', 'edit', 'embed' ),
@@ -1612 +1612 @@
 
         $query_params['orderby'] = array(
-            'description' => __( 'Sort collection by object attribute.' ),
+            'description' => __( 'Sort collection by comment attribute.' ),
             'type'        => 'string',
             'default'     => 'date_gmt',