* Creates the initial taxonomies.
*
* This function fires twice: in wp-settings.php before plugins are loaded (for
- * backwards compatibility reasons), and again on the {@see 'init'} action. We must
+ * backward compatibility reasons), and again on the {@see 'init'} action. We must
* avoid registering rewrite rules before the {@see 'init'} action.
*
* @since 2.8.0
} else {
/**
- * Filter the post formats rewrite base.
+ * Filters the post formats rewrite base.
*
* @since 3.1.0
*
'show_ui' => true,
'show_admin_column' => true,
'_builtin' => true,
+ 'capabilities' => array(
+ 'manage_terms' => 'manage_categories',
+ 'edit_terms' => 'edit_categories',
+ 'delete_terms' => 'delete_categories',
+ 'assign_terms' => 'assign_categories',
+ ),
+ 'show_in_rest' => true,
+ 'rest_base' => 'categories',
+ 'rest_controller_class' => 'WP_REST_Terms_Controller',
) );
register_taxonomy( 'post_tag', 'post', array(
'show_ui' => true,
'show_admin_column' => true,
'_builtin' => true,
+ 'capabilities' => array(
+ 'manage_terms' => 'manage_post_tags',
+ 'edit_terms' => 'edit_post_tags',
+ 'delete_terms' => 'delete_post_tags',
+ 'assign_terms' => 'assign_post_tags',
+ ),
+ 'show_in_rest' => true,
+ 'rest_base' => 'tags',
+ 'rest_controller_class' => 'WP_REST_Terms_Controller',
) );
register_taxonomy( 'nav_menu', 'nav_menu_item', array(
if ( is_object($object) ) {
if ( $object->post_type == 'attachment' )
- return get_attachment_taxonomies($object);
+ return get_attachment_taxonomies( $object, $output );
$object = $object->post_type;
}
* @global array $wp_taxonomies The registered taxonomies.
*
* @param string $taxonomy Name of taxonomy object to return.
- * @return object|false The Taxonomy Object or false if $taxonomy doesn't exist.
+ * @return WP_Taxonomy|false The Taxonomy Object or false if $taxonomy doesn't exist.
*/
function get_taxonomy( $taxonomy ) {
global $wp_taxonomies;
* @since 4.4.0 The `show_ui` argument is now enforced on the term editing screen.
* @since 4.4.0 The `public` argument now controls whether the taxonomy can be queried on the front end.
* @since 4.5.0 Introduced `publicly_queryable` argument.
+ * @since 4.7.0 Introduced `show_in_rest`, 'rest_base' and 'rest_controller_class'
+ * arguments to register the Taxonomy in REST API.
*
* @global array $wp_taxonomies Registered taxonomies.
- * @global WP $wp WP instance.
*
* @param string $taxonomy Taxonomy key, must not exceed 32 characters.
- * @param array|string $object_type Name of the object type for the taxonomy object.
+ * @param array|string $object_type Object type or array of object types with which the taxonomy should be associated.
* @param array|string $args {
* Optional. Array or query string of arguments for registering a taxonomy.
*
- * @type string $label Name of the taxonomy shown in the menu. Usually plural. If not set,
- * `$labels['name']` will be used.
- * @type array $labels An array of labels for this taxonomy. By default, Tag labels are used for
- * non-hierarchical taxonmies, and Category labels are used for hierarchical
- * taxonomies. See accepted values in get_taxonomy_labels().
- * Default empty array.
+ * @type array $labels An array of labels for this taxonomy. By default, Tag labels are
+ * used for non-hierarchical taxonomies, and Category labels are used
+ * for hierarchical taxonomies. See accepted values in
+ * get_taxonomy_labels(). Default empty array.
* @type string $description A short descriptive summary of what the taxonomy is for. Default empty.
* @type bool $public Whether a taxonomy is intended for use publicly either via
* the admin interface or by front-end users. The default settings
* (default true).
* @type bool $show_in_nav_menus Makes this taxonomy available for selection in navigation menus. If not
* set, the default is inherited from `$public` (default true).
+ * @type bool $show_in_rest Whether to include the taxonomy in the REST API.
+ * @type string $rest_base To change the base url of REST API route. Default is $taxonomy.
+ * @type string $rest_controller_class REST API Controller class name. Default is 'WP_REST_Terms_Controller'.
* @type bool $show_tagcloud Whether to list the taxonomy in the Tag Cloud Widget controls. If not set,
* the default is inherited from `$show_ui` (default true).
* @type bool $show_in_quick_edit Whether to show the taxonomy in the quick/bulk edit panel. It not set,
* @return WP_Error|void WP_Error, if errors.
*/
function register_taxonomy( $taxonomy, $object_type, $args = array() ) {
- global $wp_taxonomies, $wp;
+ global $wp_taxonomies;
if ( ! is_array( $wp_taxonomies ) )
$wp_taxonomies = array();
$args = wp_parse_args( $args );
- /**
- * Filter the arguments for registering a taxonomy.
- *
- * @since 4.4.0
- *
- * @param array $args Array of arguments for registering a taxonomy.
- * @param string $taxonomy Taxonomy key.
- * @param array $object_type Array of names of object types for the taxonomy.
- */
- $args = apply_filters( 'register_taxonomy_args', $args, $taxonomy, (array) $object_type );
-
- $defaults = array(
- 'labels' => array(),
- 'description' => '',
- 'public' => true,
- 'publicly_queryable' => null,
- 'hierarchical' => false,
- 'show_ui' => null,
- 'show_in_menu' => null,
- 'show_in_nav_menus' => null,
- 'show_tagcloud' => null,
- 'show_in_quick_edit' => null,
- 'show_admin_column' => false,
- 'meta_box_cb' => null,
- 'capabilities' => array(),
- 'rewrite' => true,
- 'query_var' => $taxonomy,
- 'update_count_callback' => '',
- '_builtin' => false,
- );
- $args = array_merge( $defaults, $args );
-
if ( empty( $taxonomy ) || strlen( $taxonomy ) > 32 ) {
- _doing_it_wrong( __FUNCTION__, __( 'Taxonomy names must be between 1 and 32 characters in length.' ), '4.2' );
+ _doing_it_wrong( __FUNCTION__, __( 'Taxonomy names must be between 1 and 32 characters in length.' ), '4.2.0' );
return new WP_Error( 'taxonomy_length_invalid', __( 'Taxonomy names must be between 1 and 32 characters in length.' ) );
}
- // If not set, default to the setting for public.
- if ( null === $args['publicly_queryable'] ) {
- $args['publicly_queryable'] = $args['public'];
- }
-
- // Non-publicly queryable taxonomies should not register query vars, except in the admin.
- if ( false !== $args['query_var'] && ( is_admin() || false !== $args['publicly_queryable'] ) && ! empty( $wp ) ) {
- if ( true === $args['query_var'] )
- $args['query_var'] = $taxonomy;
- else
- $args['query_var'] = sanitize_title_with_dashes( $args['query_var'] );
- $wp->add_query_var( $args['query_var'] );
- } else {
- // Force query_var to false for non-public taxonomies.
- $args['query_var'] = false;
- }
-
- if ( false !== $args['rewrite'] && ( is_admin() || '' != get_option( 'permalink_structure' ) ) ) {
- $args['rewrite'] = wp_parse_args( $args['rewrite'], array(
- 'with_front' => true,
- 'hierarchical' => false,
- 'ep_mask' => EP_NONE,
- ) );
-
- if ( empty( $args['rewrite']['slug'] ) )
- $args['rewrite']['slug'] = sanitize_title_with_dashes( $taxonomy );
-
- if ( $args['hierarchical'] && $args['rewrite']['hierarchical'] )
- $tag = '(.+?)';
- else
- $tag = '([^/]+)';
-
- add_rewrite_tag( "%$taxonomy%", $tag, $args['query_var'] ? "{$args['query_var']}=" : "taxonomy=$taxonomy&term=" );
- add_permastruct( $taxonomy, "{$args['rewrite']['slug']}/%$taxonomy%", $args['rewrite'] );
- }
-
- // If not set, default to the setting for public.
- if ( null === $args['show_ui'] )
- $args['show_ui'] = $args['public'];
-
- // If not set, default to the setting for show_ui.
- if ( null === $args['show_in_menu' ] || ! $args['show_ui'] )
- $args['show_in_menu' ] = $args['show_ui'];
-
- // If not set, default to the setting for public.
- if ( null === $args['show_in_nav_menus'] )
- $args['show_in_nav_menus'] = $args['public'];
-
- // If not set, default to the setting for show_ui.
- if ( null === $args['show_tagcloud'] )
- $args['show_tagcloud'] = $args['show_ui'];
-
- // If not set, default to the setting for show_ui.
- if ( null === $args['show_in_quick_edit'] ) {
- $args['show_in_quick_edit'] = $args['show_ui'];
- }
-
- $default_caps = array(
- 'manage_terms' => 'manage_categories',
- 'edit_terms' => 'manage_categories',
- 'delete_terms' => 'manage_categories',
- 'assign_terms' => 'edit_posts',
- );
- $args['cap'] = (object) array_merge( $default_caps, $args['capabilities'] );
- unset( $args['capabilities'] );
-
- $args['name'] = $taxonomy;
- $args['object_type'] = array_unique( (array) $object_type );
-
- $args['labels'] = get_taxonomy_labels( (object) $args );
- $args['label'] = $args['labels']->name;
+ $taxonomy_object = new WP_Taxonomy( $taxonomy, $object_type, $args );
+ $taxonomy_object->add_rewrite_rules();
- // If not set, use the default meta box
- if ( null === $args['meta_box_cb'] ) {
- if ( $args['hierarchical'] )
- $args['meta_box_cb'] = 'post_categories_meta_box';
- else
- $args['meta_box_cb'] = 'post_tags_meta_box';
- }
+ $wp_taxonomies[ $taxonomy ] = $taxonomy_object;
- $wp_taxonomies[ $taxonomy ] = (object) $args;
+ $taxonomy_object->add_hooks();
- // register callback handling for metabox
- add_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
/**
* Fires after a taxonomy is registered.
* @param array|string $object_type Object type or array of object types.
* @param array $args Array of taxonomy registration arguments.
*/
- do_action( 'registered_taxonomy', $taxonomy, $object_type, $args );
+ do_action( 'registered_taxonomy', $taxonomy, $object_type, (array) $taxonomy_object );
}
/**
*/
function unregister_taxonomy( $taxonomy ) {
if ( ! taxonomy_exists( $taxonomy ) ) {
- return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
- $taxonomy_args = get_taxonomy( $taxonomy );
+ $taxonomy_object = get_taxonomy( $taxonomy );
// Do not allow unregistering internal taxonomies.
- if ( $taxonomy_args->_builtin ) {
+ if ( $taxonomy_object->_builtin ) {
return new WP_Error( 'invalid_taxonomy', __( 'Unregistering a built-in taxonomy is not allowed' ) );
}
- global $wp, $wp_taxonomies;
-
- // Remove query var.
- if ( false !== $taxonomy_args->query_var ) {
- $wp->remove_query_var( $taxonomy_args->query_var );
- }
-
- // Remove rewrite tags and permastructs.
- if ( false !== $taxonomy_args->rewrite ) {
- remove_rewrite_tag( "%$taxonomy%" );
- remove_permastruct( $taxonomy );
- }
+ global $wp_taxonomies;
- // Unregister callback handling for metabox.
- remove_filter( 'wp_ajax_add-' . $taxonomy, '_wp_ajax_add_hierarchical_term' );
+ $taxonomy_object->remove_rewrite_rules();
+ $taxonomy_object->remove_hooks();
// Remove the taxonomy.
unset( $wp_taxonomies[ $taxonomy ] );
* @since 4.3.0 Added the `no_terms` label.
* @since 4.4.0 Added the `items_list_navigation` and `items_list` labels.
*
- * @param object $tax Taxonomy object.
+ * @param WP_Taxonomy $tax Taxonomy object.
* @return object object with all the labels as member variables.
*/
function get_taxonomy_labels( $tax ) {
$default_labels = clone $labels;
/**
- * Filter the labels of a specific taxonomy.
+ * Filters the labels of a specific taxonomy.
*
* The dynamic portion of the hook name, `$taxonomy`, refers to the taxonomy slug.
*
}
foreach ( (array) $taxonomies as $taxonomy ) {
if ( ! taxonomy_exists( $taxonomy ) ) {
- return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
}
* filters and return a `WP_Term` object corresponding to the `$term` data. If `WP_Term`,
* will return `$term`.
* @param string $taxonomy Optional. Taxonomy name that $term is part of.
- * @param string $output Constant OBJECT, ARRAY_A, or ARRAY_N
+ * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ * a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
* @param string $filter Optional, default is raw or no WordPress defined filter will applied.
* @return array|WP_Term|WP_Error|null Object of the type specified by `$output` on success. When `$output` is 'OBJECT',
* a WP_Term instance is returned. If taxonomy does not exist, a WP_Error is
}
if ( $taxonomy && ! taxonomy_exists( $taxonomy ) ) {
- return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
if ( $term instanceof WP_Term ) {
}
/**
- * Filter a term.
+ * Filters a term.
*
* @since 2.3.0
* @since 4.4.0 `$_term` can now also be a WP_Term object.
$_term = apply_filters( 'get_term', $_term, $taxonomy );
/**
- * Filter a taxonomy.
+ * Filters a taxonomy.
*
* The dynamic portion of the filter name, `$taxonomy`, refers
* to the taxonomy slug.
* @param int|WP_Term $_term Term object or ID.
* @param string $taxonomy The taxonomy slug.
*/
- $_term = apply_filters( "get_$taxonomy", $_term, $taxonomy );
+ $_term = apply_filters( "get_{$taxonomy}", $_term, $taxonomy );
// Bail if a filter callback has changed the type of the `$_term` object.
if ( ! ( $_term instanceof WP_Term ) ) {
* If $value does not exist, the return value will be false. If $taxonomy exists
* and $field and $value combinations exist, the Term will be returned.
*
+ * This function will always return the first term that matches the `$field`-
+ * `$value`-`$taxonomy` combination specified in the parameters. If your query
+ * is likely to match more than one term (as is likely to be the case when
+ * `$field` is 'name', for example), consider using get_terms() instead; that
+ * way, you will get all matching terms, and can provide your own logic for
+ * deciding which one was intended.
+ *
* @todo Better formatting for DocBlock.
*
* @since 2.3.0
* @param string $field Either 'slug', 'name', 'id' (term_id), or 'term_taxonomy_id'
* @param string|int $value Search for this term value
* @param string $taxonomy Taxonomy name. Optional, if `$field` is 'term_taxonomy_id'.
- * @param string $output Constant OBJECT, ARRAY_A, or ARRAY_N
+ * @param string $output Optional. The required return type. One of OBJECT, ARRAY_A, or ARRAY_N, which correspond to
+ * a WP_Term object, an associative array, or a numeric array, respectively. Default OBJECT.
* @param string $filter Optional, default is raw or no WordPress defined filter will applied.
- * @return WP_Term|bool WP_Term instance on success. Will return false if `$taxonomy` does not exist
- * or `$term` was not found.
+ * @return WP_Term|array|false WP_Term instance (or array) on success. Will return false if `$taxonomy` does not exist
+ * or `$term` was not found.
*/
function get_term_by( $field, $value, $taxonomy = '', $output = OBJECT, $filter = 'raw' ) {
global $wpdb;
* @return array|WP_Error List of Term IDs. WP_Error returned if `$taxonomy` does not exist.
*/
function get_term_children( $term_id, $taxonomy ) {
- if ( ! taxonomy_exists($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
$term_id = intval( $term_id );
function get_terms( $args = array(), $deprecated = '' ) {
global $wpdb;
- $defaults = array(
- 'taxonomy' => null,
- 'orderby' => 'name',
- 'order' => 'ASC',
- 'hide_empty' => true,
- 'include' => array(),
- 'exclude' => array(),
- 'exclude_tree' => array(),
- 'number' => '',
- 'offset' => '',
- 'fields' => 'all',
- 'name' => '',
- 'slug' => '',
- 'hierarchical' => true,
- 'search' => '',
- 'name__like' => '',
- 'description__like' => '',
- 'pad_counts' => false,
- 'get' => '',
- 'child_of' => 0,
- 'parent' => '',
- 'childless' => false,
- 'cache_domain' => 'core',
- 'update_term_meta_cache' => true,
- 'meta_query' => ''
- );
+ $term_query = new WP_Term_Query();
/*
* Legacy argument format ($taxonomy, $args) takes precedence.
* (a) a second non-empty parameter is passed, or
* (b) the first parameter shares no keys with the default array (ie, it's a list of taxonomies)
*/
- $key_intersect = array_intersect_key( $defaults, (array) $args );
+ $_args = wp_parse_args( $args );
+ $key_intersect = array_intersect_key( $term_query->query_var_defaults, (array) $_args );
$do_legacy_args = $deprecated || empty( $key_intersect );
- $taxonomies = null;
if ( $do_legacy_args ) {
$taxonomies = (array) $args;
- $args = $deprecated;
- } elseif ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) {
- $taxonomies = (array) $args['taxonomy'];
- unset( $args['taxonomy'] );
- }
-
- $empty_array = array();
-
- if ( $taxonomies ) {
- foreach ( $taxonomies as $taxonomy ) {
- if ( ! taxonomy_exists($taxonomy) ) {
- return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
- }
- }
- }
-
- /**
- * Filter the terms query default arguments.
- *
- * Use 'get_terms_args' to filter the passed arguments.
- *
- * @since 4.4.0
- *
- * @param array $defaults An array of default get_terms() arguments.
- * @param array $taxonomies An array of taxonomies.
- */
- $args = wp_parse_args( $args, apply_filters( 'get_terms_defaults', $defaults, $taxonomies ) );
-
- $args['number'] = absint( $args['number'] );
- $args['offset'] = absint( $args['offset'] );
-
- // Save queries by not crawling the tree in the case of multiple taxes or a flat tax.
- $has_hierarchical_tax = false;
- if ( $taxonomies ) {
- foreach ( $taxonomies as $_tax ) {
- if ( is_taxonomy_hierarchical( $_tax ) ) {
- $has_hierarchical_tax = true;
- }
- }
- }
-
- if ( ! $has_hierarchical_tax ) {
- $args['hierarchical'] = false;
- $args['pad_counts'] = false;
- }
-
- // 'parent' overrides 'child_of'.
- if ( 0 < intval( $args['parent'] ) ) {
- $args['child_of'] = false;
- }
-
- if ( 'all' == $args['get'] ) {
- $args['childless'] = false;
- $args['child_of'] = 0;
- $args['hide_empty'] = 0;
- $args['hierarchical'] = false;
- $args['pad_counts'] = false;
- }
-
- /**
- * Filter the terms query arguments.
- *
- * @since 3.1.0
- *
- * @param array $args An array of get_terms() arguments.
- * @param array $taxonomies An array of taxonomies.
- */
- $args = apply_filters( 'get_terms_args', $args, $taxonomies );
-
- // Avoid the query if the queried parent/child_of term has no descendants.
- $child_of = $args['child_of'];
- $parent = $args['parent'];
-
- if ( $child_of ) {
- $_parent = $child_of;
- } elseif ( $parent ) {
- $_parent = $parent;
+ $args = wp_parse_args( $deprecated );
+ $args['taxonomy'] = $taxonomies;
} else {
- $_parent = false;
- }
-
- if ( $_parent ) {
- $in_hierarchy = false;
- foreach ( $taxonomies as $_tax ) {
- $hierarchy = _get_term_hierarchy( $_tax );
-
- if ( isset( $hierarchy[ $_parent ] ) ) {
- $in_hierarchy = true;
- }
+ $args = wp_parse_args( $args );
+ if ( isset( $args['taxonomy'] ) && null !== $args['taxonomy'] ) {
+ $args['taxonomy'] = (array) $args['taxonomy'];
}
-
- if ( ! $in_hierarchy ) {
- return $empty_array;
- }
- }
-
- $_orderby = strtolower( $args['orderby'] );
- if ( 'count' == $_orderby ) {
- $orderby = 'tt.count';
- } elseif ( 'name' == $_orderby ) {
- $orderby = 't.name';
- } elseif ( 'slug' == $_orderby ) {
- $orderby = 't.slug';
- } elseif ( 'include' == $_orderby && ! empty( $args['include'] ) ) {
- $include = implode( ',', array_map( 'absint', $args['include'] ) );
- $orderby = "FIELD( t.term_id, $include )";
- } elseif ( 'term_group' == $_orderby ) {
- $orderby = 't.term_group';
- } elseif ( 'description' == $_orderby ) {
- $orderby = 'tt.description';
- } elseif ( 'none' == $_orderby ) {
- $orderby = '';
- } elseif ( empty( $_orderby ) || 'id' == $_orderby || 'term_id' === $_orderby ) {
- $orderby = 't.term_id';
- } else {
- $orderby = 't.name';
- }
-
- /**
- * Filter the ORDERBY clause of the terms query.
- *
- * @since 2.8.0
- *
- * @param string $orderby `ORDERBY` clause of the terms query.
- * @param array $args An array of terms query arguments.
- * @param array $taxonomies An array of taxonomies.
- */
- $orderby = apply_filters( 'get_terms_orderby', $orderby, $args, $taxonomies );
-
- $order = strtoupper( $args['order'] );
- if ( ! empty( $orderby ) ) {
- $orderby = "ORDER BY $orderby";
- } else {
- $order = '';
- }
-
- if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) ) {
- $order = 'ASC';
- }
-
- $where_conditions = array();
-
- if ( $taxonomies ) {
- $where_conditions[] = "tt.taxonomy IN ('" . implode("', '", array_map( 'esc_sql', $taxonomies ) ) . "')";
- }
-
- $exclude = $args['exclude'];
- $exclude_tree = $args['exclude_tree'];
- $include = $args['include'];
-
- $inclusions = '';
- if ( ! empty( $include ) ) {
- $exclude = '';
- $exclude_tree = '';
- $inclusions = implode( ',', wp_parse_id_list( $include ) );
}
- if ( ! empty( $inclusions ) ) {
- $where_conditions[] = 't.term_id IN ( ' . $inclusions . ' )';
- }
-
- $exclusions = array();
- if ( ! empty( $exclude_tree ) ) {
- $exclude_tree = wp_parse_id_list( $exclude_tree );
- $excluded_children = $exclude_tree;
- foreach ( $exclude_tree as $extrunk ) {
- $excluded_children = array_merge(
- $excluded_children,
- (array) get_terms( $taxonomies[0], array( 'child_of' => intval( $extrunk ), 'fields' => 'ids', 'hide_empty' => 0 ) )
- );
+ if ( ! empty( $args['taxonomy'] ) ) {
+ foreach ( $args['taxonomy'] as $taxonomy ) {
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
}
- $exclusions = array_merge( $excluded_children, $exclusions );
}
- if ( ! empty( $exclude ) ) {
- $exclusions = array_merge( wp_parse_id_list( $exclude ), $exclusions );
- }
+ $terms = $term_query->query( $args );
- // 'childless' terms are those without an entry in the flattened term hierarchy.
- $childless = (bool) $args['childless'];
- if ( $childless ) {
- foreach ( $taxonomies as $_tax ) {
- $term_hierarchy = _get_term_hierarchy( $_tax );
- $exclusions = array_merge( array_keys( $term_hierarchy ), $exclusions );
- }
- }
-
- if ( ! empty( $exclusions ) ) {
- $exclusions = 't.term_id NOT IN (' . implode( ',', array_map( 'intval', $exclusions ) ) . ')';
- } else {
- $exclusions = '';
+ // Count queries are not filtered, for legacy reasons.
+ if ( ! is_array( $terms ) ) {
+ return $terms;
}
/**
- * Filter the terms to exclude from the terms query.
+ * Filters the found terms.
*
* @since 2.3.0
+ * @since 4.6.0 Added the `$term_query` parameter.
*
- * @param string $exclusions `NOT IN` clause of the terms query.
- * @param array $args An array of terms query arguments.
- * @param array $taxonomies An array of taxonomies.
- */
- $exclusions = apply_filters( 'list_terms_exclusions', $exclusions, $args, $taxonomies );
-
- if ( ! empty( $exclusions ) ) {
- // Must do string manipulation here for backward compatibility with filter.
- $where_conditions[] = preg_replace( '/^\s*AND\s*/', '', $exclusions );
- }
-
- if ( ! empty( $args['name'] ) ) {
- $names = (array) $args['name'];
- foreach ( $names as &$_name ) {
- // `sanitize_term_field()` returns slashed data.
- $_name = stripslashes( sanitize_term_field( 'name', $_name, 0, reset( $taxonomies ), 'db' ) );
- }
-
- $where_conditions[] = "t.name IN ('" . implode( "', '", array_map( 'esc_sql', $names ) ) . "')";
- }
-
- if ( ! empty( $args['slug'] ) ) {
- if ( is_array( $args['slug'] ) ) {
- $slug = array_map( 'sanitize_title', $args['slug'] );
- $where_conditions[] = "t.slug IN ('" . implode( "', '", $slug ) . "')";
- } else {
- $slug = sanitize_title( $args['slug'] );
- $where_conditions[] = "t.slug = '$slug'";
- }
- }
-
- if ( ! empty( $args['name__like'] ) ) {
- $where_conditions[] = $wpdb->prepare( "t.name LIKE %s", '%' . $wpdb->esc_like( $args['name__like'] ) . '%' );
- }
-
- if ( ! empty( $args['description__like'] ) ) {
- $where_conditions[] = $wpdb->prepare( "tt.description LIKE %s", '%' . $wpdb->esc_like( $args['description__like'] ) . '%' );
- }
-
- if ( '' !== $parent ) {
- $parent = (int) $parent;
- $where_conditions[] = "tt.parent = '$parent'";
- }
-
- $hierarchical = $args['hierarchical'];
- if ( 'count' == $args['fields'] ) {
- $hierarchical = false;
- }
- if ( $args['hide_empty'] && !$hierarchical ) {
- $where_conditions[] = 'tt.count > 0';
- }
-
- $number = $args['number'];
- $offset = $args['offset'];
-
- // Don't limit the query results when we have to descend the family tree.
- if ( $number && ! $hierarchical && ! $child_of && '' === $parent ) {
- if ( $offset ) {
- $limits = 'LIMIT ' . $offset . ',' . $number;
- } else {
- $limits = 'LIMIT ' . $number;
- }
- } else {
- $limits = '';
- }
-
- if ( ! empty( $args['search'] ) ) {
- $like = '%' . $wpdb->esc_like( $args['search'] ) . '%';
- $where_conditions[] = $wpdb->prepare( '((t.name LIKE %s) OR (t.slug LIKE %s))', $like, $like );
- }
-
- // Meta query support.
- $join = '';
- $distinct = '';
-
- $mquery = new WP_Meta_Query();
- $mquery->parse_query_vars( $args );
- $mq_sql = $mquery->get_sql( 'term', 't', 'term_id' );
- $meta_clauses = $mquery->get_clauses();
-
- if ( ! empty( $meta_clauses ) ) {
- $join .= $mq_sql['join'];
- $where_conditions[] = preg_replace( '/^\s*AND\s*/', '', $mq_sql['where'] );
- $distinct .= "DISTINCT";
-
- // 'orderby' support.
- $allowed_keys = array();
- $primary_meta_key = null;
- $primary_meta_query = reset( $meta_clauses );
- if ( ! empty( $primary_meta_query['key'] ) ) {
- $primary_meta_key = $primary_meta_query['key'];
- $allowed_keys[] = $primary_meta_key;
- }
- $allowed_keys[] = 'meta_value';
- $allowed_keys[] = 'meta_value_num';
- $allowed_keys = array_merge( $allowed_keys, array_keys( $meta_clauses ) );
-
- if ( ! empty( $args['orderby'] ) && in_array( $args['orderby'], $allowed_keys ) ) {
- switch( $args['orderby'] ) {
- case $primary_meta_key:
- case 'meta_value':
- if ( ! empty( $primary_meta_query['type'] ) ) {
- $orderby = "ORDER BY CAST({$primary_meta_query['alias']}.meta_value AS {$primary_meta_query['cast']})";
- } else {
- $orderby = "ORDER BY {$primary_meta_query['alias']}.meta_value";
- }
- break;
-
- case 'meta_value_num':
- $orderby = "ORDER BY {$primary_meta_query['alias']}.meta_value+0";
- break;
-
- default:
- if ( array_key_exists( $args['orderby'], $meta_clauses ) ) {
- // $orderby corresponds to a meta_query clause.
- $meta_clause = $meta_clauses[ $args['orderby'] ];
- $orderby = "ORDER BY CAST({$meta_clause['alias']}.meta_value AS {$meta_clause['cast']})";
- }
- break;
- }
- }
- }
-
- $selects = array();
- switch ( $args['fields'] ) {
- case 'all':
- $selects = array( 't.*', 'tt.*' );
- break;
- case 'ids':
- case 'id=>parent':
- $selects = array( 't.term_id', 'tt.parent', 'tt.count', 'tt.taxonomy' );
- break;
- case 'names':
- $selects = array( 't.term_id', 'tt.parent', 'tt.count', 't.name', 'tt.taxonomy' );
- break;
- case 'count':
- $orderby = '';
- $order = '';
- $selects = array( 'COUNT(*)' );
- break;
- case 'id=>name':
- $selects = array( 't.term_id', 't.name', 'tt.count', 'tt.taxonomy' );
- break;
- case 'id=>slug':
- $selects = array( 't.term_id', 't.slug', 'tt.count', 'tt.taxonomy' );
- break;
- }
-
- $_fields = $args['fields'];
-
- /**
- * Filter the fields to select in the terms query.
- *
- * Field lists modified using this filter will only modify the term fields returned
- * by the function when the `$fields` parameter set to 'count' or 'all'. In all other
- * cases, the term fields in the results array will be determined by the `$fields`
- * parameter alone.
- *
- * Use of this filter can result in unpredictable behavior, and is not recommended.
- *
- * @since 2.8.0
- *
- * @param array $selects An array of fields to select for the terms query.
- * @param array $args An array of term query arguments.
- * @param array $taxonomies An array of taxonomies.
+ * @param array $terms Array of found terms.
+ * @param array $taxonomies An array of taxonomies.
+ * @param array $args An array of get_terms() arguments.
+ * @param WP_Term_Query $term_query The WP_Term_Query object.
*/
- $fields = implode( ', ', apply_filters( 'get_terms_fields', $selects, $args, $taxonomies ) );
-
- $join .= " INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id";
-
- $where = implode( ' AND ', $where_conditions );
-
- $pieces = array( 'fields', 'join', 'where', 'distinct', 'orderby', 'order', 'limits' );
-
- /**
- * Filter the terms query SQL clauses.
- *
- * @since 3.1.0
- *
- * @param array $pieces Terms query SQL clauses.
- * @param array $taxonomies An array of taxonomies.
- * @param array $args An array of terms query arguments.
- */
- $clauses = apply_filters( 'terms_clauses', compact( $pieces ), $taxonomies, $args );
-
- $fields = isset( $clauses[ 'fields' ] ) ? $clauses[ 'fields' ] : '';
- $join = isset( $clauses[ 'join' ] ) ? $clauses[ 'join' ] : '';
- $where = isset( $clauses[ 'where' ] ) ? $clauses[ 'where' ] : '';
- $distinct = isset( $clauses[ 'distinct' ] ) ? $clauses[ 'distinct' ] : '';
- $orderby = isset( $clauses[ 'orderby' ] ) ? $clauses[ 'orderby' ] : '';
- $order = isset( $clauses[ 'order' ] ) ? $clauses[ 'order' ] : '';
- $limits = isset( $clauses[ 'limits' ] ) ? $clauses[ 'limits' ] : '';
-
- if ( $where ) {
- $where = "WHERE $where";
- }
-
- $query = "SELECT $distinct $fields FROM $wpdb->terms AS t $join $where $orderby $order $limits";
-
- // $args can be anything. Only use the args defined in defaults to compute the key.
- $key = md5( serialize( wp_array_slice_assoc( $args, array_keys( $defaults ) ) ) . serialize( $taxonomies ) . $query );
- $last_changed = wp_cache_get( 'last_changed', 'terms' );
- if ( ! $last_changed ) {
- $last_changed = microtime();
- wp_cache_set( 'last_changed', $last_changed, 'terms' );
- }
- $cache_key = "get_terms:$key:$last_changed";
- $cache = wp_cache_get( $cache_key, 'terms' );
- if ( false !== $cache ) {
- if ( 'all' === $_fields ) {
- $cache = array_map( 'get_term', $cache );
- }
-
- /**
- * Filter the given taxonomy's terms cache.
- *
- * @since 2.3.0
- *
- * @param array $cache Cached array of terms for the given taxonomy.
- * @param array $taxonomies An array of taxonomies.
- * @param array $args An array of get_terms() arguments.
- */
- return apply_filters( 'get_terms', $cache, $taxonomies, $args );
- }
-
- if ( 'count' == $_fields ) {
- return $wpdb->get_var( $query );
- }
-
- $terms = $wpdb->get_results($query);
- if ( 'all' == $_fields ) {
- update_term_cache( $terms );
- }
-
- // Prime termmeta cache.
- if ( $args['update_term_meta_cache'] ) {
- $term_ids = wp_list_pluck( $terms, 'term_id' );
- update_termmeta_cache( $term_ids );
- }
-
- if ( empty($terms) ) {
- wp_cache_add( $cache_key, array(), 'terms', DAY_IN_SECONDS );
-
- /** This filter is documented in wp-includes/taxonomy.php */
- return apply_filters( 'get_terms', array(), $taxonomies, $args );
- }
-
- if ( $child_of ) {
- foreach ( $taxonomies as $_tax ) {
- $children = _get_term_hierarchy( $_tax );
- if ( ! empty( $children ) ) {
- $terms = _get_term_children( $child_of, $terms, $_tax );
- }
- }
- }
-
- // Update term counts to include children.
- if ( $args['pad_counts'] && 'all' == $_fields ) {
- foreach ( $taxonomies as $_tax ) {
- _pad_term_counts( $terms, $_tax );
- }
- }
-
- // Make sure we show empty categories that have children.
- if ( $hierarchical && $args['hide_empty'] && is_array( $terms ) ) {
- foreach ( $terms as $k => $term ) {
- if ( ! $term->count ) {
- $children = get_term_children( $term->term_id, $term->taxonomy );
- if ( is_array( $children ) ) {
- foreach ( $children as $child_id ) {
- $child = get_term( $child_id, $term->taxonomy );
- if ( $child->count ) {
- continue 2;
- }
- }
- }
-
- // It really is empty.
- unset($terms[$k]);
- }
- }
- }
-
- $_terms = array();
- if ( 'id=>parent' == $_fields ) {
- foreach ( $terms as $term ) {
- $_terms[ $term->term_id ] = $term->parent;
- }
- } elseif ( 'ids' == $_fields ) {
- foreach ( $terms as $term ) {
- $_terms[] = $term->term_id;
- }
- } elseif ( 'names' == $_fields ) {
- foreach ( $terms as $term ) {
- $_terms[] = $term->name;
- }
- } elseif ( 'id=>name' == $_fields ) {
- foreach ( $terms as $term ) {
- $_terms[ $term->term_id ] = $term->name;
- }
- } elseif ( 'id=>slug' == $_fields ) {
- foreach ( $terms as $term ) {
- $_terms[ $term->term_id ] = $term->slug;
- }
- }
-
- if ( ! empty( $_terms ) ) {
- $terms = $_terms;
- }
-
- // Hierarchical queries are not limited, so 'offset' and 'number' must be handled now.
- if ( $hierarchical && $number && is_array( $terms ) ) {
- if ( $offset >= count( $terms ) ) {
- $terms = array();
- } else {
- $terms = array_slice( $terms, $offset, $number, true );
- }
- }
-
- wp_cache_add( $cache_key, $terms, 'terms', DAY_IN_SECONDS );
-
- if ( 'all' === $_fields ) {
- $terms = array_map( 'get_term', $terms );
- }
-
- /** This filter is documented in wp-includes/taxonomy.php */
- return apply_filters( 'get_terms', $terms, $taxonomies, $args );
+ return apply_filters( 'get_terms', $terms, $term_query->query_vars['taxonomy'], $term_query->query_vars, $term_query );
}
/**
*
* @global wpdb $wpdb WordPress database abstraction object.
*
- * @param int|string $term The term to check
+ * @param int|string $term The term to check. Accepts term ID, slug, or name.
* @param string $taxonomy The taxonomy name to use
* @param int $parent Optional. ID of parent term under which to confine the exists search.
* @return mixed Returns null if the term does not exist. Returns the term ID
if ( 'edit' == $context ) {
/**
- * Filter a term field to edit before it is sanitized.
+ * Filters a term field to edit before it is sanitized.
*
* The dynamic portion of the filter name, `$field`, refers to the term field.
*
$value = apply_filters( "edit_term_{$field}", $value, $term_id, $taxonomy );
/**
- * Filter the taxonomy field to edit before it is sanitized.
+ * Filters the taxonomy field to edit before it is sanitized.
*
* The dynamic portions of the filter name, `$taxonomy` and `$field`, refer
* to the taxonomy slug and taxonomy field, respectively.
} elseif ( 'db' == $context ) {
/**
- * Filter a term field value before it is sanitized.
+ * Filters a term field value before it is sanitized.
*
* The dynamic portion of the filter name, `$field`, refers to the term field.
*
$value = apply_filters( "pre_term_{$field}", $value, $taxonomy );
/**
- * Filter a taxonomy field before it is sanitized.
+ * Filters a taxonomy field before it is sanitized.
*
* The dynamic portions of the filter name, `$taxonomy` and `$field`, refer
* to the taxonomy slug and field name, respectively.
// Back compat filters
if ( 'slug' == $field ) {
/**
- * Filter the category nicename before it is sanitized.
+ * Filters the category nicename before it is sanitized.
*
- * Use the pre_{$taxonomy}_{$field} hook instead.
+ * Use the {@see 'pre_$taxonomy_$field'} hook instead.
*
* @since 2.0.3
*
} elseif ( 'rss' == $context ) {
/**
- * Filter the term field for use in RSS.
+ * Filters the term field for use in RSS.
*
* The dynamic portion of the filter name, `$field`, refers to the term field.
*
$value = apply_filters( "term_{$field}_rss", $value, $taxonomy );
/**
- * Filter the taxonomy field for use in RSS.
+ * Filters the taxonomy field for use in RSS.
*
* The dynamic portions of the hook name, `$taxonomy`, and `$field`, refer
* to the taxonomy slug and field name, respectively.
// Use display filters by default.
/**
- * Filter the term field sanitized for display.
+ * Filters the term field sanitized for display.
*
* The dynamic portion of the filter name, `$field`, refers to the term field name.
*
$value = apply_filters( "term_{$field}", $value, $term_id, $taxonomy, $context );
/**
- * Filter the taxonomy field sanitized for display.
+ * Filters the taxonomy field sanitized for display.
*
* The dynamic portions of the filter name, `$taxonomy`, and `$field`, refer
* to the taxonomy slug and taxonomy field, respectively.
* @since 2.3.0
*
* @param string $taxonomy Taxonomy name.
- * @param array|string $args Optional. Array of arguments that get passed to {@see get_terms()}.
+ * @param array|string $args Optional. Array of arguments that get passed to get_terms().
* Default empty array.
* @return array|int|WP_Error Number of terms in that taxonomy or WP_Error if the taxonomy does not exist.
*/
$defaults = array('hide_empty' => false);
$args = wp_parse_args($args, $defaults);
- // backwards compatibility
+ // backward compatibility
if ( isset($args['ignore_empty']) ) {
$args['hide_empty'] = $args['ignore_empty'];
unset($args['ignore_empty']);
* by the parent function. WP_Error otherwise.
* @param array $object_ids List of term object IDs.
*/
- do_action( "delete_$taxonomy", $term, $tt_id, $deleted_term, $object_ids );
+ do_action( "delete_{$taxonomy}", $term, $tt_id, $deleted_term, $object_ids );
return true;
}
* Introduced `$parent` argument.
* @since 4.4.0 Introduced `$meta_query` and `$update_term_meta_cache` arguments. When `$fields` is 'all' or
* 'all_with_object_id', an array of `WP_Term` objects will be returned.
+ * @since 4.7.0 Refactored to use WP_Term_Query, and to support any WP_Term_Query arguments.
*
* @global wpdb $wpdb WordPress database abstraction object.
*
* @param int|array $object_ids The ID(s) of the object(s) to retrieve.
* @param string|array $taxonomies The taxonomies to retrieve terms from.
- * @param array|string $args {
- * Array of arguments.
- * @type string $orderby Field by which results should be sorted. Accepts 'name', 'count', 'slug',
- * 'term_group', 'term_order', 'taxonomy', 'parent', or 'term_taxonomy_id'.
- * Default 'name'.
- * @type string $order Sort order. Accepts 'ASC' or 'DESC'. Default 'ASC'.
- * @type string $fields Fields to return for matched terms. Accepts 'all', 'ids', 'names', and
- * 'all_with_object_id'. Note that 'all' or 'all_with_object_id' will result
- * in an array of term objects being returned, 'ids' will return an array of
- * integers, and 'names' an array of strings.
- * @type int $parent Optional. Limit results to the direct children of a given term ID.
- * @type bool $update_term_meta_cache Whether to prime termmeta cache for matched terms. Only applies when
- * `$fields` is 'all', 'all_with_object_id', or 'term_id'. Default true.
- * @type array $meta_query Meta query clauses to limit retrieved terms by. See `WP_Meta_Query`.
- * Default empty.
- * }
+ * @param array|string $args See WP_Term_Query::__construct() for supported arguments.
* @return array|WP_Error The requested term data or empty array if no terms found.
* WP_Error if any of the $taxonomies don't exist.
*/
foreach ( $taxonomies as $taxonomy ) {
if ( ! taxonomy_exists($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
if ( !is_array($object_ids) )
$object_ids = array($object_ids);
$object_ids = array_map('intval', $object_ids);
- $defaults = array(
- 'orderby' => 'name',
- 'order' => 'ASC',
- 'fields' => 'all',
- 'parent' => '',
- 'update_term_meta_cache' => true,
- 'meta_query' => '',
- );
- $args = wp_parse_args( $args, $defaults );
-
- $terms = array();
- if ( count($taxonomies) > 1 ) {
- foreach ( $taxonomies as $index => $taxonomy ) {
- $t = get_taxonomy($taxonomy);
- if ( isset($t->args) && is_array($t->args) && $args != array_merge($args, $t->args) ) {
- unset($taxonomies[$index]);
- $terms = array_merge($terms, wp_get_object_terms($object_ids, $taxonomy, array_merge($args, $t->args)));
- }
- }
- } else {
- $t = get_taxonomy($taxonomies[0]);
- if ( isset($t->args) && is_array($t->args) )
- $args = array_merge($args, $t->args);
- }
-
- $orderby = $args['orderby'];
- $order = $args['order'];
- $fields = $args['fields'];
-
- if ( in_array( $orderby, array( 'term_id', 'name', 'slug', 'term_group' ) ) ) {
- $orderby = "t.$orderby";
- } elseif ( in_array( $orderby, array( 'count', 'parent', 'taxonomy', 'term_taxonomy_id' ) ) ) {
- $orderby = "tt.$orderby";
- } elseif ( 'term_order' === $orderby ) {
- $orderby = 'tr.term_order';
- } elseif ( 'none' === $orderby ) {
- $orderby = '';
- $order = '';
- } else {
- $orderby = 't.term_id';
- }
-
- // tt_ids queries can only be none or tr.term_taxonomy_id
- if ( ('tt_ids' == $fields) && !empty($orderby) )
- $orderby = 'tr.term_taxonomy_id';
-
- if ( !empty($orderby) )
- $orderby = "ORDER BY $orderby";
-
- $order = strtoupper( $order );
- if ( '' !== $order && ! in_array( $order, array( 'ASC', 'DESC' ) ) )
- $order = 'ASC';
-
- $taxonomy_array = $taxonomies;
- $object_id_array = $object_ids;
- $taxonomies = "'" . implode("', '", array_map( 'esc_sql', $taxonomies ) ) . "'";
- $object_ids = implode(', ', $object_ids);
-
- $select_this = '';
- if ( 'all' == $fields ) {
- $select_this = 't.*, tt.*';
- } elseif ( 'ids' == $fields ) {
- $select_this = 't.term_id';
- } elseif ( 'names' == $fields ) {
- $select_this = 't.name';
- } elseif ( 'slugs' == $fields ) {
- $select_this = 't.slug';
- } elseif ( 'all_with_object_id' == $fields ) {
- $select_this = 't.*, tt.*, tr.object_id';
- }
-
- $where = array(
- "tt.taxonomy IN ($taxonomies)",
- "tr.object_id IN ($object_ids)",
- );
-
- if ( '' !== $args['parent'] ) {
- $where[] = $wpdb->prepare( 'tt.parent = %d', $args['parent'] );
- }
-
- // Meta query support.
- $meta_query_join = '';
- if ( ! empty( $args['meta_query'] ) ) {
- $mquery = new WP_Meta_Query( $args['meta_query'] );
- $mq_sql = $mquery->get_sql( 'term', 't', 'term_id' );
-
- $meta_query_join .= $mq_sql['join'];
-
- // Strip leading AND.
- $where[] = preg_replace( '/^\s*AND/', '', $mq_sql['where'] );
- }
-
- $where = implode( ' AND ', $where );
-
- $query = "SELECT $select_this FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON tt.term_id = t.term_id INNER JOIN $wpdb->term_relationships AS tr ON tr.term_taxonomy_id = tt.term_taxonomy_id $meta_query_join WHERE $where $orderby $order";
-
- $objects = false;
- if ( 'all' == $fields || 'all_with_object_id' == $fields ) {
- $_terms = $wpdb->get_results( $query );
- $object_id_index = array();
- foreach ( $_terms as $key => $term ) {
- $term = sanitize_term( $term, $taxonomy, 'raw' );
- $_terms[ $key ] = $term;
-
- if ( isset( $term->object_id ) ) {
- $object_id_index[ $key ] = $term->object_id;
- }
- }
-
- update_term_cache( $_terms );
- $_terms = array_map( 'get_term', $_terms );
-
- // Re-add the object_id data, which is lost when fetching terms from cache.
- if ( 'all_with_object_id' === $fields ) {
- foreach ( $_terms as $key => $_term ) {
- if ( isset( $object_id_index[ $key ] ) ) {
- $_term->object_id = $object_id_index[ $key ];
- }
- }
- }
-
- $terms = array_merge( $terms, $_terms );
- $objects = true;
-
- } elseif ( 'ids' == $fields || 'names' == $fields || 'slugs' == $fields ) {
- $_terms = $wpdb->get_col( $query );
- $_field = ( 'ids' == $fields ) ? 'term_id' : 'name';
- foreach ( $_terms as $key => $term ) {
- $_terms[$key] = sanitize_term_field( $_field, $term, $term, $taxonomy, 'raw' );
- }
- $terms = array_merge( $terms, $_terms );
- } elseif ( 'tt_ids' == $fields ) {
- $terms = $wpdb->get_col("SELECT tr.term_taxonomy_id FROM $wpdb->term_relationships AS tr INNER JOIN $wpdb->term_taxonomy AS tt ON tr.term_taxonomy_id = tt.term_taxonomy_id WHERE tr.object_id IN ($object_ids) AND tt.taxonomy IN ($taxonomies) $orderby $order");
- foreach ( $terms as $key => $tt_id ) {
- $terms[$key] = sanitize_term_field( 'term_taxonomy_id', $tt_id, 0, $taxonomy, 'raw' ); // 0 should be the term id, however is not needed when using raw context.
- }
- }
-
- // Update termmeta cache, if necessary.
- if ( $args['update_term_meta_cache'] && ( 'all' === $fields || 'all_with_object_ids' === $fields || 'term_id' === $fields ) ) {
- if ( 'term_id' === $fields ) {
- $term_ids = $fields;
- } else {
- $term_ids = wp_list_pluck( $terms, 'term_id' );
- }
+ $args = wp_parse_args( $args );
- update_termmeta_cache( $term_ids );
- }
+ $args['taxonomy'] = $taxonomies;
+ $args['object_ids'] = $object_ids;
- if ( ! $terms ) {
- $terms = array();
- } elseif ( $objects && 'all_with_object_id' !== $fields ) {
- $_tt_ids = array();
- $_terms = array();
- foreach ( $terms as $term ) {
- if ( in_array( $term->term_taxonomy_id, $_tt_ids ) ) {
- continue;
- }
-
- $_tt_ids[] = $term->term_taxonomy_id;
- $_terms[] = $term;
- }
- $terms = $_terms;
- } elseif ( ! $objects ) {
- $terms = array_values( array_unique( $terms ) );
- }
+ $terms = get_terms( $args );
/**
- * Filter the terms for a given object or objects.
+ * Filters 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 array $object_id_array Array of object IDs for which `$terms` were retrieved.
- * @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 wp_get_object_terms() for details.
+ * @param array $terms An array of terms for the given object or objects.
+ * @param array $object_ids Array of object IDs for which `$terms` were retrieved.
+ * @param array $taxonomies Array of taxonomies from which `$terms` were retrieved.
+ * @param array $args An array of arguments for retrieving terms for the given
+ * object(s). See wp_get_object_terms() for details.
*/
- $terms = apply_filters( 'get_object_terms', $terms, $object_id_array, $taxonomy_array, $args );
+ $terms = apply_filters( 'get_object_terms', $terms, $object_ids, $taxonomies, $args );
+
+ $object_ids = implode( ',', $object_ids );
+ $taxonomies = implode( ',', $taxonomies );
/**
- * Filter the terms for a given object or objects.
+ * Filters 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.
* @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.
+ * See wp_get_object_terms() for details.
*/
return apply_filters( 'wp_get_object_terms', $terms, $object_ids, $taxonomies, $args );
}
* @type string $slug The term slug to use. Default empty string.
* }
* @return array|WP_Error An array containing the `term_id` and `term_taxonomy_id`,
- * {@see WP_Error} otherwise.
+ * WP_Error otherwise.
*/
function wp_insert_term( $term, $taxonomy, $args = array() ) {
global $wpdb;
if ( ! taxonomy_exists($taxonomy) ) {
- return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
/**
- * Filter a term before it is sanitized and inserted into the database.
+ * Filters a term before it is sanitized and inserted into the database.
*
* @since 3.0.0
*
if ( is_wp_error( $term ) ) {
return $term;
}
- if ( is_int($term) && 0 == $term ) {
- return new WP_Error('invalid_term_id', __('Invalid term ID'));
+ if ( is_int( $term ) && 0 == $term ) {
+ return new WP_Error( 'invalid_term_id', __( 'Invalid term ID.' ) );
}
- if ( '' == trim($term) ) {
- return new WP_Error('empty_term_name', __('A name is required for this term'));
+ if ( '' == trim( $term ) ) {
+ return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) );
}
$defaults = array( 'alias_of' => '', 'description' => '', 'parent' => 0, 'slug' => '');
$args = wp_parse_args( $args, $defaults );
$slug = wp_unique_term_slug( $slug, (object) $args );
- if ( false === $wpdb->insert( $wpdb->terms, compact( 'name', 'slug', 'term_group' ) ) ) {
+ $data = compact( 'name', 'slug', 'term_group' );
+
+ /**
+ * Filters term data before it is inserted into the database.
+ *
+ * @since 4.7.0
+ *
+ * @param array $data Term data to be inserted.
+ * @param string $taxonomy Taxonomy slug.
+ * @param array $args Arguments passed to wp_insert_term().
+ */
+ $data = apply_filters( 'wp_insert_term_data', $data, $taxonomy, $args );
+
+ if ( false === $wpdb->insert( $wpdb->terms, $data ) ) {
return new WP_Error( 'db_insert_error', __( 'Could not insert term into the database' ), $wpdb->last_error );
}
* @param int $term_id Term ID.
* @param int $tt_id Term taxonomy ID.
*/
- do_action( "create_$taxonomy", $term_id, $tt_id );
+ do_action( "create_{$taxonomy}", $term_id, $tt_id );
/**
- * Filter the term ID after a new term is created.
+ * Filters the term ID after a new term is created.
*
* @since 2.3.0
*
* @param int $term_id Term ID.
* @param int $tt_id Term taxonomy ID.
*/
- do_action( "created_$taxonomy", $term_id, $tt_id );
+ do_action( "created_{$taxonomy}", $term_id, $tt_id );
return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
}
$object_id = (int) $object_id;
- if ( ! taxonomy_exists($taxonomy) )
- return new WP_Error('invalid_taxonomy', __('Invalid taxonomy'));
+ if ( ! taxonomy_exists( $taxonomy ) ) {
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
+ }
if ( !is_array($terms) )
$terms = array($terms);
* Fires immediately before an object-term relationship is added.
*
* @since 2.9.0
+ * @since 4.7.0 Added the `$taxonomy` parameter.
*
- * @param int $object_id Object ID.
- * @param int $tt_id Term taxonomy ID.
+ * @param int $object_id Object ID.
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
*/
- do_action( 'add_term_relationship', $object_id, $tt_id );
+ do_action( 'add_term_relationship', $object_id, $tt_id, $taxonomy );
$wpdb->insert( $wpdb->term_relationships, array( 'object_id' => $object_id, 'term_taxonomy_id' => $tt_id ) );
/**
* Fires immediately after an object-term relationship is added.
*
* @since 2.9.0
+ * @since 4.7.0 Added the `$taxonomy` parameter.
*
- * @param int $object_id Object ID.
- * @param int $tt_id Term taxonomy ID.
+ * @param int $object_id Object ID.
+ * @param int $tt_id Term taxonomy ID.
+ * @param string $taxonomy Taxonomy slug.
*/
- do_action( 'added_term_relationship', $object_id, $tt_id );
+ do_action( 'added_term_relationship', $object_id, $tt_id, $taxonomy );
$new_tt_ids[] = $tt_id;
}
$object_id = (int) $object_id;
if ( ! taxonomy_exists( $taxonomy ) ) {
- return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
if ( ! is_array( $terms ) ) {
* Fires immediately before an object-term relationship is deleted.
*
* @since 2.9.0
+ * @since 4.7.0 Added the `$taxonomy` parameter.
*
* @param int $object_id Object ID.
* @param array $tt_ids An array of term taxonomy IDs.
+ * @param string $taxonomy Taxonomy slug.
*/
- do_action( 'delete_term_relationships', $object_id, $tt_ids );
+ do_action( 'delete_term_relationships', $object_id, $tt_ids, $taxonomy );
$deleted = $wpdb->query( $wpdb->prepare( "DELETE FROM $wpdb->term_relationships WHERE object_id = %d AND term_taxonomy_id IN ($in_tt_ids)", $object_id ) );
wp_cache_delete( $object_id, $taxonomy . '_relationships' );
* Fires immediately after an object-term relationship is deleted.
*
* @since 2.9.0
+ * @since 4.7.0 Added the `$taxonomy` parameter.
*
- * @param int $object_id Object ID.
- * @param array $tt_ids An array of term taxonomy IDs.
+ * @param int $object_id Object ID.
+ * @param array $tt_ids An array of term taxonomy IDs.
+ * @param string $taxonomy Taxonomy slug.
*/
- do_action( 'deleted_term_relationships', $object_id, $tt_ids );
+ do_action( 'deleted_term_relationships', $object_id, $tt_ids, $taxonomy );
wp_update_term_count( $tt_ids, $taxonomy );
// If we didn't get a unique slug, try appending a number to make it unique.
/**
- * Filter whether the proposed unique term slug is bad.
+ * Filters whether the proposed unique term slug is bad.
*
* @since 4.3.0
*
}
/**
- * Filter the unique term slug.
+ * Filters the unique term slug.
*
* @since 4.3.0
*
global $wpdb;
if ( ! taxonomy_exists( $taxonomy ) ) {
- return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy' ) );
+ return new WP_Error( 'invalid_taxonomy', __( 'Invalid taxonomy.' ) );
}
$term_id = (int) $term_id;
$parsed_args['name'] = $name;
$parsed_args['description'] = $description;
- if ( '' == trim($name) )
- return new WP_Error('empty_term_name', __('A name is required for this term'));
+ if ( '' == trim( $name ) ) {
+ return new WP_Error( 'empty_term_name', __( 'A name is required for this term.' ) );
+ }
if ( $parsed_args['parent'] > 0 && ! term_exists( (int) $parsed_args['parent'] ) ) {
return new WP_Error( 'missing_parent', __( 'Parent term does not exist.' ) );
}
/**
- * Filter the term parent.
+ * Filters the term parent.
*
* Hook to this filter to see if it will cause a hierarchy loop.
*
if ( $duplicate && $duplicate->term_id != $term_id ) {
// If an empty slug was passed or the parent changed, reset the slug to something unique.
// Otherwise, bail.
- if ( $empty_slug || ( $parent != $term['parent']) )
+ if ( $empty_slug || ( $parent != $term['parent']) ) {
$slug = wp_unique_term_slug($slug, (object) $args);
- else
+ } else {
+ /* translators: 1: Taxonomy term slug */
return new WP_Error('duplicate_term_slug', sprintf(__('The slug “%s” is already in use by another term'), $slug));
+ }
}
$tt_id = (int) $wpdb->get_var( $wpdb->prepare( "SELECT tt.term_taxonomy_id FROM $wpdb->term_taxonomy AS tt INNER JOIN $wpdb->terms AS t ON tt.term_id = t.term_id WHERE tt.taxonomy = %s AND t.term_id = %d", $taxonomy, $term_id) );
* @param string $taxonomy Taxonomy slug.
*/
do_action( 'edit_terms', $term_id, $taxonomy );
- $wpdb->update($wpdb->terms, compact( 'name', 'slug', 'term_group' ), compact( 'term_id' ) );
+
+ $data = compact( 'name', 'slug', 'term_group' );
+
+ /**
+ * Filters term data before it is updated in the database.
+ *
+ * @since 4.7.0
+ *
+ * @param array $data Term data to be updated.
+ * @param int $term_id Term ID.
+ * @param string $taxonomy Taxonomy slug.
+ * @param array $args Arguments passed to wp_update_term().
+ */
+ $data = apply_filters( 'wp_update_term_data', $data, $term_id, $taxonomy, $args );
+
+ $wpdb->update( $wpdb->terms, $data, compact( 'term_id' ) );
if ( empty($slug) ) {
$slug = sanitize_title($name, $term_id);
$wpdb->update( $wpdb->terms, compact( 'slug' ), compact( 'term_id' ) );
*/
do_action( 'edited_term_taxonomy', $tt_id, $taxonomy );
- // Clean the relationship caches for all object types using this term.
- $objects = $wpdb->get_col( $wpdb->prepare( "SELECT object_id FROM $wpdb->term_relationships WHERE term_taxonomy_id = %d", $tt_id ) );
- $tax_object = get_taxonomy( $taxonomy );
- foreach ( $tax_object->object_type as $object_type ) {
- clean_object_term_cache( $objects, $object_type );
- }
-
/**
* Fires after a term has been updated, but before the term cache has been cleaned.
*
* @param int $term_id Term ID.
* @param int $tt_id Term taxonomy ID.
*/
- do_action( "edit_$taxonomy", $term_id, $tt_id );
+ do_action( "edit_{$taxonomy}", $term_id, $tt_id );
/** This filter is documented in wp-includes/taxonomy.php */
$term_id = apply_filters( 'term_id_filter', $term_id, $tt_id );
* @param int $term_id Term ID.
* @param int $tt_id Term taxonomy ID.
*/
- do_action( "edited_$taxonomy", $term_id, $tt_id );
+ do_action( "edited_{$taxonomy}", $term_id, $tt_id );
return array('term_id' => $term_id, 'term_taxonomy_id' => $tt_id);
}
/**
* Retrieves the taxonomy relationship to the term object id.
*
+ * Upstream functions (like get_the_terms() and is_object_in_term()) are
+ * responsible for populating the object-term relationship cache. The current
+ * function only fetches relationship data that is already in the cache.
+ *
* @since 2.3.0
+ * @since 4.7.0 Returns a WP_Error object if get_term() returns an error for
+ * any of the matched terms.
*
* @param int $id Term object ID.
* @param string $taxonomy Taxonomy name.
- * @return bool|mixed Empty array if $terms found, but not `$taxonomy`. False if nothing is in cache
- * for `$taxonomy` and `$id`.
+ * @return bool|array|WP_Error Array of `WP_Term` objects, if cached.
+ * False if cache is empty for `$taxonomy` and `$id`.
+ * WP_Error if get_term() returns an error object for any term.
*/
function get_object_term_cache( $id, $taxonomy ) {
- return wp_cache_get( $id, "{$taxonomy}_relationships" );
+ $_term_ids = wp_cache_get( $id, "{$taxonomy}_relationships" );
+
+ // We leave the priming of relationship caches to upstream functions.
+ if ( false === $_term_ids ) {
+ return false;
+ }
+
+ // Backward compatibility for if a plugin is putting objects into the cache, rather than IDs.
+ $term_ids = array();
+ foreach ( $_term_ids as $term_id ) {
+ if ( is_numeric( $term_id ) ) {
+ $term_ids[] = intval( $term_id );
+ } elseif ( isset( $term_id->term_id ) ) {
+ $term_ids[] = intval( $term_id->term_id );
+ }
+ }
+
+ // Fill the term objects.
+ _prime_term_caches( $term_ids );
+
+ $terms = array();
+ foreach ( $term_ids as $term_id ) {
+ $term = get_term( $term_id, $taxonomy );
+ if ( is_wp_error( $term ) ) {
+ return $term;
+ }
+
+ $terms[] = $term;
+ }
+
+ return $terms;
}
/**
) );
$object_terms = array();
- foreach ( (array) $terms as $term )
- $object_terms[$term->object_id][$term->taxonomy][] = $term;
+ foreach ( (array) $terms as $term ) {
+ $object_terms[ $term->object_id ][ $term->taxonomy ][] = $term->term_id;
+ }
foreach ( $ids as $id ) {
foreach ( $taxonomies as $taxonomy ) {
$terms_by_id[$id]->count = count($items);
}
+/**
+ * Adds any terms from the given IDs to the cache that do not already exist in cache.
+ *
+ * @since 4.6.0
+ * @access private
+ *
+ * @global wpdb $wpdb WordPress database abstraction object.
+ *
+ * @param array $term_ids Array of term IDs.
+ * @param bool $update_meta_cache Optional. Whether to update the meta cache. Default true.
+ */
+function _prime_term_caches( $term_ids, $update_meta_cache = true ) {
+ global $wpdb;
+
+ $non_cached_ids = _get_non_cached_ids( $term_ids, 'terms' );
+ if ( ! empty( $non_cached_ids ) ) {
+ $fresh_terms = $wpdb->get_results( sprintf( "SELECT t.*, tt.* FROM $wpdb->terms AS t INNER JOIN $wpdb->term_taxonomy AS tt ON t.term_id = tt.term_id WHERE t.term_id IN (%s)", join( ",", array_map( 'intval', $non_cached_ids ) ) ) );
+
+ update_term_cache( $fresh_terms, $update_meta_cache );
+
+ if ( $update_meta_cache ) {
+ update_termmeta_cache( $non_cached_ids );
+ }
+ }
+}
+
//
// Default callbacks
//
}
}
- // Keep a record of term_ids that have been split, keyed by old term_id. See {@see wp_get_split_term()}.
+ // Keep a record of term_ids that have been split, keyed by old term_id. See wp_get_split_term().
if ( $record ) {
$split_term_data = get_option( '_split_terms', array() );
if ( ! isset( $split_term_data[ $term_id ] ) ) {
if ( 'post_tag' == $taxonomy ) {
/**
- * Filter the tag link.
+ * Filters the tag link.
*
* @since 2.3.0
* @deprecated 2.5.0 Use 'term_link' instead.
} elseif ( 'category' == $taxonomy ) {
/**
- * Filter the category link.
+ * Filters the category link.
*
* @since 1.5.0
* @deprecated 2.5.0 Use 'term_link' instead.
}
/**
- * Filter the term link.
+ * Filters the term link.
*
* @since 2.5.0
*
$object_terms = get_object_term_cache( $object_id, $taxonomy );
if ( false === $object_terms ) {
$object_terms = wp_get_object_terms( $object_id, $taxonomy, array( 'update_term_meta_cache' => false ) );
- wp_cache_set( $object_id, $object_terms, "{$taxonomy}_relationships" );
+ if ( is_wp_error( $object_terms ) ) {
+ return $object_terms;
+ }
+
+ wp_cache_set( $object_id, wp_list_pluck( $object_terms, 'term_id' ), "{$taxonomy}_relationships" );
}
if ( is_wp_error( $object_terms ) )
}
/**
- * Filter a given object's ancestors.
+ * Filters a given object's ancestors.
*
* @since 3.1.0
* @since 4.1.1 Introduced the `$resource_type` parameter.
scripts.mit.edu / autoinstalls / wordpress.git / blobdiff