File: //proc/self/cwd/wp-content/new_update/plugins/wp-facebook-pixel/inc/CMB2/includes/CMB2_Field.php
<?php
/**
* CMB2 field objects
*
* @since 1.1.0
*
* @category WordPress_Plugin
* @package CMB2
* @author WebDevStudios
* @license GPL-2.0+
* @link http://webdevstudios.com
*
* @method string _id()
* @method string type()
* @method mixed fields()
*/
class CMB2_Field {
/**
* Metabox object id
* @var mixed
* @since 1.1.0
*/
public $object_id = null;
/**
* Metabox object type
* @var string
* @since 1.1.0
*/
public $object_type = '';
/**
* Field arguments
* @var mixed
* @since 1.1.0
*/
public $args = array();
/**
* Field group object or false (if no group)
* @var mixed
* @since 1.1.0
*/
public $group = false;
/**
* Field meta value
* @var mixed
* @since 1.1.0
*/
public $value = null;
/**
* Field meta value
* @var mixed
* @since 1.1.0
*/
public $escaped_value = null;
/**
* Grouped Field's current numeric index during the save process
* @var mixed
* @since 2.0.0
*/
public $index = 0;
/**
* Array of field options
* @var array
* @since 2.0.0
*/
protected $field_options = array();
/**
* Array of field param callback results
* @var array
* @since 2.0.0
*/
protected $callback_results = array();
/**
* Array of key => value data for saving. Likely $_POST data.
* @var array
* @since 2.0.0
*/
public $data_to_save = array();
/**
* Constructs our field object
* @since 1.1.0
* @param array $args Field arguments
*/
public function __construct( $args ) {
if ( ! empty( $args['group_field'] ) ) {
$this->group = $args['group_field'];
$this->object_id = $this->group->object_id;
$this->object_type = $this->group->object_type;
} else {
$this->object_id = isset( $args['object_id'] ) && '_' !== $args['object_id'] ? $args['object_id'] : 0;
$this->object_type = isset( $args['object_type'] ) ? $args['object_type'] : 'post';
}
$this->args = $this->_set_field_defaults( $args['field_args'] );
if ( $this->object_id ) {
$this->value = $this->get_data();
}
}
/**
* Non-existent methods fallback to checking for field arguments of the same name
* @since 1.1.0
* @param string $name Method name
* @param array $arguments Array of passed-in arguments
* @return mixed Value of field argument
*/
public function __call( $name, $arguments ) {
$key = isset( $arguments[0] ) ? $arguments[0] : false;
return $this->args( $name, $key );
}
/**
* Retrieves the field id
* @since 1.1.0
* @param boolean $raw Whether to retrieve pre-modidifed id
* @return string Field id
*/
public function id( $raw = false ) {
$id = $raw ? '_id' : 'id';
return $this->args( $id );
}
/**
* Get a field argument
* @since 1.1.0
* @param string $key Argument to check
* @param string $_key Sub argument to check
* @return mixed Argument value or false if non-existent
*/
public function args( $key = '', $_key = '' ) {
$arg = $this->_data( 'args', $key );
if ( 'default' == $key ) {
$arg = $this->get_param_callback_result( 'default', false );
} elseif ( $_key ) {
$arg = isset( $arg[ $_key ] ) ? $arg[ $_key ] : false;
}
return $arg;
}
/**
* Retrieve a portion of a field property
* @since 1.1.0
* @param string $var Field property to check
* @param string $key Field property array key to check
* @return mixed Queried property value or false
*/
public function _data( $var, $key = '' ) {
$vars = $this->$var;
if ( $key ) {
return isset( $vars[ $key ] ) ? $vars[ $key ] : false;
}
return $vars;
}
/**
* Get Field's value
* @since 1.1.0
* @param string $key If value is an array, is used to get array key->value
* @return mixed Field value or false if non-existent
*/
public function value( $key = '' ) {
return $this->_data( 'value', $key );
}
/**
* Retrieves metadata/option data
* @since 1.0.1
* @param string $field_id Meta key/Option array key
* @param array $args Override arguments
* @return mixed Meta/Option value
*/
public function get_data( $field_id = '', $args = array() ) {
if ( $field_id ) {
$args['field_id'] = $field_id;
} else if ( $this->group ) {
$args['field_id'] = $this->group->id();
}
$a = $this->data_args( $args );
/**
* Filter whether to override getting of meta value.
* Returning a non 'cmb2_field_no_override_val' value
* will effectively short-circuit the value retrieval.
*
* @since 2.0.0
*
* @param mixed $value The value get_metadata() should
* return - a single metadata value,
* or an array of values.
*
* @param int $object_id Object ID.
*
* @param array $args {
* An array of arguments for retrieving data
*
* @type string $type The current object type
* @type int $id The current object ID
* @type string $field_id The ID of the field being requested
* @type bool $repeat Whether current field is repeatable
* @type bool $single Whether current field is a single database row
* }
*
* @param CMB2_Field object $field This field object
*/
$data = apply_filters( 'cmb2_override_meta_value', 'cmb2_field_no_override_val', $this->object_id, $a, $this );
/**
* Filter and parameters are documented for 'cmb2_override_meta_value' filter (above).
*
* The dynamic portion of the hook, $field_id, refers to the current
* field id paramater. Returning a non 'cmb2_field_no_override_val' value
* will effectively short-circuit the value retrieval.
*
* @since 2.0.0
*/
$data = apply_filters( "cmb2_override_{$a['field_id']}_meta_value", $data, $this->object_id, $a, $this );
// If no override, get value normally
if ( 'cmb2_field_no_override_val' === $data ) {
$data = 'options-page' === $a['type']
? cmb2_options( $a['id'] )->get( $a['field_id'] )
: get_metadata( $a['type'], $a['id'], $a['field_id'], ( $a['single'] || $a['repeat'] ) );
}
if ( $this->group ) {
$data = is_array( $data ) && isset( $data[ $this->group->index ][ $this->args( '_id' ) ] )
? $data[ $this->group->index ][ $this->args( '_id' ) ]
: false;
}
return $data;
}
/**
* Updates metadata/option data
* @since 1.0.1
* @param mixed $new_value Value to update data with
* @param bool $single Whether data is an array (add_metadata)
*/
public function update_data( $new_value, $single = true ) {
$a = $this->data_args( array( 'single' => $single ) );
$a['value'] = $a['repeat'] ? array_values( $new_value ) : $new_value;
/**
* Filter whether to override saving of meta value.
* Returning a non-null value will effectively short-circuit the function.
*
* @since 2.0.0
*
* @param null|bool $check Whether to allow updating metadata for the given type.
*
* @param array $args {
* Array of data about current field including:
*
* @type string $value The value to set
* @type string $type The current object type
* @type int $id The current object ID
* @type string $field_id The ID of the field being updated
* @type bool $repeat Whether current field is repeatable
* @type bool $single Whether current field is a single database row
* }
*
* @param array $field_args All field arguments
*
* @param CMB2_Field object $field This field object
*/
$override = apply_filters( 'cmb2_override_meta_save', null, $a, $this->args(), $this );
/**
* Filter and parameters are documented for 'cmb2_override_meta_save' filter (above).
*
* The dynamic portion of the hook, $a['field_id'], refers to the current
* field id paramater. Returning a non-null value
* will effectively short-circuit the function.
*
* @since 2.0.0
*/
$override = apply_filters( "cmb2_override_{$a['field_id']}_meta_save", $override, $a, $this->args(), $this );
// If override, return that
if ( null !== $override ) {
return $override;
}
// Options page handling (or temp data store)
if ( 'options-page' === $a['type'] || empty( $a['id'] ) ) {
return cmb2_options( $a['id'] )->update( $a['field_id'], $a['value'], false, $a['single'] );
}
// Add metadata if not single
if ( ! $a['single'] ) {
return add_metadata( $a['type'], $a['id'], $a['field_id'], $a['value'], false );
}
// Delete meta if we have an empty array
if ( is_array( $a['value'] ) && empty( $a['value'] ) ) {
return delete_metadata( $a['type'], $a['id'], $a['field_id'], $this->value );
}
// Update metadata
return update_metadata( $a['type'], $a['id'], $a['field_id'], $a['value'] );
}
/**
* Removes/updates metadata/option data
* @since 1.0.1
* @param string $old Old value
*/
public function remove_data( $old = '' ) {
$a = $this->data_args( array( 'old' => $old ) );
/**
* Filter whether to override removing of meta value.
* Returning a non-null value will effectively short-circuit the function.
*
* @since 2.0.0
*
* @param null|bool $delete Whether to allow metadata deletion of the given type.
* @param array $args Array of data about current field including:
* 'type' : Current object type
* 'id' : Current object ID
* 'field_id' : Current Field ID
* 'repeat' : Whether current field is repeatable
* 'single' : Whether to save as a
* single meta value
* @param array $field_args All field arguments
* @param CMB2_Field object $field This field object
*/
$override = apply_filters( 'cmb2_override_meta_remove', null, $a, $this->args(), $this );
/**
* Filter whether to override removing of meta value.
*
* The dynamic portion of the hook, $a['field_id'], refers to the current
* field id paramater. Returning a non-null value
* will effectively short-circuit the function.
*
* @since 2.0.0
*
* @param null|bool $delete Whether to allow metadata deletion of the given type.
* @param array $args Array of data about current field including:
* 'type' : Current object type
* 'id' : Current object ID
* 'field_id' : Current Field ID
* 'repeat' : Whether current field is repeatable
* 'single' : Whether to save as a
* single meta value
* @param array $field_args All field arguments
* @param CMB2_Field object $field This field object
*/
$override = apply_filters( "cmb2_override_{$a['field_id']}_meta_remove", $override, $a, $this->args(), $this );
// If no override, remove as usual
if ( null !== $override ) {
return $override;
}
// Option page handling
elseif ( 'options-page' === $a['type'] || empty( $a['id'] ) ) {
return cmb2_options( $a['id'] )->remove( $a['field_id'] );
}
// Remove metadata
return delete_metadata( $a['type'], $a['id'], $a['field_id'], $old );
}
/**
* Data variables for get/set data methods
* @since 1.1.0
* @param array $args Override arguments
* @return array Updated arguments
*/
public function data_args( $args = array() ) {
$args = wp_parse_args( $args, array(
'type' => $this->object_type,
'id' => $this->object_id,
'field_id' => $this->id( true ),
'repeat' => $this->args( 'repeatable' ),
'single' => ! $this->args( 'multiple' ),
) );
return $args;
}
/**
* Checks if field has a registered sanitization callback
* @since 1.0.1
* @param mixed $meta_value Meta value
* @return mixed Possibly sanitized meta value
*/
public function sanitization_cb( $meta_value ) {
if ( $this->args( 'repeatable' ) && is_array( $meta_value ) ) {
// Remove empties
$meta_value = array_filter( $meta_value );
}
// Check if the field has a registered validation callback
$cb = $this->maybe_callback( 'sanitization_cb' );
if ( false === $cb ) {
// If requesting NO validation, return meta value
return $meta_value;
} elseif ( $cb ) {
// Ok, callback is good, let's run it.
return call_user_func( $cb, $meta_value, $this->args(), $this );
}
$sanitizer = new CMB2_Sanitize( $this, $meta_value );
/**
* Filter the value before it is saved.
*
* The dynamic portion of the hook name, $this->type(), refers to the field type.
*
* Passing a non-null value to the filter will short-circuit saving
* the field value, saving the passed value instead.
*
* @param bool|mixed $override_value Sanitization/Validation override value to return.
* Default false to skip it.
* @param mixed $value The value to be saved to this field.
* @param int $object_id The ID of the object where the value will be saved
* @param array $field_args The current field's arguments
* @param object $sanitizer This `CMB2_Sanitize` object
*/
$override_value = apply_filters( "cmb2_sanitize_{$this->type()}", null, $sanitizer->value, $this->object_id, $this->args(), $sanitizer );
if ( null !== $override_value ) {
return $override_value;
}
// Sanitization via 'CMB2_Sanitize'
return $sanitizer->{$this->type()}();
}
/**
* Process $_POST data to save this field's value
* @since 2.0.3
* @param array $data_to_save $_POST data to check
* @return bool Result of save
*/
public function save_field_from_data( array $data_to_save ) {
$this->data_to_save = $data_to_save;
$meta_value = isset( $this->data_to_save[ $this->id( true ) ] )
? $this->data_to_save[ $this->id( true ) ]
: null;
return $this->save_field( $meta_value );
}
/**
* Sanitize/store a value to this field
* @since 2.0.0
* @param array $meta_value Desired value to sanitize/store
* @return bool Result of save
*/
public function save_field( $meta_value ) {
$new_value = $this->sanitization_cb( $meta_value );
$old = $this->get_data();
$updated = false;
$action = '';
if ( $this->args( 'multiple' ) && ! $this->args( 'repeatable' ) && ! $this->group ) {
$this->remove_data();
$count = 0;
if ( ! empty( $new_value ) ) {
foreach ( $new_value as $add_new ) {
if ( $this->update_data( $add_new, false ) ) {
$count++;
}
}
}
$updated = $count ? $count : false;
$action = 'repeatable';
} elseif ( ! cmb2_utils()->isempty( $new_value ) && $new_value !== $old ) {
$updated = $this->update_data( $new_value );
$action = 'updated';
} elseif ( cmb2_utils()->isempty( $new_value ) ) {
$updated = $this->remove_data();
$action = 'removed';
}
if ( $updated ) {
$this->value = $this->get_data();
}
$field_id = $this->id( true );
/**
* Hooks after save field action.
*
* @since 2.2.0
*
* @param string $field_id the current field id paramater.
* @param bool $updated Whether the metadata update action occurred.
* @param string $action Action performed. Could be "repeatable", "updated", or "removed".
* @param CMB2_Field object $field This field object
*/
do_action( 'cmb2_save_field', $field_id, $updated, $action, $this );
/**
* Hooks after save field action.
*
* The dynamic portion of the hook, $field_id, refers to the
* current field id paramater.
*
* @since 2.2.0
*
* @param bool $updated Whether the metadata update action occurred.
* @param string $action Action performed. Could be "repeatable", "updated", or "removed".
* @param CMB2_Field object $field This field object
*/
do_action( "cmb2_save_field_{$field_id}", $updated, $action, $this );
return $updated;
}
/**
* Checks if field has a callback value
* @since 1.0.1
* @param string $cb Callback string
* @return mixed NULL, false for NO validation, or $cb string if it exists.
*/
public function maybe_callback( $cb ) {
$field_args = $this->args();
if ( ! isset( $field_args[ $cb ] ) ) {
return;
}
// Check if metabox is requesting NO validation
$cb = false !== $field_args[ $cb ] && 'false' !== $field_args[ $cb ] ? $field_args[ $cb ] : false;
// If requesting NO validation, return false
if ( ! $cb ) {
return false;
}
if ( is_callable( $cb ) ) {
return $cb;
}
}
/**
* Determine if current type is excempt from escaping
* @since 1.1.0
* @return bool True if exempt
*/
public function escaping_exception() {
// These types cannot be escaped
return in_array( $this->type(), array(
'file_list',
'multicheck',
'text_datetime_timestamp_timezone',
) );
}
/**
* Determine if current type cannot be repeatable
* @since 1.1.0
* @param string $type Field type to check
* @return bool True if type cannot be repeatable
*/
public function repeatable_exception( $type ) {
// These types cannot be escaped
$internal_fields = array(
// Use file_list instead
'file' => 1,
'radio' => 1,
'title' => 1,
// @todo Ajax load wp_editor: http://wordpress.stackexchange.com/questions/51776/how-to-load-wp-editor-through-ajax-jquery
'wysiwyg' => 1,
'checkbox' => 1,
'radio_inline' => 1,
'taxonomy_radio' => 1,
'taxonomy_select' => 1,
'taxonomy_multicheck' => 1,
);
/**
* Filter field types that are non-repeatable.
*
* Note that this does *not* allow overriding the default non-repeatable types.
*
* @since 2.1.1
*
* @param array $fields Array of fields designated as non-repeatable. Note that the field names are *keys*,
* and not values. The value can be anything, because it is meaningless. Example:
* array( 'my_custom_field' => 1 )
*/
$all_fields = array_merge( apply_filters( 'cmb2_non_repeatable_fields', array() ), $internal_fields );
return isset( $all_fields[ $type ] );
}
/**
* Escape the value before output. Defaults to 'esc_attr()'
* @since 1.0.1
* @param callable $func Escaping function (if not esc_attr())
* @param mixed $meta_value Meta value
* @return mixed Final value
*/
public function escaped_value( $func = 'esc_attr', $meta_value = '' ) {
if ( null !== $this->escaped_value ) {
return $this->escaped_value;
}
$meta_value = $meta_value ? $meta_value : $this->value();
// Check if the field has a registered escaping callback
if ( $cb = $this->maybe_callback( 'escape_cb' ) ) {
// Ok, callback is good, let's run it.
return call_user_func( $cb, $meta_value, $this->args(), $this );
}
// Or custom escaping filter can be used
$esc = apply_filters( "cmb2_types_esc_{$this->type()}", null, $meta_value, $this->args(), $this );
if ( null !== $esc ) {
return $esc;
}
if ( false === $cb || $this->escaping_exception() ) {
// If requesting NO escaping, return meta value
return $this->val_or_default( $meta_value );
}
// escaping function passed in?
$func = $func ? $func : 'esc_attr';
$meta_value = $this->val_or_default( $meta_value );
if ( is_array( $meta_value ) ) {
foreach ( $meta_value as $key => $value ) {
$meta_value[ $key ] = call_user_func( $func, $value );
}
} else {
$meta_value = call_user_func( $func, $meta_value );
}
$this->escaped_value = $meta_value;
return $this->escaped_value;
}
/**
* Return non-empty value or field default if value IS empty
* @since 2.0.0
* @param mixed $meta_value Field value
* @return mixed Field value, or default value
*/
public function val_or_default( $meta_value ) {
return ! cmb2_utils()->isempty( $meta_value ) ? $meta_value : $this->get_param_callback_result( 'default', false );
}
/**
* Offset a time value based on timezone
* @since 1.0.0
* @return string Offset time string
*/
public function field_timezone_offset() {
return cmb2_utils()->timezone_offset( $this->field_timezone() );
}
/**
* Return timezone string
* @since 1.0.0
* @return string Timezone string
*/
public function field_timezone() {
$value = '';
// Is timezone arg set?
if ( $this->args( 'timezone' ) ) {
$value = $this->args( 'timezone' );
}
// Is there another meta key with a timezone stored as its value we should use?
else if ( $this->args( 'timezone_meta_key' ) ) {
$value = $this->get_data( $this->args( 'timezone_meta_key' ) );
}
return $value;
}
/**
* Format the timestamp field value based on the field date/time format arg
* @since 2.0.0
* @param int $meta_value Timestamp
* @param string $format Either date_format or time_format
* @return string Formatted date
*/
public function format_timestamp( $meta_value, $format = 'date_format' ) {
return date( stripslashes( $this->args( $format ) ), $meta_value );
}
/**
* Return a formatted timestamp for a field
* @since 2.0.0
* @param string $format Either date_format or time_format
* @param string $meta_value Optional meta value to check
* @return string Formatted date
*/
public function get_timestamp_format( $format = 'date_format', $meta_value = 0 ) {
$meta_value = $meta_value ? $meta_value : $this->escaped_value();
$meta_value = cmb2_utils()->make_valid_time_stamp( $meta_value );
if ( empty( $meta_value ) ) {
return '';
}
return is_array( $meta_value )
? array_map( array( $this, 'format_timestamp' ), $meta_value, $format )
: $this->format_timestamp( $meta_value, $format );
}
/**
* Get timestamp from text date
* @since 2.2.0
* @param string $value Date value
* @return mixed Unix timestamp representing the date.
*/
public function get_timestamp_from_value( $value ) {
return cmb2_utils()->get_timestamp_from_value( $value, $this->args( 'date_format' ) );
}
/**
* Get field render callback and Render the field row
* @since 1.0.0
*/
public function render_field() {
// Check if the field has a registered render_field callback
if ( $cb = $this->maybe_callback( 'render_row_cb' ) ) {
// Ok, callback is good, let's run it.
return call_user_func( $cb, $this->args(), $this );
}
}
/**
* Default field render callback
* @since 2.1.1
*/
public function render_field_callback() {
// If field is requesting to not be shown on the front-end
if ( ! is_admin() && ! $this->args( 'on_front' ) ) {
return;
}
// If field is requesting to be conditionally shown
if ( ! $this->should_show() ) {
return;
}
$this->peform_param_callback( 'before_row' );
printf( "<div class=\"cmb-row %s\">\n", $this->row_classes() );
if ( ! $this->args( 'show_names' ) ) {
echo "\n\t<div class=\"cmb-td\">\n";
$this->peform_param_callback( 'label_cb' );
} else {
if ( $this->get_param_callback_result( 'label_cb', false ) ) {
echo '<div class="cmb-th">', $this->peform_param_callback( 'label_cb' ), '</div>';
}
echo "\n\t<div class=\"cmb-td\">\n";
}
$this->peform_param_callback( 'before' );
$field_type = new CMB2_Types( $this );
$field_type->render();
$this->peform_param_callback( 'after' );
echo "\n\t</div>\n</div>";
$this->peform_param_callback( 'after_row' );
// For chaining
return $this;
}
/**
* The default label_cb callback (if not a title field)
*
* @since 2.1.1
* @return string Label html markup
*/
public function label() {
if ( ! $this->args( 'name' ) ) {
return '';
}
$style = ! $this->args( 'show_names' ) ? ' style="display:none;"' : '';
return sprintf( "\n" . '<label%1$s for="%2$s">%3$s</label>' . "\n", $style, $this->id(), $this->args( 'name' ) );
}
/**
* Defines the classes for the current CMB2 field row
*
* @since 2.0.0
* @return string Space concatenated list of classes
*/
public function row_classes() {
$classes = array();
/**
* By default, 'text_url' and 'text' fields get table-like styling
*
* @since 2.0.0
*
* @param array $field_types The types of fields which should get the 'table-layout' class
*/
$repeat_table_rows_types = apply_filters( 'cmb2_repeat_table_row_types', array(
'text_url', 'text',
) );
$conditional_classes = array(
'cmb-type-' . str_replace( '_', '-', sanitize_html_class( $this->type() ) ) => true,
'cmb2-id-' . str_replace( '_', '-', sanitize_html_class( $this->id() ) ) => true,
'cmb-repeat' => $this->args( 'repeatable' ),
'cmb-repeat-group-field' => $this->group,
'cmb-inline' => $this->args( 'inline' ),
'table-layout' => in_array( $this->type(), $repeat_table_rows_types ),
);
foreach ( $conditional_classes as $class => $condition ) {
if ( $condition ) {
$classes[] = $class;
}
}
if ( $added_classes = $this->get_param_callback_result( 'row_classes', false ) ) {
$added_classes = is_array( $added_classes ) ? implode( ' ', $added_classes ) : (string) $added_classes;
}
if ( $added_classes ) {
$classes[] = esc_attr( $added_classes );
}
/**
* Globally filter row classes
*
* @since 2.0.0
*
* @param string $classes Space-separated list of row classes
* @param CMB2_Field object $field This field object
*/
return apply_filters( 'cmb2_row_classes', implode( ' ', $classes ), $this );
}
/**
* Determine whether this field should show, based on the 'show_on_cb' callback.
*
* @since 2.0.9
*
* @return bool Whether the field should be shown.
*/
public function should_show() {
// Default to showing the field
$show = true;
// Use the callback to determine showing the field, if it exists
if ( is_callable( $this->args( 'show_on_cb' ) ) ) {
$show = call_user_func( $this->args( 'show_on_cb' ), $this );
}
return $show;
}
/**
* Displays the results of the param callbacks.
*
* @since 2.0.0
* @param string $param Field parameter
*/
public function peform_param_callback( $param ) {
echo $this->get_param_callback_result( $param );
}
/**
* Store results of the param callbacks for continual access
* @since 2.0.0
* @param string $param Field parameter
* @param bool $echo Whether field should be 'echoed'
* @return mixed Results of param/param callback
*/
public function get_param_callback_result( $param, $echo = true ) {
// If we've already retrieved this param's value,
if ( array_key_exists( $param, $this->callback_results ) ) {
// send it back
return $this->callback_results[ $param ];
}
if ( $cb = $this->maybe_callback( $param ) ) {
if ( $echo ) {
// Ok, callback is good, let's run it and store the result
ob_start();
echo call_user_func( $cb, $this->args(), $this );
// grab the result from the output buffer and store it
$this->callback_results[ $param ] = ob_get_contents();
ob_end_clean();
} else {
$this->callback_results[ $param ] = call_user_func( $cb, $this->args(), $this );
}
return $this->callback_results[ $param ];
}
// Otherwise just get whatever is there
$this->callback_results[ $param ] = isset( $this->args[ $param ] ) ? $this->args[ $param ] : false;
return $this->callback_results[ $param ];
}
/**
* Replaces a hash key - {#} - with the repeatable index
* @since 1.2.0
* @param string $value Value to update
* @return string Updated value
*/
public function replace_hash( $value ) {
// Replace hash with 1 based count
return str_ireplace( '{#}', ( $this->index + 1 ), $value );
}
/**
* Retrieve options args. Calls options_cb if it exists.
* @since 2.0.0
* @param string $key Specific option to retrieve
* @return array Array of options
*/
public function options( $key = '' ) {
if ( ! empty( $this->field_options ) ) {
if ( $key ) {
return array_key_exists( $key, $this->field_options ) ? $this->field_options[ $key ] : false;
}
return $this->field_options;
}
$this->field_options = (array) $this->args['options'];
if ( is_callable( $this->args['options_cb'] ) ) {
$options = call_user_func( $this->args['options_cb'], $this );
if ( $options && is_array( $options ) ) {
$this->field_options += $options;
}
}
if ( $key ) {
return array_key_exists( $key, $this->field_options ) ? $this->field_options[ $key ] : false;
}
return $this->field_options;
}
/**
* Fills in empty field parameters with defaults
* @since 1.1.0
* @param array $args Metabox field config array
*/
public function _set_field_defaults( $args ) {
// Set up blank or default values for empty ones
$args = wp_parse_args( $args, array(
'type' => '',
'name' => '',
'desc' => '',
'before' => '',
'after' => '',
'options_cb' => '',
'options' => array(),
'attributes' => array(),
'protocols' => null,
'default' => null,
'select_all_button' => true,
'multiple' => false,
'repeatable' => isset( $args['type'] ) && 'group' == $args['type'],
'inline' => false,
'on_front' => true,
'show_names' => true,
'date_format' => 'm\/d\/Y',
'time_format' => 'h:i A',
'description' => isset( $args['desc'] ) ? $args['desc'] : '',
'preview_size' => 'file' == $args['type'] ? array( 350, 350 ) : array( 50, 50 ),
'render_row_cb' => array( $this, 'render_field_callback' ),
'label_cb' => 'title' != $args['type'] ? array( $this, 'label' ) : '',
) );
// Allow a filter override of the default value
$args['default'] = apply_filters( 'cmb2_default_filter', $args['default'], $this );
$args['repeatable'] = $args['repeatable'] && ! $this->repeatable_exception( $args['type'] );
$args['inline'] = $args['inline'] || false !== stripos( $args['type'], '_inline' );
// options param can be passed a callback as well
if ( is_callable( $args['options'] ) ) {
$args['options_cb'] = $args['options'];
$args['options'] = array();
}
$args['options'] = 'group' == $args['type'] ? wp_parse_args( $args['options'], array(
'add_button' => __( 'Add Group', 'cmb2' ),
'remove_button' => __( 'Remove Group', 'cmb2' ),
) ) : $args['options'];
$args['_id'] = $args['id'];
$args['_name'] = $args['id'];
if ( $this->group ) {
$args['id'] = $this->group->args( 'id' ) . '_' . $this->group->index . '_' . $args['id'];
$args['_name'] = $this->group->args( 'id' ) . '[' . $this->group->index . '][' . $args['_name'] . ']';
}
if ( 'wysiwyg' == $args['type'] ) {
$args['id'] = strtolower( str_ireplace( '-', '_', $args['id'] ) );
$args['options']['textarea_name'] = $args['_name'];
}
$option_types = apply_filters( 'cmb2_all_or_nothing_types', array( 'select', 'radio', 'radio_inline', 'taxonomy_select', 'taxonomy_radio', 'taxonomy_radio_inline' ), $this );
if ( in_array( $args['type'], $option_types, true ) ) {
$args['show_option_none'] = isset( $args['show_option_none'] ) ? $args['show_option_none'] : null;
$args['show_option_none'] = true === $args['show_option_none'] ? __( 'None', 'cmb2' ) : $args['show_option_none'];
if ( null === $args['show_option_none'] ) {
$off_by_default = in_array( $args['type'], array( 'select', 'radio', 'radio_inline' ), true );
$args['show_option_none'] = $off_by_default ? false : __( 'None', 'cmb2' );
}
}
$args['has_supporting_data'] = in_array(
$args['type'],
array(
// CMB2_Sanitize::_save_file_id_value()/CMB2_Sanitize::_get_group_file_value_array()
'file',
// See CMB2_Sanitize::_save_utc_value()
'text_datetime_timestamp_timezone',
),
true
);
return $args;
}
/**
* Updates attributes array values unless they exist from the field config array
* @since 1.1.0
* @param array $attrs Array of attributes to update
*/
public function maybe_set_attributes( $attrs = array() ) {
return wp_parse_args( $this->args['attributes'], $attrs );
}
}