函数文档

list_cats()

💡 云策文档标注

概述

list_cats() 是一个已弃用的 WordPress 函数,用于列出分类。自 2.1.0 版本起,建议使用 wp_list_categories() 替代。

关键要点

  • 函数 list_cats() 已被弃用,应改用 wp_list_categories()。
  • 该函数接受多个参数,如 $optionall、$all、$sort_column 等,用于控制分类列表的显示方式。
  • 内部调用 wp_list_cats() 并返回结果,但已标记为 deprecated。

代码示例

function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0,
		$optioncount = 0, $hide_empty = 1, $use_desc_for_title = 1, $children=false, $child_of=0, $categories=0,
		recurse=0, $feed = '', $feed_image = '', $exclude = '', $hierarchical=false) {
	_deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_categories()' );

	$query = compact('optionall', 'all', 'sort_column', 'sort_order', 'file', 'list', 'optiondates', 'optioncount', 'hide_empty', 'use_desc_for_title', 'children',
		'child_of', 'categories', 'recurse', 'feed', 'feed_image', 'exclude', 'hierarchical');
	return wp_list_cats($query);
}

注意事项

  • 使用此函数会触发 _deprecated_function() 警告,建议在开发中避免使用。
  • 相关函数包括 wp_list_cats() 和 wp_list_categories(),后者是当前推荐的方法。

📄 原文内容

Lists categories.

Description

See also

Parameters

$optionallintoptional

Default:1

$allstringrequired
$sort_columnstringrequired
$sort_orderstringrequired
$filestringrequired
$listbooloptional

Default:true

$optiondatesintrequired
$optioncountintrequired
$hide_emptyintoptional

Default:1

$use_desc_for_titleintoptional

Default:1

$childrenbooloptional

Default:false

$child_ofintrequired
$categoriesintrequired
$recurseintrequired
$feedstringrequired
$feed_imagestringrequired
$excludestringrequired
$hierarchicalbooloptional

Default:false

Return

null|false

Source

function list_cats($optionall = 1, $all = 'All', $sort_column = 'ID', $sort_order = 'asc', $file = '', $list = true, $optiondates = 0,
				$optioncount = 0, $hide_empty = 1, $use_desc_for_title = 1, $children=false, $child_of=0, $categories=0,
				$recurse=0, $feed = '', $feed_image = '', $exclude = '', $hierarchical=false) {
	_deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_categories()' );

	$query = compact('optionall', 'all', 'sort_column', 'sort_order', 'file', 'list', 'optiondates', 'optioncount', 'hide_empty', 'use_desc_for_title', 'children',
		'child_of', 'categories', 'recurse', 'feed', 'feed_image', 'exclude', 'hierarchical');
	return wp_list_cats($query);
}

Changelog

Version Description
2.1.0 Deprecated. Use wp_list_categories()
0.71 Introduced.