Make WordPress Core


Ignore:
Timestamp:
11/23/2016 02:42:00 AM (8 years ago)
Author:
joehoyle
Message:

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

Props ramiy.
Fixes #38811.

File:
1 edited

Legend:

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

    r39313 r39342  
    8888                        'type'        => 'boolean',
    8989                        'default'     => false,
    90                         'description' => __( 'Required to be true, as resource does not support trashing.' ),
     90                        'description' => __( 'Required to be true, as users do not support trashing.' ),
    9191                    ),
    9292                    'reassign' => array(
     
    121121                        'type'        => 'boolean',
    122122                        'default'     => false,
    123                         'description' => __( 'Required to be true, as resource does not support trashing.' ),
     123                        'description' => __( 'Required to be true, as users do not support trashing.' ),
    124124                    ),
    125125                    'reassign' => array(
     
    145145        // Check if roles is specified in GET request and if user can list users.
    146146        if ( ! empty( $request['roles'] ) && ! current_user_can( 'list_users' ) ) {
    147             return new WP_Error( 'rest_user_cannot_view', __( 'Sorry, you are not allowed to filter by role.' ), array( 'status' => rest_authorization_required_code() ) );
     147            return new WP_Error( 'rest_user_cannot_view', __( 'Sorry, you are not allowed to filter users by role.' ), array( 'status' => rest_authorization_required_code() ) );
    148148        }
    149149
     
    153153
    154154        if ( in_array( $request['orderby'], array( 'email', 'registered_date' ), true ) && ! current_user_can( 'list_users' ) ) {
    155             return new WP_Error( 'rest_forbidden_orderby', __( 'Sorry, you are not allowed to order by this parameter.' ), array( 'status' => rest_authorization_required_code() ) );
     155            return new WP_Error( 'rest_forbidden_orderby', __( 'Sorry, you are not allowed to order users by this parameter.' ), array( 'status' => rest_authorization_required_code() ) );
    156156        }
    157157
     
    313313
    314314        if ( empty( $id ) || empty( $user->ID ) ) {
    315             return new WP_Error( 'rest_user_invalid_id', __( 'Invalid resource ID.' ), array( 'status' => 404 ) );
     315            return new WP_Error( 'rest_user_invalid_id', __( 'Invalid user ID.' ), array( 'status' => 404 ) );
    316316        }
    317317
     
    343343
    344344        if ( empty( $id ) || empty( $user->ID ) ) {
    345             return new WP_Error( 'rest_user_invalid_id', __( 'Invalid resource ID.' ), array( 'status' => 404 ) );
     345            return new WP_Error( 'rest_user_invalid_id', __( 'Invalid user ID.' ), array( 'status' => 404 ) );
    346346        }
    347347
     
    388388
    389389        if ( ! current_user_can( 'create_users' ) ) {
    390             return new WP_Error( 'rest_cannot_create_user', __( 'Sorry, you are not allowed to create new resource.' ), array( 'status' => rest_authorization_required_code() ) );
     390            return new WP_Error( 'rest_cannot_create_user', __( 'Sorry, you are not allowed to create new users.' ), array( 'status' => rest_authorization_required_code() ) );
    391391        }
    392392
     
    405405    public function create_item( $request ) {
    406406        if ( ! empty( $request['id'] ) ) {
    407             return new WP_Error( 'rest_user_exists', __( 'Cannot create existing resource.' ), array( 'status' => 400 ) );
     407            return new WP_Error( 'rest_user_exists', __( 'Cannot create existing user.' ), array( 'status' => 400 ) );
    408408        }
    409409
     
    441441
    442442            if ( ! $user_id ) {
    443                 return new WP_Error( 'rest_user_create', __( 'Error creating new resource.' ), array( 'status' => 500 ) );
     443                return new WP_Error( 'rest_user_create', __( 'Error creating new user.' ), array( 'status' => 500 ) );
    444444            }
    445445
     
    516516
    517517        if ( ! current_user_can( 'edit_user', $id ) ) {
    518             return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this resource.' ), array( 'status' => rest_authorization_required_code() ) );
     518            return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this user.' ), array( 'status' => rest_authorization_required_code() ) );
    519519        }
    520520
    521521        if ( ! empty( $request['roles'] ) && ! current_user_can( 'edit_users' ) ) {
    522             return new WP_Error( 'rest_cannot_edit_roles', __( 'Sorry, you are not allowed to edit roles of this resource.' ), array( 'status' => rest_authorization_required_code() ) );
     522            return new WP_Error( 'rest_cannot_edit_roles', __( 'Sorry, you are not allowed to edit roles of this user.' ), array( 'status' => rest_authorization_required_code() ) );
    523523        }
    524524
     
    540540
    541541        if ( ! $user ) {
    542             return new WP_Error( 'rest_user_invalid_id', __( 'Invalid resource ID.' ), array( 'status' => 404 ) );
     542            return new WP_Error( 'rest_user_invalid_id', __( 'Invalid user ID.' ), array( 'status' => 404 ) );
    543543        }
    544544
     
    655655
    656656        if ( ! current_user_can( 'delete_user', $id ) ) {
    657             return new WP_Error( 'rest_user_cannot_delete', __( 'Sorry, you are not allowed to delete this resource.' ), array( 'status' => rest_authorization_required_code() ) );
     657            return new WP_Error( 'rest_user_cannot_delete', __( 'Sorry, you are not allowed to delete this user.' ), array( 'status' => rest_authorization_required_code() ) );
    658658        }
    659659
     
    675675        $force    = isset( $request['force'] ) ? (bool) $request['force'] : false;
    676676
    677         // We don't support trashing for this type, error out.
     677        // We don't support trashing for users.
    678678        if ( ! $force ) {
    679679            return new WP_Error( 'rest_trash_not_supported', __( 'Users do not support trashing. Set force=true to delete.' ), array( 'status' => 501 ) );
     
    683683
    684684        if ( ! $user ) {
    685             return new WP_Error( 'rest_user_invalid_id', __( 'Invalid resource ID.' ), array( 'status' => 404 ) );
     685            return new WP_Error( 'rest_user_invalid_id', __( 'Invalid user ID.' ), array( 'status' => 404 ) );
    686686        }
    687687
    688688        if ( ! empty( $reassign ) ) {
    689689            if ( $reassign === $id || ! get_userdata( $reassign ) ) {
    690                 return new WP_Error( 'rest_user_invalid_reassign', __( 'Invalid resource ID for reassignment.' ), array( 'status' => 400 ) );
     690                return new WP_Error( 'rest_user_invalid_reassign', __( 'Invalid user ID for reassignment.' ), array( 'status' => 400 ) );
    691691            }
    692692        }
     
    702702
    703703        if ( ! $result ) {
    704             return new WP_Error( 'rest_cannot_delete', __( 'The resource cannot be deleted.' ), array( 'status' => 500 ) );
     704            return new WP_Error( 'rest_cannot_delete', __( 'The user cannot be deleted.' ), array( 'status' => 500 ) );
    705705        }
    706706
     
    996996                && ! $potential_role->has_cap( 'edit_users' )
    997997            ) {
    998                 return new WP_Error( 'rest_user_invalid_role', __( 'Sorry, you are not allowed to give resource that role.' ), array( 'status' => rest_authorization_required_code() ) );
     998                return new WP_Error( 'rest_user_invalid_role', __( 'Sorry, you are not allowed to give users that role.' ), array( 'status' => rest_authorization_required_code() ) );
    999999            }
    10001000
     
    10061006
    10071007            if ( empty( $editable_roles[ $role ] ) ) {
    1008                 return new WP_Error( 'rest_user_invalid_role', __( 'Sorry, you are not allowed to give resource that role.' ), array( 'status' => 403 ) );
     1008                return new WP_Error( 'rest_user_invalid_role', __( 'Sorry, you are not allowed to give users that role.' ), array( 'status' => 403 ) );
    10091009            }
    10101010        }
     
    10831083            'properties' => array(
    10841084                'id'          => array(
    1085                     'description' => __( 'Unique identifier for the resource.' ),
     1085                    'description' => __( 'Unique identifier for the user.' ),
    10861086                    'type'        => 'integer',
    10871087                    'context'     => array( 'embed', 'view', 'edit' ),
     
    10891089                ),
    10901090                'username'    => array(
    1091                     'description' => __( 'Login name for the resource.' ),
     1091                    'description' => __( 'Login name for the user.' ),
    10921092                    'type'        => 'string',
    10931093                    'context'     => array( 'edit' ),
     
    10981098                ),
    10991099                'name'        => array(
    1100                     'description' => __( 'Display name for the resource.' ),
     1100                    'description' => __( 'Display name for the user.' ),
    11011101                    'type'        => 'string',
    11021102                    'context'     => array( 'embed', 'view', 'edit' ),
     
    11061106                ),
    11071107                'first_name'  => array(
    1108                     'description' => __( 'First name for the resource.' ),
     1108                    'description' => __( 'First name for the user.' ),
    11091109                    'type'        => 'string',
    11101110                    'context'     => array( 'edit' ),
     
    11141114                ),
    11151115                'last_name'   => array(
    1116                     'description' => __( 'Last name for the resource.' ),
     1116                    'description' => __( 'Last name for the user.' ),
    11171117                    'type'        => 'string',
    11181118                    'context'     => array( 'edit' ),
     
    11221122                ),
    11231123                'email'       => array(
    1124                     'description' => __( 'The email address for the resource.' ),
     1124                    'description' => __( 'The email address for the user.' ),
    11251125                    'type'        => 'string',
    11261126                    'format'      => 'email',
     
    11291129                ),
    11301130                'url'         => array(
    1131                     'description' => __( 'URL of the resource.' ),
     1131                    'description' => __( 'URL of the user.' ),
    11321132                    'type'        => 'string',
    11331133                    'format'      => 'uri',
     
    11351135                ),
    11361136                'description' => array(
    1137                     'description' => __( 'Description of the resource.' ),
     1137                    'description' => __( 'Description of the user.' ),
    11381138                    'type'        => 'string',
    11391139                    'context'     => array( 'embed', 'view', 'edit' ),
    11401140                ),
    11411141                'link'        => array(
    1142                     'description' => __( 'Author URL of the resource.' ),
     1142                    'description' => __( 'Author URL of the user.' ),
    11431143                    'type'        => 'string',
    11441144                    'format'      => 'uri',
     
    11471147                ),
    11481148                'locale'    => array(
    1149                     'description' => __( 'Locale for the resource.' ),
     1149                    'description' => __( 'Locale for the user.' ),
    11501150                    'type'        => 'string',
    11511151                    'enum'        => array_merge( array( '', 'en_US' ), get_available_languages() ),
     
    11531153                ),
    11541154                'nickname'    => array(
    1155                     'description' => __( 'The nickname for the resource.' ),
     1155                    'description' => __( 'The nickname for the user.' ),
    11561156                    'type'        => 'string',
    11571157                    'context'     => array( 'edit' ),
     
    11611161                ),
    11621162                'slug'        => array(
    1163                     'description' => __( 'An alphanumeric identifier for the resource.' ),
     1163                    'description' => __( 'An alphanumeric identifier for the user.' ),
    11641164                    'type'        => 'string',
    11651165                    'context'     => array( 'embed', 'view', 'edit' ),
     
    11691169                ),
    11701170                'registered_date' => array(
    1171                     'description' => __( 'Registration date for the resource.' ),
     1171                    'description' => __( 'Registration date for the user.' ),
    11721172                    'type'        => 'string',
    11731173                    'format'      => 'date-time',
     
    11761176                ),
    11771177                'roles'           => array(
    1178                     'description' => __( 'Roles assigned to the resource.' ),
     1178                    'description' => __( 'Roles assigned to the user.' ),
    11791179                    'type'        => 'array',
    11801180                    'items'       => array(
     
    11841184                ),
    11851185                'password'        => array(
    1186                     'description' => __( 'Password for the resource (never included).' ),
     1186                    'description' => __( 'Password for the user (never included).' ),
    11871187                    'type'        => 'string',
    11881188                    'context'     => array(), // Password is never displayed.
     
    11931193                ),
    11941194                'capabilities'    => array(
    1195                     'description' => __( 'All capabilities assigned to the resource.' ),
     1195                    'description' => __( 'All capabilities assigned to the user.' ),
    11961196                    'type'        => 'object',
    11971197                    'context'     => array( 'edit' ),
     
    11991199                ),
    12001200                'extra_capabilities' => array(
    1201                     'description' => __( 'Any extra capabilities assigned to the resource.' ),
     1201                    'description' => __( 'Any extra capabilities assigned to the user.' ),
    12021202                    'type'        => 'object',
    12031203                    'context'     => array( 'edit' ),
     
    12231223
    12241224            $schema['properties']['avatar_urls']  = array(
    1225                 'description' => __( 'Avatar URLs for the resource.' ),
     1225                'description' => __( 'Avatar URLs for the user.' ),
    12261226                'type'        => 'object',
    12271227                'context'     => array( 'embed', 'view', 'edit' ),
     
    12951295
    12961296        $query_params['slug']    = array(
    1297             'description'        => __( 'Limit result set to resources with a specific slug.' ),
     1297            'description'        => __( 'Limit result set to users with a specific slug.' ),
    12981298            'type'               => 'string',
    12991299        );
    13001300
    13011301        $query_params['roles']   = array(
    1302             'description'        => __( 'Limit result set to resources matching at least one specific role provided. Accepts csv list or single role.' ),
     1302            'description'        => __( 'Limit result set to users matching at least one specific role provided. Accepts csv list or single role.' ),
    13031303            'type'               => 'array',
    13041304            'items'              => array(
Note: See TracChangeset for help on using the changeset viewer.