Changeset 31581

Timestamp:

02/27/2015 08:30:13 PM (10 years ago)

Author:

boonebgorges

Message:

Introduce 'get_object_terms' filter in wp_get_object_terms().

The existing 'wp_get_object_terms' filter accepts a parameter $taxonomies,
which is a list of taxonomy names formatted for direct use in a MySQL IN clause.
This formatting makes it difficult to make use of the taxonomy list in filter
callbacks. However, changing the parameters passed to the existing filter
raises backward compatibility concerns, so we introduce a new filter that
receives a structured $taxonomy_array parameter.

We also take this opportunity to correct and clean up some of the documentation
on the 'wp_get_object_terms' filter.

Props postpostmodern, doublesharp, wonderboymusic, nacin.
Fixes #18828.

File:

• trunk/src/wp-includes/taxonomy.php (modified) (2 diffs)

trunk/src/wp-includes/taxonomy.php

@@ -2694 +2694 @@
         $order = 'ASC';
 
+    $taxonomy_array = $taxonomies;
     $taxonomies = "'" . implode("', '", $taxonomies) . "'";
     $object_ids = implode(', ', $object_ids);
@@ -2763 +2764 @@
         $terms = array_values( array_unique( $terms ) );
     }
+
     /**
      * Filter the terms for a given object or objects.
      *
+     * @since 4.2.0
+     *
+     * @param array     $terms          An array of terms for the given object or objects.
+     * @param int|array $object_ids     Object ID or array of IDs.
+     * @param array     $taxonomy_array Array of taxonomies from which `$terms` were retrieved.
+     * @param array     $args           An array of arguments for retrieving terms for the given object(s).
+     *                                  See {@see wp_get_object_terms()} for details.
+     */
+    $terms = apply_filters( 'get_object_terms', $terms, $object_ids, $taxonomy_array, $args );
+
+    /**
+     * Filter the terms for a given object or objects.
+     *
+     * The `$taxonomies` parameter passed to this filter is formatted as a SQL fragment. The
+     * {@see 'get_object_terms'} filter is recommended as an alternative.
+     *
      * @since 2.8.0
      *
-     * @param array        $terms      An array of terms for the given object or objects.
-     * @param array|int    $object_ids Object ID or array of IDs.
-     * @param array|string $taxonomies A taxonomy or array of taxonomies.
-     * @param array        $args       An array of arguments for retrieving terms for
-     *                                 the given object(s).
+     * @param array     $terms      An array of terms for the given object or objects.
+     * @param int|array $object_ids Object ID or array of IDs.
+     * @param string    $taxonomies SQL-formatted (comma-separated and quoted) list of taxonomy names.
+     * @param array     $args       An array of arguments for retrieving terms for the given object(s).
+     *                              See {@see wp_get_object_terms()} for details.
      */
     return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );