diff --git a/CHANGELOG.md b/CHANGELOG.md index 5455aef..f11ecce 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -4,6 +4,11 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.html). +## [1.3.3] - 2018-02-09 + +### Changed +- Updated the class documentation. + ## [1.3.2] - 2018-02-07 ### Changed diff --git a/docs/classes.md b/docs/classes.md index e292001..8a9b31c 100644 --- a/docs/classes.md +++ b/docs/classes.md @@ -1,60 +1,90 @@ ## Table of contents -- [\Geniem\ACF\Codifier](#class-geniemacfcodifier) +- [\Geniem\ACF\Group](#class-geniemacfgroup) - [\Geniem\ACF\ConditionalLogicGroup](#class-geniemacfconditionallogicgroup) -- [\Geniem\ACF\Exception](#class-geniemacfexception) +- [\Geniem\ACF\Codifier](#class-geniemacfcodifier) - [\Geniem\ACF\Field (abstract)](#class-geniemacffield-abstract) -- [\Geniem\ACF\Group](#class-geniemacfgroup) +- [\Geniem\ACF\Exception](#class-geniemacfexception) - [\Geniem\ACF\RuleGroup](#class-geniemacfrulegroup) -- [\Geniem\ACF\Field\Checkbox](#class-geniemacffieldcheckbox) +- [\Geniem\ACF\Field\Email](#class-geniemacffieldemail) - [\Geniem\ACF\Field\CloneField](#class-geniemacffieldclonefield) -- [\Geniem\ACF\Field\Color](#class-geniemacffieldcolor) +- [\Geniem\ACF\Field\Wysiwyg](#class-geniemacffieldwysiwyg) +- [\Geniem\ACF\Field\Taxonomy](#class-geniemacffieldtaxonomy) - [\Geniem\ACF\Field\DatePicker](#class-geniemacffielddatepicker) +- [\Geniem\ACF\Field\Radio](#class-geniemacffieldradio) +- [\Geniem\ACF\Field\Gallery](#class-geniemacffieldgallery) +- [\Geniem\ACF\Field\Number](#class-geniemacffieldnumber) +- [\Geniem\ACF\Field\Group](#class-geniemacffieldgroup) +- [\Geniem\ACF\Field\PageLink](#class-geniemacffieldpagelink) +- [\Geniem\ACF\Field\Link](#class-geniemacffieldlink) - [\Geniem\ACF\Field\DateTimePicker](#class-geniemacffielddatetimepicker) -- [\Geniem\ACF\Field\Email](#class-geniemacffieldemail) - [\Geniem\ACF\Field\File](#class-geniemacffieldfile) +- [\Geniem\ACF\Field\PostObject](#class-geniemacffieldpostobject) +- [\Geniem\ACF\Field\User](#class-geniemacffielduser) +- [\Geniem\ACF\Field\Tab](#class-geniemacffieldtab) +- [\Geniem\ACF\Field\TrueFalse](#class-geniemacffieldtruefalse) +- [\Geniem\ACF\Field\Repeater](#class-geniemacffieldrepeater) - [\Geniem\ACF\Field\FlexibleContent](#class-geniemacffieldflexiblecontent) -- [\Geniem\ACF\Field\Gallery](#class-geniemacffieldgallery) +- [\Geniem\ACF\Field\MediumEditor](#class-geniemacffieldmediumeditor) - [\Geniem\ACF\Field\GoogleMap](#class-geniemacffieldgooglemap) -- [\Geniem\ACF\Field\Group](#class-geniemacffieldgroup) -- [\Geniem\ACF\Field\Groupable](#class-geniemacffieldgroupable) -- [\Geniem\ACF\Field\GroupableField (abstract)](#class-geniemacffieldgroupablefield-abstract) -- [\Geniem\ACF\Field\Image](#class-geniemacffieldimage) -- [\Geniem\ACF\Field\Link](#class-geniemacffieldlink) -- [\Geniem\ACF\Field\Message](#class-geniemacffieldmessage) -- [\Geniem\ACF\Field\Number](#class-geniemacffieldnumber) -- [\Geniem\ACF\Field\Oembed](#class-geniemacffieldoembed) -- [\Geniem\ACF\Field\PageLink](#class-geniemacffieldpagelink) +- [\Geniem\ACF\Field\URL](#class-geniemacffieldurl) - [\Geniem\ACF\Field\Password](#class-geniemacffieldpassword) -- [\Geniem\ACF\Field\PostObject](#class-geniemacffieldpostobject) -- [\Geniem\ACF\Field\Radio](#class-geniemacffieldradio) -- [\Geniem\ACF\Field\Range](#class-geniemacffieldrange) +- [\Geniem\ACF\Field\Color](#class-geniemacffieldcolor) - [\Geniem\ACF\Field\Relationship](#class-geniemacffieldrelationship) -- [\Geniem\ACF\Field\Repeater](#class-geniemacffieldrepeater) +- [\Geniem\ACF\Field\GroupableField (abstract)](#class-geniemacffieldgroupablefield-abstract) +- [\Geniem\ACF\Field\Textarea](#class-geniemacffieldtextarea) - [\Geniem\ACF\Field\Select](#class-geniemacffieldselect) -- [\Geniem\ACF\Field\Tab](#class-geniemacffieldtab) -- [\Geniem\ACF\Field\Taxonomy](#class-geniemacffieldtaxonomy) +- [\Geniem\ACF\Field\Checkbox](#class-geniemacffieldcheckbox) +- [\Geniem\ACF\Field\Range](#class-geniemacffieldrange) +- [\Geniem\ACF\Field\Groupable](#class-geniemacffieldgroupable) +- [\Geniem\ACF\Field\Oembed](#class-geniemacffieldoembed) +- [\Geniem\ACF\Field\Message](#class-geniemacffieldmessage) - [\Geniem\ACF\Field\Text](#class-geniemacffieldtext) -- [\Geniem\ACF\Field\Textarea](#class-geniemacffieldtextarea) -- [\Geniem\ACF\Field\TrueFalse](#class-geniemacffieldtruefalse) -- [\Geniem\ACF\Field\URL](#class-geniemacffieldurl) -- [\Geniem\ACF\Field\User](#class-geniemacffielduser) -- [\Geniem\ACF\Field\Wysiwyg](#class-geniemacffieldwysiwyg) +- [\Geniem\ACF\Field\Image](#class-geniemacffieldimage) - [\Geniem\ACF\Field\Flexible\Layout](#class-geniemacffieldflexiblelayout) +- [\Geniem\ACF\Field\MediumEditor\CustomButton](#class-geniemacffieldmediumeditorcustombutton)
-### Class: \Geniem\ACF\Codifier +### Class: \Geniem\ACF\Group -> ACF Codifier +> Class Group | Visibility | Function | |:-----------|:---------| -| public static | get_label_visibility(mixed $field) : boolean
Returns true or false if an ACF field's label has been hidden | -| public static | hide_label(mixed $field) : void
Hides an ACF field label | -| public static | hide_labels() : void
Hide ACF field labels from desired fields | -| public static | init() : void
Init function for registering actions | -| public static | show_field(mixed $field) : void
Shows a previously hidden ACF field label | +| public | __construct(\string $title, \string $key=null) : void
Field group constructor | +| public | activate() : \Geniem\ACF\self
Change the field group's status as active. | +| public | add_field([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, string $order=`'last'`) : \Geniem\ACF\self
Add a field to the field group. | +| public | add_field_after([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, \Geniem\ACF\[mixed] $target) : \Geniem\ACF\self
Add a field to the field group after a target field. | +| public | add_field_before([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, \Geniem\ACF\[mixed] $target) : \Geniem\ACF\self
Add a field to the field group before a target field. | +| public | add_rule_group([\Geniem\ACF\RuleGroup](#class-geniemacfrulegroup) $group) : \Geniem\ACF\self
Add a location rule group for the field group. | +| public | clone(\string $key, \string $name=null) : \Geniem\ACF\Geniem\ACF\Group
Clone method Forces the developer to give new key to cloned field group. | +| public | deactivate() : \Geniem\ACF\self
Change the field group's status as not active. | +| public | export(bool/boolean $register=false) : array Acf fields
Export current field and sub fields to acf compatible format | +| public | export_fields() : array
Export fields in the ACF format. | +| public | get_field(\string $key) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)
Get a field by its key. | +| public | get_fields() : array
Get all fields from the field group. | +| public | get_hidden_elements() : array
Get hidden elements. | +| public | get_key() : string
Get field group key. | +| public | get_label_placement() : string
Get field group label placement value. | +| public | get_menu_order() : int
Get field group menu order. | +| public | get_position() : string
Get field group position value. | +| public | get_rule_groups() : array
Get all rule groups that have been added for the field group. | +| public | get_style() : \Geniem\ACF\self
Get field group display style. | +| public | get_title() : string
Get field group title. | +| public | hide_element(\string $element) : \Geniem\ACF\self
Set an element to be hid on the edit post screen. | +| public | register() : void
Register the field group to ACF. | +| public | remove_field(\string $key) : \Geniem\ACF\self
Remove a field from the field group. | +| public | reset() : void
Reset the field group's registered status. | +| public | set_hidden_elements(array $elements) : \Geniem\ACF\self
Set elements to be hid on the post edit screen. | +| public | set_instruction_placement(\string $placement=`'label'`) : \Geniem\ACF\self
Set field group instructions placement value. | +| public | set_key(\string $key) : \Geniem\ACF\self
Set new key for the field group. | +| public | set_label_placement(\string $placement=`'top'`) : \Geniem\ACF\self
Set field group label placement value. | +| public | set_menu_order(\integer $order) : \Geniem\ACF\self
Set field group menu order. | +| public | set_position(\string $position=`'normal'`) : \Geniem\ACF\self
Set field group position within the edit post screen. | +| public | set_style(\string $style=`'default'`) : \Geniem\ACF\self
Set field group display style. | +| public | set_title(\string $title) : \Geniem\ACF\self
Set new title for the field group. | +| public | show_element(\string $element) : \Geniem\ACF\self
Show previously hidden element on the edit post screen. |
@@ -69,16 +99,17 @@
-### Class: \Geniem\ACF\Exception +### Class: \Geniem\ACF\Codifier -> Class Exception +> ACF Codifier | Visibility | Function | |:-----------|:---------| - -*This class extends \Exception* - -*This class implements \Throwable* +| public static | get_label_visibility(mixed $field) : boolean
Returns true or false if an ACF field's label has been hidden | +| public static | hide_label(mixed $field) : void
Hides an ACF field label | +| public static | hide_labels() : void
Hide ACF field labels from desired fields | +| public static | init() : void
Init function for registering actions | +| public static | show_field(mixed $field) : void
Shows a previously hidden ACF field label |
@@ -123,50 +154,23 @@ | public | show_label() : \Geniem\ACF\self
Show the field label in the admin side | | public | unset_filter(string $filter) : \Geniem\ACF\self
Unset a previously set filter. | | public | update_value(callable $function) : \Geniem\ACF\self
Register a value updating function for the field | -| public | validate(callable $function) : \Geniem\ACF\self
Register a validation function for the field | +| public | validate_value(callable $function) : \Geniem\ACF\self
Register a value validation function for the field | | protected | __clone() : void
Prevent raw cloning. | +| protected | check_for_unique_key() : void
Checks if the field's key is unique within the project scope. Throws a notice if not. | +| protected | inner_set_key(string $key) : void
A protected function to set the field key. Sanitizes the given string first. |
-### Class: \Geniem\ACF\Group +### Class: \Geniem\ACF\Exception -> Class Group +> Class Exception | Visibility | Function | |:-----------|:---------| -| public | __construct(\string $title, \string $key=null) : void
Field group constructor | -| public | activate() : \Geniem\ACF\self
Change the field group's status as active. | -| public | add_field([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, string $order=`'last'`) : \Geniem\ACF\self
Add a field to the field group. | -| public | add_field_after([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, \Geniem\ACF\[mixed] $target) : \Geniem\ACF\self
Add a field to the field group after a target field. | -| public | add_field_before([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, \Geniem\ACF\[mixed] $target) : \Geniem\ACF\self
Add a field to the field group before a target field. | -| public | add_rule_group([\Geniem\ACF\RuleGroup](#class-geniemacfrulegroup) $group) : \Geniem\ACF\self
Add a location rule group for the field group. | -| public | clone(\string $key, \string $name=null) : \Geniem\ACF\Geniem\ACF\Group
Clone method Forces the developer to give new key to cloned field group. | -| public | deactivate() : \Geniem\ACF\self
Change the field group's status as not active. | -| public | export(bool/boolean $register=false) : array Acf fields
Export current field and sub fields to acf compatible format | -| public | export_fields() : array
Export fields in the ACF format. | -| public | get_field(\string $key) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)
Get a field by its key. | -| public | get_fields() : array
Get all fields from the field group. | -| public | get_hidden_elements() : array
Get hidden elements. | -| public | get_key() : string
Get field group key. | -| public | get_label_placement() : string
Get field group label placement value. | -| public | get_menu_order() : int
Get field group menu order. | -| public | get_position() : string
Get field group position value. | -| public | get_rule_groups() : array
Get all rule groups that have been added for the field group. | -| public | get_style() : \Geniem\ACF\self
Get field group display style. | -| public | get_title() : string
Get field group title. | -| public | hide_element(\string $element) : \Geniem\ACF\self
Set an element to be hid on the edit post screen. | -| public | register() : void
Register the field group to ACF. | -| public | remove_field(\string $key) : \Geniem\ACF\self
Remove a field from the field group. | -| public | reset() : void
Reset the field group's registered status. | -| public | set_hidden_elements(array $elements) : \Geniem\ACF\self
Set elements to be hid on the post edit screen. | -| public | set_instruction_placement(\string $placement=`'label'`) : \Geniem\ACF\self
Set field group instructions placement value. | -| public | set_key(\string $key) : \Geniem\ACF\self
Set new key for the field group. | -| public | set_label_placement(\string $placement=`'top'`) : \Geniem\ACF\self
Set field group label placement value. | -| public | set_menu_order(\integer $order) : \Geniem\ACF\self
Set field group menu order. | -| public | set_position(\string $position=`'normal'`) : \Geniem\ACF\self
Set field group position within the edit post screen. | -| public | set_style(\string $style=`'default'`) : \Geniem\ACF\self
Set field group display style. | -| public | set_title(\string $title) : \Geniem\ACF\self
Set new title for the field group. | -| public | show_element(\string $element) : \Geniem\ACF\self
Show previously hidden element on the edit post screen. | + +*This class extends \Exception* + +*This class implements \Throwable*
@@ -181,27 +185,18 @@
-### Class: \Geniem\ACF\Field\Checkbox +### Class: \Geniem\ACF\Field\Email -> Class Checkbox +> Class Email | Visibility | Function | |:-----------|:---------| -| public | add_choice(\string $choice, mixed $value) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a choice. | -| public | allow_custom() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow custom values | -| public | allow_save_custom() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow saving custom values to default values | -| public | allow_toggle() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow toggle all checkbox | -| public | disallow_custom() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow custom values | -| public | disallow_save_custom() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow saving custom values to default values | -| public | disallow_toggle() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow toggle all checkbox | -| public | get_choices() : array
Get all choices. | -| public | get_custom() : integer
Get allow custom values status | -| public | get_layout() : string
Get the current display style of the checkbox. | -| public | get_save_custom() : integer
Get save custom status | -| public | get_toggle() : integer
Get toggle all checkbox | -| public | remove_choice(\string $choice) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove a choice. | -| public | set_choices(array $choices) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set choices for the checkbox | -| public | set_layout(\string $layout=`'vertical'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set whether the checkboxes are displayed vertically or horizontally. | +| public | get_append() : string
Get the append value of the field. | +| public | get_placeholder() : string
Get the placeholder of the field. | +| public | get_prepend() : string
Get the prepend value of the field. | +| public | set_append(\string $append) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the append value of the field. | +| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the placeholder of the field. | +| public | set_prepend(\string $prepend) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the prepend value of the field. | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* @@ -214,6 +209,7 @@ | Visibility | Function | |:-----------|:---------| | public | add_clone(mixed $clone) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a field or a group to be cloned. | +| public | add_conditional_logic([\Geniem\ACF\ConditionalLogicGroup](#class-geniemacfconditionallogicgroup) $group) : void
Clone fields do not support conditional logic | | public | export(bool/boolean $register=false) : array
Export the fields to be cloned in ACF's native format. | | public | get_clones() : array
Get an array of cloned fields. | | public | get_display_mode() : string
Get the display mode. | @@ -232,12 +228,46 @@
-### Class: \Geniem\ACF\Field\Color +### Class: \Geniem\ACF\Field\Wysiwyg -> Class Color +> Class Wysiwyg + +| Visibility | Function | +|:-----------|:---------| +| public | allow_media_upload() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow media upload | +| public | disable_media_upload() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable media upload | +| public | get_media_upload() : boolean
Get media upload state | +| public | get_tabs() : string
Get allowed tabs | +| public | get_toolbar() : string
Get what toolbars to show | +| public | set_tabs(\string $tabs=`'all'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set tabs to show | +| public | set_toolbar(\string $toolbar=`'full'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set what toolbars should be shown | + +*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* + +
+ +### Class: \Geniem\ACF\Field\Taxonomy + +> Class Taxonomy | Visibility | Function | |:-----------|:---------| +| public | allow_add_term() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable adding terms | +| public | allow_load_save_terms() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable load_save_terms | +| public | allow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow null value | +| public | disallow_add_term() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable adding terms | +| public | disallow_load_save_terms() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable load_save_terms | +| public | disallow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow null value | +| public | filter_arguments(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a arguments filtering function for the field | +| public | get_add_term() : integer
Get whether terms can be added | +| public | get_allow_null() : integer
Get allow null status | +| public | get_field_type() : string
Get displayed field type | +| public | get_load_save_terms() : integer
Get load_save_terms state | +| public | get_return_format() : string
Get return format | +| public | get_taxonomy() : string
Get taxonomy | +| public | set_field_type(\string $field_type=`'checkbox'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set displayed field type | +| public | set_return_format(\string $return_format=`'object'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set return format | +| public | set_taxonomy(\string $taxonomy=`'category'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set taxonomy | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* @@ -260,370 +290,364 @@
-### Class: \Geniem\ACF\Field\DateTimePicker +### Class: \Geniem\ACF\Field\Radio -> Class DateTimePicker +> Class Radio | Visibility | Function | |:-----------|:---------| +| public | add_choice(\string $choice, mixed $value) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a choice. | +| public | allow_other_choice() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow other choice | +| public | allow_save_other_choice() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow saving custom values to default values | +| public | disallow_other_choice() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow other choice | +| public | disallow_save_other_choice() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow saving custom values to default values | +| public | get_choices() : array
Get all choices. | +| public | get_other_choice() : integer
Get other choice values status | +| public | get_save_other_choice() : integer
Get save other choice status | +| public | remove_choice(\string $choice) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove a choice. | +| public | set_choices(array $choices) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set choices for the checkbox | -*This class extends [\Geniem\ACF\Field\DatePicker](#class-geniemacffielddatepicker)* +*This class extends [\Geniem\ACF\Field\Checkbox](#class-geniemacffieldcheckbox)*
-### Class: \Geniem\ACF\Field\Email +### Class: \Geniem\ACF\Field\Gallery -> Class Email +> Class Gallery | Visibility | Function | |:-----------|:---------| -| public | get_append() : string
Get the append value of the field. | -| public | get_placeholder() : string
Get the placeholder of the field. | -| public | get_prepend() : string
Get the prepend value of the field. | -| public | set_append(\string $append) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the append value of the field. | -| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the placeholder of the field. | -| public | set_prepend(\string $prepend) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the prepend value of the field. | +| public | get_max() : integer Maximum amount
Get maximum amount | +| public | get_min() : integer Minimum amount
Get minimum amount | +| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum amount | +| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum amount | +| public | upload_prefilter(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a upload prefiltering function for the field | +| public | validate_attachment(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a attachment validating function for the field | -*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* +*This class extends [\Geniem\ACF\Field\Image](#class-geniemacffieldimage)*
-### Class: \Geniem\ACF\Field\File +### Class: \Geniem\ACF\Field\Number -> Class File +> Class Number | Visibility | Function | |:-----------|:---------| -| public | add_mime_type(\string $mime_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add an allowed MIME type for the file | -| public | get_library() : string
Get the target library of the field.$_COOKIE | -| public | get_max_size() : string
Get the maximum size of the file. | -| public | get_mime_types() : array
Get allowed MIME types. | -| public | get_min_size() : string
Get the minimum size of the file. | -| public | get_preview_size() : string
Get the preview size of the field. | -| public | get_return_format() : string
Get the return format of the field. | -| public | remove_mime_type(\string $mime_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove an allowed MIME type from the field. | -| public | set_library(\string $library=`'all'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the target library of the field. | -| public | set_max_size(\string $max_size) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the maximum size of the file. | -| public | set_mime_types(array $mime_types) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set allowed MIME types for the file. | -| public | set_min_size(\string $min_size) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the minimum size of the file. | -| public | set_preview_size(\string $preview_size=`'thumbnail'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the preview size of the field. | -| public | set_return_format(\string $format=`'array'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the return format of the field. | -| public | upload_prefilter(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a upload prefiltering function for the field | -| public | validate_attachment(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a attachment validating function for the field | +| public | get_append() : string
Get append value | +| public | get_max() : integer Maximum value.
Get maximum value | +| public | get_min() : integer Minimum value.
Get minimum value | +| public | get_placeholder() : string
Get placeholder value | +| public | get_prepend() : string
Get prepend value | +| public | get_step() : integer
Get step size | +| public | set_append(\string $append) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set append text | +| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum value | +| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum value | +| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | +| public | set_prepend(\string $prepend) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set prepend text | +| public | set_step(\integer $step) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set step size | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\FlexibleContent +### Class: \Geniem\ACF\Field\Group -> Class FlexibleContent +> Class Group | Visibility | Function | |:-----------|:---------| -| public | __construct(string $label, string $key=null, string $name=null) : void
Override field construction method to add default button label but run parent constructor after that | -| public | add_layout([\Geniem\ACF\Field\Flexible\Layout](#class-geniemacffieldflexiblelayout) $layout) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a layout to the layouts | -| public | export(bool/boolean $register=false) : array
Export field in ACF's native format. This also exports layout fields | -| public | get_button_label() : string Button label
Get button label | -| public | get_layout(\string $layout) : [\Geniem\ACF\Field\Flexible\Layout](#class-geniemacffieldflexiblelayout)
Get layout by name | -| public | get_layouts() : array
Get all layouts | -| public | get_max() : integer Maximum amount
Get maximum amount of layouts | -| public | get_min() : integer Minimum amount
Get minimum amount of layouts | -| public | remove_layout([\Geniem\ACF\Field\Flexible\Layout](#class-geniemacffieldflexiblelayout)/string $layout) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove layout from layouts | -| public | set_button_label(\string $button_label) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set add row button label | -| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum amount of layouts | -| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum amount of layouts | +| public | get_layout() : string
Get layout | +| public | set_layout(\string $layout=`'table'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set layout | -*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* +*This class extends [\Geniem\ACF\Field\GroupableField](#class-geniemacffieldgroupablefield-abstract)*
-### Class: \Geniem\ACF\Field\Gallery +### Class: \Geniem\ACF\Field\PageLink -> Class Gallery +> Class PageLink | Visibility | Function | |:-----------|:---------| -| public | get_max() : integer Maximum amount
Get maximum amount | -| public | get_min() : integer Minimum amount
Get minimum amount | -| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum amount | -| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum amount | -| public | upload_prefilter(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a upload prefiltering function for the field | -| public | validate_attachment(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a attachment validating function for the field | +| public | allow_archives() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow archive links | +| public | disallow_archives() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow archive links | +| public | get_allow_archives() : integer
Get whether archives should be allowed or not | -*This class extends [\Geniem\ACF\Field\Image](#class-geniemacffieldimage)* +*This class extends [\Geniem\ACF\Field\PostObject](#class-geniemacffieldpostobject)*
-### Class: \Geniem\ACF\Field\GoogleMap +### Class: \Geniem\ACF\Field\Link -> Class GoogleMap +> Class Link | Visibility | Function | |:-----------|:---------| -| public | get_center_lat() : integer
Get center_lat variable | -| public | get_center_lng() : integer
Get center_lng variable | -| public | get_height() : integer
Get height variable | -| public | get_zoom() : integer
Get zoom variable | -| public | set_center_lat(\integer $lat) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set center_lat variable | -| public | set_center_lng(\integer $lng) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set center_lng variable | -| public | set_height(\integer $height) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set height variable | -| public | set_zoom(\integer $zoom) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set zoom variable | +| public | get_return_format() : string
Get the placeholder of the field. | +| public | set_return_format(\string $format) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the return format of the field. | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Group +### Class: \Geniem\ACF\Field\DateTimePicker -> Class Group +> Class DateTimePicker | Visibility | Function | |:-----------|:---------| -| public | get_layout() : string
Get layout | -| public | set_layout(\string $layout=`'table'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set layout | -*This class extends [\Geniem\ACF\Field\Groupable](#class-geniemacffieldgroupable)* +*This class extends [\Geniem\ACF\Field\DatePicker](#class-geniemacffielddatepicker)*
-### Class: \Geniem\ACF\Field\Groupable +### Class: \Geniem\ACF\Field\File -> Groupable Class +> Class File | Visibility | Function | |:-----------|:---------| -| public | __construct(mixed $inheritee=null) : void
Constructor. | -| public | __get(string $name) : mixed
__get Reference allows the referenced property to be modified through the call. | -| public | add_field([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, string $order=`'last'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add field to group | -| public | add_field_after([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, [\Geniem\ACF\Field](#class-geniemacffield-abstract)\[mixed] $target) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a field to the group after a target field. | -| public | add_field_before([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, [\Geniem\ACF\Field](#class-geniemacffield-abstract)\[mixed] $target) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a field to the group before a target field. | -| public | export(bool/boolean $register=false) : array
Export current field and sub fields to acf compatible format | -| public | get_field(string $key) : array
Get a field | -| public | get_fields() : array
Get fields | -| public | remove_field(\integer $field) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove field from sub fields | -| public | remove_fields() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove all sub fields | -| public | set_fields(array $fields) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set fields | +| public | add_mime_type(\string $mime_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add an allowed MIME type for the file | +| public | export(bool/boolean $register=false) : array
Export field in ACF's native format. | +| public | get_library() : string
Get the target library of the field.$_COOKIE | +| public | get_max_size() : string
Get the maximum size of the file. | +| public | get_mime_types() : array
Get allowed MIME types. | +| public | get_min_size() : string
Get the minimum size of the file. | +| public | get_preview_size() : string
Get the preview size of the field. | +| public | get_return_format() : string
Get the return format of the field. | +| public | remove_mime_type(\string $mime_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove an allowed MIME type from the field. | +| public | set_library(\string $library=`'all'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the target library of the field. | +| public | set_max_size(\string $max_size) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the maximum size of the file. | +| public | set_mime_types(array $mime_types) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set allowed MIME types for the file. | +| public | set_min_size(\string $min_size) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the minimum size of the file. | +| public | set_preview_size(\string $preview_size=`'thumbnail'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the preview size of the field. | +| public | set_return_format(\string $format=`'array'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the return format of the field. | +| public | upload_prefilter(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a upload prefiltering function for the field | +| public | validate_attachment(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a attachment validating function for the field | + +*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\GroupableField (abstract) +### Class: \Geniem\ACF\Field\PostObject -> Abstract class GroupableField +> Class PostObject | Visibility | Function | |:-----------|:---------| -| public | __call(string $name, array $arguments) : mixed Return value of the function
Magic function __call | -| public | __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor. | +| public | add_post_type(\string $post_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a post type to allowed post types | +| public | add_taxonomy(string $taxonomy) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add an allowed taxonomy | +| public | allow_multiple() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow multiple values | +| public | allow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow null value | +| public | disallow_multiple() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow multiple values | +| public | disallow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow null value | +| public | get_ajax() : integer
Get ajax loading state | +| public | get_allow_multiple() : integer
Get allow multiple status | +| public | get_allow_null() : integer
Get allow null status | +| public | get_post_types() : array
Get allowed post types | +| public | get_return_format() : string
Get return format | +| public | get_taxonomies() : array
Get allowed taxonomies | +| public | no_ajax() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable loading values via ajax | +| public | post_object_query(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a post object query filtering function for the field | +| public | post_object_result(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a post object result filtering function for the field | +| public | remove_post_type(string $post_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove post type by name from allowed | +| public | remove_taxonomy(string $taxonomy) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove taxonomy from allowed by slug | +| public | set_post_types(array $post_types) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set post types to show | +| public | set_return_format(\string $return_format=`'object'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set return format | +| public | set_taxonomies(array $taxonomies) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set taxonomies to show | +| public | use_ajax() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable loading values via ajax | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Image +### Class: \Geniem\ACF\Field\User -> Class Image +> Class User | Visibility | Function | |:-----------|:---------| -| public | add_mime_type(\string $mime_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Adds a mime types to allowed mime types | -| public | get_library() : string Library
Get library | -| public | get_max_height() : integer Maximum height
Get maximum height | -| public | get_max_size() : string Maximum size
Get maximum size | -| public | get_max_width() : integer Maximum width
Get maximum width | -| public | get_mime_types() : array Mime types
Get mime types | -| public | get_min_height() : integer Minimum height
Get minimum height | -| public | get_min_size() : string Minimum size
Get minimum size | -| public | get_min_width() : integer Minimum width
Get minimum width | -| public | get_preview_size() : string Preview size
Get preview size | -| public | get_return_format() : string Return format
Get return format | -| public | remove_mime_type(\string $mime_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove a mime type from allowed mime types | -| public | set_library(\string $library=`'all'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Sets library | -| public | set_max_height(\integer $max_height) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum height | -| public | set_max_size(\string $max_size) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum size | -| public | set_max_width(\integer $max_width) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum width | -| public | set_mime_types(array $mime_types) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set allowed mime types | -| public | set_min_height(\integer $min_height) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum height | -| public | set_min_size(\string $min_size) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum size | -| public | set_min_width(\integer $min_width) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum width | -| public | set_preview_size(\string $preview_size=`'thumbnail'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set preview size | -| public | set_return_format(\string $format=`'array'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Sets return format | -| public | upload_prefilter(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a upload prefiltering function for the field | -| public | validate_attachment(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a attachment validating function for the field | +| public | add_role(\string $role) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a single role to allowed roles | +| public | allow_multiple() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow multiple values | +| public | allow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow null value | +| public | disallow_multiple() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow multiple values | +| public | disallow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow null value | +| public | get_allow_multiple() : integer
Get allow multiple status | +| public | get_allow_null() : integer
Get allow null status | +| public | get_roles() : array
Get allowed roles | +| public | remove_role(string $role) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove role from allowed roles | +| public | set_roles(array $roles) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set allowed roles | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Link +### Class: \Geniem\ACF\Field\Tab -> Class Link +> Class Tab | Visibility | Function | |:-----------|:---------| -| public | get_return_format() : string
Get the placeholder of the field. | -| public | set_return_format(\string $format) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set the return format of the field. | +| public | get_endpoint() : integer
Get endpoint status | +| public | get_layout() : string
Get layout | +| public | get_placement() : string
Get placement | +| public | remove_endpoint() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable endpoint | +| public | set_endpoint() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable endpoint | +| public | set_layout(\string $layout=`'table'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set layout | +| public | set_placement(\string $placement=`'top'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set tab placement | -*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* +*This class extends [\Geniem\ACF\Field\GroupableField](#class-geniemacffieldgroupablefield-abstract)*
-### Class: \Geniem\ACF\Field\Message +### Class: \Geniem\ACF\Field\TrueFalse -> Class Message +> Class TrueFalse | Visibility | Function | |:-----------|:---------| -| public | esc_html() : integer Escape html status.
Get escape html | -| public | get_message() : string Message.
Get message | -| public | get_new_lines() : string Newline type.
Get newline type | -| public | no_esc_html() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable escape html | +| public | get_message() : string
Get message | +| public | get_ui_off_text() : string
Get button off text | +| public | get_ui_on_text() : string
Get button on text | +| public | no_ui() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable custom ui | | public | set_message(\string $message) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set message | -| public | set_new_lines(\string $type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set newline handling | -| public | use_esc_html() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable escape html | +| public | set_ui_off_text(\string $text) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set button off text | +| public | set_ui_on_text(\string $text) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set button on text | +| public | ui() : integer
Get custom ui state | +| public | use_ui() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable custom ui | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Number +### Class: \Geniem\ACF\Field\Repeater -> Class Number +> Class Repeater | Visibility | Function | |:-----------|:---------| -| public | get_append() : string
Get append value | -| public | get_max() : integer Maximum value.
Get maximum value | -| public | get_min() : integer Minimum value.
Get minimum value | -| public | get_placeholder() : string
Get placeholder value | -| public | get_prepend() : string
Get prepend value | -| public | get_step() : integer
Get step size | -| public | set_append(\string $append) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set append text | -| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum value | -| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum value | -| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | -| public | set_prepend(\string $prepend) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set prepend text | -| public | set_step(\integer $step) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set step size | +| public | __construct(string $label, string $key=null, string $name=null) : void
Override field construction method to add default button label but run parent constructor after that | +| public | export(bool/boolean $register=false) : array
Export field in ACF's native format. This also exports sub fields | +| public | get_button_label() : string Button label
Get button label | +| public | get_layout() : string
Get layout | +| public | get_max() : integer Maximum amount
Get maximum amount of layouts | +| public | get_min() : integer Minimum amount
Get minimum amount of layouts | +| public | set_button_label(\string $button_label) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set add row button label | +| public | set_layout(\string $layout=`'table'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set layout | +| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum amount of layouts | +| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum amount of layouts | -*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* +*This class extends [\Geniem\ACF\Field\GroupableField](#class-geniemacffieldgroupablefield-abstract)*
-### Class: \Geniem\ACF\Field\Oembed +### Class: \Geniem\ACF\Field\FlexibleContent -> Class Oembed +> Class FlexibleContent | Visibility | Function | |:-----------|:---------| -| public | get_height() : string
Get embed height | -| public | get_width() : string
Get embed width | -| public | set_height(\string $height) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set embed height | -| public | set_width(\string $width) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set embed width | +| public | __construct(string $label, string $key=null, string $name=null) : void
Override field construction method to add default button label but run parent constructor after that | +| public | add_layout([\Geniem\ACF\Field\Flexible\Layout](#class-geniemacffieldflexiblelayout) $layout) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a layout to the layouts | +| public | export(bool/boolean $register=false) : array
Export field in ACF's native format. This also exports layout fields | +| public | get_button_label() : string Button label
Get button label | +| public | get_layout(\string $layout) : [\Geniem\ACF\Field\Flexible\Layout](#class-geniemacffieldflexiblelayout)
Get layout by name | +| public | get_layouts() : array
Get all layouts | +| public | get_max() : integer Maximum amount
Get maximum amount of layouts | +| public | get_min() : integer Minimum amount
Get minimum amount of layouts | +| public | remove_layout([\Geniem\ACF\Field\Flexible\Layout](#class-geniemacffieldflexiblelayout)/string $layout) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove layout from layouts | +| public | set_button_label(\string $button_label) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set add row button label | +| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum amount of layouts | +| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum amount of layouts | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\PageLink +### Class: \Geniem\ACF\Field\MediumEditor -> Class PageLink +> Class MediumEditor | Visibility | Function | |:-----------|:---------| -| public | allow_archives() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow archive links | -| public | disallow_archives() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow archive links | -| public | get_allow_archives() : integer
Get whether archives should be allowed or not | +| public | __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor to throw an error if the Medium Editor plugin is not present | +| public | add_button(string $button) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a button into the standard text formatting buttons Adds one button in the array without affecting the others. Possible values: - bold - italic - underline - strikethrough - subscript - superscript - anchor - image - quote - pre - orderedlist - unorderedlist - indent - outdent - justifyLeft - justifyCenter - justifyRight - justifyFull - h1 - h2 - h3 - h4 - h5 - h6 - html - removeFormat | +| public | add_custom_button([\Geniem\ACF\Field\MediumEditor\CustomButton](#class-geniemacffieldmediumeditorcustombutton) $custom_button) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a button to the custom buttons. The custom button must be defined as a \Geniem\ACF\Field\MediumEditor\CustomButton object. | +| public | add_option(string $option) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add an option | +| public | delay_loading() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Delay the initialization of Medium until the field is clicked | +| public | dont_delay_loading() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Do not delay the initialization of Medium until the field is clicked | +| public | export(bool/boolean $register=false) : array
ACF Codifier core function to export the field in ACF array format. | +| public | get_buttons() : array
Returns the defined text formatting buttons as an array | +| public | get_custom_button(\string $custom_button) : [\Geniem\ACF\Field\MediumEditor\CustomButton](#class-geniemacffieldmediumeditorcustombutton)
Get custom button by name | +| public | get_custom_buttons() : array
Get all custom buttons | +| public | get_delay_status() : integer
Get delay status | +| public | get_options() : array
Returns set options as an array | +| public | get_placeholder() : string
Get placeholder value | +| public | remove_button(string $button) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Removes a standard button from the text formatting buttons | +| public | remove_custom_button([\Geniem\ACF\Field\MediumEditor\CustomButton](#class-geniemacffieldmediumeditorcustombutton)/string $custom_button) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove a button from custom buttons | +| public | remove_option(string $option) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove an option | +| public | set_buttons(array $buttons) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set standard text formatting buttons to show Takes an array of buttons and overrides possible previous values with the new array. Possible values: - bold - italic - underline - strikethrough - subscript - superscript - anchor - image - quote - pre - orderedlist - unorderedlist - indent - outdent - justifyLeft - justifyCenter - justifyRight - justifyFull - h1 - h2 - h3 - h4 - h5 - h6 - html - removeFormat | +| public | set_options(array $options) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set Medium Editor options | +| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | -*This class extends [\Geniem\ACF\Field\PostObject](#class-geniemacffieldpostobject)* +*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Password +### Class: \Geniem\ACF\Field\GoogleMap + +> Class GoogleMap | Visibility | Function | |:-----------|:---------| -| public | get_append() : mixed | -| public | get_placeholder() : mixed | -| public | get_prepend() : mixed | -| public | set_append(\string $append) : void | -| public | set_placeholder(\string $placeholder) : void | -| public | set_prepend(\string $prepend) : void | +| public | get_center_lat() : integer
Get center_lat variable | +| public | get_center_lng() : integer
Get center_lng variable | +| public | get_height() : integer
Get height variable | +| public | get_zoom() : integer
Get zoom variable | +| public | set_center_lat(\integer $lat) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set center_lat variable | +| public | set_center_lng(\integer $lng) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set center_lng variable | +| public | set_height(\integer $height) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set height variable | +| public | set_zoom(\integer $zoom) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set zoom variable | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\PostObject +### Class: \Geniem\ACF\Field\URL -> Class PostObject +> Class URL | Visibility | Function | |:-----------|:---------| -| public | add_post_type(\string $post_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a post type to allowed post types | -| public | add_taxonomy(string $taxonomy) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add an allowed taxonomy | -| public | allow_multiple() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow multiple values | -| public | allow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow null value | -| public | disallow_multiple() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow multiple values | -| public | disallow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow null value | -| public | get_ajax() : integer
Get ajax loading state | -| public | get_allow_multiple() : integer
Get allow multiple status | -| public | get_allow_null() : integer
Get allow null status | -| public | get_post_types() : array
Get allowed post types | -| public | get_return_format() : string
Get return format | -| public | get_taxonomies() : array
Get allowed taxonomies | -| public | no_ajax() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable loading values via ajax | -| public | post_object_query(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a post object query filtering function for the field | -| public | post_object_result(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a post object result filtering function for the field | -| public | remove_post_type(string $post_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove post type by name from allowed | -| public | remove_taxonomy(string $taxonomy) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove taxonomy from allowed by slug | -| public | set_post_types(array $post_types) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set post types to show | -| public | set_return_format(\string $return_format=`'object'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set return format | -| public | set_taxonomies(array $taxonomies) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set taxonomies to show | -| public | use_ajax() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable loading values via ajax | +| public | get_placeholder() : string
Get placeholder value | +| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Radio - -> Class Radio +### Class: \Geniem\ACF\Field\Password | Visibility | Function | |:-----------|:---------| -| public | add_choice(\string $choice, mixed $value) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a choice. | -| public | allow_other_choice() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow other choice | -| public | allow_save_other_choice() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow saving custom values to default values | -| public | disallow_other_choice() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow other choice | -| public | disallow_save_other_choice() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow saving custom values to default values | -| public | get_choices() : array
Get all choices. | -| public | get_other_choice() : integer
Get other choice values status | -| public | get_save_other_choice() : integer
Get save other choice status | -| public | remove_choice(\string $choice) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove a choice. | -| public | set_choices(array $choices) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set choices for the checkbox | +| public | get_append() : mixed | +| public | get_placeholder() : mixed | +| public | get_prepend() : mixed | +| public | set_append(\string $append) : void | +| public | set_placeholder(\string $placeholder) : void | +| public | set_prepend(\string $prepend) : void | -*This class extends [\Geniem\ACF\Field\Checkbox](#class-geniemacffieldcheckbox)* +*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Range +### Class: \Geniem\ACF\Field\Color -> Class Number +> Class Color | Visibility | Function | |:-----------|:---------| -| public | get_append() : string
Get append value | -| public | get_max() : integer Maximum value.
Get maximum value | -| public | get_min() : integer Minimum value.
Get minimum value | -| public | get_placeholder() : string
Get placeholder value | -| public | get_prepend() : string
Get prepend value | -| public | get_step() : integer
Get step size | -| public | set_append(\string $append) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set append text | -| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum value | -| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum value | -| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | -| public | set_prepend(\string $prepend) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set prepend text | -| public | set_step(\integer $step) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set step size | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* @@ -664,24 +688,40 @@
-### Class: \Geniem\ACF\Field\Repeater +### Class: \Geniem\ACF\Field\GroupableField (abstract) -> Class Repeater +> Abstract class GroupableField | Visibility | Function | |:-----------|:---------| -| public | __construct(string $label, string $key=null, string $name=null) : void
Override field construction method to add default button label but run parent constructor after that | -| public | export(bool/boolean $register=false) : array
Export field in ACF's native format. This also exports sub fields | -| public | get_button_label() : string Button label
Get button label | -| public | get_layout() : string
Get layout | -| public | get_max() : integer Maximum amount
Get maximum amount of layouts | -| public | get_min() : integer Minimum amount
Get minimum amount of layouts | -| public | set_button_label(\string $button_label) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set add row button label | -| public | set_layout(\string $layout=`'table'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set layout | -| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum amount of layouts | -| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum amount of layouts | +| public | __call(string $name, array $arguments) : mixed Return value of the function
Magic function __call | +| public | __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor. | -*This class extends [\Geniem\ACF\Field\GroupableField](#class-geniemacffieldgroupablefield-abstract)* +*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* + +
+ +### Class: \Geniem\ACF\Field\Textarea + +> Class Textarea + +| Visibility | Function | +|:-----------|:---------| +| public | disable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable field | +| public | enable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable field | +| public | get_disabled() : boolean
Get whether field is disabled or not | +| public | get_new_lines() : string
Get new line handling way | +| public | get_placeholder() : string
Get placeholder value | +| public | get_readonly() : boolean
Get field readonly state | +| public | get_rows() : integer
Get max rows | +| public | set_maxlength(\integer $maxlength) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set text max length | +| public | set_new_lines(\string $new_lines=`'wpautop'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set new line handling | +| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | +| public | set_readonly() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set field to read only | +| public | set_rows(\integer $rows) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set max rows | +| public | set_writable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set field to writable | + +*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
@@ -714,166 +754,162 @@
-### Class: \Geniem\ACF\Field\Tab - -> Class Tab - -| Visibility | Function | -|:-----------|:---------| -| public | get_endpoint() : integer
Get endpoint status | -| public | get_layout() : string
Get layout | -| public | get_placement() : string
Get placement | -| public | remove_endpoint() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable endpoint | -| public | set_endpoint() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable endpoint | -| public | set_layout(\string $layout=`'table'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set layout | -| public | set_placement(\string $placement=`'top'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set tab placement | - -*This class extends [\Geniem\ACF\Field\GroupableField](#class-geniemacffieldgroupablefield-abstract)* - -
- -### Class: \Geniem\ACF\Field\Taxonomy +### Class: \Geniem\ACF\Field\Checkbox -> Class Taxonomy +> Class Checkbox | Visibility | Function | |:-----------|:---------| -| public | allow_add_term() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable adding terms | -| public | allow_load_save_terms() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable load_save_terms | -| public | allow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow null value | -| public | disallow_add_term() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable adding terms | -| public | disallow_load_save_terms() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable load_save_terms | -| public | disallow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow null value | -| public | filter_arguments(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a arguments filtering function for the field | -| public | get_add_term() : integer
Get whether terms can be added | -| public | get_allow_null() : integer
Get allow null status | -| public | get_field_type() : string
Get displayed field type | -| public | get_load_save_terms() : integer
Get load_save_terms state | -| public | get_return_format() : string
Get return format | -| public | get_taxonomy() : string
Get taxonomy | -| public | set_field_type(\string $field_type=`'checkbox'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set displayed field type | -| public | set_return_format(\string $return_format=`'object'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set return format | -| public | set_taxonomy(\string $taxonomy=`'category'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set taxonomy | +| public | add_choice(\string $choice, mixed $value) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a choice. | +| public | allow_custom() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow custom values | +| public | allow_save_custom() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow saving custom values to default values | +| public | allow_toggle() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow toggle all checkbox | +| public | disallow_custom() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow custom values | +| public | disallow_save_custom() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow saving custom values to default values | +| public | disallow_toggle() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow toggle all checkbox | +| public | get_choices() : array
Get all choices. | +| public | get_custom() : integer
Get allow custom values status | +| public | get_layout() : string
Get the current display style of the checkbox. | +| public | get_save_custom() : integer
Get save custom status | +| public | get_toggle() : integer
Get toggle all checkbox | +| public | remove_choice(\string $choice) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove a choice. | +| public | set_choices(array $choices) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set choices for the checkbox | +| public | set_layout(\string $layout=`'vertical'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set whether the checkboxes are displayed vertically or horizontally. | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Text +### Class: \Geniem\ACF\Field\Range -> Class Text +> Class Number | Visibility | Function | |:-----------|:---------| -| public | disable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable field | -| public | enable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable field | | public | get_append() : string
Get append value | -| public | get_disabled() : boolean
Get whether field is disabled or not | +| public | get_max() : integer Maximum value.
Get maximum value | +| public | get_min() : integer Minimum value.
Get minimum value | | public | get_placeholder() : string
Get placeholder value | | public | get_prepend() : string
Get prepend value | -| public | get_readonly() : boolean
Get field readonly state | +| public | get_step() : integer
Get step size | | public | set_append(\string $append) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set append text | -| public | set_maxlength(\integer $maxlength) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set text max length | +| public | set_max(\integer $max) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum value | +| public | set_min(\integer $min) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum value | | public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | | public | set_prepend(\string $prepend) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set prepend text | -| public | set_readonly() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set field to read only | -| public | set_writable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set field to writable | +| public | set_step(\integer $step) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set step size | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Textarea +### Class: \Geniem\ACF\Field\Groupable -> Class Textarea +> Groupable Class | Visibility | Function | |:-----------|:---------| -| public | disable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable field | -| public | enable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable field | -| public | get_disabled() : boolean
Get whether field is disabled or not | -| public | get_new_lines() : string
Get new line handling way | -| public | get_placeholder() : string
Get placeholder value | -| public | get_readonly() : boolean
Get field readonly state | -| public | get_rows() : integer
Get max rows | -| public | set_maxlength(\integer $maxlength) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set text max length | -| public | set_new_lines(\string $new_lines=`'wpautop'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set new line handling | -| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | -| public | set_readonly() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set field to read only | -| public | set_rows(\integer $rows) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set max rows | -| public | set_writable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set field to writable | - -*This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* +| public | __construct(mixed $inheritee=null) : void
Constructor. | +| public | __get(string $name) : mixed
__get Reference allows the referenced property to be modified through the call. | +| public | add_field([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, string $order=`'last'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add field to group | +| public | add_field_after([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, [\Geniem\ACF\Field](#class-geniemacffield-abstract)\[mixed] $target) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a field to the group after a target field. | +| public | add_field_before([\Geniem\ACF\Field](#class-geniemacffield-abstract) $field, [\Geniem\ACF\Field](#class-geniemacffield-abstract)\[mixed] $target) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a field to the group before a target field. | +| public | export(bool/boolean $register=false) : array
Export current field and sub fields to acf compatible format | +| public | get_field(string $key) : array
Get a field | +| public | get_fields() : array
Get fields | +| public | remove_field(\string $field_name) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove field from sub fields | +| public | remove_fields() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove all sub fields | +| public | set_fields(array $fields) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set fields |
-### Class: \Geniem\ACF\Field\TrueFalse +### Class: \Geniem\ACF\Field\Oembed -> Class TrueFalse +> Class Oembed | Visibility | Function | |:-----------|:---------| -| public | get_message() : string
Get message | -| public | get_ui_off_text() : string
Get button off text | -| public | get_ui_on_text() : string
Get button on text | -| public | no_ui() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable custom ui | -| public | set_message(\string $message) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set message | -| public | set_ui_off_text(\string $text) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set button off text | -| public | set_ui_on_text(\string $text) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set button on text | -| public | ui() : integer
Get custom ui state | -| public | use_ui() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable custom ui | +| public | get_height() : string
Get embed height | +| public | get_width() : string
Get embed width | +| public | set_height(\string $height) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set embed height | +| public | set_width(\string $width) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set embed width | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\URL +### Class: \Geniem\ACF\Field\Message -> Class URL +> Class Message | Visibility | Function | |:-----------|:---------| -| public | get_placeholder() : string
Get placeholder value | -| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | +| public | esc_html() : integer Escape html status.
Get escape html | +| public | get_message() : string Message.
Get message | +| public | get_new_lines() : string Newline type.
Get newline type | +| public | no_esc_html() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable escape html | +| public | set_message(\string $message) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set message | +| public | set_new_lines(\string $type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set newline handling | +| public | use_esc_html() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable escape html | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\User +### Class: \Geniem\ACF\Field\Text -> Class User +> Class Text | Visibility | Function | |:-----------|:---------| -| public | add_role(\string $role) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Add a single role to allowed roles | -| public | allow_multiple() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow multiple values | -| public | allow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow null value | -| public | disallow_multiple() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow multiple values | -| public | disallow_null() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disallow null value | -| public | get_allow_multiple() : integer
Get allow multiple status | -| public | get_allow_null() : integer
Get allow null status | -| public | get_roles() : array
Get allowed roles | -| public | remove_role(string $role) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove role from allowed roles | -| public | set_roles(array $roles) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set allowed roles | +| public | disable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable field | +| public | enable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Enable field | +| public | get_append() : string
Get append value | +| public | get_disabled() : boolean
Get whether field is disabled or not | +| public | get_placeholder() : string
Get placeholder value | +| public | get_prepend() : string
Get prepend value | +| public | get_readonly() : boolean
Get field readonly state | +| public | set_append(\string $append) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set append text | +| public | set_maxlength(\integer $maxlength) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set text max length | +| public | set_placeholder(\string $placeholder) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set placeholder value | +| public | set_prepend(\string $prepend) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set prepend text | +| public | set_readonly() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set field to read only | +| public | set_writable() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set field to writable | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)*
-### Class: \Geniem\ACF\Field\Wysiwyg +### Class: \Geniem\ACF\Field\Image -> Class Wysiwyg +> Class Image | Visibility | Function | |:-----------|:---------| -| public | allow_media_upload() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Allow media upload | -| public | disable_media_upload() : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Disable media upload | -| public | get_media_upload() : boolean
Get media upload state | -| public | get_tabs() : string
Get allowed tabs | -| public | get_toolbar() : string
Get what toolbars to show | -| public | set_tabs(\string $tabs=`'all'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set tabs to show | -| public | set_toolbar(\string $toolbar=`'full'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set what toolbars should be shown | +| public | add_mime_type(\string $mime_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Adds a mime types to allowed mime types | +| public | get_library() : string Library
Get library | +| public | get_max_height() : integer Maximum height
Get maximum height | +| public | get_max_size() : string Maximum size
Get maximum size | +| public | get_max_width() : integer Maximum width
Get maximum width | +| public | get_mime_types() : array Mime types
Get mime types | +| public | get_min_height() : integer Minimum height
Get minimum height | +| public | get_min_size() : string Minimum size
Get minimum size | +| public | get_min_width() : integer Minimum width
Get minimum width | +| public | get_preview_size() : string Preview size
Get preview size | +| public | get_return_format() : string Return format
Get return format | +| public | remove_mime_type(\string $mime_type) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Remove a mime type from allowed mime types | +| public | set_library(\string $library=`'all'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Sets library | +| public | set_max_height(\integer $max_height) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum height | +| public | set_max_size(\string $max_size) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum size | +| public | set_max_width(\integer $max_width) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set maximum width | +| public | set_mime_types(array $mime_types) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set allowed mime types | +| public | set_min_height(\integer $min_height) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum height | +| public | set_min_size(\string $min_size) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum size | +| public | set_min_width(\integer $min_width) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set minimum width | +| public | set_preview_size(\string $preview_size=`'thumbnail'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Set preview size | +| public | set_return_format(\string $format=`'array'`) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Sets return format | +| public | upload_prefilter(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a upload prefiltering function for the field | +| public | validate_attachment(callable $function) : [\Geniem\ACF\Field](#class-geniemacffield-abstract)\self
Register a attachment validating function for the field | *This class extends [\Geniem\ACF\Field](#class-geniemacffield-abstract)* @@ -897,3 +933,23 @@ *This class extends [\Geniem\ACF\Field\Groupable](#class-geniemacffieldgroupable)* +
+ +### Class: \Geniem\ACF\Field\MediumEditor\CustomButton + +> Class Layout + +| Visibility | Function | +|:-----------|:---------| +| public | add_attribute(\string $name, \string $value) : [\Geniem\ACF\Field\MediumEditor](#class-geniemacffieldmediumeditor)\self
Add an attribute An HTML attribute to be used with the custom element. | +| public | export() : array
Export the button as an array | +| public | get_attributes() : array
Get the defined attributes | +| public | get_label() : string Label
Get button label | +| public | get_name() : string Name
Get name | +| public | get_tag() : string Tag
Get the defined HTML tag | +| public | remove_attribute(\string $name) : [\Geniem\ACF\Field\MediumEditor](#class-geniemacffieldmediumeditor)\self
Remove an attribute | +| public | set_attributes(array $attributes) : [\Geniem\ACF\Field\MediumEditor](#class-geniemacffieldmediumeditor)\self
Set attributes to use Use a two-dimensional array with the inner level having two keys: name and value. | +| public | set_label(\string $label) : [\Geniem\ACF\Field\MediumEditor](#class-geniemacffieldmediumeditor)\self
Set button label | +| public | set_name(\string $name) : [\Geniem\ACF\Field\MediumEditor](#class-geniemacffieldmediumeditor)\self
Set name | +| public | set_tag(\string $tag) : [\Geniem\ACF\Field\MediumEditor](#class-geniemacffieldmediumeditor)\self
Set the HTML tag to be used. | + diff --git a/plugin.php b/plugin.php index a6537e9..4b252cd 100644 --- a/plugin.php +++ b/plugin.php @@ -3,7 +3,7 @@ Plugin Name: ACF Codifier Plugin URI: https://github.com/devgeniem/acf-codifier Description: A helper class to make defining ACF field groups and fields easier in the code. -Version: 1.3.2 +Version: 1.3.3 Author: Miika Arponen / Geniem Oy Author URI: https://geniem.fi License: GPL-3.0