TYPO3 Logo
TCA Reference
Release: 11.5

Loading data.

  • Introduction
  • Examples
    • About the examples
    • How to use the styleguide extension
  • Best practices
    • Common fields
    • Language fields
  • Field definitions (columns)
    • Examples
    • Properties
      • config
      • Description
      • displayCond
      • exclude
      • Localization display (l10n_display)
      • Localization mode (l10n_mode)
      • label
      • onChange
  • Field types (config > type)
    • Introduction
    • Common properties
      • autoSizeMax
      • allowLanguageSynchronization behaviour
      • default
      • dontRemapTablesOnCopy
      • fieldControl
        • addRecord
        • editPopup
        • listModule
        • resetSelection
      • fieldInformation
      • fieldWizard
        • defaultLanguageDifferences
        • localizationStateSelector
        • otherLanguageContent
        • recordsOverview
        • selectIcons
        • tableList
      • itemsProcFunc
      • localizeReferencesAtParentLocalization
      • maxitems
      • minitems
      • MM
      • mode
      • multiple
      • placeholder
      • readOnly
      • search
      • size
      • softref
    • Category
      • Examples
      • Category field properties
        • default value
        • exclusiveKeys
        • relationship
        • treeConfig
        • foreign_table
        • foreign_table_prefix
        • foreign_table_where
        • MM
    • Checkboxes
      • Default checkbox
      • Toggle checkbox
      • Labeled toggle checkbox
      • Properties
        • cols
        • default
        • eval
        • invertStateDisplay
        • items
        • renderType
        • validation
    • FlexForm field
      • About the data structure
      • FlexForm syntax
      • Examples
      • Properties
        • Data structure (ds)
        • ds_pointerField
        • ds_pointerField_searchParent
        • ds_pointerField_searchParent_subField
        • ds_tableField
    • Group fields
      • Examples
      • Stored data values
      • Properties
        • allowed
        • appearance
        • fieldControl
        • filter
        • foreign_table
        • hideMoveIcons
        • hideSuggest
        • internal_type
        • MM
        • prepend_tname
        • suggestOptions
    • Image manipulation
      • Examples
      • Properties
        • allowedExtensions
        • cropVariants
        • file_field
    • IRRE / inline
      • Properties
        • appearance
        • disableMovingChildrenWithParent behaviour
        • enableCascadingDelete
        • customControls
        • filter
        • foreign_default_sortby
        • foreign_field
        • foreign_label
        • foreign_match_fields
        • foreign_selector
        • foreign_sortby
        • foreign_table
        • foreign_table_field
        • foreign_unique
        • MM
        • overrideChildTca
        • size
        • symmetric_field
        • symmetric_label
        • symmetric_sortby
      • Examples
    • Input
      • Default input
        • Examples
      • Colorpicker
        • Examples
      • DateTime input
        • Examples
        • Properties
          • dbType
          • disableAgeDisplay
          • eval
          • format
          • range
      • Link input
        • Examples
      • Properties
        • autocomplete
        • eval
        • is_in
        • linkPopup
        • max
        • range
        • size
        • slider
        • valuePicker
    • Language fields
      • Introduction
      • Examples
      • Language field properties
      • Migration
      • History
    • The none field
      • Examples
      • Properties
        • cols
        • format
        • pass_content
        • size
    • Pass through / virtual field
    • Radiobuttons
      • Examples
      • Properties
        • items
    • Select fields
      • Select field properties
        • allowNonIdValues
        • authMode
        • authMode_enforce
        • appearance - selectCheckBox
        • default value
        • disableNoMatchingValueElement
        • exclusiveKeys
        • fileFolderConfig
        • foreign_table
        • foreign_table_prefix
        • foreign_table_where
        • itemGroups
        • items
        • MM
        • multiSelectFilterItems
        • treeConfig
        • sortItems
        • special
      • selectSingle
        • Examples
        • Properties
      • Select multiple values (selectSingleBox)
        • Example
        • Properties
      • selectCheckBox
        • Examples
        • selectCheckBox and type check fields compared
        • Properties
      • selectMultipleSideBySide
        • Examples
        • Properties
      • selectTree
        • Examples
        • Properties
    • Slugs / URL parts
      • Introduction
      • Examples
      • Properties
        • appearance
        • eval
        • fallbackCharacter
        • generatorOptions
        • prependSlash
    • Text areas & RTE
      • Properties
        • cols
        • enableRichtext
        • enableTabulator
        • eval
        • fixedFont
        • format
        • is_in
        • max
        • richtextConfiguration
        • <Unknown>
        • rows
        • wrap
      • text (default)
        • Examples
        • Properties
      • belayoutwizard
        • Example
        • Properties
      • t3editor
        • Example
        • Properties
      • textTable
        • Example
        • Properties
    • Custom inputs (user)
  • Table properties (ctrl)
    • Examples
    • Properties
      • adminOnly
      • container
      • copyAfterDuplFields
      • crdate
      • cruser_id
      • default_sortby
      • delete
      • descriptionColumn
      • editlock
      • enablecolumns
      • EXT
      • formattedLabel_userFunc
      • formattedLabel_userFunc_options
      • groupName
      • hideAtCopy
      • hideTable
      • iconfile
      • is_static
      • label
      • label_userFunc
      • languageField
      • origUid
      • prependAtCopy
      • previewRenderer
      • readOnly
      • rootLevel
      • searchFields
      • security
      • selicon_field
      • sortby
      • title
      • translationSource
      • transOrigDiffSourceField
      • transOrigPointerField
      • tstamp
      • Record types
      • typeicon_classes
      • typeicon_column
      • useColumnsForDefaultValues
      • versioningWS
      • versioningWS_alwaysAllowLiveEdit
  • Backend display (interface)
    • Examples
    • Properties
  • Grouping fields (palettes)
    • Examples
    • Properties
      • isHiddenPalette
      • label
      • description
      • showitem
  • Fields to be displayed (types)
    • Introduction
    • Examples
    • Properties
      • bitmask_excludelist_bits
      • bitmask_value_field
      • columnsOverrides
      • showitem
      • subtype_value_field
      • subtypes_addlist
      • subtypes_excludelist
  • Sitemap

