Skip to content

field:create

11.0+

Create a new field.

Examples

  • field:create taxonomy_term tag
  • field:create taxonomy_term tag --field-name=field_tag_label --field-label=Label --field-type=string --field-widget=string_textfield --is-required=1 --cardinality=2
  • field:create node article --field-name=field_article_summary --field-label=Summary --field-type=text_long --allowed-formats=full_html --allowed-formats=basic_html

Arguments

  • [entityType]. The machine name of the entity type
  • [bundle]. The machine name of the bundle

Options

  • --field-name=FIELD-NAME. A unique machine-readable name containing letters, numbers, and underscores
  • --field-label=FIELD-LABEL. The field label
  • --field-description[=FIELD-DESCRIPTION]. Instructions to present to the user below this field on the editing form
  • --field-type=FIELD-TYPE. The field type
  • --field-widget=FIELD-WIDGET. The field widget
  • --is-required[=IS-REQUIRED]. Whether the field is required
  • --is-translatable[=IS-TRANSLATABLE]. Whether the field is translatable
  • --cardinality=CARDINALITY. The allowed number of values
  • --target-type[=TARGET-TYPE]. The target entity type for the entity reference field.
  • --target-bundle[=TARGET-BUNDLE]. The target bundle for the entity reference field.
  • --existing[=EXISTING]. Re-use an existing field.
  • --existing-field-name[=EXISTING-FIELD-NAME]. The name of an existing field you want to re-use. Only used in non-interactive context.
  • --show-machine-names[=SHOW-MACHINE-NAMES]. Show machine names instead of labels in option lists
  • --link-type=LINK-TYPE. Allowed link type.
  • --allow-link-text=ALLOW-LINK-TEXT. Allow link text.
  • --allowed-formats=ALLOWED-FORMATS. Restrict which text formats are allowed, given the user has the required permissions.

Global Options

  • -v|vv|vvv, --verbose. Increase the verbosity of messages: 1 for normal output, 2 for more verbose output and 3 for debug
  • -y, --yes. Auto-accept the default for all user prompts. Equivalent to --no-interaction.
  • -l, --uri=URI. A base URL for building links and selecting a multi-site. Defaults to https://default.
  • To see all global options, run drush core:global-options.

Aliases

  • field-create
  • fc

Legend

  • An argument or option with square brackets is optional.
  • Any default value is listed at end of arg/option description.
  • An ellipsis indicates that an argument accepts multiple values separated by a space.