云策 WordPress 开发者社区

函数文档

is_taxonomy_hierarchical()

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

概述

is_taxonomy_hierarchical() 函数用于判断指定的分类法对象是否为层级结构。它首先验证分类法是否存在，然后获取其对象并返回 hierarchical 属性值。

关键要点

  • 函数接受一个必需参数 $taxonomy，表示分类法名称，返回布尔值指示是否为层级分类法。
  • 如果分类法不存在，函数返回 false，这可能意味着分类法无效或未注册。
  • 函数内部依赖 taxonomy_exists() 和 get_taxonomy() 来确保操作安全性和准确性。
  • 该函数在 WordPress 2.3.0 版本中引入，广泛用于主题开发、REST API 和后台管理功能中。

代码示例

function is_taxonomy_hierarchical( $taxonomy ) {
    if ( ! taxonomy_exists( $taxonomy ) ) {
        return false;
    }

    $taxonomy = get_taxonomy( $taxonomy );
    return $taxonomy->hierarchical;
}

注意事项

  • 使用前应确保分类法已正确注册，否则可能返回 false 导致误判。
  • 该函数常用于条件标签中，开发者可参考主题开发手册中的 Conditional Tags 文章了解更多类似函数。
📄 原文内容

Determines whether the taxonomy object is hierarchical.

Description

Checks to make sure that the taxonomy is an object first. Then Gets the object, and finally returns the hierarchical value in the object.

A false return value might also mean that the taxonomy does not exist.

For more information on this and similar theme functions, check out the Conditional Tags article in the Theme Developer Handbook.

Parameters

$taxonomystringrequired
Name of taxonomy object.

Return

bool Whether the taxonomy is hierarchical.

Source

function is_taxonomy_hierarchical( $taxonomy ) {
	if ( ! taxonomy_exists( $taxonomy ) ) {
		return false;
	}

	$taxonomy = get_taxonomy( $taxonomy );
	return $taxonomy->hierarchical;
}

View all references View on Trac View on GitHub

Uses Description
taxonomy_exists()wp-includes/taxonomy.php

Determines whether the taxonomy name exists.
get_taxonomy()wp-includes/taxonomy.php

Retrieves the taxonomy object of $taxonomy.
Used by Description
WP_REST_Menus_Controller::create_item()wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php

Creates a single term in a taxonomy.
WP_REST_Menus_Controller::update_item()wp-includes/rest-api/endpoints/class-wp-rest-menus-controller.php

Updates a single term from a taxonomy.
register_and_do_post_meta_boxes()wp-admin/includes/meta-boxes.php

Registers the default post meta boxes, and runs the do_meta_boxes actions.
WP_REST_Posts_Controller::get_available_actions()wp-includes/rest-api/endpoints/class-wp-rest-posts-controller.php

Gets the link relations available for the post and current user.
clean_taxonomy_cache()wp-includes/taxonomy.php

Cleans the caches for a taxonomy.
WP_REST_Terms_Controller::create_item_permissions_check()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Checks if a request has access to create a term.
WP_REST_Terms_Controller::create_item()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Creates a single term in a taxonomy.
WP_REST_Terms_Controller::update_item()wp-includes/rest-api/endpoints/class-wp-rest-terms-controller.php

Updates a single term from a taxonomy.
WP_Term_Query::get_terms()wp-includes/class-wp-term-query.php

Retrieves the query results.
bulk_edit_posts()wp-admin/includes/post.php

Processes the post data for the bulk editing of posts.
wp_ajax_add_tag()wp-admin/includes/ajax-actions.php

Handles adding a tag via AJAX.
WP_Terms_List_Table::prepare_items()wp-admin/includes/class-wp-terms-list-table.php
WP_Terms_List_Table::get_sortable_columns()wp-admin/includes/class-wp-terms-list-table.php
WP_Terms_List_Table::display_rows_or_placeholder()wp-admin/includes/class-wp-terms-list-table.php
wp_nav_menu_item_taxonomy_meta_box()wp-admin/includes/nav-menu.php

Displays a meta box for a taxonomy menu item.
WP_Tax_Query::clean_query()wp-includes/class-wp-tax-query.php

Validates a single query.
WP_Tax_Query::transform_query()wp-includes/class-wp-tax-query.php

Transforms a single query, from one field to another.
_get_term_hierarchy()wp-includes/taxonomy.php

Retrieves children of taxonomy as term IDs.
_pad_term_counts()wp-includes/taxonomy.php

Adds count of children to parent count.
get_ancestors()wp-includes/taxonomy.php

Gets an array of ancestor IDs for a given object.
wp_unique_term_slug()wp-includes/taxonomy.php

Makes term slug unique, if it isn’t already.
wp_insert_term()wp-includes/taxonomy.php

Adds a new term to the database.
wp_delete_term()wp-includes/taxonomy.php

Removes a term from the database.
_wp_menu_item_classes_by_context()wp-includes/nav-menu-template.php

Adds the class property classes for the current context, if applicable.
wp_set_post_terms()wp-includes/post.php

Sets the terms for a post.
wp_xmlrpc_server::_insert_post()wp-includes/class-wp-xmlrpc-server.php

Helper method for wp_newPost() and wp_editPost(), containing shared logic.

Show 21 moreShow less

Changelog

Version Description
2.3.0 Introduced.