Skip to content

Latest commit

 

History

History
1460 lines (1150 loc) · 137 KB

classes.md

File metadata and controls

1460 lines (1150 loc) · 137 KB

Table of contents


Class: \Geniem\ACF\Group

Class Group

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 $field, \string $order='last') : \Geniem\ACF\self
Add a field to the field group.
public add_field_after(\Geniem\ACF\Field $field, \Geniem\ACF[mixed] $target) : \Geniem\ACF\GroupableInterface
Add a field to the group after a target field.
public add_field_before(\Geniem\ACF\Field $field, \Geniem\ACF[mixed] $target) : \Geniem\ACF\GroupableInterface
Add a field to the group before a target field.
public add_fields(array $fields, \string $order='last') : \Geniem\ACF\GroupableInterface
Add an array of fields to group
public add_fields_from(\Geniem\ACF\Interfaces\Groupable $groupable, \string $order='last') : \Geniem\ACF\GroupableInterface
Add fields from another groupable
public add_rule_group(\Geniem\ACF\RuleGroup $group) : \Geniem\ACF\self
Add a location rule group for the field group.
public clone(\string $key, \string $name=null) : \Geniem\ACF\GroupableInterface
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 $register=false, mixed $parent=null) : array Acf fields
Export current field and sub fields to acf compatible format
public export_fields() : array
Export fields in the ACF format.
public fields_var() : string
Returns current fields_var
public get_field(\string $name) : array
Get a field
public get_fields() : array
Get fields
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 remove_fields() : \Geniem\ACF\GroupableInterface
Remove all sub fields
public reset() : void
Reset the field group's registered status.
public set_fields(array $fields) : \Geniem\ACF\GroupableInterface
Set fields
public set_fields_from(\Geniem\ACF\GroupableInterface/\Geniem\ACF\Interfaces\Groupable $groupable) : \Geniem\ACF\GroupableInterface
Set fields from another Groupable.
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/\int $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 implements \Geniem\ACF\Interfaces\Groupable


Class: \Geniem\ACF\ConditionalLogicGroup

Class ConditionalLogicGroup

Visibility Function
public add_rule(mixed $field, \string $operator, mixed $value) : \Geniem\ACF\self
Add a conditional logic rule.
public get_rules() : array
Get added conditional logic rules.

Class: \Geniem\ACF\Codifier

ACF Codifier

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

Class: \Geniem\ACF\Field (abstract)

Class Field

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor.
public add_conditional_logic(\Geniem\ACF\ConditionalLogicGroup $group) : \Geniem\ACF\self
Add a conditional logic for the field.
public add_wrapper_class(\string $class) : \Geniem\ACF\self
Add a single wrapper class to be added for the field.
public clone(\string $key, \string $name=null) : \Geniem\ACF\Geniem\ACF\Field
Clone method Forces the developer to give new key to cloned field.
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
public format_value(\callable $function, \int $priority=11) : \Geniem\ACF\self
Register a value formatting function for the field
public get_conditional_logic() : \Geniem\ACF\ConditionalLogicGroup
Get the conditional logic group that have been added to the group.
public get_default_value() : mixed
Get the default value of the field.
public get_instructions() : string
Get the instruction text of the field.
public get_key() : string
Get the key of the field.
public get_label() : string
Get the label of the field.
public get_label_visibility() : boolean
Get the label visibility status
public get_name() : string
Get the name of the field.
public get_required() : boolean
Get the required status of the field.
public get_type() : string
Get the type of the field.
public get_wrapper_classes() : array
Get all wrapper classes that have been added for the field.
public get_wrapper_id() : string
Get the id that has been added for the field.
public get_wrapper_width() : int
Get the wrapper width.
public hide_label() : \Geniem\ACF\self
Hide the field label in the admin side
public load_field(\callable $function, \int $priority=10) : \Geniem\ACF\self
Register a field loading function for the field
public load_value(\callable $function, \int $priority=10) : \Geniem\ACF\self
Register a value loading function for the field
public prepare_field(\callable $function, \int $priority=10) : \Geniem\ACF\self
Register a field preparing function for the field
public redipress_add_queryable(\string $field_name=null, \float $weight=1, \string $method='use_last') : \Geniem\ACF\self
Add this field's value as a queryable value to RediSearch index. Possibilities: use_last, concat, concat_with_spaces, sum, custom (needs filter).
public redipress_exclude_search() : \Geniem\ACF\self
Exclude this field's value in the RediPress search index.
public static redipress_get_fields(\WP_Post/\WP_User $item) : void
A wrapper for ACF get_fields to get the values for indexing.
public redipress_get_queryable_status() : boolean
Whether this field is queryable in RediSearch index or not.
public redipress_get_search_status() : boolean
Get RediPress search index status of this field.
public redipress_include_search(\callable $callback=null) : \Geniem\ACF\self
Include this field's value in the RediPress search index.
public redipress_queryable_filter(\callable $filter) : \Geniem\ACF\self
Add a filter method for the value before inserting it into RediSearch.
public redipress_remove_queryable() : \Geniem\ACF\self
Remove this field from being queryable in RediSearch index.
public redipress_set_field_type(\string $type) : \Geniem\ACF\self
Set the RediSearch index field type for the field
public static redipress_use_include_search_filter() : void
Use RediPress formatting functions in all suitable fields.
public remove_wrapper_class(\string $class) : \Geniem\ACF\self
Remove a single wrapper class from the field.
public render_field(\callable $function, \int $priority=10) : \Geniem\ACF\self
Register a field rendering function for the field
public static running_update_field() : boolean
A helper function to detect if we are running ACF's update_field function.
public set_default_value(mixed $value) : \Geniem\ACF\self
Set the default value for the field.
public set_instructions(\string $instructions) : \Geniem\ACF\self
Set instruction text for the field.
public set_key(\string $key) : \Geniem\ACF\self
Set key for the field.
public set_label(\string $label) : \Geniem\ACF\self
Set label for the field.
public set_name(\string $name) : \Geniem\ACF\self
Set name for the field.
public set_required() : \Geniem\ACF\self
Set the field to be required.
public set_unrequired() : \Geniem\ACF\self
Set the field to be unrequired.
public set_wrapper_classes(mixed $classes) : \Geniem\ACF\self
Set classes to be added for the field.
public set_wrapper_id(\string $id) : \Geniem\ACF\self
Add a wrapper id for the field.
public set_wrapper_width(integer/\int $width) : \Geniem\ACF\self
Set the wrapper width in percents.
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, \int $priority=10) : \Geniem\ACF\self
Register a value updating function for the field
public validate_value(\callable $function, \int $priority=10) : \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 get_field_group(mixed $parent) : \Geniem\ACF\Group
Get field group
protected get_is_user() : bool
If the field is for user or not
protected redipress_additional_field(mixed $value, int $post_id, array $field) : mixed
A helper function to use to enable indexing the post outside save action.
protected static redipress_include_search_filter(mixed $value, integer $post_id, array $field) : mixed
Include the field's value in RediPress search index.

Class: \Geniem\ACF\Block

Class Block

