PageTypes

Folder: ContentBlocks/PageTypes

EXT:your_extension/ContentBlocks/PageTypes/blog/config.yaml

name: example/blog
typeName: 1701284006
fields:
  - identifier: additional_field
    type: Text

Learn more about Page Types.

Options

Here you can find all common root options.

Name	Type	Default	Required
typeName	integer		true
group	string	default
allowedRecordTypes	array<string>
labelField	string\|array		true
fallbackLabelFields	array
wizardSteps	array
isViewable	array	true

typeName

Type: integer
Required: true

The typeName has to be a numerical value. There are some reserved numbers, which you can't use either: 199, 254.

typeName: 1701284021

Tip

We recommend to use the current unix timestamp fo your type name. This is almost guaranteed unique. The kickstart command will default to the current timestamp as well.

group

Type: string
Default: default

The group is used for the grouping of the record type selector in the edit view of records. In addition, it is used for the "Create multiple pages" view for selecting the type. By default, all new types are placed in the default group.

group: special

The Core defines these groups for Page Types:

default
link
special

allowedRecordTypes

Type: array<string>

List of allowed Record Types (tables) for this specific Page Type. If defined, only this list of records can be created on this Page Type. This is also evaluated when switching a Page Type to another one. Per default the tables pages, sys_category, sys_file_reference and sys_file_collection are allowed, if not configured otherwise.

Hint

If a Record Type ignores Page Type restrictions, then you don't need to list it here. It will be allowed regardless of this setting.

security:
    ignorePageTypeRestriction: true

Example: Extending the default allowed values with custom ones.

allowedRecordTypes:
  - pages
  - sys_category
  - sys_file_reference
  - my_custom_table

Example: Allow all records with an asterisk:

allowedRecordTypes:
  - *

labelField

Type: string|array
Required: true

Defines which field should be used as the title of the record. If not defined, the first valid child field will be used as the label. It is possible to define an array of fields, which will be displayed comma-separated in the backend.

# a single field for the label
labelField: title

# multiple fields will be displayed comma-separated
labelField:
    - title
    - text

fallbackLabelFields

Type: array

Defines which fields should be used as fallback, if labelField is not filled. The first filled field which is found will be used. Can only be used if there is only one labelField field defined.

# fallback fields will be used, if title from labelField is empty
labelField: title
fallbackLabelFields:
    - text1
    - text2

wizardSteps

Type: array

The page creation wizard supports a dynamic configuration for its steps. This allows to define which fields are displayed in which step of the wizard. The steps are sorted, allowing steps to be positioned relative to each other using the after or before keys.

wizardSteps:
  setup:
    title: Setup
    fields:
      - title
      - slug
      - nav_title
      - hidden
      - nav_hide
  special:
    title: Special
    fields:
      - additional_field
    after:
      - setup

isViewable

Type: array
Default: true

Whether a specific page type can be linked to in the page browser and in frontend TypoLink generation.