This page is a translated version of the page Extension:CategoryTree and the translation is 40% complete.
此扩展随附于MediaWiki 1.31及更高版本。 因此您无需另外下载。 但是,您仍需遵循此页面提供的其他使用说明。
发行状态: 稳定版
实现 标签 , 解析器函数 , 特殊页面
描述 以树的形式提供wiki类别结构的动态视图。
作者 Daniel Kinzler (Duesentrieb留言)
最新版本 持续更新
兼容性政策 快照跟随MediaWiki发布。 master分支不向后兼容。
MediaWiki 1.25+
许可协议 GNU通用公眾授權條款2.0或更新版本
  • $wgCategoryTreeAllowTag
  • $wgCategoryTreeCategoryPageOptions
  • $wgCategoryTreePageCategoryOptions
  • $wgCategoryTreeMaxDepth
  • $wgCategoryTreeSidebarOptions
  • $wgCategoryTreeDefaultOptions
  • $wgCategoryTreeMaxChildren
  • $wgCategoryTreeSpecialPageOptions
  • $wgCategoryTreeOmitNamespace
  • $wgCategoryTreeSidebarRoot
  • $wgCategoryTreeDisableCache
  • $wgCategoryTreeCategoryPageMode
  • $wgCategoryTreeDefaultMode
  • $wgCategoryTreeUseCategoryTable
  • $wgCategoryTreeHijackPageCategories
季度下載量 303 (Ranked 14th)
正在使用的公开wiki数 10,554 (Ranked 11th)
問題 开启的任务 · 报告错误

CategoryTree扩展以动态树视图的形式提供了wiki的分类结构。它使用AJAX依據需要加载树的某些部分。CategoryTree最初是由Daniel Kinzler作为外部工具编写的,但后来在Tim Starling的帮助下被集成到MediaWiki软件中。


  • 下载文件,并将解压后的CategoryTree文件夹移动到extensions/目录中。
    开发者和代码贡献人员应从Git安装扩展,输入:cd extensions/
    git clone
  • 将下列代码放置在您的LocalSettings.php 的底部:
    wfLoadExtension( 'CategoryTree' );
  •   完成 – 在您的wiki上导航至Special:Version,以验证已成功安装扩展。



  • 直接用于分类页面,
  • 作为“自定义标签”(或“解析器函数”)在wiki页面中内联显示分类结构,
  • 作为特殊页面。




<categorytree mode="pages">Manual</categorytree>


set this to "on" to only show the "root" node of the tree initially. Equivalent to depth="0". (Introduced in r20385, March 13 2007.) Deprecated as of r36864, July 2008: use depth="0" instead.
always hide the prefix. Should be used only if all pages come from the same namespace (configuration constant 10).
never hide the namespace prefix, not even for categories (configuration constant 0).
hide the namespace of categories if only categories are shown, as with mode="categories" (configuration constant 30). This is equivalent to the old default behavior (before Jun 2008).
always hide the namespace of categories, but show all other prefixes (configuration constant 20). This is the new default behavior (since r36864, July 2008).
set this to "on" to show the number of entries in subcategories, i.e. showcount="on" (since r36864, July 2008). This is disabled per default for category trees inlined on pages, but enabled per default in category listings and on Special:CategoryTree.
set this to "on" to hide all translations pages corresponding to the pages pertaining to the category, i.e. notranslations="on" (since Gerrit change 526234, November 2019). This is disabled by default. If this option is set to "on", instead of the different translations (e.g. Page, Page/en, Page/fr, Page/de) only the standard translation "Page" is displayed and all translations are suppressed.
This doesn't affect "showcount", so still a bug.
a list of namespaces from which pages should be shown in the tree (since r36864, July 2008). The entries in the list must be namespace names, separated by spaces. The main namespace can be represented by "-" or "0". Subcategories will be shown only if Category namespace is present on the list.
class, style, id, etc
The ‎<categorytree> tag supports all standard HTML attributes for block elements (since r36864, July 2008; before that, only style was supported).


Category is a namespace. Categories are shown in all modes by default, but specifying the namespaces parameter hides them just like any other namespace not present on the list. If you want to list pages in a given namespace, including pages in subcategories, simply add Category to the namespace list.


  • Listing main namespace pages in Category:Manual:
<categorytree mode="pages" namespaces="Main">Manual</categorytree>
  • Listing main namespace pages and subcategories in Category:Manual:
<categorytree mode="pages" namespaces="Main Category">Manual</categorytree>

The mode parameter is overridden by namespaces:

  • if only Category namespace is asked, it's equivalent to mode=categories;
  • if file namespace is present on the list, it will imply mode=all;
  • otherwise mode=pages will be used. It means that if the site configuration hasn't been changed, the following are equivalent (the first two are always equivalent, the third only if $wgCategoryTreeDefaultMode is the default CategoryTreeMode::CATEGORIES):
<categorytree mode="categories">Manual</categorytree>
<categorytree namespaces="Category">Manual</categorytree>



