Changeset 47122 for trunk/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

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:

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

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

@@ -145 +145 @@
     public function get_items_permissions_check( $request ) {
         $tax_obj = get_taxonomy( $this->taxonomy );
+
         if ( ! $tax_obj || ! $this->check_is_taxonomy_allowed( $this->taxonomy ) ) {
             return false;
         }
+
         if ( 'edit' === $request['context'] && ! current_user_can( $tax_obj->cap->edit_terms ) ) {
-            return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit terms in this taxonomy.' ), array( 'status' => rest_authorization_required_code() ) );
-        }
+            return new WP_Error(
+                'rest_forbidden_context',
+                __( 'Sorry, you are not allowed to edit terms in this taxonomy.' ),
+                array( 'status' => rest_authorization_required_code() )
+            );
+        }
+
         return true;
     }
@@ -259 +266 @@
         $total_terms = wp_count_terms( $this->taxonomy, $count_args );
 
-        // wp_count_terms can return a falsy value when the term has no children.
+        // wp_count_terms() can return a falsy value when the term has no children.
         if ( ! $total_terms ) {
             $total_terms = 0;
@@ -313 +320 @@
      */
     protected function get_term( $id ) {
-        $error = new WP_Error( 'rest_term_invalid', __( 'Term does not exist.' ), array( 'status' => 404 ) );
+        $error = new WP_Error(
+            'rest_term_invalid',
+            __( 'Term does not exist.' ),
+            array( 'status' => 404 )
+        );
 
         if ( ! $this->check_is_taxonomy_allowed( $this->taxonomy ) ) {
@@ -341 +352 @@
     public function get_item_permissions_check( $request ) {
         $term = $this->get_term( $request['id'] );
+
         if ( is_wp_error( $term ) ) {
             return $term;
@@ -346 +358 @@
 
         if ( 'edit' === $request['context'] && ! current_user_can( 'edit_term', $term->term_id ) ) {
-            return new WP_Error( 'rest_forbidden_context', __( 'Sorry, you are not allowed to edit this term.' ), array( 'status' => rest_authorization_required_code() ) );
-        }
+            return new WP_Error(
+                'rest_forbidden_context',
+                __( 'Sorry, you are not allowed to edit this term.' ),
+                array( 'status' => rest_authorization_required_code() )
+            );
+        }
+
         return true;
     }
@@ -385 +402 @@
 
         $taxonomy_obj = get_taxonomy( $this->taxonomy );
+
         if ( ( is_taxonomy_hierarchical( $this->taxonomy )
                 && ! current_user_can( $taxonomy_obj->cap->edit_terms ) )
             || ( ! is_taxonomy_hierarchical( $this->taxonomy )
                 && ! current_user_can( $taxonomy_obj->cap->assign_terms ) ) ) {
-            return new WP_Error( 'rest_cannot_create', __( 'Sorry, you are not allowed to create new terms.' ), array( 'status' => rest_authorization_required_code() ) );
+            return new WP_Error(
+                'rest_cannot_create',
+                __( 'Sorry, you are not allowed to create new terms.' ),
+                array( 'status' => rest_authorization_required_code() )
+            );
         }
 
@@ -406 +428 @@
         if ( isset( $request['parent'] ) ) {
             if ( ! is_taxonomy_hierarchical( $this->taxonomy ) ) {
-                return new WP_Error( 'rest_taxonomy_not_hierarchical', __( 'Cannot set parent term, taxonomy is not hierarchical.' ), array( 'status' => 400 ) );
+                return new WP_Error(
+                    'rest_taxonomy_not_hierarchical',
+                    __( 'Cannot set parent term, taxonomy is not hierarchical.' ),
+                    array( 'status' => 400 )
+                );
             }
 
@@ -412 +438 @@
 
             if ( ! $parent ) {
-                return new WP_Error( 'rest_term_invalid', __( 'Parent term does not exist.' ), array( 'status' => 400 ) );
+                return new WP_Error(
+                    'rest_term_invalid',
+                    __( 'Parent term does not exist.' ),
+                    array( 'status' => 400 )
+                );
             }
         }
@@ -503 +533 @@
     public function update_item_permissions_check( $request ) {
         $term = $this->get_term( $request['id'] );
+
         if ( is_wp_error( $term ) ) {
             return $term;
@@ -508 +539 @@
 
         if ( ! current_user_can( 'edit_term', $term->term_id ) ) {
-            return new WP_Error( 'rest_cannot_update', __( 'Sorry, you are not allowed to edit this term.' ), array( 'status' => rest_authorization_required_code() ) );
+            return new WP_Error(
+                'rest_cannot_update',
+                __( 'Sorry, you are not allowed to edit this term.' ),
+                array( 'status' => rest_authorization_required_code() )
+            );
         }
 
@@ -530 +565 @@
         if ( isset( $request['parent'] ) ) {
             if ( ! is_taxonomy_hierarchical( $this->taxonomy ) ) {
-                return new WP_Error( 'rest_taxonomy_not_hierarchical', __( 'Cannot set parent term, taxonomy is not hierarchical.' ), array( 'status' => 400 ) );
+                return new WP_Error(
+                    'rest_taxonomy_not_hierarchical',
+                    __( 'Cannot set parent term, taxonomy is not hierarchical.' ),
+                    array( 'status' => 400 )
+                );
             }
 
@@ -536 +575 @@
 
             if ( ! $parent ) {
-                return new WP_Error( 'rest_term_invalid', __( 'Parent term does not exist.' ), array( 'status' => 400 ) );
+                return new WP_Error(
+                    'rest_term_invalid',
+                    __( 'Parent term does not exist.' ),
+                    array( 'status' => 400 )
+                );
             }
         }
@@ -591 +634 @@
     public function delete_item_permissions_check( $request ) {
         $term = $this->get_term( $request['id'] );
+
         if ( is_wp_error( $term ) ) {
             return $term;
@@ -596 +640 @@
 
         if ( ! current_user_can( 'delete_term', $term->term_id ) ) {
-            return new WP_Error( 'rest_cannot_delete', __( 'Sorry, you are not allowed to delete this term.' ), array( 'status' => rest_authorization_required_code() ) );
+            return new WP_Error(
+                'rest_cannot_delete',
+                __( 'Sorry, you are not allowed to delete this term.' ),
+                array( 'status' => rest_authorization_required_code() )
+            );
         }
 
@@ -620 +668 @@
         // We don't support trashing for terms.
         if ( ! $force ) {
-            /* translators: %s: force=true */
-            return new WP_Error( 'rest_trash_not_supported', sprintf( __( "Terms do not support trashing. Set '%s' to delete." ), 'force=true' ), array( 'status' => 501 ) );
+            return new WP_Error(
+                'rest_trash_not_supported',
+                /* translators: %s: force=true */
+                sprintf( __( "Terms do not support trashing. Set '%s' to delete." ), 'force=true' ),
+                array( 'status' => 501 )
+            );
         }
 
@@ -631 +683 @@
 
         if ( ! $retval ) {
-            return new WP_Error( 'rest_cannot_delete', __( 'The term cannot be deleted.' ), array( 'status' => 500 ) );
+            return new WP_Error(
+                'rest_cannot_delete',
+                __( 'The term cannot be deleted.' ),
+                array( 'status' => 500 )
+            );
         }
 
@@ -930 +986 @@
 
         $this->schema = $schema;
+
         return $this->add_additional_fields_schema( $this->schema );
     }