Visibility Function
public __construct(\string $title, \string $name) : void
Constructor
public add_data_filter(\callable $function, \int $priority=10) : \Geniem\ACF\self
Add a data filtering function for the block
public add_field(\Geniem\ACF\Field $field, \string $order='last') : \Geniem\ACF\GroupableInterface
Add field to group
public add_field_after(\Geniem\ACF\Field $field, \Geniem\ACF[mixed] $target) : \Geniem\ACF\GroupableInterface
Add a field to the group after a target field.
public add_field_before(\Geniem\ACF\Field $field, \Geniem\ACF[mixed] $target) : \Geniem\ACF\GroupableInterface
Add a field to the group before a target field.
public add_fields(array $fields, \string $order='last') : \Geniem\ACF\GroupableInterface
Add an array of fields to group
public add_fields_from(\Geniem\ACF\Interfaces\Groupable $groupable, \string $order='last') : \Geniem\ACF\GroupableInterface
Add fields from another groupable
public add_keyword(\string $keyword) : \Geniem\ACF\self
Add a single keyword
public add_keywords(array $keywords) : \Geniem\ACF\self
Add multiple keywords
public add_post_type(\string $post_type) : \Geniem\ACF\self
Add a single post type
public add_post_types(array $post_types) : \Geniem\ACF\self
Add multiple post types
public clone(\string $key, \string $name=null) : \Geniem\ACF\self
Clone method Forces the developer to give new key to cloned field.
public export(\bool $register=false, mixed $parent=null) : array
Export current field and sub fields to acf compatible format
public fields_var() : string
Returns current fields_var
public get_align() : string
Getter for the default block alignment.
public get_category() : string
Getter for the category.
public get_description() : string
Getter for the description.
public get_field(\string $name) : array
Get a field
public get_fields() : array
Get fields
public get_icon() : string
Getter for the icon.
public get_keywords() : array
Getter for the keywords.
public get_mode() : string
Getter for the display mode.
public get_name() : string
Getter for the name.
public get_parent() : array
public get_post_types() : array
Getter for the post types.
public get_renderer() : \Geniem\ACF\Interfaces\Renderer
Getter for the component renderer.
public get_styles() : array
Getter for the styles of the block.
public get_supports() : array
Getter for the supported features of the block.
public get_title() : string
Getter for the title.
public register() : array The registered block data.
Registers the ACF Gutenberg block
public remove_data_filter(\callable $function, \int $priority=10) : \Geniem\ACF\self
Remove a data filtering function.
public remove_field(\string $field_name) : \Geniem\ACF\GroupableInterface
Remove field from sub fields
public remove_fields() : \Geniem\ACF\GroupableInterface
Remove all sub fields
public remove_keyword(\string $keyword) : \Geniem\ACF\self
Remove a single keyword
public remove_post_type(\string $post_type) : \Geniem\ACF\self
Remove a single post type
public set_align(\string $align) : \Geniem\ACF\self
Setter for the default block alignment.
public set_category(\string $category) : \Geniem\ACF\self
Setter for the category.
public set_description(\string $description) : \Geniem\ACF\self
Setter for the description.
public set_fields(array $fields) : \Geniem\ACF\GroupableInterface
Set fields
public set_fields_from(\Geniem\ACF\GroupableInterface/\Geniem\ACF\Interfaces\Groupable $groupable) : \Geniem\ACF\GroupableInterface
Set fields from another Groupable.
public set_icon(\string $icon) : \Geniem\ACF\self
Setter for the icon.
public set_keywords(array $keywords) : \Geniem\ACF\self
Setter for the keywords.
public set_mode(\string $mode) : \Geniem\ACF\self
Setter for the display mode Options: auto, preview or edit.
public set_name(\string $name) : \Geniem\ACF\self
Setter for the name.
public set_parent(\array
public set_post_types(array $post_types) : \Geniem\ACF\self
Setter for the post_types.
public set_renderer(\Geniem\ACF\Interfaces\Renderer $renderer) : void
Set the renderer for the component.
public set_styles(array $styles) : \Geniem\ACF\self
Setter for the styles of the block.
public set_supports(array $supports) : \Geniem\ACF\self
Setter for the supported features of the block.
public set_title(\string $title) : \Geniem\ACF\self
Setter for the title
protected register_block() : array
Register the ACF block.
protected register_field_group() : void
Register the ACF field group for the block.
protected render(array $block=array(), \string $content='', bool/mixed $is_preview=false, mixed $post_id) : void
The render callback method for ACF blocks. Passes the data to the defined renderer and prints out the rendered markup.

This class implements \Geniem\ACF\Interfaces\Groupable


Class: \Geniem\ACF\Exception

Class Exception

Visibility Function

This class extends \Exception

This class implements \Throwable


Class: \Geniem\ACF\RuleGroup

Class RuleGroup

Visibility Function
public add_rule(\string $param, \string $operator, \string $value) : \Geniem\ACF\self
Add a location rule to the rule group
public get_rules() : array
Get all rules in the rule group.

Class: \Geniem\ACF\Field\Email

Class Email

Visibility Function
public disable() : \Geniem\ACF\Field\self
Set field disabled
public enable() : \Geniem\ACF\Field\self
Set field enabled
public get_append() : string
Get the field append value
public get_disabled() : boolean
Get field's disabled state
public get_placeholder() : string
Get field placeholder
public get_prepend() : string
Get the field prepend value
public get_readonly() : boolean
Get field readonly state
public set_append(\string $append) : \Geniem\ACF\Field\self
Set field append value
public set_placeholder(\string $placeholder) : \Geniem\ACF\Field\self
Set field placeholder
public set_prepend(\string $prepend) : \Geniem\ACF\Field\self
Set field prepend value
public set_readonly() : \Geniem\ACF\Field\self
Set field to read only
public set_writable() : \Geniem\ACF\Field\self
Set field to writable

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\CloneField

Class CloneField Named like this because 'Clone' is a reserved word in PHP.

Visibility Function
public add_clone(mixed $clone) : \Geniem\ACF\Field\self
Add a field or a group to be cloned.
public add_conditional_logic(\Geniem\ACF\ConditionalLogicGroup $group) : void
Clone fields do not support conditional logic
public export(\bool $register=false, mixed $parent=null) : 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.
public get_label_prefix() : boolean
Get the label prefixing status.
public get_layout() : string
Get the field's layout mode.
public get_name_prefix() : boolean
Get the name prefixing status.
public remove_clone(mixed $clone) : \Geniem\ACF\Field\self
Remove a cloned item.
public remove_label_prefix() : \Geniem\ACF\Field\self
Don't prefix the field's label.
public remove_name_prefix() : \Geniem\ACF\Field\self
Don't prefix the field's name.
public set_display_mode(\string $display_mode='seamless') : \Geniem\ACF\Field\self
Set the clone field's display mode.
public set_label_prefix() : \Geniem\ACF\Field\self
Prefix the field's label.
public set_layout(\string $layout='block') : \Geniem\ACF\Field\self
Set the clone field's layout mode.
public set_name_prefix() : \Geniem\ACF\Field\self
Prefix the field's name.

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Wysiwyg

Class Wysiwyg

Visibility Function
public allow_media_upload() : \Geniem\ACF\Field\self
Allow media upload
public disable_delay() : \Geniem\ACF\Field\self
Disable delay of the wysiwyg editor initialization
public disable_media_upload() : \Geniem\ACF\Field\self
Disable media upload
public enable_delay() : \Geniem\ACF\Field\self
Enable delay of the wysiwyg editor initialization
public get_delay() : integer
Get wysiwyg initialization delay state
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\self
Set tabs to show
public set_toolbar(string/string/array/callable $toolbar='full') : \Geniem\ACF\Field\self
Set what toolbars should be shown

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Taxonomy

Class Taxonomy

Visibility Function
public allow_add_term() : \Geniem\ACF\Field\self
Enable adding terms
public allow_load_terms() : \Geniem\ACF\Field\self
Enable loading terms to the post object
public allow_null() : \Geniem\ACF\Field\self
Allow null value
public allow_save_terms() : \Geniem\ACF\Field\self
Enable saving terms to the post object
public disable() : \Geniem\ACF\Field\self
Set field disabled
public disallow_add_term() : \Geniem\ACF\Field\self
Disable adding terms
public disallow_load_terms() : \Geniem\ACF\Field\self
Disable loading terms to the post object
public disallow_null() : \Geniem\ACF\Field\self
Disallow null value
public disallow_save_terms() : \Geniem\ACF\Field\self
Disable saving terms to the post object
public enable() : \Geniem\ACF\Field\self
Set field enabled
public filter_arguments(\callable $function) : \Geniem\ACF\Field\self
Register a arguments filtering function for the field
public filter_results(\callable $function) : \Geniem\ACF\Field\self
Register a function to filter the result texts for the field in admin
public get_add_term() : integer
Get whether terms can be added
public get_allow_null() : integer
Get allow null status
public get_disabled() : boolean
Get field's disabled state
public get_field_type() : string
Get displayed field type
public get_load_terms() : integer
Get the status of loading terms to the post object
public get_return_format() : string
Get return format
public get_save_terms() : integer
Get the status of saving terms to the post object
public get_taxonomy() : string
Get taxonomy
public set_field_type(\string $field_type='checkbox') : \Geniem\ACF\Field\self
Set displayed field type
public set_return_format(\string $return_format='object') : \Geniem\ACF\Field\self
Set return format
public set_taxonomy(\string $taxonomy='category') : \Geniem\ACF\Field\self
Set taxonomy

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\DatePicker

Class DatePicker

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor.
public disable() : \Geniem\ACF\Field\self
Set field disabled
public enable() : \Geniem\ACF\Field\self
Set field enabled
public get_disabled() : boolean
Get field's disabled state
public get_display_format() : string
Get display_format variable
public get_first_day() : integer
Get first_day variable
public get_readonly() : boolean
Get field readonly state
public get_return_format() : string
Get return_format variable
public set_display_format(\string $format) : \Geniem\ACF\Field\self
Set display_format variable
public set_first_day(integer/\int $day) : \Geniem\ACF\Field\self
Set first_day variable
public set_readonly() : \Geniem\ACF\Field\self
Set field to read only
public set_return_format(\string $format) : \Geniem\ACF\Field\self
Set return_format variable
public set_writable() : \Geniem\ACF\Field\self
Set field to writable

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Radio

Class Radio

Visibility Function
public add_choice(\string $choice, mixed $value) : \Geniem\ACF\Field\self
Add a choice.
public allow_null() : \Geniem\ACF\Field\self
Allow null value
public allow_other_choice() : \Geniem\ACF\Field\self
Allow other choice
public allow_save_other_choice() : \Geniem\ACF\Field\self
Allow saving custom values to default values
public disallow_other_choice() : \Geniem\ACF\Field\self
Disallow other choice
public disallow_save_other_choice() : \Geniem\ACF\Field\self
Disallow saving custom values to default values
public get_allow_null() : integer
Get allow null status
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\self
Remove a choice.
public set_choices(array $choices) : \Geniem\ACF\Field\self
Set choices for the checkbox

This class extends \Geniem\ACF\Field\Checkbox


Class: \Geniem\ACF\Field\MultisiteTaxonomy

Class Taxonomy

Visibility Function
public allow_save_terms() : \Geniem\ACF\Field\self
Not in use. Only here because of the parent class.
public disallow_save_terms() : \Geniem\ACF\Field\self
Not in use. Only here because of the parent class.
public get_blog_id() : integer Blog ID.
Get blog id
public set_blog_id(integer/\int $blog_id) : \Geniem\ACF\Field\self
Set blog id

This class extends \Geniem\ACF\Field\Multitaxonomy


Class: \Geniem\ACF\Field\Gallery

Class Gallery

Visibility Function
public add_allowed_file_extension(\string $file_extension) : void
A better named wrapper for add_mime_type() Adds an extensions to allowed file extensions, e.g. jpn, png, gif
public add_mime_type(\string $mime_type) : \Geniem\ACF\Field\self
Adds an extension to allowed file extensions e.g. jpg, png, gif
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
public get_allowed_file_extensions() : void
A better named wrapper for get_mime_types() Returns a list of allowed file extensions
public get_library() : string Library
Get library
public get_max() : integer Maximum amount
Get maximum amount
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 File extensions
Get allowed file extensions
public get_min() : integer Minimum amount
Get minimum amount
public get_min_height() : integer Minimum height
Get minimum height
public get_min_size() : string
Get the minimum size of the file.
public get_min_width() : integer Minimum width
Get minimum width
public get_preview_size() : string
Get the preview size of the field.
public remove_allowed_file_extension(\string $file_extension) : void
A better named wrapper for remove_mime_type() Removes a file extension from allowed file extensions
public remove_mime_type(\string $mime_type) : \Geniem\ACF\Field\self
Remove a file extensions from allowed file extensions
public set_allowed_file_extensions(array $file_extensions) : void
A better named wrapper for set_mime_types() Sets allowed file extensions, e.g. jpg, png, gif.
public set_library(\string $library='all') : \Geniem\ACF\Field\self
Sets library
public set_max(integer/\int $max) : \Geniem\ACF\Field\self
Set maximum amount
public set_max_height(integer/\int $max_height) : \Geniem\ACF\Field\self
Set maximum height
public set_max_size(\string $max_size) : \Geniem\ACF\Field\self
Set maximum size
public set_max_width(integer/\int $max_width) : \Geniem\ACF\Field\self
Set maximum width
public set_mime_types(array $mime_types) : \Geniem\ACF\Field\self
Set allowed file extensions e.g. jpg, png, gif
public set_min(integer/\int $min) : \Geniem\ACF\Field\self
Set minimum amount
public set_min_height(integer/\int $min_height) : \Geniem\ACF\Field\self
Set minimum height
public set_min_size(\string $min_size) : \Geniem\ACF\Field\self
Set the minimum size of the file.
public set_min_width(integer/\int $min_width) : \Geniem\ACF\Field\self
Set minimum width
public set_preview_size(\string $preview_size='thumbnail') : \Geniem\ACF\Field\self
Set the preview size of the field.
public upload_prefilter(\callable $function) : \Geniem\ACF\Field\self
Register a upload prefiltering function for the field
public validate_attachment(\callable $function) : \Geniem\ACF\Field\self
Register a attachment validating function for the field

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\ButtonGroup

Class ButtonGroup

Visibility Function
public add_choice(\string $choice, mixed $value) : \Geniem\ACF\Field\self
Add a choice.
public allow_null() : \Geniem\ACF\Field\self
Allow null value
public disallow_null() : \Geniem\ACF\Field\self
Disallow null value
public get_allow_null() : integer
Get allow null status
public get_choices() : array
Get all choices.
public get_layout() : string
Get layout
public get_return_format() : string
Get return format
public remove_choice(\string $choice) : \Geniem\ACF\Field\self
Remove a choice.
public set_choices(array $choices) : \Geniem\ACF\Field\self
Set choices for the checkbox
public set_layout(\string $layout='vertical') : \Geniem\ACF\Field\self
Set layout
public set_return_format(\string $return_format='value') : \Geniem\ACF\Field\self
Set return format

This class extends \Geniem\ACF\Field\Checkbox


Class: \Geniem\ACF\Field\Number

Class Number

Visibility Function
public disable() : \Geniem\ACF\Field\self
Set field disabled
public enable() : \Geniem\ACF\Field\self
Set field enabled
public get_append() : string
Get the field append value
public get_disabled() : boolean
Get field's disabled state
public get_max() : integer Maximum amount
Get maximum amount
public get_min() : integer Minimum amount
Get minimum amount
public get_placeholder() : string
Get field placeholder
public get_prepend() : string
Get the field 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\self
Set field append value
public set_max(integer/\int $max) : \Geniem\ACF\Field\self
Set maximum amount
public set_min(integer/\int $min) : \Geniem\ACF\Field\self
Set minimum amount
public set_placeholder(\string $placeholder) : \Geniem\ACF\Field\self
Set field placeholder
public set_prepend(\string $prepend) : \Geniem\ACF\Field\self
Set field prepend value
public set_readonly() : \Geniem\ACF\Field\self
Set field to read only
public set_step(integer/\int $step) : \Geniem\ACF\Field\self
Set step size
public set_writable() : \Geniem\ACF\Field\self
Set field to writable

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\PostContent

Class PostContent

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Overridden constructor to provide our special functionality
public load_post_content(\string $value, integer/\int $post_id, array $field) : void
Load the value from post_content
public save_post_content(\string $value, integer/\int $post_id, array $field) : void
Save the value to post_content

This class extends \Geniem\ACF\Field\Wysiwyg


Class: \Geniem\ACF\Field\Group

Class Group

Visibility Function
public get_layout() : string
Get layout
public set_layout(\string $layout='table') : \Geniem\ACF\Field\self
Set layout

This class extends \Geniem\ACF\Field\GroupableField

This class implements \Geniem\ACF\Interfaces\Groupable


Class: \Geniem\ACF\Field\MultisitePostObject

Class MultisitePostObject

Visibility Function
public get_blog_id() : integer Blog ID.
Get blog id
public set_blog_id(integer/\int $blog_id) : \Geniem\ACF\Field\self
Set blog id

This class extends \Geniem\ACF\Field\PostObject


Class: \Geniem\ACF\Field\PageLink

Class PageLink

Visibility Function
public allow_archives() : \Geniem\ACF\Field\self
Allow archive links
public disallow_archives() : \Geniem\ACF\Field\self
Disallow archive links
public get_allow_archives() : integer
Get whether archives should be allowed or not

This class extends \Geniem\ACF\Field\PostObject


Class: \Geniem\ACF\Field\Link

Class Link

Visibility Function
public get_return_format() : string
Get the placeholder of the field.
public set_return_format(\string $format) : \Geniem\ACF\Field\self
Set the return format of the field.

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\PostExcerpt

Class Excerpt

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Overridden constructor to provide our special functionality
public load_post_excerpt(\string $value, integer/\int $post_id, array $field) : void
Load the value from post_excerpt
public save_post_excerpt(\string $value, integer/\int $post_id, array $field) : void
Save the value to post_excerpt

This class extends \Geniem\ACF\Field\Textarea


Class: \Geniem\ACF\Field\Accordion

Class Accordion

Visibility Function
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
public get_endpoint() : integer
Get endpoint status
public get_layout() : string
Get layout
public get_multi_expand() : integer
Get multi expand status
public get_open() : integer
Get open status
public get_placement() : string
Get placement
public remove_endpoint() : \Geniem\ACF\Field\self
Disable endpoint
public remove_multi_expand() : \Geniem\ACF\Field\self
Disable multi expand
public remove_open() : \Geniem\ACF\Field\self
Disable open on page load
public set_endpoint() : \Geniem\ACF\Field\self
Enable endpoint
public set_layout(\string $layout='table') : \Geniem\ACF\Field\self
Set layout
public set_multi_expand() : \Geniem\ACF\Field\self
Enable multi expand
public set_open() : \Geniem\ACF\Field\self
Enable opening on page load
public set_placement(\string $placement='top') : \Geniem\ACF\Field\self
Set tab placement

This class extends \Geniem\ACF\Field\GroupableField

This class implements \Geniem\ACF\Interfaces\Groupable, \Geniem\ACF\Field\PseudoGroupableField


Class: \Geniem\ACF\Field\DateTimePicker

Class DateTimePicker

Visibility Function

This class extends \Geniem\ACF\Field\DatePicker


Class: \Geniem\ACF\Field\File

Class File

Visibility Function
public add_allowed_file_extension(\string $file_extension) : void
A better named wrapper for add_mime_type() Adds an extensions to allowed file extensions, e.g. jpn, png, gif
public add_mime_type(\string $mime_type) : \Geniem\ACF\Field\self
Adds an extension to allowed file extensions e.g. jpg, png, gif
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
public get_allowed_file_extensions() : void
A better named wrapper for get_mime_types() Returns a list of allowed file extensions
public get_library() : string Library
Get library
public get_max_size() : string Maximum size
Get maximum size
public get_mime_types() : array File extensions
Get allowed file extensions
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_allowed_file_extension(\string $file_extension) : void
A better named wrapper for remove_mime_type() Removes a file extension from allowed file extensions
public remove_mime_type(\string $mime_type) : \Geniem\ACF\Field\self
Remove a file extensions from allowed file extensions
public set_allowed_file_extensions(array $file_extensions) : void
A better named wrapper for set_mime_types() Sets allowed file extensions, e.g. jpg, png, gif.
public set_library(\string $library='all') : \Geniem\ACF\Field\self
Sets library
public set_max_size(\string $max_size) : \Geniem\ACF\Field\self
Set maximum size
public set_mime_types(array $mime_types) : \Geniem\ACF\Field\self
Set allowed file extensions e.g. jpg, png, gif
public set_min_size(\string $min_size) : \Geniem\ACF\Field\self
Set the minimum size of the file.
public set_preview_size(\string $preview_size='thumbnail') : \Geniem\ACF\Field\self
Set the preview size of the field.
public set_return_format(\string $format='array') : \Geniem\ACF\Field\self
Set the return format of the field.
public upload_prefilter(\callable $function) : \Geniem\ACF\Field\self
Register a upload prefiltering function for the field
public validate_attachment(\callable $function) : \Geniem\ACF\Field\self
Register a attachment validating function for the field

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\PostObject

Class PostObject

Visibility Function
public add_post_type(\string $post_type) : \Geniem\ACF\Field\self
Add a post type to allowed post types
public add_taxonomy(string $taxonomy) : \Geniem\ACF\Field\self
Add an allowed taxonomy
public allow_multiple() : \Geniem\ACF\Field\self
Allow multiple values
public allow_null() : \Geniem\ACF\Field\self
Allow null value
public disallow_multiple() : \Geniem\ACF\Field\self
Disallow multiple values
public disallow_null() : \Geniem\ACF\Field\self
Disallow null value
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
public get_added_post_types() : array
Get added post types
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_removed_post_types() : array
Get removed post types
public get_return_format() : string
Get return format
public get_taxonomies() : array
Get allowed taxonomies
public no_ajax() : \Geniem\ACF\Field\self
Disable loading values via ajax
public post_object_query(\callable $function) : \Geniem\ACF\Field\self
Register a post object query filtering function for the field
public post_object_result(\callable $function) : \Geniem\ACF\Field\self
Register a post object result filtering function for the field
public remove_post_type(string $post_type) : \Geniem\ACF\Field\self
Remove post type by name from allowed
public remove_taxonomy(string $taxonomy) : \Geniem\ACF\Field\self
Remove taxonomy from allowed by slug
public set_post_types(array $post_types) : \Geniem\ACF\Field\self
Set post types to show
public set_removed_post_types(array $post_types) : \Geniem\ACF\Field\self
Set post types to not show
public set_return_format(\string $return_format='object') : \Geniem\ACF\Field\self
Set return format
public set_taxonomies(array $taxonomies) : \Geniem\ACF\Field\self
Set taxonomies to show
public use_ajax() : \Geniem\ACF\Field\self
Enable loading values via ajax

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\PseudoGroup

Class PseudoGroup

Visibility Function
public clone(\string $key, \string $name=null) : \Geniem\ACF\Field\Geniem\ACF\Field
Clone method No key forcing or prefixing because this is just a pseudo group. Parameters are there just for compatibility.
public export(\bool $register=false, mixed $parent=null) : array
Export empty array because this is not a real field.

This class extends \Geniem\ACF\Field\GroupableField

This class implements \Geniem\ACF\Interfaces\Groupable, \Geniem\ACF\Field\PseudoGroupableField


Class: \Geniem\ACF\Field\TimePicker

Class TimePicker

Visibility Function
public get_display_format() : string
Get display_format variable
public get_return_format() : string
Get return_format variable
public set_display_format(\string $format) : \Geniem\ACF\Field\self
Set display_format variable
public set_return_format(\string $format) : \Geniem\ACF\Field\self
Set return_format variable

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\User

Class User

Visibility Function
public add_role(\string $role) : \Geniem\ACF\Field\self
Add a single role to allowed roles
public allow_multiple() : \Geniem\ACF\Field\self
Allow multiple values
public allow_null() : \Geniem\ACF\Field\self
Allow null value
public disallow_multiple() : \Geniem\ACF\Field\self
Disallow multiple values
public disallow_null() : \Geniem\ACF\Field\self
Disallow null value
public get_allow_multiple() : integer
Get allow multiple status
public get_allow_null() : integer
Get allow null status
public get_return_format() : string
Get return format
public get_roles() : array
Get allowed roles
public remove_role(string $role) : \Geniem\ACF\Field\self
Remove role from allowed roles
public set_return_format(\string $return_format='object') : \Geniem\ACF\Field\self
Set return format
public set_roles(array $roles) : \Geniem\ACF\Field\self
Set allowed roles
public user_query(\callable $function) : \Geniem\ACF\Field\self
Register a user query filtering function for the field

This class extends \Geniem\ACF\Field


Interface: \Geniem\ACF\Field\PseudoGroupableField

Interface class PseudoGroupableField

Visibility Function

Class: \Geniem\ACF\Field\Tab

Class Tab

Visibility Function
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
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\self
Disable endpoint
public set_endpoint() : \Geniem\ACF\Field\self
Enable endpoint
public set_layout(\string $layout='table') : \Geniem\ACF\Field\self
Set layout
public set_placement(\string $placement='top') : \Geniem\ACF\Field\self
Set tab placement

This class extends \Geniem\ACF\Field\GroupableField

This class implements \Geniem\ACF\Interfaces\Groupable, \Geniem\ACF\Field\PseudoGroupableField


Class: \Geniem\ACF\Field\GravityForms

Class GravityForms

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor.
public get_return_format() : string
A deprecated function to cover previous functionality.
public set_return_format(\string $return_format='object') : \Geniem\ACF\Field\self
A deprecated function to cover previous functionality.
protected populate_options() : void
Populate the Gravity Forms forms

This class extends \Geniem\ACF\Field\Select


Class: \Geniem\ACF\Field\TrueFalse

Class TrueFalse

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor.
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\self
Disable custom ui
public set_message(\string $message) : \Geniem\ACF\Field\self
Set message
public set_ui_off_text(\string $text) : \Geniem\ACF\Field\self
Set button off text
public set_ui_on_text(\string $text) : \Geniem\ACF\Field\self
Set button on text
public ui() : integer
Get custom ui state
public use_ui() : \Geniem\ACF\Field\self
Enable custom ui

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Repeater

Class Repeater

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 get_button_label() : string Button label
Get button label
public get_layout() : string
Get layout
public get_max() : integer Maximum amount
Get maximum amount
public get_min() : integer Minimum amount
Get minimum amount
public remove_collapsed() : \Geniem\ACF\Field\self
Remove collapsed field.
public set_button_label(\string $button_label) : \Geniem\ACF\Field\self
Set add row button label
public set_collapsed(\Geniem\ACF\Field $field) : \Geniem\ACF\Field\self
Set field whose value is shown when collapsed.
public set_layout(\string $layout='table') : \Geniem\ACF\Field\self
Set layout
public set_max(integer/\int $max) : \Geniem\ACF\Field\self
Set maximum amount
public set_min(integer/\int $min) : \Geniem\ACF\Field\self
Set minimum amount

This class extends \Geniem\ACF\Field\GroupableField

This class implements \Geniem\ACF\Interfaces\Groupable


Class: \Geniem\ACF\Field\Multitaxonomy

Class Taxonomy

Visibility Function
public add_taxonomy(\string $taxonomy='category') : \Geniem\ACF\Field\self
You should not use this method! Overridden method of the parent class. Use set_taxonomies() instead.
public allow_add_term() : \Geniem\ACF\Field\self
Override the parent method to disallow adding terms.
public get_add_term() : integer
Override the parent method to disallow adding terms.
public get_taxonomies() : array
Get taxonomies.
public get_taxonomy() : string/null
You should not use this method! Overridden method of the parent class. Use get_taxonomies() instead.
public remove_taxonomy(\string $taxonomy) : \Geniem\ACF\Field\self
Remove a taxonomy from the list.
public set_taxonomies(array $taxonomy=array()) : \Geniem\ACF\Field\self
Set taxonomies.
public set_taxonomy(\string $taxonomy='category') : \Geniem\ACF\Field\self
You should not use this method! Overridden method of the parent class. Use set_taxonomies() or add_taxonomy() instead.

This class extends \Geniem\ACF\Field\Taxonomy


Class: \Geniem\ACF\Field\FlexibleContent

Class FlexibleContent

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 $layout) : \Geniem\ACF\Field\self
Add a layout to the layouts
public export(\bool $register=false, mixed $parent=null) : 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
Get layout by name
public get_layouts() : array
Get all layouts
public get_max() : integer Maximum amount
Get maximum amount
public get_min() : integer Minimum amount
Get minimum amount
public remove_layout(\Geniem\ACF\Field\Flexible\Layout/string $layout) : \Geniem\ACF\Field\self
Remove layout from layouts
public set_button_label(\string $button_label) : \Geniem\ACF\Field\self
Set add row button label
public set_layouts(array $layouts) : \Geniem\ACF\Field\self
Set layouts
public set_max(integer/\int $max) : \Geniem\ACF\Field\self
Set maximum amount
public set_min(integer/\int $min) : \Geniem\ACF\Field\self
Set minimum amount
protected exclude_fields() : void
Exclude from fields
protected exclude_post_types() : void
Exclude from post types
protected exclude_templates() : void
Exclude from templates

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\MediumEditor

