云策 WordPress 开发者社区

钩子文档

register_taxonomy_args

查看官方原文 ↗
💡 云策文档标注

概述

register_taxonomy_args 是一个 WordPress 过滤器，用于在注册分类法时修改其参数数组。它允许开发者动态调整分类法的属性，如标签、可见性、REST API 集成等。

关键要点

  • 过滤器名称：register_taxonomy_args，用于过滤分类法注册参数。
  • 参数：接受 $args（参数数组）、$taxonomy（分类法键名）和 $object_type（对象类型数组）。
  • 用途：可自定义分类法的 hierarchical、public、show_in_rest 等属性，增强灵活性。
  • 相关函数：与 register_taxonomy() 和 WP_Taxonomy::set_props() 紧密关联。

代码示例

add_filter( 'register_taxonomy_args', 'wpdocs_my_taxonomy_args', 10, 2 );
function wpdocs_my_taxonomy_args( $args, $taxonomy ) {
    
    // Target "my-taxonomy"
    if ( 'my-taxonomy' !== $taxonomy ) {
        return $args;
    }
    
    // Set Hierarchical
    $args['hierarchical'] = true;
    
    // Return
    return $args;
}
📄 原文内容

Filters the arguments for registering a taxonomy.

Parameters

$argsarray
Array of arguments for registering a taxonomy.
See the register_taxonomy() function for accepted arguments.

More Arguments from register_taxonomy( … $args )

Array or query string of arguments for registering a taxonomy.

  • labels string[]
    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() .
  • description string
    A short descriptive summary of what the taxonomy is for.
  • public bool
    Whether a taxonomy is intended for use publicly either via the admin interface or by front-end users. The default settings of $publicly_queryable, $show_ui, and $show_in_nav_menus are inherited from $public.
  • publicly_queryable bool
    Whether the taxonomy is publicly queryable.
    If not set, the default is inherited from $public
  • hierarchical bool
    Whether the taxonomy is hierarchical. Default false.
  • show_ui bool
    Whether to generate and allow a UI for managing terms in this taxonomy in the admin. If not set, the default is inherited from $public (default true).
  • show_in_menu bool
    Whether to show the taxonomy in the admin menu. If true, the taxonomy is shown as a submenu of the object type menu. If false, no menu is shown.
    $show_ui must be true. If not set, default is inherited from $show_ui (default true).
  • show_in_nav_menus bool
    Makes this taxonomy available for selection in navigation menus. If not set, the default is inherited from $public (default true).
  • show_in_rest bool
    Whether to include the taxonomy in the REST API. Set this to true for the taxonomy to be available in the block editor.
  • rest_base string
    To change the base url of REST API route. Default is $taxonomy.
  • rest_namespace string
    To change the namespace URL of REST API route. Default is wp/v2.
  • rest_controller_class string
    REST API Controller class name. Default is ‘WP_REST_Terms_Controller‘.
  • show_tagcloud bool
    Whether to list the taxonomy in the Tag Cloud Widget controls. If not set, the default is inherited from $show_ui (default true).
  • show_in_quick_edit bool
    Whether to show the taxonomy in the quick/bulk edit panel. It not set, the default is inherited from $show_ui (default true).
  • show_admin_column bool
    Whether to display a column for the taxonomy on its post type listing screens. Default false.
  • meta_box_cb bool|callable
    Provide a callback function for the meta box display. If not set, post_categories_meta_box() is used for hierarchical taxonomies, and post_tags_meta_box() is used for non-hierarchical. If false, no meta box is shown.
  • meta_box_sanitize_cb callable
    Callback function for sanitizing taxonomy data saved from a meta box. If no callback is defined, an appropriate one is determined based on the value of $meta_box_cb.
  • capabilities string[]
    Array of capabilities for this taxonomy.

    • manage_terms string
      Default 'manage_categories'.
    • edit_terms string
      Default 'manage_categories'.
    • delete_terms string
      Default 'manage_categories'.
    • assign_terms string
      Default 'edit_posts'.
  • rewrite bool|array
    Triggers the handling of rewrites for this taxonomy. Default true, using $taxonomy as slug. To prevent rewrite, set to false. To specify rewrite rules, an array can be passed with any of these keys:

    • slug string
      Customize the permastruct slug. Default $taxonomy key.
    • with_front bool
      Should the permastruct be prepended with WP_Rewrite::$front. Default true.
    • hierarchical bool
      Either hierarchical rewrite tag or not. Default false.
    • ep_mask int
      Assign an endpoint mask. Default EP_NONE.
  • query_var string|bool
    Sets the query var key for this taxonomy. Default $taxonomy key. If false, a taxonomy cannot be loaded at ?{query_var}={term_slug}. If a string, the query ?{query_var}={term_slug} will be valid.
  • update_count_callback callable
    Works much like a hook, in that it will be called when the count is updated. Default _update_post_term_count() for taxonomies attached to post types, which confirms that the objects are published before counting them. Default _update_generic_term_count() for taxonomies attached to other object types, such as users.
  • default_term string|array
    Default term to be used for the taxonomy.

    • name string
      Name of default term.
    • slug string
      Slug for default term.
    • description string
      Description for default term.
  • sort bool
    Whether terms in this taxonomy should be sorted in the order they are provided to wp_set_object_terms(). Default null which equates to false.
  • args array
    Array of arguments to automatically use inside wp_get_object_terms() for this taxonomy.
  • _builtin bool
    This taxonomy is a “built-in” taxonomy. INTERNAL USE ONLY! Default false.

$taxonomystring
Taxonomy key.
$object_typestring[]
Array of names of object types for the taxonomy.

Source

$args = apply_filters( 'register_taxonomy_args', $args, $this->name, (array) $object_type );

View all references View on Trac View on GitHub

Used by Description
WP_Taxonomy::set_props()wp-includes/class-wp-taxonomy.php

Sets taxonomy properties.

Changelog

Version Description
4.4.0 Introduced.

User Contributed Notes

  1. Skip to note 2 content


    Konrad Chmielewski


    You must log in to vote on the helpfulness of this noteVote results for this note: 1You must log in to vote on the helpfulness of this note

    Usage example:

    add_filter( 'register_taxonomy_args', 'wpdocs_my_taxonomy_args', 10, 2 );
function wpdocs_my_taxonomy_args( $args, $taxonomy ) {
    
    // Target "my-taxonomy"
    if ( 'my-taxonomy' !== $taxonomy ) {
        return $args;
    }
    
    // Set Hierarchical
    $args['hierarchical'] = true;
    
    // Return
    return $args;
}

You must log in before being able to contribute a note or feedback.