• Class
  • Tree
  • Deprecated

Classes

  • Papi_Admin
  • Papi_Admin_Ajax
  • Papi_Admin_Assets
  • Papi_Admin_Columns
  • Papi_Admin_Menu
  • Papi_Admin_Meta_Box
  • Papi_Admin_Meta_Box_Tabs
  • Papi_Admin_Meta_Handler
  • Papi_Admin_Option_Handler
  • Papi_Admin_Taxonomy
  • Papi_Admin_View
  • Papi_Attachment_Type
  • Papi_CLI
  • Papi_CLI_Command
  • Papi_CLI_Post_Command
  • Papi_CLI_Term_Command
  • Papi_CLI_Type_Command
  • Papi_Conditional_Rules
  • Papi_Container
  • Papi_Core_Autoload
  • Papi_Core_Box
  • Papi_Core_Conditional
  • Papi_Core_Conditional_Rule
  • Papi_Core_Data_Handler
  • Papi_Core_Meta_Store
  • Papi_Core_Property
  • Papi_Core_Tab
  • Papi_Core_Type
  • Papi_Entry_Type
  • Papi_Loader
  • Papi_Option_Store
  • Papi_Option_Type
  • Papi_Page_Type
  • Papi_Porter
  • Papi_Porter_Driver
  • Papi_Porter_Driver_Core
  • Papi_Post_Store
  • Papi_Property
  • Papi_Property_Bool
  • Papi_Property_Checkbox
  • Papi_Property_Color
  • Papi_Property_Datetime
  • Papi_Property_Divider
  • Papi_Property_Dropdown
  • Papi_Property_Editor
  • Papi_Property_Email
  • Papi_Property_File
  • Papi_Property_Flexible
  • Papi_Property_Gallery
  • Papi_Property_Group
  • Papi_Property_Hidden
  • Papi_Property_Html
  • Papi_Property_Image
  • Papi_Property_Link
  • Papi_Property_Number
  • Papi_Property_Post
  • Papi_Property_Radio
  • Papi_Property_Reference
  • Papi_Property_Relationship
  • Papi_Property_Repeater
  • Papi_Property_String
  • Papi_Property_Term
  • Papi_Property_Text
  • Papi_Property_Url
  • Papi_Property_User
  • Papi_Taxonomy_Type
  • Papi_Term_Store

