Fieldhtml

Html Field

Field type: html Renderer class: Html Aliases using the same renderer: None

Html Field

Field type: html
Renderer class: Html
Aliases using the same renderer: None

Purpose

Static HTML output field.

Value shape

String unless the field options enable multiple/nested values.

Supported attributes

Common attributes

Attribute Type Description
id string Required for data-saving fields. Unique key inside the option/meta array.
type string Required. Field type slug, for example text, select, or repeater.
title string Main field label displayed in the left column.
subtitle string Small helper text below the field title.
desc string/html Description displayed below the control. Limited HTML is allowed.
default mixed Default value used when there is no saved value yet.
placeholder string Placeholder text for input/select-like fields when supported.
dependency array Conditional visibility rules. Example: [ "field" => "enable", "operator" => "==", "value" => 1 ].
sanitize_callback callable Custom sanitizer callback. Receives $value and $field.

Field-specific attributes

Attribute Type Description
content string/html Static content rendered by layout/information fields.

Options Framework example

KAVRO::createSection( $prefix, array(
    'title'  => 'Html Example',
    'fields' => array(
        array(
            'type' => 'html',
            'title' => 'Html',
            'subtitle' => 'Html field example.',
            'desc' => 'This is a documented html field example.',
            'content' => '<strong>Kavro documentation example.</strong>',
        ),
    ),
) );

Metabox example

KAVRO::createSection( $metabox_prefix, array(
    'title'  => 'Html Meta',
    'fields' => array(
        array(
            'type' => 'html',
            'title' => 'Html',
            'subtitle' => 'Html field example.',
            'desc' => 'This is a documented html field example.',
            'content' => '<strong>Kavro documentation example.</strong>',
        ),
    ),
) );

Saving behavior

This field is primarily structural/display-only and normally does not save a value because it does not require an id.

From Customizer

$value = get_theme_mod( 'demo_html', null );

From Taxonomy Options

$value = kavro_get_term_meta( $term_id, $taxonomy_prefix, 'demo_html', null );

From Profile/User Options

$value = kavro_get_user_meta( $user_id, $profile_prefix, 'demo_html', null );

From Nav Menu Options

$value = kavro_get_nav_menu_item_meta( $menu_item_id, $nav_menu_prefix, 'demo_html', null );

From Widget Options

$value = kavro_get_widget_option( $widget_id, $widget_prefix, 'demo_html', null );

From Comment Options

$value = kavro_get_comment_meta( $comment_id, $comment_prefix, 'demo_html', null );

From Shortcode Framework

Shortcode field values are passed to the shortcode callback as attributes or normalized settings depending on your shortcode registration callback.

$value = isset( $atts['demo_html'] ) ? $atts['demo_html'] : null;

Notes

This field is commonly used for display/admin UX. Use it in options pages when possible; metabox usage is supported when the output makes sense for editors.