Image

The Image field creates a field where you can either upload a new image or select an existing image out of the media library.

Click image to enlarge

1. Field Label: The field label will be displayed next to the field when adding 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 Image 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).

PHP API Controls

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

Template Usage

To display the Image 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>How can you say no to a face like this?</p>
     <img src="{{pets-photo}}" />
</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:

<img src="<?php block_field( 'pets-photo' ); ?>" />

The API will return the Attachment Post ID of the chosen image as an integer, and echo the full-size URL of the chosen image as a string.

<?php
$attachment_id = block_value( 'pets-photo' );
echo wp_get_attachment_image( $attachment_id, 'thumbnail' );
?>

Example template file /blocks/block-example.php

<?php
// Example Image Field
?>

<p>How can you say no to a face like this?</p>
<img src="<?php block_field( 'pets-photo' ); ?>" />

Block Usage

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

Click image to enlarge

And on the front end of your site.

Click image to enlarge