Changeset 39957 for branches/4.7/src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Timestamp:

01/26/2017 01:46:54 PM (8 years ago)

Author:

ocean90

Message:

REST API: Unify object access handling for simplicity.

Rather than repeating ourselves, unifying the access into a single method keeps everything tidy. While we're at it, add in additional schema handling for common parameters.

Merge of [39954] to the 4.7 branch.

See #38792.

Location:

branches/4.7

Files:

• . (modified) (1 prop)
• src/wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php (modified) (13 diffs)

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

@@ -97 +97 @@
 
         register_rest_route( $this->namespace, '/' . $this->rest_base . '/(?P<id>[\d]+)', array(
+            'args' => array(
+                'id' => array(
+                    'description' => __( 'Unique identifier for the term.' ),
+                    'type'        => 'integer',
+                ),
+            ),
             array(
                 'methods'             => WP_REST_Server::READABLE,
@@ -109 +115 @@
                 'callback'            => array( $this, 'update_item' ),
                 'permission_callback' => array( $this, 'update_item_permissions_check' ),
-                'args'                 => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
+                'args'                => $this->get_endpoint_args_for_item_schema( WP_REST_Server::EDITABLE ),
             ),
             array(
@@ -289 +295 @@
 
     /**
+     * Get the term, if the ID is valid.
+     *
+     * @since 4.7.2
+     *
+     * @param int $id Supplied ID.
+     * @return WP_Term|WP_Error Term object if ID is valid, WP_Error otherwise.
+     */
+    protected function get_term( $id ) {
+        $error = new WP_Error( 'rest_term_invalid', __( 'Term does not exist.' ), array( 'status' => 404 ) );
+
+        if ( ! $this->check_is_taxonomy_allowed( $this->taxonomy ) ) {
+            return $error;
+        }
+
+        if ( (int) $id <= 0 ) {
+            return $error;
+        }
+
+        $term = get_term( (int) $id, $this->taxonomy );
+        if ( empty( $term ) || $term->taxonomy !== $this->taxonomy ) {
+            return $error;
+        }
+
+        return $term;
+    }
+
+    /**
      * Checks if a request has access to read or edit the specified term.
      *
@@ -298 +331 @@
      */
     public function get_item_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( 'edit_term', (int) $request['id'] ) ) {
+        $term = $this->get_term( $request['id'] );
+        if ( is_wp_error( $term ) ) {
+            return $term;
+        }
+
+        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() ) );
         }
@@ -318 +352 @@
      */
     public function get_item( $request ) {
-
-        $term = get_term( (int) $request['id'], $this->taxonomy );
-
-        if ( ! $term || $term->taxonomy !== $this->taxonomy ) {
-            return new WP_Error( 'rest_term_invalid', __( "Term doesn't exist." ), array( 'status' => 404 ) );
-        }
+        $term = $this->get_term( $request['id'] );
 
         if ( is_wp_error( $term ) ) {
@@ -446 +475 @@
      */
     public function update_item_permissions_check( $request ) {
-
-        if ( ! $this->check_is_taxonomy_allowed( $this->taxonomy ) ) {
-            return false;
-        }
-
-        $term = get_term( (int) $request['id'], $this->taxonomy );
-
-        if ( ! $term ) {
-            return new WP_Error( 'rest_term_invalid', __( "Term doesn't exist." ), array( 'status' => 404 ) );
+        $term = $this->get_term( $request['id'] );
+        if ( is_wp_error( $term ) ) {
+            return $term;
         }
 
@@ -474 +497 @@
      */
     public function update_item( $request ) {
+        $term = $this->get_term( $request['id'] );
+        if ( is_wp_error( $term ) ) {
+            return $term;
+        }
+
         if ( isset( $request['parent'] ) ) {
             if ( ! is_taxonomy_hierarchical( $this->taxonomy ) ) {
@@ -488 +516 @@
         $prepared_term = $this->prepare_item_for_database( $request );
 
-        $term = get_term( (int) $request['id'], $this->taxonomy );
-
         // Only update the term if we haz something to update.
         if ( ! empty( $prepared_term ) ) {
@@ -499 +525 @@
         }
 
-        $term = get_term( (int) $request['id'], $this->taxonomy );
+        $term = get_term( $term->term_id, $this->taxonomy );
 
         /* This action is documented in lib/endpoints/class-wp-rest-terms-controller.php */
@@ -506 +532 @@
         $schema = $this->get_item_schema();
         if ( ! empty( $schema['properties']['meta'] ) && isset( $request['meta'] ) ) {
-            $meta_update = $this->meta->update_value( $request['meta'], (int) $request['id'] );
+            $meta_update = $this->meta->update_value( $request['meta'], $term->term_id );
 
             if ( is_wp_error( $meta_update ) ) {
@@ -536 +562 @@
      */
     public function delete_item_permissions_check( $request ) {
-        if ( ! $this->check_is_taxonomy_allowed( $this->taxonomy ) ) {
-            return false;
-        }
-
-        $term = get_term( (int) $request['id'], $this->taxonomy );
-
-        if ( ! $term ) {
-            return new WP_Error( 'rest_term_invalid', __( "Term doesn't exist." ), array( 'status' => 404 ) );
+        $term = $this->get_term( $request['id'] );
+        if ( is_wp_error( $term ) ) {
+            return $term;
         }
 
@@ -563 +584 @@
      */
     public function delete_item( $request ) {
+        $term = $this->get_term( $request['id'] );
+        if ( is_wp_error( $term ) ) {
+            return $term;
+        }
 
         $force = isset( $request['force'] ) ? (bool) $request['force'] : false;
@@ -570 +595 @@
             return new WP_Error( 'rest_trash_not_supported', __( 'Terms do not support trashing. Set force=true to delete.' ), array( 'status' => 501 ) );
         }
-
-        $term = get_term( (int) $request['id'], $this->taxonomy );
 
         $request->set_param( 'context', 'view' );