is_post_type_hierarchical()

💡 云策文档标注

概述

is_post_type_hierarchical() 函数用于判断指定的文章类型是否为层级结构（如页面）。如果文章类型不存在，函数也会返回 false。

关键要点

函数接受一个必需的字符串参数 $post_type，表示文章类型名称。
返回布尔值，指示文章类型是否为层级结构。
内部实现先检查文章类型是否存在，然后通过 get_post_type_object() 获取对象并返回其 hierarchical 属性。
相关函数包括 post_type_exists() 和 get_post_type_object()。

代码示例

$post_type = 'page';

if ( is_post_type_hierarchical( $post_type ) ) {
    echo 'The post type ' . $post_type . ' is hierarchical.';
} else {
    echo 'The post type ' . $post_type . ' is not hierarchical.';
}

注意事项

返回 false 可能表示文章类型不是层级结构，也可能表示文章类型未注册或不存在。
函数自 WordPress 3.0.0 版本引入。
在多个核心功能中被使用，如构建查询、处理菜单项和重定向旧链接等。

📄 原文内容

Determines whether the post type is hierarchical.

Description

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

Parameters

$post_typestringrequired: Post type name

Return

bool Whether post type is hierarchical.

Source

function is_post_type_hierarchical( $post_type ) {
	if ( ! post_type_exists( $post_type ) ) {
		return false;
	}

	$post_type = get_post_type_object( $post_type );
	return $post_type->hierarchical;
}

View all references View on Trac View on GitHub

Uses	Description
post_type_exists()`wp-includes/post.php`	Determines whether a post type is registered.
get_post_type_object()`wp-includes/post.php`	Retrieves a post type object by name.

Used by	Description
build_query_vars_from_query_block()`wp-includes/blocks.php`	Helper function that constructs a WP_Query args array from a `Query` block properties.
wp_check_for_changed_dates()`wp-includes/post.php`	Checks for changed dates for published post objects and save the old date.
WP_Posts_List_Table::handle_row_actions()`wp-admin/includes/class-wp-posts-list-table.php`	Generates and displays row action links.
WP_Posts_List_Table::column_title()`wp-admin/includes/class-wp-posts-list-table.php`	Handles the title column output.
WP_Posts_List_Table::column_default()`wp-admin/includes/class-wp-posts-list-table.php`	Handles the default column output.
wp_edit_posts_query()`wp-admin/includes/post.php`	Runs the query to fetch the posts for listing on the edit posts page.
wp_ajax_inline_save()`wp-admin/includes/ajax-actions.php`	Handles Quick Edit saving a post from a list table via AJAX.
page_attributes_meta_box()`wp-admin/includes/meta-boxes.php`	Displays page attributes form fields.
wp_nav_menu_item_post_type_meta_box()`wp-admin/includes/nav-menu.php`	Displays a meta box for a post type menu item.
WP_Posts_List_Table::get_table_classes()`wp-admin/includes/class-wp-posts-list-table.php`
WP_Posts_List_Table::prepare_items()`wp-admin/includes/class-wp-posts-list-table.php`
wp_old_slug_redirect()`wp-includes/query.php`	Redirect old slugs to the correct permalink.
_wp_menu_item_classes_by_context()`wp-includes/nav-menu-template.php`	Adds the class property classes for the current context, if applicable.
wp_list_pages()`wp-includes/post-template.php`	Retrieves or displays a list of pages (or hierarchical post type items) in list (li) format.
wp_check_for_changed_slugs()`wp-includes/post.php`	Checks for changed slugs for published post objects and save the old slug.
wp_unique_post_slug()`wp-includes/post.php`	Computes a unique slug for the post, when given the desired slug and some post details.
wp_delete_post()`wp-includes/post.php`	Trashes or deletes a post or page.
WP_Rewrite::generate_rewrite_rules()`wp-includes/class-wp-rewrite.php`	Generates rewrite rules from a permalink structure.

Show 13 more Show less

Changelog

Version	Description
3.0.0	Introduced.

User Contributed Notes

Skip to note 2 content

Darshit Rajyaguru

3 years ago

$post_type = 'page';

if ( is_post_type_hierarchical( $post_type ) ) {
    echo 'The post type <code>' . $post_type . '</code> is hierarchical.';
} else {
    echo 'The post type <code>' . $post_type . '</code> is not hierarchical.';
}

云策 WordPress 开发者社区

函数文档