Toggle

The Toggle field creates an on / off toggle switch 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 Toggle 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 when adding the block. Checked for yes/true/1, unchecked for no/false/0.

PHP API Controls

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

Template Usage

To display the Toggle 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>
     <h3>Is this pet still available?</h3>     
     <p>{{pets-availability}}</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( 'pets-availability' ); ?>

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

<?php
// Example Toggle Field
?>

<h3>Is this pet still available?</h3>
<p><?php block_field( 'pets-availability' ); ?></p>

Block Usage

To use the block with the Toggle 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.

<?php
// Example Toggle Field

// Have a red border if the pet is still available or no border if it is not available

$border = 'class="container';
if ( block_value( 'pets-availability' ) ) {
    $border .= '" style="border:3px solid red;padding-top:15px;"';
} else {
    $border .= '"';
}
?>

<div <?php echo $border; ?>>
    <h3>Is this pet still available?</h3>
        <p><?php block_field( 'pets-availability' ); ?></p>
</div>

Click image to enlarge