WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
01/29/2020 12:43:23 AM (5 years ago)
Author:
SergeyBiryukov
Message:

Docs: Improve inline comments per the documentation standards.

Includes minor code layout fixes for better readability.

See #48303.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r47036 r47122  
    128128
    129129                if ( ! empty( $post_id ) && $post && ! $this->check_read_post_permission( $post, $request ) ) {
    130                     return new WP_Error( 'rest_cannot_read_post', __( 'Sorry, you are not allowed to read the post for this comment.' ), array( 'status' => rest_authorization_required_code() ) );
     130                    return new WP_Error(
     131                        'rest_cannot_read_post',
     132                        __( 'Sorry, you are not allowed to read the post for this comment.' ),
     133                        array( 'status' => rest_authorization_required_code() )
     134                    );
    131135                } elseif ( 0 === $post_id && ! current_user_can( 'moderate_comments' ) ) {
    132                     return new WP_Error( 'rest_cannot_read', __( 'Sorry, you are not allowed to read comments without a post.' ), array( 'status' => rest_authorization_required_code() ) );
     136                    return new WP_Error(
     137                        'rest_cannot_read',
     138                        __( 'Sorry, you are not allowed to read comments without a post.' ),
     139                        array( 'status' => rest_authorization_required_code() )
     140                    );
    133141                }
    134142            }
    … …  
    136144
    137145        if ( ! empty( $request['context'] ) && 'edit' === $request['context'] && ! current_user_can( 'moderate_comments' ) ) {
    138             return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit comments.' ), array( 'status' => rest_authorization_required_code() ) );
     146            return new WP_Error(
     147                'rest_forbidden_context',
     148                __( 'Sorry, you are not allowed to edit comments.' ),
     149                array( 'status' => rest_authorization_required_code() )
     150            );
    139151        }
    140152
    … …  
    323335     */
    324336    protected function get_comment( $id ) {
    325         $error = new WP_Error( 'rest_comment_invalid_id', __( 'Invalid comment ID.' ), array( 'status' => 404 ) );
     337        $error = new WP_Error(
     338            'rest_comment_invalid_id',
     339            __( 'Invalid comment ID.' ),
     340            array( 'status' => 404 )
     341        );
     342
    326343        if ( (int) $id <= 0 ) {
    327344            return $error;
    … …  
    336353        if ( ! empty( $comment->comment_post_ID ) ) {
    337354            $post = get_post( (int) $comment->comment_post_ID );
     355
    338356            if ( empty( $post ) ) {
    339                 return new WP_Error( 'rest_post_invalid_id', __( 'Invalid post ID.' ), array( 'status' => 404 ) );
     357                return new WP_Error(
     358                    'rest_post_invalid_id',
     359                    __( 'Invalid post ID.' ),
     360                    array( 'status' => 404 )
     361                );
    340362            }
    341363        }
    … …  
    359381
    360382        if ( ! empty( $request['context'] ) && 'edit' === $request['context'] && ! current_user_can( 'moderate_comments' ) ) {
    361             return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit comments.' ), array( 'status' => rest_authorization_required_code() ) );
     383            return new WP_Error(
     384                'rest_forbidden_context',
     385                __( 'Sorry, you are not allowed to edit comments.' ),
     386                array( 'status' => rest_authorization_required_code() )
     387            );
    362388        }
    363389
    … …  
    365391
    366392        if ( ! $this->check_read_permission( $comment, $request ) ) {
    367             return new WP_Error( 'rest_cannot_read', __( 'Sorry, you are not allowed to read this comment.' ), array( 'status' => rest_authorization_required_code() ) );
     393            return new WP_Error(
     394                'rest_cannot_read',
     395                __( 'Sorry, you are not allowed to read this comment.' ),
     396                array( 'status' => rest_authorization_required_code() )
     397            );
    368398        }
    369399
    370400        if ( $post && ! $this->check_read_post_permission( $post, $request ) ) {
    371             return new WP_Error( 'rest_cannot_read_post', __( 'Sorry, you are not allowed to read the post for this comment.' ), array( 'status' => rest_authorization_required_code() ) );
     401            return new WP_Error(
     402                'rest_cannot_read_post',
     403                __( 'Sorry, you are not allowed to read the post for this comment.' ),
     404                array( 'status' => rest_authorization_required_code() )
     405            );
    372406        }
    373407
    … …  
    406440        if ( ! is_user_logged_in() ) {
    407441            if ( get_option( 'comment_registration' ) ) {
    408                 return new WP_Error( 'rest_comment_login_required', __( 'Sorry, you must be logged in to comment.' ), array( 'status' => 401 ) );
     442                return new WP_Error(
     443                    'rest_comment_login_required',
     444                    __( 'Sorry, you must be logged in to comment.' ),
     445                    array( 'status' => 401 )
     446                );
    409447            }
    410448
    … …  
    422460             */
    423461            $allow_anonymous = apply_filters( 'rest_allow_anonymous_comments', false, $request );
     462
    424463            if ( ! $allow_anonymous ) {
    425                 return new WP_Error( 'rest_comment_login_required', __( 'Sorry, you must be logged in to comment.' ), array( 'status' => 401 ) );
     464                return new WP_Error(
     465                    'rest_comment_login_required',
     466                    __( 'Sorry, you must be logged in to comment.' ),
     467                    array( 'status' => 401 )
     468                );
    426469            }
    427470        }
    … …  
    458501
    459502        if ( empty( $request['post'] ) ) {
    460             return new WP_Error( 'rest_comment_invalid_post_id', __( 'Sorry, you are not allowed to create this comment without a post.' ), array( 'status' => 403 ) );
     503            return new WP_Error(
     504                'rest_comment_invalid_post_id',
     505                __( 'Sorry, you are not allowed to create this comment without a post.' ),
     506                array( 'status' => 403 )
     507            );
    461508        }
    462509
    463510        $post = get_post( (int) $request['post'] );
     511
    464512        if ( ! $post ) {
    465             return new WP_Error( 'rest_comment_invalid_post_id', __( 'Sorry, you are not allowed to create this comment without a post.' ), array( 'status' => 403 ) );
     513            return new WP_Error(
     514                'rest_comment_invalid_post_id',
     515                __( 'Sorry, you are not allowed to create this comment without a post.' ),
     516                array( 'status' => 403 )
     517            );
    466518        }
    467519
    468520        if ( 'draft' === $post->post_status ) {
    469             return new WP_Error( 'rest_comment_draft_post', __( 'Sorry, you are not allowed to create a comment on this post.' ), array( 'status' => 403 ) );
     521            return new WP_Error(
     522                'rest_comment_draft_post',
     523                __( 'Sorry, you are not allowed to create a comment on this post.' ),
     524                array( 'status' => 403 )
     525            );
    470526        }
    471527
    472528        if ( 'trash' === $post->post_status ) {
    473             return new WP_Error( 'rest_comment_trash_post', __( 'Sorry, you are not allowed to create a comment on this post.' ), array( 'status' => 403 ) );
     529            return new WP_Error(
     530                'rest_comment_trash_post',
     531                __( 'Sorry, you are not allowed to create a comment on this post.' ),
     532                array( 'status' => 403 )
     533            );
    474534        }
    475535
    476536        if ( ! $this->check_read_post_permission( $post, $request ) ) {
    477             return new WP_Error( 'rest_cannot_read_post', __( 'Sorry, you are not allowed to read the post for this comment.' ), array( 'status' => rest_authorization_required_code() ) );
     537            return new WP_Error(
     538                'rest_cannot_read_post',
     539                __( 'Sorry, you are not allowed to read the post for this comment.' ),
     540                array( 'status' => rest_authorization_required_code() )
     541            );
    478542        }
    479543
    480544        if ( ! comments_open( $post->ID ) ) {
    481             return new WP_Error( 'rest_comment_closed', __( 'Sorry, comments are closed for this item.' ), array( 'status' => 403 ) );
     545            return new WP_Error(
     546                'rest_comment_closed',
     547                __( 'Sorry, comments are closed for this item.' ),
     548                array( 'status' => 403 )
     549            );
    482550        }
    483551
    … …  
    495563    public function create_item( $request ) {
    496564        if ( ! empty( $request['id'] ) ) {
    497             return new WP_Error( 'rest_comment_exists', __( 'Cannot create existing comment.' ), array( 'status' => 400 ) );
     565            return new WP_Error(
     566                'rest_comment_exists',
     567                __( 'Cannot create existing comment.' ),
     568                array( 'status' => 400 )
     569            );
    498570        }
    499571
    500572        // Do not allow comments to be created with a non-default type.
    501573        if ( ! empty( $request['type'] ) && 'comment' !== $request['type'] ) {
    502             return new WP_Error( 'rest_invalid_comment_type', __( 'Cannot create a comment with that type.' ), array( 'status' => 400 ) );
     574            return new WP_Error(
     575                'rest_invalid_comment_type',
     576                __( 'Cannot create a comment with that type.' ),
     577                array( 'status' => 400 )
     578            );
    503579        }
    504580
    … …  
    515591         */
    516592        if ( empty( $prepared_comment['comment_content'] ) ) {
    517             return new WP_Error( 'rest_comment_content_invalid', __( 'Invalid comment content.' ), array( 'status' => 400 ) );
     593            return new WP_Error(
     594                'rest_comment_content_invalid',
     595                __( 'Invalid comment content.' ),
     596                array( 'status' => 400 )
     597            );
    518598        }
    519599
    … …  
    541621        if ( get_option( 'require_name_email' ) ) {
    542622            if ( empty( $prepared_comment['comment_author'] ) || empty( $prepared_comment['comment_author_email'] ) ) {
    543                 return new WP_Error( 'rest_comment_author_data_required', __( 'Creating a comment requires valid author name and email values.' ), array( 'status' => 400 ) );
     623                return new WP_Error(
     624                    'rest_comment_author_data_required',
     625                    __( 'Creating a comment requires valid author name and email values.' ),
     626                    array( 'status' => 400 )
     627                );
    544628            }
    545629        }
    … …  
    558642
    559643        $check_comment_lengths = wp_check_comment_data_max_lengths( $prepared_comment );
     644
    560645        if ( is_wp_error( $check_comment_lengths ) ) {
    561646            $error_code = $check_comment_lengths->get_error_code();
    562             return new WP_Error( $error_code, __( 'Comment field exceeds maximum length allowed.' ), array( 'status' => 400 ) );
     647            return new WP_Error(
     648                $error_code,
     649                __( 'Comment field exceeds maximum length allowed.' ),
     650                array( 'status' => 400 )
     651            );
    563652        }
    564653
    … …  
    570659
    571660            if ( 'comment_duplicate' === $error_code ) {
    572                 return new WP_Error( $error_code, $error_message, array( 'status' => 409 ) );
     661                return new WP_Error(
     662                    $error_code,
     663                    $error_message,
     664                    array( 'status' => 409 )
     665                );
    573666            }
    574667
    575668            if ( 'comment_flood' === $error_code ) {
    576                 return new WP_Error( $error_code, $error_message, array( 'status' => 400 ) );
     669                return new WP_Error(
     670                    $error_code,
     671                    $error_message,
     672                    array( 'status' => 400 )
     673                );
    577674            }
    578675
    … …  
    601698
    602699        if ( ! $comment_id ) {
    603             return new WP_Error( 'rest_comment_failed_create', __( 'Creating comment failed.' ), array( 'status' => 500 ) );
     700            return new WP_Error(
     701                'rest_comment_failed_create',
     702                __( 'Creating comment failed.' ),
     703                array( 'status' => 500 )
     704            );
    604705        }
    605706
    … …  
    677778
    678779        if ( ! $this->check_edit_permission( $comment ) ) {
    679             return new WP_Error( 'rest_cannot_edit', __( 'Sorry, you are not allowed to edit this comment.' ), array( 'status' => rest_authorization_required_code() ) );
     780            return new WP_Error(
     781                'rest_cannot_edit',
     782                __( 'Sorry, you are not allowed to edit this comment.' ),
     783                array( 'status' => rest_authorization_required_code() )
     784            );
    680785        }
    681786
    … …  
    700805
    701806        if ( isset( $request['type'] ) && get_comment_type( $id ) !== $request['type'] ) {
    702             return new WP_Error( 'rest_comment_invalid_type', __( 'Sorry, you are not allowed to change the comment type.' ), array( 'status' => 404 ) );
     807            return new WP_Error(
     808                'rest_comment_invalid_type',
     809                __( 'Sorry, you are not allowed to change the comment type.' ),
     810                array( 'status' => 404 )
     811            );
    703812        }
    704813
    … …  
    711820        if ( ! empty( $prepared_args['comment_post_ID'] ) ) {
    712821            $post = get_post( $prepared_args['comment_post_ID'] );
     822
    713823            if ( empty( $post ) ) {
    714                 return new WP_Error( 'rest_comment_invalid_post_id', __( 'Invalid post ID.' ), array( 'status' => 403 ) );
     824                return new WP_Error(
     825                    'rest_comment_invalid_post_id',
     826                    __( 'Invalid post ID.' ),
     827                    array( 'status' => 403 )
     828                );
    715829            }
    716830        }
    … …  
    721835
    722836            if ( ! $change ) {
    723                 return new WP_Error( 'rest_comment_failed_edit', __( 'Updating comment status failed.' ), array( 'status' => 500 ) );
     837                return new WP_Error(
     838                    'rest_comment_failed_edit',
     839                    __( 'Updating comment status failed.' ),
     840                    array( 'status' => 500 )
     841                );
    724842            }
    725843        } elseif ( ! empty( $prepared_args ) ) {
    … …  
    729847
    730848            if ( isset( $prepared_args['comment_content'] ) && empty( $prepared_args['comment_content'] ) ) {
    731                 return new WP_Error( 'rest_comment_content_invalid', __( 'Invalid comment content.' ), array( 'status' => 400 ) );
     849                return new WP_Error(
     850                    'rest_comment_content_invalid',
     851                    __( 'Invalid comment content.' ),
     852                    array( 'status' => 400 )
     853                );
    732854            }
    733855
    … …  
    735857
    736858            $check_comment_lengths = wp_check_comment_data_max_lengths( $prepared_args );
     859
    737860            if ( is_wp_error( $check_comment_lengths ) ) {
    738861                $error_code = $check_comment_lengths->get_error_code();
    739                 return new WP_Error( $error_code, __( 'Comment field exceeds maximum length allowed.' ), array( 'status' => 400 ) );
     862                return new WP_Error(
     863                    $error_code,
     864                    __( 'Comment field exceeds maximum length allowed.' ),
     865                    array( 'status' => 400 )
     866                );
    740867            }
    741868
    … …  
    743870
    744871            if ( false === $updated ) {
    745                 return new WP_Error( 'rest_comment_failed_edit', __( 'Updating comment failed.' ), array( 'status' => 500 ) );
     872                return new WP_Error(
     873                    'rest_comment_failed_edit',
     874                    __( 'Updating comment failed.' ),
     875                    array( 'status' => 500 )
     876                );
    746877            }
    747878
    … …  
    797928
    798929        if ( ! $this->check_edit_permission( $comment ) ) {
    799             return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this comment.' ), array( 'status' => rest_authorization_required_code() ) );
     930            return new WP_Error(
     931                'rest_cannot_delete',
     932                __( 'Sorry, you are not allowed to delete this comment.' ),
     933                array( 'status' => rest_authorization_required_code() )
     934            );
    800935        }
    801936        return true;
    … …  
    845980            // If this type doesn't support trashing, error out.
    846981            if ( ! $supports_trash ) {
    847                 /* translators: %s: force=true */
    848                 return new WP_Error( 'rest_trash_not_supported', sprintf( __( "The comment does not support trashing. Set '%s' to delete." ), 'force=true' ), array( 'status' => 501 ) );
     982                return new WP_Error(
     983                    'rest_trash_not_supported',
     984                    /* translators: %s: force=true */
     985                    sprintf( __( "The comment does not support trashing. Set '%s' to delete." ), 'force=true' ),
     986                    array( 'status' => 501 )
     987                );
    849988            }
    850989
    851990            if ( 'trash' === $comment->comment_approved ) {
    852                 return new WP_Error( 'rest_already_trashed', __( 'The comment has already been trashed.' ), array( 'status' => 410 ) );
     991                return new WP_Error(
     992                    'rest_already_trashed',
     993                    __( 'The comment has already been trashed.' ),
     994                    array( 'status' => 410 )
     995                );
    853996            }
    854997
    … …  
    8591002
    8601003        if ( ! $result ) {
    861             return new WP_Error( 'rest_cannot_delete', __( 'The comment cannot be deleted.' ), array( 'status' => 500 ) );
     1004            return new WP_Error(
     1005                'rest_cannot_delete',
     1006                __( 'The comment cannot be deleted.' ),
     1007                array( 'status' => 500 )
     1008            );
    8621009        }
    8631010
    … …  
    11561303                $prepared_comment['comment_author_url']   = $user->user_url;
    11571304            } else {
    1158                 return new WP_Error( 'rest_comment_author_invalid', __( 'Invalid comment author ID.' ), array( 'status' => 400 ) );
     1305                return new WP_Error(
     1306                    'rest_comment_author_invalid',
     1307                    __( 'Invalid comment author ID.' ),
     1308                    array( 'status' => 400 )
     1309                );
    11591310            }
    11601311        }
    … …  
    12481399                    'arg_options' => array(
    12491400                        'sanitize_callback' => array( $this, 'check_comment_author_email' ),
    1250                         'validate_callback' => null, // skip built-in validation of 'email'.
     1401                        'validate_callback' => null, // Skip built-in validation of 'email'.
    12511402                    ),
    12521403                ),
    … …  
    12841435                    'context'     => array( 'view', 'edit', 'embed' ),
    12851436                    'arg_options' => array(
    1286                         'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database()
    1287                         'validate_callback' => null, // Note: validation implemented in self::prepare_item_for_database()
     1437                        'sanitize_callback' => null, // Note: sanitization implemented in self::prepare_item_for_database().
     1438                        'validate_callback' => null, // Note: validation implemented in self::prepare_item_for_database().
    12881439                    ),
    12891440                    'properties'  => array(
    … …  
    13531504
    13541505            $avatar_sizes = rest_get_avatar_sizes();
     1506
    13551507            foreach ( $avatar_sizes as $size ) {
    13561508                $avatar_properties[ $size ] = array(
    … …  
    13751527
    13761528        $this->schema = $schema;
     1529
    13771530        return $this->add_additional_fields_schema( $this->schema );
    13781531    }
Note: See TracChangeset for help on using the changeset viewer.