Class MediumEditor

Visibility Function
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\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 $custom_button) : \Geniem\ACF\Field\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\self
Add an option
public delay_loading() : \Geniem\ACF\Field\self
Delay the initialization of Medium until the field is clicked
public dont_delay_loading() : \Geniem\ACF\Field\self
Do not delay the initialization of Medium until the field is clicked
public export(\bool $register=false, mixed $parent=null) : 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
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 field placeholder
public remove_button(string $button) : \Geniem\ACF\Field\self
Removes a standard button from the text formatting buttons
public remove_custom_button(\Geniem\ACF\Field\MediumEditor\CustomButton/string $custom_button) : \Geniem\ACF\Field\self
Remove a button from custom buttons
public remove_option(string $option) : \Geniem\ACF\Field\self
Remove an option
public set_buttons(array $buttons) : \Geniem\ACF\Field\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\self
Set Medium Editor options
public set_placeholder(\string $placeholder) : \Geniem\ACF\Field\self
Set field placeholder

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\MultisiteRelationship

Class MultisiteRelationship

Visibility Function
public get_blog_id() : integer Blog ID.
Get blog id
public set_blog_id(integer/\int $blog_id) : \Geniem\ACF\Field\self
Set blog id

This class extends \Geniem\ACF\Field\Relationship


