云策 WordPress 开发者社区

函数文档

wp_list_cats()

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

概述

wp_list_cats() 是一个已弃用的 WordPress 函数，用于列出分类目录。自 WordPress 2.1.0 起，建议使用 wp_list_categories() 替代。

关键要点

  • 函数 wp_list_cats() 已被弃用，应改用 wp_list_categories()。
  • 接受字符串或数组参数 $args，返回 null、字符串或 false。
  • 内部通过 wp_parse_args() 处理参数，并将旧参数名映射到 wp_list_categories() 的新参数名。

代码示例

function wp_list_cats($args = '') {
    _deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_categories()' );
    $parsed_args = wp_parse_args( $args );
    // 参数映射示例
    if ( isset($parsed_args['optionall']) && isset($parsed_args['all']))
        $parsed_args['show_option_all'] = $parsed_args['all'];
    // 其他映射...
    return wp_list_categories($parsed_args);
}

注意事项

  • 使用此函数会触发 _deprecated_function() 警告，建议更新代码以避免兼容性问题。
  • 参数映射包括 optionall 到 show_option_all、sort_column 到 orderby 等，确保向后兼容。
📄 原文内容

Lists categories.

Description

See also

Parameters

$argsstring|arrayrequired

Return

null|string|false

Source

function wp_list_cats($args = '') {
	_deprecated_function( __FUNCTION__, '2.1.0', 'wp_list_categories()' );

	$parsed_args = wp_parse_args( $args );

	// Map to new names.
	if ( isset($parsed_args['optionall']) && isset($parsed_args['all']))
		$parsed_args['show_option_all'] = $parsed_args['all'];
	if ( isset($parsed_args['sort_column']) )
		$parsed_args['orderby'] = $parsed_args['sort_column'];
	if ( isset($parsed_args['sort_order']) )
		$parsed_args['order'] = $parsed_args['sort_order'];
	if ( isset($parsed_args['optiondates']) )
		$parsed_args['show_last_update'] = $parsed_args['optiondates'];
	if ( isset($parsed_args['optioncount']) )
		$parsed_args['show_count'] = $parsed_args['optioncount'];
	if ( isset($parsed_args['list']) )
		$parsed_args['style'] = $parsed_args['list'] ? 'list' : 'break';
	$parsed_args['title_li'] = '';

	return wp_list_categories($parsed_args);
}

View all references View on Trac View on GitHub

Uses Description
wp_list_categories()wp-includes/category-template.php

Displays or retrieves the HTML list of categories.
_deprecated_function()wp-includes/functions.php

Marks a function as deprecated and inform when it has been used.
wp_parse_args()wp-includes/functions.php

Merges user defined arguments into defaults array.

Show 1 moreShow less

Used by Description
list_cats()wp-includes/deprecated.php

Lists categories.

Changelog

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