Changeset 40994

Timestamp:

07/02/2017 06:28:21 PM (7 years ago)

Author:

boonebgorges

Message:

Introduce wp_get_object_terms_args filter.

This filter allows developers to modify the arguments passed to
wp_get_object_terms() before the query is run.

Props enrico.sorcinelli.
Fixes #35925.

Location:

trunk

Files:

• src/wp-includes/taxonomy.php (modified) (1 diff)
• tests/phpunit/tests/term/wpGetObjectTerms.php (modified) (1 diff)

trunk/src/wp-includes/taxonomy.php

@@ -1883 +1883 @@
     $args = wp_parse_args( $args );
 
+    /**
+     * Filter arguments for retrieving object terms.
+     *
+     * @since 4.9.0
+     *
+     * @param array        $args       An array of arguments for retrieving terms for the given object(s).
+     *                                 See {@see wp_get_object_terms()} for details.
+     * @param int|array    $object_ids Object ID or array of IDs.
+     * @param string|array $taxonomies The taxonomies to retrieve terms from.
+     */
+    $args = apply_filters( 'wp_get_object_terms_args', $args, $object_ids, $taxonomies );
+
     /*
      * When one or more queried taxonomies is registered with an 'args' array,

trunk/tests/phpunit/tests/term/wpGetObjectTerms.php

@@ -733 +733 @@
         $this->assertEquals( array( $t1, $t3, $t2 ), $found );
     }
+
+    /**
+     * @ticket 35925
+     */
+    public function test_wp_get_object_terms_args_filter() {
+        $taxonomy = 'wptests_tax_4';
+
+        register_taxonomy( $taxonomy, 'post', array( 'sort' => 'true' ) );
+        $post_id = self::factory()->post->create();
+        $terms = array( 'foo', 'bar', 'baz' );
+        $set = wp_set_object_terms( $post_id, $terms, $taxonomy );
+
+        // Filter for maintaining term order
+        add_filter( 'wp_get_object_terms_args', array( $this, 'filter_wp_get_object_terms_args' ), 10, 3 );
+
+        // Test directly
+        $get_object_terms = wp_get_object_terms( $post_id, $taxonomy, array( 'fields' => 'names' ) );
+        $this->assertEquals( $terms, $get_object_terms );
+
+        // Test metabox taxonomy (admin advanced edit)
+        $terms_to_edit = get_terms_to_edit( $post_id, $taxonomy );
+        $this->assertEquals( implode( ',', $terms ), $terms_to_edit );
+    }
+
+    function filter_wp_get_object_terms_args ( $args, $object_ids, $taxonomies ) {
+        $args['orderby'] = 'term_order';
+        return $args;
+    }
 }