Class: \Geniem\ACF\Field\GoogleMap

Class GoogleMap

Visibility Function
public get_center_lat() : float
Get center_lat variable
public get_center_lng() : float
Get center_lng variable
public get_height() : integer
Get height variable
public get_zoom() : integer
Get zoom variable
public set_center_lat(\float $lat) : \Geniem\ACF\Field\self
Set center_lat variable
public set_center_lng(\float $lng) : \Geniem\ACF\Field\self
Set center_lng variable
public set_height(integer/\int $height) : \Geniem\ACF\Field\self
Set height variable
public set_zoom(integer/\int $zoom) : \Geniem\ACF\Field\self
Set zoom variable

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\URL

Class URL

Visibility Function
public disable() : \Geniem\ACF\Field\self
Set field disabled
public enable() : \Geniem\ACF\Field\self
Set field enabled
public get_disabled() : boolean
Get field's disabled state
public get_placeholder() : string
Get field placeholder
public get_readonly() : boolean
Get field readonly state
public set_placeholder(\string $placeholder) : \Geniem\ACF\Field\self
Set field placeholder
public set_readonly() : \Geniem\ACF\Field\self
Set field to read only
public set_writable() : \Geniem\ACF\Field\self
Set field to writable

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\ExtendedWysiwyg

Class ExtendedWysiwyg