Contributors Corner

  • View source of current document
  • How to edit
  • Edit current document on GitHub
  1. TCA Reference
  2. Field types (config > type)
  3. Common properties
  4. search
Report issue View source How to edit Edit on GitHub

Attention

TYPO3 v11 has reached end-of-life as of October 31th 2024 and is no longer being maintained. Use the version switcher on the top left of this page to select documentation for a supported version of TYPO3.

Need more time before upgrading? You can purchase Extended Long Term Support (ELTS) for TYPO3 v10 here: TYPO3 ELTS.

search

search

search
Path

$GLOBALS['TCA'][$table]['columns'][$field]['config']

type

array

Scope

Search

Types

input

Defines additional search-related options for a given field.

pidonly

pidonly
type

boolean

Searches in the column only if search happens on the single page, does not search the field if searching in the whole table.

case

case
type

boolean

Makes the search case-sensitive. This requires a proper database collation for the field, see your database documentation.

andWhere

andWhere
type

string

Additional SQL WHERE statement without 'AND'. With this it is possible to place an additional condition on the field when it is searched

Example from "tt_content" bodytext:

'bodytext' => [
   'config' => [
      'search' => [
         'andWhere' => '{#CType}=\'text\' OR {#CType}=\'textpic\'',
      ],
      ...
   ],
   ...
],
Copied!

This means that the "bodytext" field of the "tt_content" table will be searched in only for elements of type Text and Text & Images. This helps making any search more relevant.

The above example uses the special field quoting syntax {#...} around identifiers of the QueryHelper to be as DBAL compatible as possible.

  • Previous
  • Next
Reference to the headline

Copy and freely share the link

This link target has no permanent anchor assigned. You can make a pull request on GitHub to suggest an anchor. The link below can be used, but is prone to change if the page gets moved.

Copy this link into your TYPO3 manual.

  • Home
  • Contact
  • Issues
  • Repository

Last rendered: Nov 01, 2024 06:55

© since 2012 by the TYPO3 contributors
  • Legal Notice
  • Privacy Policy