args = wp_parse_args( $args, array(
'tax' => 'category',
'priority' => 10,
'builder_cb' => false,
'fields' => array(),
'id' => false,
) );
if ( empty( $this->args['fields'] ) ) {
return;
}
add_action( 'admin_enqueue_scripts', array( $this, 'init_builder' ), 0 );
$priority = intval( $this->args['priority'] );
$tax = esc_attr( $this->args['tax'] );
add_action( "{$tax}_add_form_fields", array( $this, 'render_add_fields' ), $priority );
add_action( "{$tax}_edit_form", array( $this, 'render_edit_fields' ), $priority, 2 );
add_action( "created_{$tax}", array( $this, 'save_meta' ) );
add_action( "edited_{$tax}", array( $this, 'save_meta' ) );
}
/**
* Initialize builder
*
* @return [type] [description]
*/
public function init_builder( $hook ) {
if ( ! in_array( $hook, array( 'edit-tags.php', 'term.php' ) ) ) {
return;
}
$tax = $_GET['taxonomy'];
if ( $tax !== $this->args['tax'] ) {
return;
}
if ( ! isset( $this->args['builder_cb'] ) || ! is_callable( $this->args['builder_cb'] ) ) {
return;
}
$this->builder = call_user_func( $this->args['builder_cb'] );
if ( 'edit-tags.php' === $hook ) {
$term = false;
} else {
$term = get_term( absint( $_GET['tag_ID'] ), $tax );
}
$this->get_fields( $term );
}
/**
* Safely get attribute from field settings array.
*
* @since 1.0.0
* @param array $field arguments array.
* @param string|int|float $arg argument key.
* @param mixed $default default argument value.
* @return mixed
*/
public function get_arg( $field = array(), $arg = '', $default = '' ) {
if ( is_array( $field ) && isset( $field[ $arg ] ) ) {
return $field[ $arg ];
}
return $default;
}
/**
* Get registered control fields
*
* @since 1.0.0
* @param mixed $term Current term object.
* @return void
*/
public function get_fields( $term ) {
$zero_allowed = apply_filters(
'cx_post_meta/zero_allowed_controls',
array(
'stepper',
'slider',
)
);
foreach ( $this->args['fields'] as $key => $field ) {
$default = $this->get_arg( $field, 'value', '' );
$value = $this->get_meta( $term, $key, $default, $field );
if ( isset( $field['options_callback'] ) ) {
$field['options'] = call_user_func( $field['options_callback'] );
}
$value = $this->prepare_field_value( $field, $value );
$element = $this->get_arg( $field, 'element', 'control' );
$field['id'] = $this->get_arg( $field, 'id', $key );
$field['name'] = $this->get_arg( $field, 'name', $key );
$field['type'] = $this->get_arg( $field, 'type', '' );
$field['value'] = $value;
// Fix zero values for stepper and slider
if ( ! $value && in_array( $field['type'], $zero_allowed ) ) {
$field['value'] = 0;
}
$register_callback = 'register_' . $element;
if ( method_exists( $this->builder, $register_callback ) ) {
call_user_func( array( $this->builder, $register_callback ), $field );
}
}
}
/**
* Prepare field value.
*
* @param array $field
* @param mixed $value
*
* @return mixed
*/
public function prepare_field_value( $field, $value ) {
switch ( $field['type'] ) {
case 'repeater':
if ( is_array( $value ) && ! empty( $field['fields'] ) ) {
$repeater_fields = $field['fields'];
foreach ( $value as $item_id => $item_value ) {
foreach ( $item_value as $repeater_field_id => $repeater_field_value ) {
$value[ $item_id ][ $repeater_field_id ] = $this->prepare_field_value( $repeater_fields[ $repeater_field_id ], $repeater_field_value );
}
}
}
break;
case 'checkbox':
if ( ! empty( $field['is_array'] ) && ! empty( $field['options'] ) && ! empty( $value ) ) {
$adjusted = array();
if ( ! is_array( $value ) ) {
$value = array( $value );
}
foreach ( $value as $val ) {
$adjusted[ $val ] = 'true';
}
foreach ( $field['options'] as $opt_val => $opt_label ) {
if ( ! in_array( $opt_val, $value ) ) {
$adjusted[ $opt_val ] = 'false';
}
}
$value = $adjusted;
}
break;
case 'text':
if ( ! empty( $value ) && $this->to_timestamp( $field ) && is_numeric( $value ) ) {
switch ( $field['input_type'] ) {
case 'date':
$value = $this->get_date( 'Y-m-d', $value );
break;
case 'datetime-local':
$value = $this->get_date( 'Y-m-d\TH:i', $value );
break;
}
}
break;
}
return $value;
}
/**
* Returns date converted from timestamp
*
* @return [type] [description]
*/
public function get_date( $format, $time ) {
return apply_filters( 'cx_term_meta/date', date( $format, $time ), $time, $format );
}
/**
* Retrieve post meta field.
*
* @since 1.0.0
*
* @param object $term Current post object.
* @param string $key The meta key to retrieve.
* @param mixed $default Default value.
* @param array $field Meta field appropriate to current key.
* @return string
*/
public function get_meta( $term = null, $key = '', $default = false, $field = array() ) {
if ( ! is_object( $term ) ) {
return $default;
}
$meta = get_term_meta( $term->term_id, $key, false );
return ( empty( $meta ) ) ? $default : $meta[0];
}
/**
* Render add term form fields
*
* @since 1.0.0
* @param [type] $taxonomy taxonomy name.
* @return void
*/
public function render_add_fields( $taxonomy ) {
echo '';
$this->render_fields();
echo '
';
}
/**
* Render edit term form fields
*
* @since 1.0.0
* @param object $term current term object.
* @param [type] $taxonomy taxonomy name.
* @return void
*/
public function render_edit_fields( $term, $taxonomy ) {
echo '| | ';
$this->render_fields();
echo ' |
|---|
';
}
/**
* Render metabox funciton
*
* @since 1.0.0
* @param object $post The post object currently being edited.
* @param array $metabox Specific information about the meta box being loaded.
* @return void
*/
public function render_fields() {
if ( ! $this->builder ) {
return;
}
/**
* Hook fires before metabox output started.
*/
do_action( 'cx_term_meta/meta_box/before', $this->args );
$this->builder->render();
/**
* Hook fires after metabox output finished.
*/
do_action( 'cx_term_meta/meta_box/after', $this->args );
}
/**
* Save additional taxonomy meta on edit or create tax
*
* @since 1.0.0
* @param int $term_id Term ID.
* @return bool
*/
public function save_meta( $term_id ) {
if ( ! current_user_can( 'edit_term', $term_id ) ) {
return false;
}
/**
* Hook on before current metabox saving for all meta boxes
*/
do_action( 'cx_term_meta/before_save', $term_id );
foreach ( $this->args['fields'] as $key => $field ) {
if ( ! isset( $_POST[ $key ] ) ) {
// Specific key will be deleted only on `editedtag` page
if ( ! empty( $_POST['action'] ) && 'editedtag' === $_POST['action'] ) {
/**
* Fires before specific key will be deleted
*/
do_action( 'cx_term_meta/before_delete_meta/' . $key, $term_id, $key, $field );
// Delete all separate fields of repeater.
if ( 'repeater' === $field['type'] && ! empty( $field['save_separate'] ) ) {
$this->delete_repeater_separate_fields( $term_id, $key, $field );
}
update_term_meta( $term_id, $key, false );
}
continue;
}
$new_val = $this->sanitize_meta( $field, $_POST[ $key ] );
/**
* Hook on before current metabox saving with meta box id as dynamic part
*/
do_action( 'cx_term_meta/before_save_meta/' . $key, $term_id, $new_val, $key, $field );
// Save the value of each repeater field as a separate field.
if ( 'repeater' === $field['type'] && ! empty( $field['save_separate'] ) ) {
$this->save_repeater_separate_fields( $term_id, $key, $new_val, $field );
}
update_term_meta( $term_id, $key, $new_val );
}
/**
* Hook on after current metabox saving for all meta boxes
*/
do_action( 'cx_term_meta/after_save', $term_id );
return true;
}
/**
* Is date field
*
* @param array $field Field arguments
* @return boolean
*/
public function to_timestamp( $field ) {
if ( empty( $field['input_type'] ) ) {
return false;
}
if ( empty( $field['is_timestamp'] ) ) {
return false;
}
if ( ! in_array( $field['input_type'], array( 'date', 'datetime-local' ) ) ) {
return false;
}
return ( true === $field['is_timestamp'] );
}
/**
* Sanitize passed meta value
*
* @param array $field Meta field to sanitize.
* @param mixed $value Meta value.
* @return mixed
*/
public function sanitize_meta( $field, $value ) {
if ( 'repeater' === $field['type'] && ! empty( $field['fields'] ) && is_array( $value ) ) {
$repeater_fields = $field['fields'];
foreach ( $value as $item_id => $item_value ) {
foreach ( $item_value as $repeater_field_id => $repeater_field_value ) {
$value[ $item_id ][ $repeater_field_id ] = $this->sanitize_meta( $repeater_fields[ $repeater_field_id ], $repeater_field_value );
}
}
}
if ( 'checkbox' === $field['type'] && ! empty( $field['is_array'] ) ) {
$raw = ! empty( $value ) ? $value : array();
$result = array();
if ( is_array( $raw ) ) {
foreach ( $raw as $raw_key => $raw_value ) {
$bool_value = filter_var( $raw_value, FILTER_VALIDATE_BOOLEAN );
if ( $bool_value ) {
$result[] = $raw_key;
}
}
}
return $result;
}
if ( $this->to_timestamp( $field ) ) {
return apply_filters( 'cx_term_meta/strtotime', strtotime( $value ), $value );
}
if ( ! empty( $field['sanitize_callback'] ) && is_callable( $field['sanitize_callback'] ) ) {
$key = ! empty( $field['name'] ) ? $field['name'] : null;
return call_user_func( $field['sanitize_callback'], $value, $key, $field );
}
return is_array( $value ) ? $value : sanitize_text_field( $value );
}
/**
* Returns the repeater separate field key.
*
* @param $repeater_key
* @param $field_key
*
* @return string
*/
public function get_repeater_separate_field_key( $repeater_key, $field_key ) {
return apply_filters(
'cx_term_meta/repeater/separate_field_key',
$repeater_key . '_' . $field_key,
$repeater_key,
$field_key
);
}
/**
* Delete all separate fields of repeater.
*
* @param $term_id
* @param $key
* @param $field
*/
public function delete_repeater_separate_fields( $term_id, $key, $field ) {
if ( empty( $field['fields'] ) ) {
return;
}
foreach ( $field['fields'] as $repeater_field_key => $repeater_field ) {
delete_term_meta( $term_id, $this->get_repeater_separate_field_key( $key, $repeater_field_key ) );
}
}
/**
* Save the value of each repeater field as a separate field.
*
* @param $term_id
* @param $key
* @param $value
* @param $field
*/
public function save_repeater_separate_fields( $term_id, $key, $value, $field ) {
$this->delete_repeater_separate_fields( $term_id, $key, $field );
if ( empty( $value ) || ! is_array( $value ) ) {
return;
}
foreach ( $value as $repeater_item_value ) {
if ( empty( $repeater_item_value ) ) {
continue;
}
foreach ( $repeater_item_value as $repeater_field_key => $repeater_field_value ) {
add_term_meta(
$term_id,
$this->get_repeater_separate_field_key( $key, $repeater_field_key ),
$repeater_field_value
);
}
}
}
}
}