Overview

Namespaces

  • None
  • PHP

Classes

  • Sidecar
  • Sidecar_Admin_Page
  • Sidecar_Admin_Tab
  • Sidecar_Field
  • Sidecar_Form
  • Sidecar_Form_Settings
  • Sidecar_Plugin_Base
  • Sidecar_Plugin_Settings
  • Sidecar_Settings_Base
  • Sidecar_Shortcode
  • Sidecar_Singleton_Base

Functions

  • body
  • format_gmt_string
  • headers
  • output_css
  • Overview
  • Namespace
  • Class
  • Tree
  • Deprecated
  • Todo
  • Download

Class Sidecar_Field

Located at classes/class-field.php
Methods summary
public
# __construct( string $field_name, array $args = array() )

Parameters

$field_name
string
$field_name
$args
array
$args
public string
# get_input_name( )

Returns

string
public string
# get_input_id( )

Sets HTML id like the following:

Sets HTML id like the following:

Returns

string

Example

HTML name = my_plugin_settings[_form-name}[field-name] HTML id => my-plugin-settings--form-name-field-name
public string
# get_input_size_html( )

Returns

string
public string
# get_input_help_html( )

Returns

string
public string
# get_html( )

Returns

string
public null|integer|string
# get_extra( string|$property_name $property_name )

Parameters

$property_name
string|$property_name
$property_name

Returns

null|integer|string
public string
# get_wrapper_id( )

Returns

string
Properties summary
public Sidecar_Plugin_Base $plugin
#
public Sidecar_Form $form
#
public array $section
#
public string $field_name
#
public string $field_slug
#
public string $field_label
#
public string $field_type
#
public string $field_help
#
public integer $field_size
#
public integer|array $field_validator
#
public string $field_default
#
public array $field_options
#
public boolean $field_required false
#
public boolean|callable $field_handler false
#
public null|boolean|string $api_var
#

Indicates this field value if used for an API. Defaults to $this->field_name, can be see to another name (i.e. field_name = 'content_type', api_var = 'type' but if set to false it will cause the API to ignore this field.

Indicates this field value if used for an API. Defaults to $this->field_name, can be see to another name (i.e. field_name = 'content_type', api_var = 'type' but if set to false it will cause the API to ignore this field.

public array $_extra array()
#
public array $field_allow_html false
#
API documentation generated by ApiGen 2.8.0