Ticket #35991: 35991.5.patch

src/wp-includes/class-wp-xmlrpc-server.php

@@ -404 +404 @@
         }
 
         /**
+         * Retrieve custom fields for term.
+         *
+         * @since 4.8.0
+         *
+         * @param int $post_id Post ID.
+         * @return array Custom fields, if exist.
+         */
+        public function get_term_custom_fields($term_id) {
+                $term_id = (int) $term_id;
+
+                $custom_fields = array();
+
+                foreach ( (array) has_term_meta($term_id) as $meta ) {
+
+                        if ( ! current_user_can( 'edit_term_meta', $term_id ) ) {
+                                continue;
+                        }
+
+                        $custom_fields[] = array(
+                                "id"    => $meta['meta_id'],
+                                "key"   => $meta['meta_key'],
+                                "value" => $meta['meta_value']
+                        );
+                }
+
+                return $custom_fields;
+        }
+        
+        /**
+         * Set custom fields for term.
+         *
+         * @since 4.8.0
+         *
+         * @param int $post_id Post ID.
+         * @param array $fields Custom fields.
+         */
+        public function set_term_custom_fields($term_id, $fields) {
+                $term_id = (int) $term_id;
+
+                foreach ( (array) $fields as $meta ) {
+                        if ( isset($meta['id']) ) {
+                                $meta['id'] = (int) $meta['id'];
+                                $pmeta = get_metadata_by_mid( 'term', $meta['id'] );
+                                if ( isset($meta['key']) ) {
+                                        $meta['key'] = wp_unslash( $meta['key'] );
+                                        if ( $meta['key'] !== $pmeta->meta_key ) {
+                                                continue;
+                                        }
+                                        $meta['value'] = wp_unslash( $meta['value'] );
+                                        if ( current_user_can( 'edit_term_meta', $term_id ) ) {
+                                                update_metadata_by_mid( 'term', $meta['id'], $meta['value'] );
+                                        }
+                                } elseif ( current_user_can( 'delete_term_meta', $term_id ) ) {
+                                        delete_metadata_by_mid( 'term', $meta['id'] );
+                                }
+                        } elseif ( current_user_can( 'add_term_meta', $term_id ) ) {
+                                add_term_meta( $term_id, $meta['key'], $meta['value'] );
+                        }
+                }
+        }
+
+        /**
          * Set up blog options property.
          *
          * Passes property through {@see 'xmlrpc_blog_options'} filter.
@@ -742 +804 @@
                 // Count we are happy to return as an integer because people really shouldn't use terms that much.
                 $_term['count'] = intval( $_term['count'] );
 
+                // Get term meta
+                $_term['custom_fields'] = $this->get_term_custom_fields($_term['term_id']);
+
                 /**
                  * Filters XML-RPC-prepared data for the given term.
                  *
@@ -1943 +2008 @@
                 if ( ! $term )
                         return new IXR_Error( 500, __( 'Sorry, your term could not be created.' ) );
 
+                // Add term meta
+                if ( isset( $content_struct['custom_fields'] ) ) {
+                        $this->set_term_custom_fields( $term['term_id'], $content_struct['custom_fields'] );
+                }
+
                 return strval( $term['term_id'] );
         }
 
@@ -2042 +2112 @@
                 if ( ! $term )
                         return new IXR_Error( 500, __( 'Sorry, editing the term failed.' ) );
 
+                // Update term meta
+                if ( isset( $content_struct['custom_fields'] ) ) {
+                        $this->set_term_custom_fields( $term_id, $content_struct['custom_fields'] );
+                }
+
                 return true;
         }
 

src/wp-includes/taxonomy.php

@@ -1241 +1241 @@
 }
 
 /**
+ * Get meta data for the given term ID.
+ *
+ * @since 4.8.0
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param int $term_id
+ * @return array|false
+ */
+function has_term_meta( $term_id ) {
+        // Bail if term meta table is not installed.
+        if ( get_option( 'db_version' ) < 34370 ) {
+                return;
+        }
+
+        global $wpdb;
+
+        return $wpdb->get_results( $wpdb->prepare("SELECT meta_key, meta_value, meta_id, term_id
+                FROM $wpdb->termmeta WHERE term_id = %d
+                ORDER BY meta_key,meta_id", $term_id), ARRAY_A );
+}
+
+/**
  * Check if Term exists.
  *
  * Formerly is_term(), introduced in 2.3.0.

tests/phpunit/tests/term/meta.php

@@ -407 +407 @@
         public static function set_cache_results( $q ) {
                 $q->set( 'cache_results', true );
         }
+
+        /**
+         * @ticket 35991
+         */
+        public function test_has_term_meta() {
+                $t = self::factory()->term->create( array( 'taxonomy' => 'wptests_tax' ) );
+                
+                $term_meta_id = add_term_meta( $t, 'foo', 'bar' );
+                $meta = has_term_meta( $t );
+
+                $this->assertInternalType( 'array', $meta );
+                $this->assertEquals( array( 'meta_key' => 'foo', 'meta_value' => 'bar', 'meta_id' => $term_meta_id, 'term_id' => $t ), $meta[0] );
+        }
 }

tests/phpunit/tests/xmlrpc/wp/getTerm.php

@@ -73 +73 @@
                 $result = $this->myxmlrpcserver->wp_getTerm( array( 1, 'editor', 'editor', 'category', self::$term_id ) );
 
                 $this->assertNotIXRError( $result );
+                unset($result['custom_fields']);
                 $this->assertEquals( $result, $term );
 
                 // Check DataTypes
@@ -95 +96 @@
                 $this->assertEquals( 'category', $result['taxonomy'] );
                 $this->assertEquals( $term['description'], $result['description'] );
         }
