name = 'taxonomy';
$this->label = __("Taxonomy",'acf');
$this->category = __("Relational",'acf');
$this->defaults = array(
'taxonomy' => 'category',
'field_type' => 'checkbox',
'allow_null' => 0,
'load_save_terms' => 0,
'multiple' => 0,
'return_format' => 'id'
);
// do not delete!
parent::__construct();
}
/*
* get_terms
*
* This function will return an array of terms for a given field value
*
* @type function
* @date 13/06/2014
* @since 5.0.0
*
* @param $value (array)
* @return $value
*/
function get_terms( $value, $taxonomy = 'category' ) {
// load terms in 1 query to save multiple DB calls from following code
if( count($value) > 1 ) {
$terms = get_terms($taxonomy, array(
'hide_empty' => false,
'include' => $value,
));
}
// update value to include $post
foreach( array_keys($value) as $i ) {
$value[ $i ] = get_term( $value[ $i ], $taxonomy );
}
// filter out null values
$value = array_filter($value);
// return
return $value;
}
/*
* load_value()
*
* This filter is appied to the $value after it is loaded from the db
*
* @type filter
* @since 3.6
* @date 23/01/13
*
* @param $value - the value found in the database
* @param $post_id - the $post_id from which the value was loaded from
* @param $field - the field array holding all the field options
*
* @return $value - the value to be saved in te database
*/
function load_value( $value, $post_id, $field ) {
// get valid terms
$value = acf_get_valid_terms($value, $field['taxonomy']);
// load/save
if( $field['load_save_terms'] ) {
// bail early if no value
if( empty($value) ) {
return $value;
}
// get current ID's
$term_ids = wp_get_object_terms($post_id, $field['taxonomy'], array('fields' => 'ids', 'orderby' => 'none'));
// case
if( empty($term_ids) ) {
// 1. no terms for this post
return null;
} elseif( is_array($value) ) {
// 2. remove metadata terms which are no longer for this post
$value = array_map('intval', $value);
$value = array_intersect( $value, $term_ids );
} elseif( !in_array($value, $term_ids)) {
// 3. term is no longer for this post
return null;
}
}
// return
return $value;
}
/*
* 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 ) {
// vars
if( is_array($value) ) {
$value = array_filter($value);
}
// load_save_terms
if( $field['load_save_terms'] ) {
// vars
$taxonomy = $field['taxonomy'];
// force value to array
$term_ids = acf_force_type_array( $value );
// convert to int
$term_ids = array_map('intval', $term_ids);
// bypass $this->set_terms if called directly from update_field
if( !did_action('acf/save_post') ) {
wp_set_object_terms( $post_id, $term_ids, $taxonomy, false );
return $value;
}
// initialize
if( empty($this->set_terms) ) {
// create holder
$this->set_terms = array();
// add action
add_action('acf/save_post', array($this, 'set_terms'), 15, 1);
}
// append
if( empty($this->set_terms[ $taxonomy ]) ) {
$this->set_terms[ $taxonomy ] = array();
}
$this->set_terms[ $taxonomy ] = array_merge($this->set_terms[ $taxonomy ], $term_ids);
}
// return
return $value;
}
/*
* set_terms
*
* description
*
* @type function
* @date 26/11/2014
* @since 5.0.9
*
* @param $post_id (int)
* @return $post_id (int)
*/
function set_terms( $post_id ) {
// bail ealry if no terms
if( empty($this->set_terms) ) {
return;
}
// loop over terms
foreach( $this->set_terms as $taxonomy => $term_ids ){
wp_set_object_terms( $post_id, $term_ids, $taxonomy, false );
}
// reset array ( WP saves twice )
$this->set_terms = array();
}
/*
* format_value_for_api()
*
* This filter is appied to the $value after it is loaded from the db and before it is passed back to the api functions such as the_field
*
* @type filter
* @since 3.6
* @date 23/01/13
*
* @param $value - the value which was loaded from the database
* @param $post_id - the $post_id from which the value was loaded
* @param $field - the field array holding all the field options
*
* @return $value - the modified value
*/
function format_value_for_api( $value, $post_id, $field ) {
// bail early if no value
if( empty($value) ) {
return $value;
}
// force value to array
$value = acf_force_type_array( $value );
// convert values to int
$value = array_map('intval', $value);
// load posts if needed
if( $field['return_format'] == 'object' ) {
// get posts
$value = $this->get_terms( $value, $field["taxonomy"] );
}
// convert back from array if neccessary
if( $field['field_type'] == 'select' || $field['field_type'] == 'radio' ) {
$value = array_shift($value);
}
// return
return $value;
}
/*
* create_field()
*
* Create the HTML interface for your field
*
* @type action
* @since 3.6
* @date 23/01/13
*
* @param $field - an array holding all the field's data
*/
function create_field( $field )
{
// vars
$single_name = $field['name'];
// multi select?
if( $field['field_type'] == 'multi_select' )
{
$field['multiple'] = 1;
$field['field_type'] = 'select';
$field['name'] .= '[]';
}
elseif( $field['field_type'] == 'checkbox' )
{
$field['name'] .= '[]';
}
// value must be array!
if( !is_array($field['value']) )
{
$field['value'] = array( $field['value'] );
}
// vars
$args = array(
'taxonomy' => $field['taxonomy'],
'hide_empty' => false,
'style' => 'none',
'walker' => new acf_taxonomy_field_walker( $field ),
);
$args = apply_filters('acf/fields/taxonomy/wp_list_categories', $args, $field );
?>
'true_false',
'name' => 'fields['.$key.'][load_save_terms]',
'value' => $field['load_save_terms'],
'message' => __("Load value based on the post's terms and update the post's terms on save",'acf')
));
?>