Using the parser function syntax has the advantage that it allows you to use magic words, templates and template parameters when specifying the category to show. Some examples:

  • Using a magic variable to show this page's category tree (may be useful on category description pages): {{#categorytree:{{PAGENAME}}}}.
  • Using a template to specify the category: {{#categorytree:{{root category}}}} - the name of the root category would be defined by the contents of Template:Root_category.
  • Using a template parameter to specify the category, when using CategoryTree inside a template: {{#categorytree:{{{1}}}}} in Template:Baz can be called using {{Baz|Foo}}.


The special page is called Special:CategoryTree; there you can enter the name of a category and then browse its content.


There are some options you can specify in your LocalSettings.php file.

You can no longer use CT_* constants in LocalSettings.php. Instead use 0 for category mode, 10 for pages, 20 for all, 100 for parents.
maximum number of children shown in a tree node. Default is 200.
enable <categorytree> tag. Default is true.
loads the first level of the tree in a <categorytree> dynamically. This way, the cache does not need to be disabled. Default is false.
disables the parser cache for pages with a <categorytree> tag, or provides max cache time in seconds. Default is 21600 which is 6 hours.
enable HTTP cache for anon users. Default is false.
do not show the namespace name for pages and categories. Default is false, namespaces are shown unless showing categories only. Deprecated as of r36864, July 2008: use $wgCategoryTreeDefaultOptions['hideprefix'] instead.
an array defining the maximum depth for each mode, to which the tree may be expanded initially using the depth parameter in a <category> tag. By default, this is set to 2 for the "categories" mode, and 1 for other modes. To set it to 3 for categories and 2 for other modes, for example, you can use $wgCategoryTreeMaxDepth = [10 => 2, 20 => 2, 0 => 3, 100 => 2];.
the default mode to use when no mode attribute is specified in a <categorytree> tag. May be 0 (the default - categories), 10 (pages), or 20 (all).
the mode to use when rendering trees on category pages. Deprecated as of r36864, July 2008: use $wgCategoryTreeCategoryPageOptions['mode'] instead.
root category to use for integrating the category tree in the sidebar (since r36920, July 2008). If not set, no tree is integrated (this is the default). Integrating a CategoryTree into the sidebar only works with skins based upon SkinTemplate, that is, Modern, Monobook, Chick, Simple, and MySkin, but not Standard, Nostalgia or CologneBlue. This is currently broken for MediaWiki 1.35.1 and the vector skin, see phab:278306.
default options to apply, as an array (since r36864, July 2008). The available options are described above. Example: $wgCategoryTreeDefaultOptions['mode'] = 'pages';.
options to use on category pages, as an array (since r36864, July 2008).
options to use on Special:CategoryTree, as an array (since r36864, July 2008).
options to use when showing the tree in the sidebar, as an array (since r36920, July 2008)



By default, when listing subcategories on a category page, each subcategory is followed by an integer, indicating how many subcategories lie beneath it, how many pages it contains, and how many files are in the category (if applicable):

My category name (5 C, 2 P, 1 F)

You can change this behavior by overriding the system message MediaWiki:Categorytree-member-num. It takes five parameters:

参数 含义
$1 子分类数
$2 文章数(不包括分类页面和文件页面)
$3 上传文件的个数
$4 成员页面总数,包括分类页面和文件页面
$5 Something close to ($1 C, $2 P, $3 F) but with anything that is 0 omitted.

More precisely, a comma separated list of the number of pages (mediawiki:categorytree-num-pages), subcategories (mediawiki:categorytree-num-categories), and files (mediawiki:categorytree-num-files) in the category, or empty (mediawiki:categorytree-num-empty) in the case the category has no members. In versions prior to those around 1.19 this value was different. See older version of these docs.


Tip: Use the ParserFunctions extension to provide if/then/else logic to display different parts conditionally. For example:

{{#ifeq:$1|0||$1 categories}}

A configuration to manage commas and spaces when outputting all info:

Abbreviation version:

({{#ifeq:$4|0|empty|{{#ifeq:$1|0||$1 C{{#ifeq:{{#expr:$3+$2}}|0||,}}}} {{#ifeq:$2|0||$2 P{{#ifeq:$3|0||,}}}} {{#ifeq:$3|0||$3 F}}}})

Full name version:

({{#ifeq:$4|0|empty|{{#ifeq:$1|0||$1 categories{{#ifeq:{{#expr:$3+$2}}|0||,}}}} {{#ifeq:$2|0||$2 pages{{#ifeq:$3|0||,}}}} {{#ifeq:$3|0||$3 files}}}})



  • Turn on error reporting
  • Make sure you have all files installed
  • Make sure all of the CategoryTree extension files have mode 644, and the CategoryTree directory has mode 755.


  • Make sure you specify the options after including the extension.

<span id="Clicking_the__has_no_effect,_gives_a_JavaScript_error_or_just_sits_on_loading">


  • Note that using the <categorytree> tag in system messages (MediaWiki namespace) may not work as expected - this is a known caveat. For a workaround, see Using CategoryTree in the Sidebar below.
  • Make sure you have $wgUseAjax = true; in your LocalSettings.php before including the extension.
  • If you are using rewrite rules or aliasing (e.g. to have "very short URLs" - i.e. wiki pages in the document root or perhaps redirecting to a www-version of the requested URL), make sure you have an exception in place for the /extensions directory, just like you would for the /skins directory. Also see below.

<span id="Clicking_the__shows_no_sub-categories_error">

点击显示no sub-categories错误

  • Try to fix this by adding this code to LocalSettings.php: $wgCategoryTreeDefaultOptions['namespaces'] = [ 0, NS_CATEGORY, NS_FILE ];


  • Make sure your web server uses the correct MIME types for .js and .css files
  • Enter the URLs directly into the browser and see if it is serving the pages at all, and not some error page; especially:
  • If you are using rewrite rules or aliasing (e.g. to have "very short URLs" - i.e. wiki pages in the document root), make sure you have an exception in place for the /extensions directory, just like you would for the /skins directory.

<span id="Member_counts_are_wrong,_grey_arrows__are_shown_instead_of_">


Since MediaWiki 1.13, CategoryTree can show the number of members of a category, and can show a grey arrow for tree nodes that do not have any children based on that number. This information is based on the new category table. However, populating that table with the current values does not always work when upgrading to 1.13. In that case, run the populateCategory.php maintenance script, if necessary with the --force option.

<span id=" _toggles_shown_only_on_the_first_level_of_the_category_tree_view">


In case you get only one level depth while visualing the tree, try to set in modules/ext.categoryTree.styles.css file display: none; to display: inline !important;.

The JavaScript intended to switch the tag style is somehow buggy.


Bots and scripts that parse the HTML of category pages can use the notree URL parameter to force the traditional output. However, HTML output is generally not stable, so it is recommended to change your script to use the API to fetch category listings and similar.

“Category Not Found”消息

After you implement the CategoryTree plugin and add the code to show the tree, if you see a message that says Category Not Found, you need to add some content in your category pages. The category pages can't be red pages, basically. Click your category names, add some text in the category page, and then your tree should work fine.


Make sure the right version of this extension is installed, relative to the version of MediaWiki you have installed. In particular, versions of this extension made for versions of MediaWiki prior to 1.17 are not compatible with MediaWiki 1.17 and greater, and will cause issues where all the paging links on category pages are broken.





In older versions of CategoryTree, you have to modify the code to make this work: find the efCategoryTreeParserOutput function in the file CategoryTree.php, and remove the condition; i.e. it should then look like this:

function efCategoryTreeParserOutput( &$outputPage, &$parserOutput )  {
    CategoryTree::setHeaders( $outputPage );
    return true;



Since r36920 (July 2008) with MediaWiki 1.13 (r36917), you can integrate a CategoryTree in the sidebar simply by setting $wgCategoryTreeSidebarRoot to the category you want to use as a root. This only works with skins based upon SkinTemplate however, that is, Modern, Monobook, Chick, Simple, and MySkin, but not Standard, Nostalgia or CologneBlue.

If you want the CategoryTree on a different position in the sidebar, you can reference it on MediaWiki:Sidebar as "categorytree-portlet".

For earlier versions of CategoryTree and/or MediaWiki, you'll need to install a mod to MonoBook.php to enable normal wikitext in the sidebar, see Wikitext in side bar --DJ 19:26, 24 January 2008 (UTC)

To append a link "CategoryTree" to your toolbox (sidebar ) add following code to the JavaScript page (e.g. monobook.js) of your skin and customize the URL "w:Special:CategoryTree".

function AppendCategoryTreeToSidebar() {
    try {
        var node = document.getElementById( "p-tb" )
        var aNode = document.createElement( 'a' );
        var liNode = document.createElement( 'li' );
        aNode.appendChild( document.createTextNode( 'CategoryTree' ) );
        aNode.setAttribute( 'href' , '[[w:Special:CategoryTree]]' );
        liNode.appendChild( aNode );
        liNode.className = 'plainlinks';
        node.appendChild( liNode );
    } catch(e) {
        // lets just ignore what's happened
addOnloadHook( AppendCategoryTreeToSidebar );

A more generic version of this code can be found at Manual:Interface/Sidebar#content of sidebar and toolbox (javascript) .

Step by step if works easy:

$wgCategoryTreeSidebarRoot = 'Category:article_name';

通过MediaWiki: 命名空间页面

If you want to create a link that goes to the generic categorytree (displayed as Category tree) when you're on a non-category page, and to a particular categorytree (displayed as View as category tree, with foo being the name of the category you're viewing) when you're on a category page:

  • Add to your MediaWiki:Sidebar (right above the SEARCH is a good place) a line, ** sidebarcategorytree-url|sidebarcategorytree
  • Create a [[MediaWiki:Sidebarcategorytree]] with, say: {{#ifeq: {{NAMESPACE}}|Category|View as category tree|Category tree}}
  • Create a [[MediaWiki:Sidebarcategorytree-url]] with, say: {{#ifeq: {{NAMESPACE}}|Category|Special:CategoryTree/{{BASEPAGENAME}}|Special:CategoryTree/Categories}}

See also