Class AdminPageFramework_Controller_Form

Adds sections.

It inserts the given section definition arrays into the class property and later they are parsed when sections are registered. The section definition array have required keys. Refer to the parameter section of this method.

Example

$this->addSettingSections(
      array(
           'section_id'    => 'text_fields',
           'title'         => __( 'Text Fields', 'your-text-domain' ),
           'description'   => __( 'These are text type fields.', 'your-text-domain' ),
      ),
      array(
           'section_id'    => 'selectors',
           'title'         => __( 'Selectors', 'your-text-domain' ),
           'description'   => __( 'These are selector type options such as dropdown lists, radio buttons, and checkboxes', 'your-text-domain' ),
      )
);

Example

$this->addSettingSections(
     array(
         'section_id'    => 'text_fields',
         'page_slug'     => 'first_page',
         'tab_slug'      => 'textfields',
         'title'         => 'Text Fields',
         'description'   => 'These are text type fields.',
         'order'         => 10,
     ),
     array(
         'section_id'    => 'selectors',
         'page_slug'     => 'first_page',
         'tab_slug'      => 'selectors',
         'title'         => 'Selectors',
         'description'   => 'These are selector type options such as dropdown lists, radio buttons, and checkboxes',
     )
);

Since

Remark

Overrides

A singular form of the adSettingSections() method which takes only a single parameter.

This is useful when adding section arrays in loops.

Parameters

Since

Overrides

Removes the given section(s) by section ID.

This accesses the property storing the added section arrays and removes the specified ones.

Example

$this->removeSettingSections( 'text_fields', 'selectors', 'another_section', 'yet_another_section' );

Since

Remark

Adds form fields.

It inserts the given field definition arrays into the class property and later they are parsed when fields are registered. The field definition array requires specific keys. Refer to the parameter section of this method.

Example

$this->addSettingFields(
     array(
         'field_id'      => 'text',
         'section_id'    => 'text_fields',
         'title'         => __( 'Text', 'my-text-domain' ),
         'description'   => __( 'Type something here.', 'my-text-domain' ),
         'type'          => 'text',
         'order'         => 1,
         'default'       => 123456,
     ),
     array(
         'field_id'      => 'text_multiple',
         'section_id'    => 'text_fields',
         'title'         => __( 'Multiple Text Fields', 'my-text-domain' ),
         'description'   => __( 'These are multiple text fields.', 'my-text-domain' ),
         'type'          => 'text',
         'order'         => 2,
         'default'       => __( 'Hello World', 'my-text-domain' ),
         'label'         => __( 'First Item', 'my-text-domain' ),
         'attributes' => array(
             'size' => 30
         ),
         array(
             'label'         => __( 'Second Item', 'my-text-domain' ),
             'default'       => __( 'Foo bar', 'my-text-domain' ),
             'attributes'    => array(
                 'size' => 60,
             ),
         ),
         array(
             'label'         => __( 'Third Item', 'my-text-domain' ),
             'default'       => __( 'Yes, we can.', 'my-text-domain' ),
             'attributes' => array(
                 'size' => 90,
             ),
         ),
     )
);

Since

Remark

Overrides

Adds the given field array items into the field array property.

Identical to the addSettingFields() method except that this method does not accept enumerated parameters.

Parameters

Since

Overrides

Removes the given field(s) by field ID.

This accesses the property storing the added field arrays and removes the specified ones.

Example

$this->removeSettingFields( 'fieldID_A', 'fieldID_B', 'fieldID_C', 'fieldID_D' );

Parameters

Since

Remark

Retrieves the specified field value stored in the options by field ID.

Example

$this->addSettingFields(
    'number_section',  // section id
    array(
        'field_id'          => 'preset_field',
        'title'             => __( 'Preset', 'admin-page-framework-demo' ),
        'type'              => 'number',
    ),
    array(
        'field_id'          => 'value_based_on_preset',
        'title'             => __( 'Value Based on Preset', 'admin-page-framework-demo' ),
        'type'              => 'number',
        'default'           => 10 + ( int ) $this->getValue(
            'number_section',   // section id
            'preset_field'      // field id
        ),
    ),
);

Since