Class Papi_Core_Property

Core class that implements a Papi property.

Direct known subclasses

Indirect known subclasses

Papi_Property_Bool, Papi_Property_Checkbox, Papi_Property_Gallery, 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_Color, Papi_Property_Repeater, Papi_Property_String, Papi_Property_Term, Papi_Property_Text, Papi_Property_Url, Papi_Property_User, Papi_Property_Datetime, Papi_Property_Divider, Papi_Property_Dropdown, Papi_Property_Editor, Papi_Property_Email, Papi_Property_File, Papi_Property_Flexible

Located at core/class-papi-core-property.php

Methods summary
`public`	# `__construct( )` The constructor. The constructor.
`public mixed`	# `__get( string $key )` Get option value dynamic. Get option value dynamic. Parameters `$key` Returns mixed
`public boolean`	# `__isset( string $key )` Check if options value exists or not. Check if options value exists or not. Parameters `$key` Returns boolean
`public`	# `__set( string $key, mixed $value )` Set options value dynamic. Set options value dynamic. Parameters `$key` `$value`
`public static Papi_Property`	# `create( array\|object $options = [] )` Create a property from options. Create a property from options. Parameters `$options` Returns `Papi_Property`
`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
`public boolean`	# `disabled( )` Determine if the property is disabled or not. Determine if the property is disabled or not. Returns boolean
`public boolean`	# `display( )` Determine if the property should be displayed. Determine if the property should be displayed. Returns boolean
`public static object`	# `factory( mixed $type )` Create a new instance of the given type. Create a new instance of the given type. Parameters `$type` Returns object
`public mixed`	# `format_value( mixed $value, string $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 `$value` `$slug` `$post_id` Returns mixed
`public mixed`	# `get_child_properties( )` Get child properties from `items` in the settings array. Get child properties from `items` in the settings array. Returns mixed
`public array`	# `get_default_settings( )` Get default settings. Get default settings. Returns array
`public array`	# `get_import_settings( )` Get import settings. Get import settings. Returns array
`public mixed`	# `get_option( string $key )` Get option value. Get option value. Parameters `$key` Returns mixed
`public stdClass`	# `get_options( )` Get the current property options object. Get the current property options object. Returns stdClass
`public Papi_Core_Page\|null`	# `get_page( )` Get the page that the property is on. Get the page that the property is on. Returns `Papi_Core_Page`\|null
`public integer`	# `get_post_id( )` Get post id. Get post id. Returns integer
`public array`	# `get_rules( )` Get conditional rules. Get conditional rules. Returns array
`public stdClass`	# `get_setting( string $key, mixed $default = null )` Get setting value. Get setting value. Parameters `$key` `$default` Returns stdClass
`public stdClass`	# `get_settings( )` Get custom property settings. Get custom property settings. Returns stdClass
`public string`	# `get_slug( boolean $remove_prefix = false )` Get property slug. Get property slug. Parameters `$remove_prefix` Returns string
`public mixed`	# `get_value( )` Get value. Get value. Returns mixed
`public string`	# `html_id( object\|string $suffix = '', integer $row = null )` Get the html id attribute value. Get the html id attribute value. Parameters `$suffix` `$row` Returns string
`public string`	# `html_name( array\|object $sub_property = null, integer $row = null )` Get html name for property with or without sub property and row number. Get html name for property with or without sub property and row number. Parameters `$sub_property` `$row` Returns string
`public mixed`	# `import_setting( string $key, mixed $default = null )` Get the import settings. Get the import settings. Parameters `$key` `$default` Returns mixed
`public object`	# `import_settings( )` Get the import settings. Get the import settings. Returns object
`public mixed`	# `import_value( mixed $value, string $slug, integer $post_id )` Import value to the property. Import value to the property. Parameters `$value` `$slug` `$post_id` Returns mixed
`public boolean`	# `is_option_page( )` Check if it's a option page or not. Check if it's a option page or not. Returns boolean
`public mixed`	# `load_value( mixed $value, string $slug, integer $post_id )` Change value after it's loaded from the database. Change value after it's loaded from the database. Parameters `$value` `$slug` `$post_id` Returns mixed
`public boolean`	# `match_slug( string $slug )` Match property slug with given slug value. Match property slug with given slug value. Parameters `$slug` Returns boolean
`protected mixed`	# `prepare_value( mixed $value )` Prepare property value. Prepare property value. Parameters `$value` Returns mixed
`public`	# `render_ajax_request( )` Render AJAX request. Render AJAX request.
`public boolean`	# `render_is_allowed_by_rules( array $rules = [] )` Check if the property is allowed to render by the conditional rules. Check if the property is allowed to render by the conditional rules. Parameters `$rules` Returns boolean
`public`	# `set_page( Papi_Core_Page $page )` Set the page that the property is on. Set the page that the property is on. Parameters `$page`
`public`	# `set_post_id( integer $post_id )` Set post id. Set post id. Parameters `$post_id`
`public`	# `set_options( array\|object $options )` Set the current property options object. Set the current property options object. Parameters `$options`
`public`	# `set_option( string $key, mixed $value )` Set property option value. Set property option value. Parameters `$key` `$value`
`public`	# `set_setting( string $key, mixed $value )` Set property setting value. Set property setting value. Parameters `$key` `$value`
`protected`	# `setup_actions( )` Setup actions. Setup actions.
`protected`	# `setup_conditional( )` Setup conditional class. Setup conditional class.
`protected`	# `setup_filters( )` Setup filters. Setup filters.
`public mixed`	# `update_value( mixed $value, string $slug, integer $post_id )` Update value before it's saved to the database. Update value before it's saved to the database. Parameters `$value` `$slug` `$post_id` Returns mixed

Properties summary
`protected Papi_Core_Conditional`	`$conditional` The conditional class. The conditional class.	#
`public string`	`$convert_type` The convert type. The convert type.	# `'string'`
`protected array`	`$default_options` Default options. Default options.	# `[ 'after_class' => '', 'after_html' => '', 'before_class' => '', 'before_html' => '', 'capabilities' => [], 'default' => '', 'description' => '', 'disabled' => false, 'display' => true, 'lang' => false, 'overwrite' => false, 'post_type' => '', 'raw' => false, 'required' => false, 'rules' => [], 'settings' => [], 'sidebar' => true, 'slug' => '', 'sort_order' => -1, 'title' => '', 'type' => '', 'value' => '' ]`
`public null`	`$default_value` Default value. Default value.	#
`protected boolean`	`$display` Display the property in WordPress admin. Display the property in WordPress admin.	# `true`

Classes

Functions

Class Papi_Core_Property

Direct known subclasses

Indirect known subclasses

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Returns

Parameters

Returns

Returns

Returns

Parameters

Returns

Parameters

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Returns

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Returns

Parameters

Returns

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Returns

Parameters

Parameters

Parameters

Parameters

Parameters

Parameters

Returns