register_taxonomy
函数
register_taxonomy ( $taxonomy, $object_type, $args = array() )
- 参数
-
-
(string)
$taxonomy
Taxonomy key, must not exceed 32 characters and may only contain lowercase alphanumeric characters, dashes, and underscores. See sanitize_key().- Required: 是
-
(array|string)
$object_type
Object type or array of object types with which the taxonomy should be associated.- Required: 是
-
(array|string)
$args
{ Optional. Array or query string of arguments for registering a taxonomy. @type string[] $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 of `$publicly_queryable`, `$show_ui`, and `$show_in_nav_menus` are inherited from `$public`. @type bool $publicly_queryable Whether the taxonomy is publicly queryable. If not set, the default is inherited from `$public` @type bool $hierarchical Whether the taxonomy is hierarchical. Default false. @type bool $show_ui 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). @type bool $show_in_menu 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). @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. Set this to true for the taxonomy to be available in the block editor. @type string $rest_base To change the base url of REST API route. Default is $taxonomy. @type string $rest_namespace To change the namespace URL of REST API route. Default is wp/v2. @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, the default is inherited from `$show_ui` (default true). @type bool $show_admin_column Whether to display a column for the taxonomy on its post type listing screens. Default false. @type bool|callable $meta_box_cb 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. @type callable $meta_box_sanitize_cb 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`. @type string[] $capabilities { Array of capabilities for this taxonomy. @type string $manage_terms Default ‘manage_categories’. @type string $edit_terms Default ‘manage_categories’. @type string $delete_terms Default ‘manage_categories’. @type string $assign_terms Default ‘edit_posts’. } @type bool|array $rewrite { 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: @type string $slug Customize the permastruct slug. Default `$taxonomy` key. @type bool $with_front Should the permastruct be prepended with WP_Rewrite::$front. Default true. @type bool $hierarchical Either hierarchical rewrite tag or not. Default false. @type int $ep_mask Assign an endpoint mask. Default `EP_NONE`. } @type string|bool $query_var 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. @type callable $update_count_callback 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. @type string|array $default_term { Default term to be used for the taxonomy. @type string $name Name of default term. @type string $slug Slug for default term. Default empty. @type string $description Description for default term. Default empty. } @type bool $sort 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. @type array $args Array of arguments to automatically use inside `wp_get_object_terms()` for this taxonomy. @type bool $_builtin This taxonomy is a “built-in” taxonomy. INTERNAL USE ONLY! Default false. }- Required: 否
- Default: array()
-
(string)
- 返回值
-
- (WP_Taxonomy|WP_Error) The registered taxonomy object on success, WP_Error object on failure.
- 定义位置
-
-
wp-includes/taxonomy.php
, line 479
-
wp-includes/taxonomy.php
- 引入
- 2.3.0
- 弃用
- –
Creates or modifies a taxonomy object.
Note: Do not use before the {@see ‘init’} hook.
A simple function for creating or modifying a taxonomy object based on
the parameters given. If modifying an existing taxonomy object, note
that the `$object_type` value from the original registration will be
overwritten.
function register_taxonomy( $taxonomy, $object_type, $args = array() ) { global $wp_taxonomies; if ( ! is_array( $wp_taxonomies ) ) { $wp_taxonomies = array(); } $args = wp_parse_args( $args ); if ( empty( $taxonomy ) || strlen( $taxonomy ) > 32 ) { _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.' ) ); } $taxonomy_object = new WP_Taxonomy( $taxonomy, $object_type, $args ); $taxonomy_object->add_rewrite_rules(); $wp_taxonomies[ $taxonomy ] = $taxonomy_object; $taxonomy_object->add_hooks(); // Add default term. if ( ! empty( $taxonomy_object->default_term ) ) { $term = term_exists( $taxonomy_object->default_term['name'], $taxonomy ); if ( $term ) { update_option( 'default_term_' . $taxonomy_object->name, $term['term_id'] ); } else { $term = wp_insert_term( $taxonomy_object->default_term['name'], $taxonomy, array( 'slug' => sanitize_title( $taxonomy_object->default_term['slug'] ), 'description' => $taxonomy_object->default_term['description'], ) ); // Update `term_id` in options. if ( ! is_wp_error( $term ) ) { update_option( 'default_term_' . $taxonomy_object->name, $term['term_id'] ); } } } /** * Fires after a taxonomy is registered. * * @since 3.3.0 * * @param string $taxonomy Taxonomy slug. * @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, (array) $taxonomy_object ); /** * Fires after a specific taxonomy is registered. * * The dynamic portion of the filter name, `$taxonomy`, refers to the taxonomy key. * * Possible hook names include: * * - `registered_taxonomy_category` * - `registered_taxonomy_post_tag` * * @since 6.0.0 * * @param string $taxonomy Taxonomy slug. * @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}", $taxonomy, $object_type, (array) $taxonomy_object ); return $taxonomy_object; }
声明:本站所有文章,如无特殊说明或标注,均为本站原创发布。任何个人或组织,在未征得本站同意时,禁止复制、盗用、采集、发布本站内容到任何网站、书籍等各类媒体平台。如若本站内容侵犯了原著者的合法权益,可联系我们进行处理。