Settings Reference

The document is a reference to the available settings properties that you can configure via the settings object in theme.json. Each of the settings has an in-depth guide on how to use it within the Settings documentation.

Appearance Tools

settings.appearanceTools is a top-level property with no sub-properties nested beneath it. It is documented at Settings: Appearance Tools.

PropertyTypeDefault
appearanceToolsbooleanfalse

Top ↑

Border

settings.border is an object that supports the nested properties listed in the below table. It is documented at Settings: Border.

PropertyTypeDefault
colorbooleanfalse
radiusbooleanfalse
stylebooleanfalse
widthbooleanfalse

Enabling any one of the color, style, or width settings will automatically enable the other two since the properties are linked together.

Top ↑

Color

settings.color is an object that supports the nested properties listed in the below table. It is documented at Settings: Color.

PropertyTypeDefaultProps
backgroundbooleantrue
custombooleantrue
customDuotonebooleantrue
customGradientbooleantrue
defaultDuotonebooleantrue
defaultGradientsbooleantrue
defaultPalettebooleantrue
duotonearray <object>arraycolors, name, slug
gradientsarray <object>arraygradient, name, slug
linkbooleanfalse
palettearray <object>arraycolor, name, slug
textbooleantrue

Top ↑

Custom

settings.custom is an object that supports any number of nested custom properties, as shown in the below table. It is documented at Settings: Custom.

PropertyTypeDefault
custom.<custom>any

Top ↑

Dimensions

settings.dimensions is an object that supports the nested properties listed in the below table. It is documented at Settings: Dimensions.

PropertyTypeDefault
minHeightbooleanfalse

Top ↑

Layout

settings.layout is an object that supports the nested properties listed in the below table. It is documented at Settings: Layout.

PropertyTypeDefault
contentSizestring""
wideSizestring""

Top ↑

settings.lightbox is an object that supports the nested properties listed in the below table. It is documented at Settings: Lightbox.

PropertyTypeDefault
allowEditingbooleantrue
enabledbooleanfalse

This setting is only available as of WordPress 6.4 and is specific to the core Image block (core/image).

Top ↑

Position

settings.position is an object that supports the nested properties listed in the below table. It is documented at Settings: Position.

PropertyTypeDefault
stickybooleanfalse

Top ↑

Shadow

settings.shadow is an object that supports the nested properties listed in the below table. It is documented at Settings: Shadow.

PropertyTypeDefaultProps
defaultPresetsbooleantrue
presetsarray <object>arrayname, shadow, slug

Top ↑

Spacing

settings.spacing is an object that supports the nested properties listed in the below table. It is documented at Settings: Spacing.

PropertyTypeDefaultProps
blockGapboolean|nullnull
customSpacingSizebooleantrue
marginbooleanfalse
paddingbooleanfalse
spacingScaleobjectobjectoperator, increment, steps, mediumStep, unit
spacingSizesarray <object>arrayname, size, slug
unitsarray <string>[ "px", "em", "rem", "vh", "vw", "%" ]

Top ↑

Typography

settings.typography is an object that supports the nested properties listed in the below table. It is documented at Settings: Typography.

PropertyTypeDefaultProps
customFontSizebooleantrue
dropCapbooleantrue
fontFamiliesarray <object>arrayfontFace, fontFamily, name, slug
fontSizesarray <object>arrayfluid, name, size, slug
fontStylebooleantrue
fontWeightbooleantrue
fluidbooleanfalse
letterSpacingbooleantrue
lineHeightbooleanfalse
textColumnsbooleanfalse
textDecorationbooleantrue
textTransformbooleantrue
writingModebooleanfalse

Top ↑

Use Root Padding Aware Alignments

settings.useRootPaddingAwareAlignments is a top-level property with no sub-properties nested beneath it. It is documented at Settings: Use Root Padding Aware Alignments.

PropertyTypeDefault
useRootPaddingAwareAlignmentsbooleanfalse

This setting works together with styles.spacing.padding in theme.json. If enabled, styles.spacing.padding must be an object that defines the top, rightbottom, and left styles separately.