Functions

  • papi
  • papi_action_delete_value
  • papi_append_post_type_query
  • papi_body_class
  • papi_cache_delete
  • papi_cache_get
  • papi_cache_key
  • papi_cache_set
  • papi_camel_case
  • papi_cast_string_value
  • papi_convert_to_string
  • papi_current_user_is_allowed
  • papi_delete_field
  • papi_delete_option
  • papi_delete_property_meta_value
  • papi_delete_term_field
  • papi_display_page_type
  • papi_doing_ajax
  • papi_entry_type_exists
  • papi_esc_html
  • papi_f
  • papi_field_shortcode
  • papi_field_value
  • papi_filter_conditional_rule_allowed
  • papi_filter_format_value
  • papi_filter_load_value
  • papi_filter_settings_directories
  • papi_filter_settings_only_page_type
  • papi_filter_settings_only_taxonomy_type
  • papi_filter_settings_show_page_type
  • papi_filter_settings_show_standard_page_type
  • papi_filter_settings_show_standard_page_type_in_filter
  • papi_filter_settings_show_standard_taxonomy_type
  • papi_filter_settings_sort_order
  • papi_filter_settings_standard_page_type_description
  • papi_filter_settings_standard_page_type_name
  • papi_filter_settings_standard_page_type_thumbnail
  • papi_filter_settings_standard_taxonomy_type_name
  • papi_filter_update_value
  • papi_from_property_array_slugs
  • papi_get_all_core_type_files
  • papi_get_all_entry_types
  • papi_get_all_files_in_directory
  • papi_get_all_page_types
  • papi_get_class_name
  • papi_get_core_type_base_path
  • papi_get_core_type_file_path
  • papi_get_entry_type
  • papi_get_entry_type_by_id
  • papi_get_entry_type_by_meta_id
  • papi_get_entry_type_count
  • papi_get_entry_type_css_class
  • papi_get_entry_type_id
  • papi_get_entry_type_template
  • papi_get_field
  • papi_get_file_path
  • papi_get_meta_id
  • papi_get_meta_id_column
  • papi_get_meta_store
  • papi_get_meta_type
  • papi_get_only_objects
  • papi_get_option
  • papi_get_options_and_properties
  • papi_get_or_post
  • papi_get_page
  • papi_get_page_new_url
  • papi_get_page_type_id
  • papi_get_page_type_key
  • papi_get_page_type_name
  • papi_get_parent_post_id
  • papi_get_post_id
  • papi_get_post_type
  • papi_get_post_type_label
  • papi_get_post_types
  • papi_get_property_class_name
  • papi_get_property_meta_value
  • papi_get_property_type
  • papi_get_property_type_key
  • papi_get_property_type_key_f
  • papi_get_qs
  • papi_get_sanitized_post
  • papi_get_slugs
  • papi_get_taxonomies
  • papi_get_taxonomy
  • papi_get_taxonomy_label
  • papi_get_taxonomy_type_id
  • papi_get_taxonomy_type_name
  • papi_get_template_file_name
  • papi_get_term_field
  • papi_get_term_id
  • papi_get_term_slugs
  • papi_html_name
  • papi_html_tag
  • papi_include_query_strings
  • papi_include_template
  • papi_is_empty
  • papi_is_json
  • papi_is_method
  • papi_is_option_type
  • papi_is_page_type
  • papi_is_property
  • papi_is_property_type_key
  • papi_is_rule
  • papi_load_page_type_id
  • papi_load_taxonomy_type_id
  • papi_maybe_convert_to_array
  • papi_maybe_convert_to_object
  • papi_maybe_get_callable_value
  • papi_maybe_json_decode
  • papi_maybe_json_encode
  • papi_nl2br
  • papi_option_shortcode
  • papi_option_type_exists
  • papi_populate_properties
  • papi_property
  • papi_remove_trailing_quotes
  • papi_render_html_tag
  • papi_render_properties
  • papi_render_property
  • papi_require_text
  • papi_required_html
  • papi_rule
  • papi_santize_data
  • papi_set_page_type_id
  • papi_set_taxonomy_type_id
  • papi_slugify
  • papi_sort_order
  • papi_supports_term_meta
  • papi_tab
  • papi_tabs_setup
  • papi_taxonomy_shortcode
  • papi_template
  • papi_template_include
  • papi_to_array
  • papi_to_property_array_slugs
  • papi_underscorify
  • papi_update_field
  • papi_update_option
  • papi_update_property_meta_value
  • papi_update_property_meta_value_cache_delete
  • papi_update_term_field
  • papify
  • the_papi_field
  • the_papi_option
  • the_papi_page_type_name
  • the_papi_taxonomy_type_name
  • the_papi_term_field
  • unpapify

Class Papi_Property_Flexible

Flexible repeater property that can repeat multiple properties with different properties per layout.

Papi_Core_Property
Extended by Papi_Property
Extended by Papi_Property_Repeater
Extended by Papi_Property_Flexible
Located at properties/class-papi-property-flexible.php

Methods summary

public boolean
# delete_value( string $slug, integer $post_id, string $type )

Delete value from the database.

Delete value from the database.

Parameters

$slug
$post_id
$type

Returns

boolean

Overrides

Papi_Property_Repeater::delete_value
public array
# format_value( mixed $values, string $repeater_slug, integer $post_id )

Format the value of the property before it's returned to WordPress admin or the site.

Format the value of the property before it's returned to WordPress admin or the site.

Parameters

$values
$repeater_slug
$post_id

Returns

array

Overrides

Papi_Property_Repeater::format_value
protected boolean
# is_layout_key( string $key )

Check if the given key is a valid layout key.

Check if the given key is a valid layout key.

Parameters

$key

Returns

