Skip to main content

GF_Field_Section

Source: includes/fields/class-gf-field-section.php:7

Details

  • Kind: class
  • Namespace: (global)
  • Extends: GF_Field

Methods

MethodDescription
get_form_editor_field_description()Returns the field's form editor description.
get_form_editor_field_icon()Returns the field's form editor icon.
get_field_label()Retrieve the field label.
post_convert_field()Actions to be performed once the field has been converted to an object.

Method Reference

get_form_editor_field_description()

public function get_form_editor_field_description()

Returns the field's form editor description.

Returns

  • string

Since: 2.5

Source: includes/fields/class-gf-field-section.php:22

get_form_editor_field_icon()

public function get_form_editor_field_icon()

Returns the field's form editor icon.

This could be an icon url or a gform-icon class.

Returns

  • string

Since: 2.5

Source: includes/fields/class-gf-field-section.php:35

get_field_label()

public function get_field_label( $force_frontend_label=true, $value='' )

Retrieve the field label.

Parameters

NameTypeDefaultDescription
$force_frontend_labelbooltrueShould the frontend label be displayed in the admin even if an admin label is configured.
$valuestring''The field value. From default/dynamic population, $_POST, or a resumed incomplete submission.

Returns

  • string

Since:

  • 2.5.2 (Don't force this field to have a label.)
  • 3.0 (Made the params optional.)

Source: includes/fields/class-gf-field-section.php:60

post_convert_field()

public function post_convert_field()

Actions to be performed once the field has been converted to an object.

Since: 2.5

Source: includes/fields/class-gf-field-section.php:87