Visibility Function
public get_height() : integer
Get the height of the element.
public set_height(integer/\int $height) : \Geniem\ACF\Field\self
Set the height of the element

This class extends \Geniem\ACF\Field\Wysiwyg


Class: \Geniem\ACF\Field\Password

Visibility Function
public get_append() : string
Get the field append value
public get_placeholder() : string
Get field placeholder
public get_prepend() : string
Get the field prepend value
public set_append(\string $append) : \Geniem\ACF\Field\self
Set field append value
public set_placeholder(\string $placeholder) : \Geniem\ACF\Field\self
Set field placeholder
public set_prepend(\string $prepend) : \Geniem\ACF\Field\self
Set field prepend value

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Color

Class Color

Visibility Function

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Relationship

Class Relationship

Visibility Function
public add_element(\string $element) : \Geniem\ACF\Field\self
Add an element to show
public add_filter(\string $filter) : \Geniem\ACF\Field\self
Add a filter
public add_post_type(\string $post_type) : \Geniem\ACF\Field\self
Add a post type to allowed post types
public add_taxonomy(string $taxonomy) : \Geniem\ACF\Field\self
Add an allowed taxonomy
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
public get_elements() : array
Get elements to show
public get_filters() : array
Get usable filters
public get_max() : integer Maximum amount
Get maximum amount
public get_min() : integer Minimum amount
Get minimum amount
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 relationship_query(\callable $function) : \Geniem\ACF\Field\self
Register a relationship query filtering function for the field
public relationship_result(\callable $function) : \Geniem\ACF\Field\self
Register a relationship result filtering function for the field
public remove_element(\string $element) : \Geniem\ACF\Field\self
Remove element by name
public remove_filter(\string $filter) : \Geniem\ACF\Field\self
Remove filter by name
public remove_post_type(\string $post_type) : \Geniem\ACF\Field\self
Remove post type by name from allowed
public remove_taxonomy(string $taxonomy) : \Geniem\ACF\Field\self
Remove taxonomy from allowed by slug
public set_elements(array $elements) : \Geniem\ACF\Field\self
Set elements to show
public set_filters(array $filters) : \Geniem\ACF\Field\self
Set filters to show
public set_max(integer/\int $max) : \Geniem\ACF\Field\self
Set maximum amount
public set_min(integer/\int $min) : \Geniem\ACF\Field\self
Set minimum amount
public set_post_types(array $post_types) : \Geniem\ACF\Field\self
Set post types to show
public set_return_format(\string $return_format='object') : \Geniem\ACF\Field\self
Set return format
public set_taxonomies(array $taxonomies) : \Geniem\ACF\Field\self
Set taxonomies to show

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\GroupableField (abstract)

