Make WordPress Core


Ignore:
Timestamp:
05/25/2021 01:11:55 PM (3 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:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-comments-controller.php

    r49955 r51000  
    3838
    3939    /**
    40      * Registers the routes for the objects of the controller.
     40     * Registers the routes for comments.
    4141     *
    4242     * @since 4.7.0
     
    7272                'args'   => array(
    7373                    'id' => array(
    74                         'description' => __( 'Unique identifier for the object.' ),
     74                        'description' => __( 'Unique identifier for the comment.' ),
    7575                        'type'        => 'integer',
    7676                    ),
     
    13821382            'properties' => array(
    13831383                'id'                => array(
    1384                     'description' => __( 'Unique identifier for the object.' ),
     1384                    'description' => __( 'Unique identifier for the comment.' ),
    13851385                    'type'        => 'integer',
    13861386                    'context'     => array( 'view', 'edit', 'embed' ),
     
    13931393                ),
    13941394                'author_email'      => array(
    1395                     'description' => __( 'Email address for the object author.' ),
     1395                    'description' => __( 'Email address for the comment author.' ),
    13961396                    'type'        => 'string',
    13971397                    'format'      => 'email',
     
    14031403                ),
    14041404                'author_ip'         => array(
    1405                     'description' => __( 'IP address for the object author.' ),
     1405                    'description' => __( 'IP address for the comment author.' ),
    14061406                    'type'        => 'string',
    14071407                    'format'      => 'ip',
     
    14091409                ),
    14101410                'author_name'       => array(
    1411                     'description' => __( 'Display name for the object author.' ),
     1411                    'description' => __( 'Display name for the comment author.' ),
    14121412                    'type'        => 'string',
    14131413                    'context'     => array( 'view', 'edit', 'embed' ),
     
    14171417                ),
    14181418                'author_url'        => array(
    1419                     'description' => __( 'URL for the object author.' ),
     1419                    'description' => __( 'URL for the comment author.' ),
    14201420                    'type'        => 'string',
    14211421                    'format'      => 'uri',
     
    14231423                ),
    14241424                'author_user_agent' => array(
    1425                     'description' => __( 'User agent for the object author.' ),
     1425                    'description' => __( 'User agent for the comment author.' ),
    14261426                    'type'        => 'string',
    14271427                    'context'     => array( 'edit' ),
     
    14311431                ),
    14321432                'content'           => array(
    1433                     'description' => __( 'The content for the object.' ),
     1433                    'description' => __( 'The content for the comment.' ),
    14341434                    'type'        => 'object',
    14351435                    'context'     => array( 'view', 'edit', 'embed' ),
     
    14401440                    'properties'  => array(
    14411441                        'raw'      => array(
    1442                             'description' => __( 'Content for the object, as it exists in the database.' ),
     1442                            'description' => __( 'Content for the comment, as it exists in the database.' ),
    14431443                            'type'        => 'string',
    14441444                            'context'     => array( 'edit' ),
    14451445                        ),
    14461446                        'rendered' => array(
    1447                             'description' => __( 'HTML content for the object, transformed for display.' ),
     1447                            'description' => __( 'HTML content for the comment, transformed for display.' ),
    14481448                            'type'        => 'string',
    14491449                            'context'     => array( 'view', 'edit', 'embed' ),
     
    14531453                ),
    14541454                'date'              => array(
    1455                     'description' => __( "The date the object was published, in the site's timezone." ),
     1455                    'description' => __( "The date the comment was published, in the site's timezone." ),
    14561456                    'type'        => 'string',
    14571457                    'format'      => 'date-time',
     
    14591459                ),
    14601460                'date_gmt'          => array(
    1461                     'description' => __( 'The date the object was published, as GMT.' ),
     1461                    'description' => __( 'The date the comment was published, as GMT.' ),
    14621462                    'type'        => 'string',
    14631463                    'format'      => 'date-time',
     
    14651465                ),
    14661466                'link'              => array(
    1467                     'description' => __( 'URL to the object.' ),
     1467                    'description' => __( 'URL to the comment.' ),
    14681468                    'type'        => 'string',
    14691469                    'format'      => 'uri',
     
    14721472                ),
    14731473                'parent'            => array(
    1474                     'description' => __( 'The ID for the parent of the object.' ),
     1474                    'description' => __( 'The ID for the parent of the comment.' ),
    14751475                    'type'        => 'integer',
    14761476                    'context'     => array( 'view', 'edit', 'embed' ),
     
    14841484                ),
    14851485                'status'            => array(
    1486                     'description' => __( 'State of the object.' ),
     1486                    'description' => __( 'State of the comment.' ),
    14871487                    'type'        => 'string',
    14881488                    'context'     => array( 'view', 'edit' ),
     
    14921492                ),
    14931493                'type'              => array(
    1494                     'description' => __( 'Type of Comment for the object.' ),
     1494                    'description' => __( 'Type of the comment.' ),
    14951495                    'type'        => 'string',
    14961496                    'context'     => array( 'view', 'edit', 'embed' ),
     
    15161516
    15171517            $schema['properties']['author_avatar_urls'] = array(
    1518                 'description' => __( 'Avatar URLs for the object author.' ),
     1518                'description' => __( 'Avatar URLs for the comment author.' ),
    15191519                'type'        => 'object',
    15201520                'context'     => array( 'view', 'edit', 'embed' ),
     
    16121612
    16131613        $query_params['orderby'] = array(
    1614             'description' => __( 'Sort collection by object attribute.' ),
     1614            'description' => __( 'Sort collection by comment attribute.' ),
    16151615            'type'        => 'string',
    16161616            'default'     => 'date_gmt',
Note: See TracChangeset for help on using the changeset viewer.