Fieldmanager
  • Package
  • Class
  • Tree
  • Todo

Packages

  • Fieldmanager
    • Context
    • Datasource
    • Field
    • Util
  • None

Classes

  • Fieldmanager_Autocomplete
  • Fieldmanager_Checkbox
  • Fieldmanager_Checkboxes
  • Fieldmanager_Colorpicker
  • Fieldmanager_Datepicker
  • Fieldmanager_DraggablePost
  • Fieldmanager_Field
  • Fieldmanager_Grid
  • Fieldmanager_Group
  • Fieldmanager_Hidden
  • Fieldmanager_Link
  • Fieldmanager_Media
  • Fieldmanager_Options
  • Fieldmanager_Password
  • Fieldmanager_Radios
  • Fieldmanager_RichTextArea
  • Fieldmanager_Select
  • Fieldmanager_TextArea
  • Fieldmanager_TextField

Class Fieldmanager_RichTextArea

WordPress visual editor (TinyMCE) which submits HTML.

Fieldmanager_Field
Extended by Fieldmanager_RichTextArea
Package: Fieldmanager\Field
Located at class-fieldmanager-richtextarea.php

Methods summary

public
# __construct( string $label = '', array $options = array() )

Construct defaults for this field.

Construct defaults for this field.

Parameters

$label
string
$label title of form field
$options
array
$options with keys matching vars of the field in use.

Overrides

Fieldmanager_Field::__construct
public string
# sanitize( string $value )

Default sanitization function for RichTextAreas.

Default sanitization function for RichTextAreas.

Parameters

$value
string
$value Raw content for this field.

Returns

string
sanitized content.
public string
# form_element( mixed $value = '' )

Render the form element, which is a textarea by default.

Render the form element, which is a textarea by default.

Parameters

$value
mixed
$value

Returns

string
HTML

Overrides

Fieldmanager_Field::form_element
public string
# add_proto_id( string $editor )

Note the ID for the proto so in repeated fields we can dig up the editor settings.

Note the ID for the proto so in repeated fields we can dig up the editor settings.

Parameters

$editor
string
$editor HTML for the editor.

Returns

string
The editor HTML with a data-proto-id attribute added.
public array
# customize_buttons( array $buttons )

Filter the editor buttons.

Filter the editor buttons.

Parameters

$buttons
array
$buttons Buttons for the editor toolbar.

Returns

array
Filtered buttons.
public array
# editor_config( array $mceInit )

Make final tweaks to the editor config.

Make final tweaks to the editor config.

Parameters

$mceInit
array
$mceInit The raw settings passed to TinyMCE.

Returns

array
The raw settings passed to TinyMCE.

Methods inherited from Fieldmanager_Field

_invalid_definition(), _unauthorized_access(), activate_submenu_page(), add_another(), add_meta_box(), add_page_form(), add_quickedit_box(), add_submenu_page(), add_term_meta_box(), add_user_form(), element_markup(), escape(), get_collapse_handle(), get_element_attributes(), get_element_id(), get_element_key(), get_element_label(), get_extra_element_classes(), get_form_name(), get_form_tree(), get_remove_handle(), get_sort_handle(), is_group(), is_repeatable(), preload_alter_values(), presave(), presave_all(), set_options(), single_element_markup(), wrap_with_multi_tools()

Magic methods summary

Properties summary

public string $field_class
#

Override field_class

Override field_class

public array $editor_settings
#

Arguments passed to wp_editor()'s $settings parameter.

Arguments passed to wp_editor()'s $settings parameter.

See

http://codex.wordpress.org/Function_Reference/wp_editor#Arguments
public array $buttons_1
#

First row of buttons for the tinymce toolbar

First row of buttons for the tinymce toolbar

public array $buttons_2
#

Second row of buttons for the tinymce toolbar

Second row of buttons for the tinymce toolbar

public array $buttons_3
#

Third row of buttons for the tinymce toolbar

Third row of buttons for the tinymce toolbar

public array $buttons_4
#

Fourth row of buttons for the tinymce toolbar

Fourth row of buttons for the tinymce toolbar

public string $stylesheet
#

External stylesheet(s) to include in the editor. Multiple files can be included delimited by commas.

External stylesheet(s) to include in the editor. Multiple files can be included delimited by commas.

Properties inherited from Fieldmanager_Field

$add_more_label, $add_more_position, $attributes, $data_id, $data_type, $datasource, $debug, $default_value, $description, $description_after_element, $display_if, $escape, $extra_elements, $index, $index_filter, $inline_label, $input_type, $is_attachment, $label, $label_after_element, $label_element, $limit, $meta_boxes_to_remove, $minimum_count, $name, $one_label_per_item, $remove_default_meta_boxes, $required, $sanitize, $save_empty, $serialize_data, $skip_save, $sortable, $template, $validate, $validation_messages, $validation_rules

Fieldmanager API documentation generated by ApiGen 2.8.0