Abstract class GroupableField

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor.
public add_field(\Geniem\ACF\Field $field, \string $order='last') : \Geniem\ACF\Field\GroupableInterface
Add field to group
public add_field_after(\Geniem\ACF\Field $field, \Geniem\ACF\Field[mixed] $target) : \Geniem\ACF\Field\GroupableInterface
Add a field to the group after a target field.
public add_field_before(\Geniem\ACF\Field $field, \Geniem\ACF\Field[mixed] $target) : \Geniem\ACF\Field\GroupableInterface
Add a field to the group before a target field.
public add_fields(array $fields, \string $order='last') : \Geniem\ACF\Field\GroupableInterface
Add an array of fields to group
public add_fields_from(\Geniem\ACF\Interfaces\Groupable $groupable, \string $order='last') : \Geniem\ACF\Field\GroupableInterface
Add fields from another groupable
public clone(\string $key, \string $name=null) : \Geniem\ACF\Field\Field
Clone method Forces the developer to give new key to cloned field.
public export(\bool $register=false, mixed $parent=null) : array
Export current field and sub fields to acf compatible format
public fields_var() : string
Returns current fields_var
public get_field(\string $name) : array
Get a field
public get_fields() : array
Get fields
public remove_field(\string $field_name) : \Geniem\ACF\Field\GroupableInterface
Remove field from sub fields
public remove_fields() : \Geniem\ACF\Field\GroupableInterface
Remove all sub fields
public set_fields(array $fields) : \Geniem\ACF\Field\GroupableInterface
Set fields
public set_fields_from(\Geniem\ACF\Field\GroupableInterface/\Geniem\ACF\Interfaces\Groupable $groupable) : \Geniem\ACF\Field\GroupableInterface
Set fields from another Groupable.

