Block attributes and controls in Wordpress - Cheat Sheet & Quick Revision

Recall & Review

beginner

What are block attributes in WordPress block development?

Block attributes are pieces of data that store the state or settings of a block. They define what content or options the block holds and how it behaves.

beginner

How do block controls help users in the WordPress editor?

Block controls provide user interface elements like buttons, toggles, or inputs that let users change block attributes easily while editing.

intermediate

Which WordPress component is commonly used to add controls in the block toolbar?

The BlockControls component is used to add controls in the block toolbar above the block content.

intermediate

What is the purpose of the InspectorControls component in block development?

The InspectorControls component adds controls in the sidebar panel, allowing users to adjust block settings in a detailed way.

beginner

How do you define a block attribute that stores a string value?

You define it in the block's attributes object with a type of 'string', for example: content: { type: 'string' }.

Which component is used to add controls to the block toolbar in WordPress?

A BlockControls

B InspectorControls

C PanelBody

D RichText

BlockControls adds controls to the block toolbar, while InspectorControls adds controls to the sidebar.

What type of data would you assign to a block attribute that stores a number?

A number

B string

C boolean

D object

The 'number' type is used for numeric values in block attributes.

Where do InspectorControls appear in the WordPress editor?

A Above the block content

B In the footer

C In the block toolbar

D In the sidebar panel

InspectorControls appear in the sidebar panel for detailed block settings.

Which of these is NOT a typical control used in block controls?

A ButtonControl

B TextControl

C ImageControl

D ToggleControl

ImageControl is not a standard control; images are usually handled differently.

How do block attributes help with saving block content?

A They style the block visually

B They store the block's settings and content data

C They add animations to the block

D They create new blocks

Block attributes store the data needed to save and render the block content.

Explain how block attributes and controls work together in a WordPress block.

Think about how users interact with blocks and how data is saved.

Describe the difference between BlockControls and InspectorControls in WordPress block development.

Consider where the controls appear in the editor.

Practice

1. What is the main purpose of block attributes in WordPress block development?

easy

A. To store data or settings related to the block

B. To style the block with CSS

C. To add animations to the block

D. To create new blocks automatically

Solution

1. Step 1: Understand block attributes role

   Block attributes hold the data or settings that define how a block behaves or looks. Differentiate from styling or automation: Attributes are not for styling or creating blocks automatically but for storing block-specific data.

2. Final Answer:

   To store data or settings related to the block -> Option A

3. Quick Check:

   Block attributes = store data/settings [OK]

Hint: Attributes hold block data/settings, not styles or animations [OK]

Common Mistakes:

• Confusing attributes with CSS styling
• Thinking attributes create blocks automatically
• Assuming attributes control animations directly

2. Which of the following is the correct way to define a block attribute named title of type string in a block's attributes object?

easy

A. "title": { type: String }

B. "title": "string"

C. "title": { value: "string" }

D. "title": { type: "string" }

Solution

1. Step 1: Recall attribute syntax in block.json or registerBlockType

   Attributes are defined as objects with a type property as a lowercase string. Compare options: \"title\": { type: \"string\" } uses { type: \"string\" } which is correct. \"title\": { type: String } uses String (capitalized) which is invalid.

2. Final Answer:

   \"title\": { type: \"string\" } -> Option D

3. Quick Check:

   Attribute type uses lowercase string \"string\" [OK]

Hint: Use { type: \"string\" } with lowercase type name [OK]

Common Mistakes:

• Using capitalized String instead of \"string\"
• Assigning attribute directly to a string
• Using incorrect property like value instead of type

3. Given this block attribute and control code snippet:

const [content, setContent] = useState('Hello');

return (
   setContent(value)}
  />
);

What will happen when the user types "World" into the TextControl?

medium

A. An error occurs because useState is not allowed in blocks

B. The content state updates to "World" and the TextControl shows "World"

C. The content state remains "Hello" and TextControl does not change

D. The TextControl clears and shows an empty string

Solution

1. Step 1: Understand useState and TextControl interaction

   The useState hook holds the current content. The TextControl shows this content and updates it on user input. Follow the onChange handler: When user types \"World\", onChange calls setContent(\"World\"), updating the state and re-rendering the control with new value.

2. Final Answer:

   The content state updates to "World" and the TextControl shows "World" -> Option B

3. Quick Check:

   Typing updates state and control value [OK]

Hint: State updates on change, control reflects new value [OK]

Common Mistakes:

• Thinking state won't update without explicit save
• Believing useState is disallowed in block edit
• Assuming control clears on input

4. Consider this block attribute definition:

attributes: {
  count: { type: 'number', default: 0 }
}

And this control code:

 setAttributes({ count: value })}
/>

What is the likely cause if the control does not update the count attribute correctly when typing?

medium

A. The value prop should be a number, but onChange passes a string

B. The attribute type should be "string" instead of "number"

C. The default value must be set inside setAttributes

D. The control component NumberControl does not exist in WordPress

Solution

1. Step 1: Check data types between attribute and control

   The attribute expects a number, but onChange often passes a string from input controls. Identify mismatch causing update failure: Passing a string instead of a number causes the attribute not to update properly because types differ.

2. Final Answer:

   The value prop should be a number, but onChange passes a string -> Option A

3. Quick Check:

   Type mismatch: onChange passes string to number attribute [OK]

Hint: Ensure onChange passes correct type matching attribute [OK]

Common Mistakes:

• Ignoring type conversion from string to number
• Changing attribute type unnecessarily
• Assuming default value fixes runtime type issues

5. You want to create a block with a toggle control that updates a boolean attribute isActive. Which code snippet correctly defines the attribute and control to toggle this value?

hard

A. attributes: { isActive: { type: 'boolean' } }

setAttributes({ isActive: !attributes.isActive })}
/>

B. attributes: { isActive: { type: 'string', default: 'false' } }

setAttributes({ isActive: value })}
/>

C. attributes: { isActive: { type: 'boolean', default: false } }

setAttributes({ isActive: value })}
/>

D. attributes: { isActive: { type: 'boolean', default: true } }

setAttributes({ isActive: !value })}
/>

Solution

1. Step 1: Define boolean attribute with default false

   attributes: { isActive: { type: 'boolean', default: false } }
   
    setAttributes({ isActive: value })}
   />

   correctly defines isActive as boolean with default false, which is standard for toggles. Use ToggleControl with checked and onChange: The checked prop uses the attribute value, and onChange updates the attribute with the new boolean value passed by the toggle.

2. Final Answer:

   { isActive: { type: 'boolean', default: false } }, ToggleControl checked={attributes.isActive} onChange={(value) => setAttributes({ isActive: value })} -> Option C

3. Quick Check:

   Boolean attribute with checked and direct onChange update [OK]

Hint: Use checked prop and boolean attribute with default false [OK]

Common Mistakes:

• Using string type for boolean attribute
• Using value instead of checked prop
• Inverting value incorrectly in onChange