Checkbox

The Checkbox field creates a single checkbox input option for the block.

Click image to enlarge

1. Field Label: The field label will be displayed next to the field when adding it the block to the post or page.
2. Field Name: The field name should auto-fill based on the field label, but can be customized. This will be used in the PHP as part of the block template.
3. Field Type: Choose the Checkbox field type.
4. Field Location: Choose a location to display the field.
   • Editor will show the field in the main editing area of a post or page.
   • Inspector will display the field in the right-hand sidebar under the block inspector.
5. Field Width: Select how widely the field should be displayed.
6. Help Text: Enter instructions to describe the data needed in the field. (optional).
7. Default Value: The default value for this field (checked or unchecked) when adding the block.

PHP API Controls

• name
• label
• control
• type
• order
• location
• width
• help
• default

Template Usage

To display the Checkbox field in your template, use the field name you provided.

There are two ways you can do this.

1. Template Editor: Using the built-in template editor is the easiest way to create the required block template. The template editor accepts HTML markup, field names (enclosed in 2 brackets), and CSS only.

Here’s an example of HTML you can use in the template editor:

<div>
   <p>Is the pet housebroken?</p>
   <p>{{housebroken}}</p>
</div>

2. PHP Template: If you need to use logic, loop syntax, define variables, or use PHP, you can create the template manually using the PHP templating method instead.

For example:

<?php block_field( 'housebroken' ); ?>

Example template file: /blocks/block-example.php

<?php
// Example Checkbox Field
?>

<p>Is the pet housebroken?</p>
<p><?php block_field( 'housebroken' ); ?></p> 

Block Usage

To use the block with the Checkbox field on your site, locate it in the blocks menu.

Click image to enlarge.

It will then display within your post or page editor.

Click image to enlarge

And on the front end of your site.

Click image to enlarge

The API will return a Boolean with ‘true’ as the default value.

<?php
// Example Checkbox Field
?>

<p>Is the pet housebroken?</p>

<?php
if ( block_value( 'housebroken' ) ) {
 echo 'This pet is already housebroken.';
} else {
 echo 'This pet will need some training to become housebroken.';
}
?>

Click image to enlarge

Click image to enlarge