This class extends \Geniem\ACF\Field

This class implements \Geniem\ACF\Interfaces\Groupable


Class: \Geniem\ACF\Field\Textarea

Class Textarea

Visibility Function
public disable() : \Geniem\ACF\Field\self
Set field disabled
public enable() : \Geniem\ACF\Field\self
Set field enabled
public get_disabled() : boolean
Get field's disabled state
public get_new_lines() : string
Get new line handling way
public get_placeholder() : string
Get field placeholder
public get_readonly() : boolean
Get field readonly state
public get_rows() : integer
Get max rows
public set_maxlength(integer/\int $maxlength) : \Geniem\ACF\Field\self
Set text max length
public set_new_lines(\string $new_lines='wpautop') : \Geniem\ACF\Field\self
Set new line handling
public set_placeholder(\string $placeholder) : \Geniem\ACF\Field\self
Set field placeholder
public set_readonly() : \Geniem\ACF\Field\self
Set field to read only
public set_rows(integer/\int $rows) : \Geniem\ACF\Field\self
Set max rows
public set_writable() : \Geniem\ACF\Field\self
Set field to writable

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Select

Class Select

Visibility Function
public add_choice(mixed $choice, mixed $value=null) : \Geniem\ACF\Field\self
Adds a choice to the choices array
public allow_multiple() : \Geniem\ACF\Field\self
Allow multiple values
public allow_null() : \Geniem\ACF\Field\self
Allow null value
public disable() : \Geniem\ACF\Field\self
Set field disabled
public disallow_multiple() : \Geniem\ACF\Field\self
Disallow multiple values
public disallow_null() : \Geniem\ACF\Field\self
Disallow null value
public enable() : \Geniem\ACF\Field\self
Set field enabled
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_choices() : array
Get all choices.
public get_disabled() : boolean
Get field's disabled state
public get_placeholder() : string
Get field placeholder
public get_return_format() : string
Get return format
public no_ajax() : \Geniem\ACF\Field\self
Disable loading values via ajax
public no_ui() : \Geniem\ACF\Field\self
Disable custom ui
public remove_choice(mixed $choice) : \Geniem\ACF\Field\self
Remove a choice.
public set_choices(mixed $choices) : \Geniem\ACF\Field\self
Set choices for the checkbox
public set_placeholder(\string $placeholder) : \Geniem\ACF\Field\self
Set field placeholder
public set_return_format(\string $return_format='value') : \Geniem\ACF\Field\self
Set return format
public ui() : integer
Get custom ui state
public use_ajax() : \Geniem\ACF\Field\self
Enable loading values via ajax
public use_ui() : \Geniem\ACF\Field\self
Enable custom ui

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Checkbox

Class Checkbox

Visibility Function
public add_choice(\string $choice, mixed $value) : \Geniem\ACF\Field\self
Add a choice.
public allow_custom() : \Geniem\ACF\Field\self
Allow custom values
public allow_save_custom() : \Geniem\ACF\Field\self
Allow saving custom values to default values
public allow_toggle() : \Geniem\ACF\Field\self
Allow toggle all checkbox
public disable() : \Geniem\ACF\Field\self
Disable all checkboxes
public disallow_custom() : \Geniem\ACF\Field\self
Disallow custom values
public disallow_save_custom() : \Geniem\ACF\Field\self
Disallow saving custom values to default values
public disallow_toggle() : \Geniem\ACF\Field\self
Disallow toggle all checkbox
public enable() : \Geniem\ACF\Field\self
Set all checkboxes to be enabled
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
public get_choices() : array
Get all choices.
public get_custom() : integer
Get allow custom values status
public get_disabled() : string/array
Get the disabled checkboxes
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\self
Remove a choice.
public set_choices(array $choices) : \Geniem\ACF\Field\self
Set choices for the checkbox
public set_disabled(array $keys) : \Geniem\ACF\Field\self
Set the disabled checkboxes as array
public set_layout(\string $layout='vertical') : \Geniem\ACF\Field\self
Set whether the checkboxes are displayed vertically or horizontally.

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Range

Class Range

Visibility Function

This class extends \Geniem\ACF\Field\Number


Class: \Geniem\ACF\Field\Oembed

Class Oembed

Visibility Function
public get_height() : string
Get embed height
public get_width() : string
Get embed width
public set_height(\string $height) : \Geniem\ACF\Field\self
Set embed height
public set_width(\string $width) : \Geniem\ACF\Field\self
Set embed width

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\PHP

Class PHP

Visibility Function
public run(\callable $callable) : \Geniem\ACF\Field\self
Run the attached code.

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Message

Class Message

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor.
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\self
Disable escape html
public set_message(\string $message) : \Geniem\ACF\Field\self
Set message
public set_new_lines(\string $type) : \Geniem\ACF\Field\self
Set newline handling
public use_esc_html() : \Geniem\ACF\Field\self
Enable escape html

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Text

Class Text

Visibility Function
public disable() : \Geniem\ACF\Field\self
Set field disabled
public enable() : \Geniem\ACF\Field\self
Set field enabled
public get_append() : string
Get the field append value
public get_disabled() : boolean
Get field's disabled state
public get_placeholder() : string
Get field placeholder
public get_prepend() : string
Get the field prepend value
public get_readonly() : boolean
Get field readonly state
public set_append(\string $append) : \Geniem\ACF\Field\self
Set field append value
public set_maxlength(integer/\int $maxlength) : \Geniem\ACF\Field\self
Set text max length
public set_placeholder(\string $placeholder) : \Geniem\ACF\Field\self
Set field placeholder
public set_prepend(\string $prepend) : \Geniem\ACF\Field\self
Set field prepend value
public set_readonly() : \Geniem\ACF\Field\self
Set field to read only
public set_writable() : \Geniem\ACF\Field\self
Set field to writable

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Image

Class Image

Visibility Function
public add_allowed_file_extension(\string $file_extension) : void
A better named wrapper for add_mime_type() Adds an extensions to allowed file extensions, e.g. jpn, png, gif
public add_mime_type(\string $mime_type) : \Geniem\ACF\Field\self
Adds an extension to allowed file extensions e.g. jpg, png, gif
public export(\bool $register=false, mixed $parent=null) : array
Export field in ACF's native format.
public get_allowed_file_extensions() : void
A better named wrapper for get_mime_types() Returns a list of allowed file extensions
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 File extensions
Get allowed file extensions
public get_min_height() : integer Minimum height
Get minimum height
public get_min_size() : string
Get the minimum size of the file.
public get_min_width() : integer Minimum width
Get minimum width
public get_preview_size() : string
Get the preview size of the field.
public get_return_format() : string Return format
Get return format
public remove_allowed_file_extension(\string $file_extension) : void
A better named wrapper for remove_mime_type() Removes a file extension from allowed file extensions
public remove_mime_type(\string $mime_type) : \Geniem\ACF\Field\self
Remove a file extensions from allowed file extensions
public set_allowed_file_extensions(array $file_extensions) : void
A better named wrapper for set_mime_types() Sets allowed file extensions, e.g. jpg, png, gif.
public set_library(\string $library='all') : \Geniem\ACF\Field\self
Sets library
public set_max_height(integer/\int $max_height) : \Geniem\ACF\Field\self
Set maximum height
public set_max_size(\string $max_size) : \Geniem\ACF\Field\self
Set maximum size
public set_max_width(integer/\int $max_width) : \Geniem\ACF\Field\self
Set maximum width
public set_mime_types(array $mime_types) : \Geniem\ACF\Field\self
Set allowed file extensions e.g. jpg, png, gif
public set_min_height(integer/\int $min_height) : \Geniem\ACF\Field\self
Set minimum height
public set_min_size(\string $min_size) : \Geniem\ACF\Field\self
Set the minimum size of the file.
public set_min_width(integer/\int $min_width) : \Geniem\ACF\Field\self
Set minimum width
public set_preview_size(\string $preview_size='thumbnail') : \Geniem\ACF\Field\self
Set the preview size of the field.
public set_return_format(\string $format='array') : \Geniem\ACF\Field\self
Sets return format
public upload_prefilter(\callable $function) : \Geniem\ACF\Field\self
Register a upload prefiltering function for the field
public validate_attachment(\callable $function) : \Geniem\ACF\Field\self
Register a attachment validating function for the field

