TYPO3 Logo
TCA Reference
Release: main

Loading data.

  • Introduction
  • Examples
    • About the examples
    • How to use the styleguide extension
  • Best practises
    • 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
        • selectIcons
      • hideMoveIcons
      • itemsProcFunc
      • localizeReferencesAtParentLocalization
      • maxitems
      • minitems
      • MM
      • mode
      • multiple
      • placeholder
      • readOnly
      • required
      • search
      • size
      • softref
    • Category
      • Examples
      • Category field properties
        • default value
        • exclusiveKeys
        • relationship
        • treeConfig
    • Checkboxes
      • Default checkbox
      • Toggle checkbox
      • Labeled toggle checkbox
      • Properties
        • cols
        • default
        • eval
        • invertStateDisplay
        • items
        • renderType
        • validation
    • Color
      • Properties
        • nullable
        • size
        • valuePicker
    • Datetime
      • Properties
        • dbType
        • disableAgeDisplay
        • format
        • nullable
        • range
    • Email
      • Properties
        • autocomplete
        • eval
        • nullable
        • size
    • File
      • Properties
        • allowed
        • appearance
        • allowLanguageSynchronization behaviour
        • disableMovingChildrenWithParent behaviour
        • enableCascadingDelete
        • disallowed (type => file)
        • fieldInformation
        • fieldWizard
        • maxitems
        • minitems
        • overrideChildTca
        • readOnly
    • FlexForm field
      • About the data structure
      • FlexForm syntax
      • Examples
      • Properties
        • Data structure (ds)
        • ds_pointerField
        • ds_pointerField_searchParent
        • ds_pointerField_searchParent_subField
        • ds_tableField
    • Folder
      • Properties
        • elementBrowserEntryPoints
        • fieldControl
    • Group fields
      • Examples
      • Stored data values
      • Properties
        • allowed
        • appearance
        • elementBrowserEntryPoints
        • fieldControl
        • fieldWizard
        • filter
        • foreign_table
        • hideSuggest
        • 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
      • Properties
        • autocomplete
        • eval
        • is_in
        • max
        • min
        • nullable
        • size
        • valuePicker
    • Language fields
      • Introduction
      • Examples
      • Language field properties
      • Migration
      • History
    • Link
      • Properties
        • allowedTypes
        • appearance
        • autocomplete
        • nullable
        • size
        • valuePicker
    • The none field
      • Examples
      • Properties
        • format
        • pass_content
        • size
    • Number
      • Properties
        • autocomplete
        • format
        • nullable
        • range
        • size
        • slider
        • valuePicker
    • Pass through / virtual field
    • Password
      • Properties
        • autocomplete
        • hashed
        • nullable
        • passwordGenerator
        • passwordPolicy
        • size
    • Radiobuttons
      • Examples
      • Properties
        • items
    • Select fields
      • Select field properties
        • allowNonIdValues
        • authMode
        • appearance - selectCheckBox
        • default value
        • disableNoMatchingValueElement
        • exclusiveKeys
        • fileFolderConfig
        • foreign_table
        • foreign_table_prefix
        • foreign_table_where
        • itemGroups
        • items
        • MM
        • multiSelectFilterItems
        • treeConfig
        • sortItems
      • selectSingle
        • Examples
        • Properties
      • Select multiple values (selectSingleBox)
        • Example
        • Properties
      • selectCheckBox
        • Examples
        • selectCheckBox and type check fields compared
        • Properties
      • selectMultipleSideBySide
        • Examples
        • Properties
      • selectTree
        • Examples
        • A happy little tree!
        • 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
        • min
        • nullable
        • richtextConfiguration
        • rows
        • wrap
      • text (default)
        • Examples
        • Properties
      • belayoutwizard
        • Example
        • Properties
      • t3editor
        • Example
        • Properties
      • textTable
        • Example
        • Properties
    • Custom inputs (user)
    • Uuid
      • Properties
        • enableCopyToClipboard
        • size
        • version
  • Table properties (ctrl)
    • Examples
    • Properties
      • adminOnly
      • container
      • copyAfterDuplFields
      • crdate
      • default_sortby
      • delete
      • descriptionColumn
      • editlock
      • enablecolumns
      • EXT
      • formattedLabel_userFunc
      • formattedLabel_userFunc_options
      • groupName
      • hideAtCopy
      • hideTable
      • iconfile
      • is_static
      • label
      • label_alt
      • label_alt_force
      • label_userFunc
      • languageField
      • origUid
      • prependAtCopy
      • readOnly
      • rootLevel
      • searchFields
      • security
      • selicon_field
      • shadowColumnsForNewPlaceholders
      • sortby
      • title
      • translationSource
      • transOrigDiffSourceField
      • transOrigPointerField
      • tstamp
      • type
      • 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
  • Index

PAGE CONTENTS

  • search
  1. Start
  2. Field types (config > type)
  3. Common properties
  4. search
View source How to edit Edit on GitHub

Display settings


Color scheme of code blocks:


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¶
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¶
Type

boolean

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

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\'',
      ],
      ...
   ],
   ...
],

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
  • Home
  • Contact
  • Issues
  • Repository

Last updated: Mar 24, 2023 06:48

Last rendered: Mar 24, 2023 06:49

  • TYPO3 Theme 4.7.9
  • DRC v3.0.dev30
© Copyright since 2012 by the TYPO3 contributors
  • Legal Notice
  • Privacy Policy
  • Code of Conduct