<?php /* * ACF Repeater Field Class * * All the logic for this field type * * @class acf_field_repeater * @extends acf_field * @package ACF * @subpackage Fields */ if( ! class_exists('acf_field_repeater') ) : class acf_field_repeater extends acf_field { /* * __construct * * This function will setup the field type data * * @type function * @date 5/03/2014 * @since 5.0.0 * * @param n/a * @return n/a */ function __construct() { // vars $this->name = 'repeater'; $this->label = __("Repeater",'acf'); $this->category = 'layout'; $this->defaults = array( 'sub_fields' => array(), 'min' => 0, 'max' => 0, 'layout' => 'table', 'button_label' => '', 'collapsed' => '' ); $this->l10n = array( 'min' => __("Minimum rows reached ({min} rows)",'acf'), 'max' => __("Maximum rows reached ({max} rows)",'acf'), ); // field filters $this->add_field_filter('acf/get_sub_field', array($this, 'get_sub_field'), 10, 3); $this->add_field_filter('acf/prepare_field_for_export', array($this, 'prepare_field_for_export')); $this->add_field_filter('acf/prepare_field_for_import', array($this, 'prepare_field_for_import')); // filters $this->add_filter('acf/validate_field', array($this, 'validate_any_field')); // do not delete! parent::__construct(); } /* * load_field() * * This filter is appied to the $field after it is loaded from the database * * @type filter * @since 3.6 * @date 23/01/13 * * @param $field - the field array holding all the field options * * @return $field - the field array holding all the field options */ function load_field( $field ) { // min/max $field['min'] = (int) $field['min']; $field['max'] = (int) $field['max']; // vars $sub_fields = acf_get_fields( $field ); // append if( $sub_fields ) { $field['sub_fields'] = $sub_fields; } // return return $field; } /* * get_sub_field * * This function will return a specific sub field * * @type function * @date 29/09/2016 * @since 5.4.0 * * @param $sub_field * @param $selector (string) * @param $field (array) * @return $post_id (int) */ function get_sub_field( $sub_field, $selector, $field ) { // bail early if no sub fields if( empty($field['sub_fields']) ) return false; // loop foreach( $field['sub_fields'] as $sub_field ) { // check name and key if( $sub_field['name'] == $selector || $sub_field['key'] == $selector ) { // return return $sub_field; } } // return return false; } /* * render_field() * * Create the HTML interface for your field * * @param $field - an array holding all the field's data * * @type action * @since 3.6 * @date 23/01/13 */ function render_field( $field ) { // vars $sub_fields = $field['sub_fields']; $show_order = true; $show_add = true; $show_remove = true; // bail early if no sub fields if( empty($sub_fields) ) return; // value $value = is_array($field['value']) ? $field['value'] : array(); // div $div = array( 'class' => 'acf-repeater', 'data-min' => $field['min'], 'data-max' => $field['max'] ); // empty if( empty($value) ) { $div['class'] .= ' -empty'; } // If there are less values than min, populate the extra values if( $field['min'] ) { $value = array_pad($value, $field['min'], array()); } // If there are more values than man, remove some values if( $field['max'] ) { $value = array_slice($value, 0, $field['max']); // if max 1 row, don't show order if( $field['max'] == 1 ) { $show_order = false; } // if max == min, don't show add or remove buttons if( $field['max'] <= $field['min'] ) { $show_remove = false; $show_add = false; } } // setup values for row clone $value['acfcloneindex'] = array(); // button label if( $field['button_label'] === '' ) $field['button_label'] = __('Add Row', 'acf'); // field wrap $el = 'td'; $before_fields = ''; $after_fields = ''; if( $field['layout'] == 'row' ) { $el = 'div'; $before_fields = '<td class="acf-fields -left">'; $after_fields = '</td>'; } elseif( $field['layout'] == 'block' ) { $el = 'div'; $before_fields = '<td class="acf-fields">'; $after_fields = '</td>'; } // layout $div['class'] .= ' -' . $field['layout']; // hidden input acf_hidden_input(array( 'type' => 'hidden', 'name' => $field['name'], )); // collapsed if( $field['collapsed'] ) { // add target class foreach( $sub_fields as $i => $sub_field ) { // bail early if no match if( $sub_field['key'] !== $field['collapsed'] ) continue; // class $sub_field['wrapper']['class'] .= ' -collapsed-target'; // update $sub_fields[ $i ] = $sub_field; } } ?> <div <?php acf_esc_attr_e($div); ?>> <table class="acf-table"> <?php if( $field['layout'] == 'table' ): ?> <thead> <tr> <?php if( $show_order ): ?> <th class="acf-row-handle"></th> <?php endif; ?> <?php foreach( $sub_fields as $sub_field ): // prepare field (allow sub fields to be removed) $sub_field = acf_prepare_field($sub_field); // bail ealry if no field if( !$sub_field ) continue; // vars $atts = array(); $atts['class'] = 'acf-th'; $atts['data-name'] = $sub_field['_name']; $atts['data-type'] = $sub_field['type']; $atts['data-key'] = $sub_field['key']; // Add custom width if( $sub_field['wrapper']['width'] ) { $atts['data-width'] = $sub_field['wrapper']['width']; $atts['style'] = 'width: ' . $sub_field['wrapper']['width'] . '%;'; } ?> <th <?php echo acf_esc_attr( $atts ); ?>> <?php echo acf_get_field_label( $sub_field ); ?> <?php if( $sub_field['instructions'] ): ?> <p class="description"><?php echo $sub_field['instructions']; ?></p> <?php endif; ?> </th> <?php endforeach; ?> <?php if( $show_remove ): ?> <th class="acf-row-handle"></th> <?php endif; ?> </tr> </thead> <?php endif; ?> <tbody> <?php foreach( $value as $i => $row ): $row_class = 'acf-row'; if( $i === 'acfcloneindex' ) { $row_class .= ' acf-clone'; } elseif( acf_is_row_collapsed($field['key'], $i) ) { $row_class .= ' -collapsed'; } ?> <tr class="<?php echo $row_class; ?>" data-id="<?php echo $i; ?>"> <?php if( $show_order ): ?> <td class="acf-row-handle order" title="<?php _e('Drag to reorder','acf'); ?>"> <?php if( $field['collapsed'] ): ?> <a class="acf-icon -collapse small" href="#" data-event="collapse-row" title="<?php _e('Click to toggle','acf'); ?>"></a> <?php endif; ?> <span><?php echo intval($i) + 1; ?></span> </td> <?php endif; ?> <?php echo $before_fields; ?> <?php foreach( $sub_fields as $sub_field ): // prevent repeater field from creating multiple conditional logic items for each row if( $i !== 'acfcloneindex' ) { $sub_field['conditional_logic'] = 0; } // add value if( isset($row[ $sub_field['key'] ]) ) { // this is a normal value $sub_field['value'] = $row[ $sub_field['key'] ]; } elseif( isset($sub_field['default_value']) ) { // no value, but this sub field has a default value $sub_field['value'] = $sub_field['default_value']; } // update prefix to allow for nested values $sub_field['prefix'] = $field['name'] . '[' . $i . ']'; // render input acf_render_field_wrap( $sub_field, $el ); ?> <?php endforeach; ?> <?php echo $after_fields; ?> <?php if( $show_remove ): ?> <td class="acf-row-handle remove"> <a class="acf-icon -plus small" href="#" data-event="add-row" title="<?php _e('Add row','acf'); ?>"></a> <a class="acf-icon -minus small" href="#" data-event="remove-row" title="<?php _e('Remove row','acf'); ?>"></a> </td> <?php endif; ?> </tr> <?php endforeach; ?> </tbody> </table> <?php if( $show_add ): ?> <ul class="acf-actions acf-hl"> <li> <a class="acf-button button button-primary" href="#" data-event="add-row"><?php echo $field['button_label']; ?></a> </li> </ul> <?php endif; ?> </div> <?php } /* * render_field_settings() * * Create extra options for your field. This is rendered when editing a field. * The value of $field['name'] can be used (like bellow) to save extra data to the $field * * @type action * @since 3.6 * @date 23/01/13 * * @param $field - an array holding all the field's data */ function render_field_settings( $field ) { // vars $args = array( 'fields' => $field['sub_fields'], 'parent' => $field['ID'] ); ?><tr class="acf-field acf-field-setting-sub_fields" data-setting="repeater" data-name="sub_fields"> <td class="acf-label"> <label><?php _e("Sub Fields",'acf'); ?></label> <p class="description"></p> </td> <td class="acf-input"> <?php acf_get_view('field-group-fields', $args); ?> </td> </tr> <?php // rows $field['min'] = empty($field['min']) ? '' : $field['min']; $field['max'] = empty($field['max']) ? '' : $field['max']; // preview $choices = array(); if( $field['collapsed'] ) { $choices[ $field['collapsed'] ] = $field['collapsed']; } acf_render_field_setting( $field, array( 'label' => __('Collapsed','acf'), 'instructions' => __('Select a sub field to show when row is collapsed','acf'), 'type' => 'select', 'name' => 'collapsed', 'allow_null' => 1, 'choices' => $choices )); // min acf_render_field_setting( $field, array( 'label' => __('Minimum Rows','acf'), 'instructions' => '', 'type' => 'number', 'name' => 'min', 'placeholder' => '0', )); // max acf_render_field_setting( $field, array( 'label' => __('Maximum Rows','acf'), 'instructions' => '', 'type' => 'number', 'name' => 'max', 'placeholder' => '0', )); // layout acf_render_field_setting( $field, array( 'label' => __('Layout','acf'), 'instructions' => '', 'class' => 'acf-repeater-layout', 'type' => 'radio', 'name' => 'layout', 'layout' => 'horizontal', 'choices' => array( 'table' => __('Table','acf'), 'block' => __('Block','acf'), 'row' => __('Row','acf') ) )); // button_label acf_render_field_setting( $field, array( 'label' => __('Button Label','acf'), 'instructions' => '', 'type' => 'text', 'name' => 'button_label', 'placeholder' => __('Add Row','acf') )); } /* * load_value() * * This filter is applied to the $value after it is loaded from the db * * @type filter * @since 3.6 * @date 23/01/13 * * @param $value (mixed) the value found in the database * @param $post_id (mixed) the $post_id from which the value was loaded * @param $field (array) the field array holding all the field options * @return $value */ function load_value( $value, $post_id, $field ) { // bail early if no value if( empty($value) ) return false; // bail ealry if not numeric if( !is_numeric($value) ) return false; // bail early if no sub fields if( empty($field['sub_fields']) ) return false; // vars $value = intval($value); $rows = array(); // loop for( $i = 0; $i < $value; $i++ ) { // create empty array $rows[ $i ] = array(); // loop through sub fields foreach( array_keys($field['sub_fields']) as $j ) { // get sub field $sub_field = $field['sub_fields'][ $j ]; // bail ealry if no name (tab) if( acf_is_empty($sub_field['name']) ) continue; // update $sub_field name $sub_field['name'] = "{$field['name']}_{$i}_{$sub_field['name']}"; // get value $sub_value = acf_get_value( $post_id, $sub_field ); // add value $rows[ $i ][ $sub_field['key'] ] = $sub_value; } } // return return $rows; } /* * format_value() * * This filter is appied to the $value after it is loaded from the db and before it is returned to the template * * @type filter * @since 3.6 * @date 23/01/13 * * @param $value (mixed) the value which was loaded from the database * @param $post_id (mixed) the $post_id from which the value was loaded * @param $field (array) the field array holding all the field options * * @return $value (mixed) the modified value */ function format_value( $value, $post_id, $field ) { // bail early if no value if( empty($value) ) return false; // bail ealry if not array if( !is_array($value) ) return false; // bail early if no sub fields if( empty($field['sub_fields']) ) return false; // loop over rows foreach( array_keys($value) as $i ) { // loop through sub fields foreach( array_keys($field['sub_fields']) as $j ) { // get sub field $sub_field = $field['sub_fields'][ $j ]; // bail ealry if no name (tab) if( acf_is_empty($sub_field['name']) ) continue; // extract value $sub_value = acf_extract_var( $value[ $i ], $sub_field['key'] ); // update $sub_field name $sub_field['name'] = "{$field['name']}_{$i}_{$sub_field['name']}"; // format value $sub_value = acf_format_value( $sub_value, $post_id, $sub_field ); // append to $row $value[ $i ][ $sub_field['_name'] ] = $sub_value; } } // return return $value; } /* * validate_value * * description * * @type function * @date 11/02/2014 * @since 5.0.0 * * @param $post_id (int) * @return $post_id (int) */ function validate_value( $valid, $value, $field, $input ){ // remove acfcloneindex if( isset($value['acfcloneindex']) ) { unset($value['acfcloneindex']); } // valid if( $field['required'] && empty($value) ) { $valid = false; } // check sub fields if( !empty($field['sub_fields']) && !empty($value) ) { $keys = array_keys($value); foreach( $keys as $i ) { foreach( $field['sub_fields'] as $sub_field ) { // vars $k = $sub_field['key']; // test sub field exists if( !isset($value[ $i ][ $k ]) ) { continue; } // validate acf_validate_value( $value[ $i ][ $k ], $sub_field, "{$input}[{$i}][{$k}]" ); } } } return $valid; } /* * update_row * * This function will update a value row * * @type function * @date 15/2/17 * @since 5.5.8 * * @param $i (int) * @param $field (array) * @param $post_id (mixed) * @return (boolean) */ function update_row( $row, $i = 0, $field, $post_id ) { // bail early if no layout reference if( !is_array($row) ) return false; // bail early if no layout if( empty($field['sub_fields']) ) return false; // loop foreach( $field['sub_fields'] as $sub_field ) { // value $value = null; // find value (key) if( isset($row[ $sub_field['key'] ]) ) { $value = $row[ $sub_field['key'] ]; // find value (name) } elseif( isset($row[ $sub_field['name'] ]) ) { $value = $row[ $sub_field['name'] ]; // value does not exist } else { continue; } // modify name for save $sub_field['name'] = "{$field['name']}_{$i}_{$sub_field['name']}"; // update field acf_update_value( $value, $post_id, $sub_field ); } // return return true; } /* * delete_row * * This function will delete a value row * * @type function * @date 15/2/17 * @since 5.5.8 * * @param $i (int) * @param $field (array) * @param $post_id (mixed) * @return (boolean) */ function delete_row( $i = 0, $field, $post_id ) { // bail early if no sub fields if( empty($field['sub_fields']) ) return false; // loop foreach( $field['sub_fields'] as $sub_field ) { // modify name for delete $sub_field['name'] = "{$field['name']}_{$i}_{$sub_field['name']}"; // delete value acf_delete_value( $post_id, $sub_field ); } // return return true; } /* * update_value() * * This filter is appied to the $value before it is updated in the db * * @type filter * @since 3.6 * @date 23/01/13 * * @param $value - the value which will be saved in the database * @param $field - the field array holding all the field options * @param $post_id - the $post_id of which the value will be saved * * @return $value - the modified value */ function update_value( $value, $post_id, $field ) { // bail early if no sub fields if( empty($field['sub_fields']) ) return $value; // vars $new_value = 0; $old_value = (int) acf_get_metadata( $post_id, $field['name'] ); // update sub fields if( !empty($value) ) { $i = -1; // remove acfcloneindex if( isset($value['acfcloneindex']) ) { unset($value['acfcloneindex']); } // loop through rows foreach( $value as $row ) { $i++; // bail early if no row if( !is_array($row) ) continue; // update row $this->update_row( $row, $i, $field, $post_id ); // append $new_value++; } } // remove old rows if( $old_value > $new_value ) { // loop for( $i = $new_value; $i < $old_value; $i++ ) { $this->delete_row( $i, $field, $post_id ); } } // save false for empty value if( empty($new_value) ) $new_value = ''; // return return $new_value; } /* * delete_value * * description * * @type function * @date 1/07/2015 * @since 5.2.3 * * @param $post_id (int) * @return $post_id (int) */ function delete_value( $post_id, $key, $field ) { // get old value (db only) $old_value = (int) acf_get_metadata( $post_id, $field['name'] ); // bail early if no rows or no sub fields if( !$old_value || empty($field['sub_fields']) ) return; // loop for( $i = 0; $i < $old_value; $i++ ) { $this->delete_row( $i, $field, $post_id ); } } /* * delete_field * * description * * @type function * @date 4/04/2014 * @since 5.0.0 * * @param $post_id (int) * @return $post_id (int) */ function delete_field( $field ) { // bail early if no sub fields if( empty($field['sub_fields']) ) return; // loop through sub fields foreach( $field['sub_fields'] as $sub_field ) { acf_delete_field( $sub_field['ID'] ); } } /* * update_field() * * This filter is appied to the $field before it is saved to the database * * @type filter * @since 3.6 * @date 23/01/13 * * @param $field - the field array holding all the field options * @param $post_id - the field group ID (post_type = acf) * * @return $field - the modified field */ function update_field( $field ) { // remove sub fields unset($field['sub_fields']); // return return $field; } /* * duplicate_field() * * This filter is appied to the $field before it is duplicated and saved to the database * * @type filter * @since 3.6 * @date 23/01/13 * * @param $field - the field array holding all the field options * * @return $field - the modified field */ function duplicate_field( $field ) { // get sub fields $sub_fields = acf_extract_var( $field, 'sub_fields' ); // save field to get ID $field = acf_update_field( $field ); // duplicate sub fields acf_duplicate_fields( $sub_fields, $field['ID'] ); // return return $field; } /* * translate_field * * This function will translate field settings * * @type function * @date 8/03/2016 * @since 5.3.2 * * @param $field (array) * @return $field */ function translate_field( $field ) { // translate $field['button_label'] = acf_translate( $field['button_label'] ); // return return $field; } /* * prepare_field_for_export * * description * * @type function * @date 11/03/2014 * @since 5.0.0 * * @param $post_id (int) * @return $post_id (int) */ function prepare_field_for_export( $field ) { // bail early if no layouts if( empty($field['sub_fields']) ) return $field; // prepare $field['sub_fields'] = acf_prepare_fields_for_export( $field['sub_fields'] ); // return return $field; } /* * prepare_field_for_import * * description * * @type function * @date 11/03/2014 * @since 5.0.0 * * @param $post_id (int) * @return $post_id (int) */ function prepare_field_for_import( $field ) { // bail early if no layouts if( empty($field['sub_fields']) ) return $field; // var $extra = array(); // extract sub fields $sub_fields = acf_extract_var( $field, 'sub_fields'); // reset field setting $field['sub_fields'] = array(); // loop foreach( array_keys($sub_fields) as $i ) { // extract sub field $sub_field = acf_extract_var( $sub_fields, $i ); // attributes $sub_field['parent'] = $field['key']; // append to extra $extra[] = $sub_field; } // extra if( !empty($extra) ) { array_unshift($extra, $field); return $extra; } // return return $field; } /* * validate_any_field * * This function will add compatibility for the 'column_width' setting * * @type function * @date 30/1/17 * @since 5.5.6 * * @param $field (array) * @return $field */ function validate_any_field( $field ) { // width has changed if( isset($field['column_width']) ) { $field['wrapper']['width'] = acf_extract_var($field, 'column_width'); } // return return $field; } } // initialize acf_register_field_type( new acf_field_repeater() ); endif; // class_exists check ?>