TCA column type category 

Default value set if a new record is created. If empty, no category gets selected.

List of keys that exclude any other keys in a select box where multiple items could be selected. See also property exclusiveKeys of selectTree.

The item-array will be filled with records from the table defined here. The table must have a TCA definition.

The uids of the chosen records will be saved in a comma-separated list by default.

Use property MM to store the values in an intermediate MM table instead.

This property references a specific field in the foreign table, which holds an item group identifier.

See also property foreign_table_item_group of select field.

Label prefix to the title of the records from the foreign-table.

See also property foreign_table_prefix of select field.

The items from foreign_table are selected with this WHERE clause. If set make sure to append the default value to your query. See also property foreign_table_where of select field.

Contains an array of key-value pairs. The key contains the id of the item group, the value contains the label of the item group or its language reference.

Only groups containing items will be displayed. In the select field first all items with no group defined are listed then the item groups in the order of their definition, each group with the corresponding items.

See also property itemGroups of select field.

Maximum number of child items. Defaults to a high value. JavaScript record validation prevents the record from being saved if the limit is not satisfied.

Minimum number of child items. Defaults to 0. JavaScript record validation prevents the record from being saved if the limit is not satisfied.

This value contains the name of the table in which to store a MM relation. It is used together with foreign_table.

The database field with a MM property only stores the number of records in the relation.

Please have a look into the additional information in the MM common property description and the property MM of select field

Renders the field in a way that the user can see the values but cannot edit them. The rendering is as similar as possible to the normal rendering but may differ in layout and size.

All possible values are:

oneToOne

Stores the uid of the selected category. When using this relationship, maxitems=1 will automatically be added to the column configuration. While one record can only have a relation to one category, each category can still have a relationship to more then one record.

oneToMany

Stores the uids of selected categories in a comma-separated list.

manyToMany (default):

Uses the intermediate table sys_category_record_mm and only stores the categories count on the local side. This is the use case, which was previously accomplished using ExtensionManagementUtility::makeCategorizable() , a static method removed in TYPO3 v12.

In the following example a category tree is displayed, but only one category can be selected.

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_mytable', [
  'categories' => [
    'label' => 'Categories',
    'config' => [
      'type' => 'category',
    ],
  ],
  'main_category' => [
    'label' => 'Main category',
    'config' => [
      'type' => 'category',
      'relationship' => 'oneToOne',
    ],
  ],
  'site_categories' => [
    'label' => 'Categories of this site',
    'config' => [
      'type' => 'category',
      'treeConfig' => [
        'startingPoints' => '1,2,###SITE:categories.root###',
      ],
    ],
  ],
]);

ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_mytable',
  'categories, main_category, site_categories',
);

All other relevant options, for example maxitems=1, are being set automatically.

Maximal number of elements to be displayed by default

Either childrenField or parentField has to be set - childrenField takes precedence. Keywords:

dataProvider

Allows to define a custom data provider class for usecases where special data preparation is necessary. By default \TYPO3\CMS\Core\Tree\TableConfiguration\DatabaseTreeDataProvider is used.

childrenField (string)

Field name of the foreign_table that references the uid of the child records.

parentField (string)

Field name of the foreign_table that references the uid of the parent record

startingPoints (string, comma separated values)

allows to set multiple records as roots for tree records.

The setting takes a CSV value, e.g. 2,3,4711, which takes records of the uids 2, 3 and 4711 into account and creates a tree of these records.

Additionally, each value used in startingPoints may be fed from a site configuration by using the ###SITE:### syntax.

Example:

# Site config
base: /
rootPageId: 1
categories:
    root: 123

Copied!

EXT:my_extension/Configuration/TCA/Overrides/tx_myextension_mytable.php

<?php

use TYPO3\CMS\Core\Utility\ExtensionManagementUtility;

defined('TYPO3') or die();

ExtensionManagementUtility::addTCAcolumns('tx_myextension_mytable', [
  'categories' => [
    'label' => 'Categories',
    'config' => [
      'type' => 'category',
    ],
  ],
  'main_category' => [
    'label' => 'Main category',
    'config' => [
      'type' => 'category',
      'relationship' => 'oneToOne',
    ],
  ],
  'site_categories' => [
    'label' => 'Categories of this site',
    'config' => [
      'type' => 'category',
      'treeConfig' => [
        'startingPoints' => '1,2,###SITE:categories.root###',
      ],
    ],
  ],
]);

ExtensionManagementUtility::addToAllTCAtypes(
  'tx_myextension_mytable',
  'categories, main_category, site_categories',
);

Copied!

This will evaluate to 'startingPoints' => '1,2,123' .

appearance (array, optional)

showHeader (boolean)

Whether to show the header of the tree that contains a field to filter the records and allows to expand or collapse all nodes

expandAll (boolean)

Whether to show the tree with all nodes expanded

maxLevels (integer)

The maximal amount of levels to be rendered (can be used to stop possible recursions)

nonSelectableLevels (list, default "0")

Comma-separated list of levels that will not be selectable, by default the root node (which is "0") cannot be selected