This class extends \Geniem\ACF\Field


Class: \Geniem\ACF\Field\Flexible\Layout

Class Layout

Visibility Function
public __construct(\string $label, \string $key=null, \string $name=null) : void
Constructor
public add_field(\Geniem\ACF\Field $field, \string $order='last') : \Geniem\ACF\Field\Flexible\GroupableInterface
Add field to group
public add_field_after(\Geniem\ACF\Field $field, \Geniem\ACF\Field\Flexible[mixed] $target) : \Geniem\ACF\Field\Flexible\GroupableInterface
Add a field to the group after a target field.
public add_field_before(\Geniem\ACF\Field $field, \Geniem\ACF\Field\Flexible[mixed] $target) : \Geniem\ACF\Field\Flexible\GroupableInterface
Add a field to the group before a target field.
public add_fields(array $fields, \string $order='last') : \Geniem\ACF\Field\Flexible\GroupableInterface
Add an array of fields to group
public add_fields_from(\Geniem\ACF\Interfaces\Groupable $groupable, \string $order='last') : \Geniem\ACF\Field\Flexible\GroupableInterface
Add fields from another groupable
public clone(\string $key, \string $name=null) : \Geniem\ACF\Field\Flexible\Field
Clone method Forces the developer to give new key to cloned field.
public exclude_field(string/object $field) : \Geniem\ACF\Field\Flexible\self
Exclude a Flexible Content field.
public exclude_post_type(\string $post_type) : \Geniem\ACF\Field\Flexible\self
Exclude the post type.
public exclude_template(\string $template) : \Geniem\ACF\Field\Flexible\self
Exclude a template.
public export(\bool $register=false, mixed $parent=null) : array
Export current field and sub fields to acf compatible format
public fields_var() : string
Returns current fields_var
public get_excluded_fields() : array Excluded fields.
Get the list of excluded fields.
public get_excluded_post_types() : array Excluded post types.
Get the list of excluded post types.
public get_excluded_templates() : array Excluded templates.
Get the list of excluded templates.
public get_field(\string $name) : array
Get a field
public get_fields() : array
Get fields
public get_key() : string Key
Get key
public get_label() : string Label
Get label
public get_name() : string Name
Get name
public remove_excluded_field(string/object $field) : \Geniem\ACF\Field\Flexible\self
Remove a field from the excluded fields list.
public remove_excluded_post_type(\string $post_type) : \Geniem\ACF\Field\Flexible\self
Remove a post type from the excluded post types list.
public remove_excluded_template(\string $template) : \Geniem\ACF\Field\Flexible\self
Remove a template from the excluded templates list.
public remove_field(\string $field_name) : \Geniem\ACF\Field\Flexible\GroupableInterface
Remove field from sub fields
public remove_fields() : \Geniem\ACF\Field\Flexible\GroupableInterface
Remove all sub fields
public set_display_mode(\string $display_mode='block') : \Geniem\ACF\Field\Flexible\self
Set display mode
public set_excluded_fields(array $fields) : \Geniem\ACF\Field\Flexible\self
Set all fields to exclude.
public set_excluded_post_types(array $post_types) : \Geniem\ACF\Field\Flexible\self
Set all post types to exclude.
public set_excluded_templates(array $templates) : \Geniem\ACF\Field\Flexible\self
Set all templates to exclude.
public set_fields(array $fields) : \Geniem\ACF\Field\Flexible\GroupableInterface
Set fields
public set_fields_from(\Geniem\ACF\Field\Flexible\GroupableInterface/\Geniem\ACF\Interfaces\Groupable $groupable) : \Geniem\ACF\Field\Flexible\GroupableInterface
Set fields from another Groupable.
public set_key(\string $key) : \Geniem\ACF\Field\Flexible\self
Set key
public set_label(\string $label) : \Geniem\ACF\Field\Flexible\self
Set label
public set_name(\string $name) : \Geniem\ACF\Field\Flexible\self
Set name

This class implements \Geniem\ACF\Interfaces\Groupable


Class: \Geniem\ACF\Field\MediumEditor\CustomButton

Class Layout

Visibility Function
public add_attribute(\string $name, \string $value) : \Geniem\ACF\Field\MediumEditor\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\self
Remove an attribute
public set_attributes(array $attributes) : \Geniem\ACF\Field\MediumEditor\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\self
Set button label
public set_name(\string $name) : \Geniem\ACF\Field\MediumEditor\self
Set name
public set_tag(\string $tag) : \Geniem\ACF\Field\MediumEditor\self
Set the HTML tag to be used.

Interface: \Geniem\ACF\Interfaces\Renderer

Interface Renderer

Visibility Function
public render(array $data) : string
A rendered must implement the render method.

Interface: \Geniem\ACF\Interfaces\Groupable

Groupable interface

Visibility Function
public add_field(\Geniem\ACF\Field $field, \string $order='last') : void
public add_field_after(\Geniem\ACF\Field $field, mixed $target) : void
public add_field_before(\Geniem\ACF\Field $field, mixed $target) : void
public add_fields(array $fields, \string $order='last') : void
public add_fields_from(\Geniem\ACF\Interfaces\Groupable $groupable, \string $order='last') : void
public clone(\string $key, \string $name=null) : void
public export(\bool $register=false) : void
public fields_var() : void
public get_field(\string $name) : mixed
public get_fields() : mixed
public remove_field(\string $field_name) : void
public remove_fields() : void
public set_fields(array $fields) : void
public set_fields_from(\Geniem\ACF\Interfaces\Groupable $groupable) : void

Class: \Geniem\ACF\Renderer\Dust

Class DustComponentRenderer Component renderer for Dust template files.

Visibility Function
public __construct(\string $template) : void
Constructor
public render(array $fields) : string
Renders ACF fields with the given template file.

This class implements \Geniem\ACF\Interfaces\Renderer


Class: \Geniem\ACF\Renderer\CallableRenderer

Class Callable renderer Block renderer with simple methods.

Visibility Function
public __construct(\callable $method) : void
Constructor
public render(array $fields) : string
Renders ACF fields with the given method.

This class implements \Geniem\ACF\Interfaces\Renderer


Class: \Geniem\ACF\Renderer\PHP

Class PHPComponentRenderer Component renderer for PHP files.

Visibility Function
public __construct(\string $template) : void
Constructor
public render(array $fields) : string
Renders ACF fields with the given template file.

This class implements \Geniem\ACF\Interfaces\Renderer