+
+        /**
+         * @ticket 35991
+         */
+        public function test_get_term_meta () {
+                $this->make_user_by_role( 'editor' );
+
+                // Add term meta to test wp.getTerm
+                add_term_meta( self::$term_id, 'foo', 'bar' );
+
+                $term = get_term( self::$term_id, 'category', ARRAY_A );
+
+                $result = $this->myxmlrpcserver->wp_getTerm( array( 1, 'editor', 'editor', 'category', self::$term_id ) );
+                $this->assertNotIXRError( $result );
+                        
+                $this->assertInternalType( 'array', $result['custom_fields'] );
+                $term_meta = get_term_meta( self::$term_id, '', true );
+                $this->assertEquals( $term_meta['foo'][0], $result['custom_fields'][0]['value'] );
+        }
 }

tests/phpunit/tests/xmlrpc/wp/newTerm.php

@@ -106 +106 @@
                 $this->assertNotIXRError( $result );
                 $this->assertStringMatchesFormat( '%d', $result );
         }
+
+        /**
+         * @ticket 35991
+         */
+        public function test_add_term_meta() {
+                $this->make_user_by_role( 'editor' );
+                $result = $this->myxmlrpcserver->wp_newTerm( array( 1, 'editor', 'editor', array( 'taxonomy' => 'category', 'name' => 'Test meta', 'custom_fields' => array( array('key' => 'key1', 'value' => 'value1') ) ) ) );
+                $this->assertNotIXRError( $result );
+                $this->assertStringMatchesFormat( '%d', $result );
+        }
 }

tests/phpunit/tests/xmlrpc/wp/getTerms.php

@@ -50 +50 @@
                 foreach( $results as $term ) {
                         $this->assertInternalType( 'int', $term['count'] );
 
+                        // Check custom term meta
+                        $this->assertInternalType( 'array', $term['custom_fields'] );
+
                         // We expect all other IDs to be strings not integers so we don't return something larger than an XMLRPC integer can describe.
                         $this->assertStringMatchesFormat( '%d', $term['term_id'] );
                         $this->assertStringMatchesFormat( '%d', $term['term_group'] );