boolean
protected string
# get_json_id( string $key, string $extra = '' )

Generate layout slug.

Generate layout slug.

Parameters

$key
$extra

Returns

string
protected string
# get_layout( string $slug )

Get layout by slug.

Get layout by slug.

Parameters

$slug

Returns

string
protected string
# get_layout_value( string $layout )

Get layout value.

Get layout value.

Parameters

$layout

Returns

string
protected array
# get_results( integer $value, string $repeater_slug, integer $post_id )

Get results from the database.

Get results from the database.

Parameters

$value
$repeater_slug
$post_id

Returns

array

Overrides

Papi_Property_Repeater::get_results
protected array
# get_settings_layouts( )

Get layouts.

Get layouts.

Returns

array
public array
# load_value( mixed $value, string $repeater_slug, integer $post_id )

Change value after it's loaded from the database and populate every property in the flexible with the right property type.

Change value after it's loaded from the database and populate every property in the flexible with the right property type.

Parameters

$value
$repeater_slug
$post_id

Returns

array

Overrides

Papi_Property_Repeater::load_value
protected array
# prepare_properties( array $layouts )

Prepare properties.

Prepare properties.

Not the best name for this function, but since property repeater using this we can't rename it.

Parameters

$layouts

Returns

array

Overrides

Papi_Property_Repeater::prepare_properties
public
# render_ajax_request( )

Render AJAX request.

Render AJAX request.

Overrides

Papi_Property_Repeater::render_ajax_request
protected
# render_json_template( string $slug )

Render layout JSON template.

Render layout JSON template.

Parameters

$slug

Overrides

Papi_Property_Repeater::render_json_template
protected
# render_layout_input( string $value )

Render layout input.

Render layout input.

Parameters

$value
protected
# render_properties( array $row, array|boolean $value )

Render properties.

Render properties.

Parameters

$row
$value

Overrides

Papi_Property_Repeater::render_properties
protected
# render_repeater( object $options )

Render repeater html.

Render repeater html.

Parameters

$options

Overrides

Papi_Property_Repeater::render_repeater
protected
# render_repeater_row( )

Render repeater row.

Render repeater row.

public
# render_repeater_row_template( )

Render repeater row template.

Render repeater row template.

protected
# setup_actions( )

Setup actions.

Setup actions.

Overrides

Papi_Property_Repeater::setup_actions

Methods inherited from Papi_Property_Repeater

get_child_slug(), get_default_settings(), get_import_settings(), get_row_results(), get_settings_properties(), html(), import_value(), layout(), load_child_properties(), prepare_property_for_json(), remove_repeater_rows(), render_repeater_head(), render_repeater_rows(), render_repeater_rows_template(), update_value()

Methods inherited from Papi_Property

get_value(), is_option_page(), render(), render_description_html(), render_hidden_html(), render_label_html(), render_property_html(), render_row_html(), render_rules_json()

Methods inherited from Papi_Core_Property

__construct(), __get(), __isset(), __set(), __toString(), create(), current_user_can(), disabled(), display(), factory(), get_child_properties(), get_child_property(), get_meta_type(), get_option(), get_options(), get_post_id(), get_rules(), get_setting(), get_settings(), get_slug(), get_store(), html_id(), html_name(), import_setting(), import_settings(), match_slug(), prepare_value(), render_is_allowed_by_rules(), set_option(), set_options(), set_post_id(), set_setting(), set_store(), setup_conditional(), setup_filters()

Properties summary

public string $convert_type

The convert type.

The convert type.

# 'array'
protected integer $counter

Flexible repeater counter number.

Flexible repeater counter number.

# 0
public array $default_value

The default value.

The default value.

# []
protected array $exclude_properties

Exclude properties that is not allowed in a repeater.

Exclude properties that is not allowed in a repeater.

# ['flexible']
protected string $layout_key

The layout key.

The layout key.

# '_flexible_layout'

Properties inherited from Papi_Property_Repeater

$cache

Properties inherited from Papi_Core_Property

$conditional, $default_options, $display, $tab

API documentation generated by ApiGen