name = 'related_terms'; $this->label = __( 'Related Terms', 'frontend-admin' ); $this->category = 'relational'; $this->defaults = array( 'taxonomy' => 'category', 'field_type' => 'checkbox', 'hierarchical' => 0, 'multiple' => 0, 'allow_null' => 0, 'return_format' => 'id', 'add_term' => 1, 'save_terms' => 0, ); acf_add_filter_variations( 'acf/fields/related_terms/query', array( 'name', 'key' ), 1 ); acf_add_filter_variations( 'acf/fields/related_terms/result', array( 'name', 'key' ), 2 ); // ajax add_action( 'wp_ajax_acf/fields/related_terms/query', array( $this, 'ajax_query' ) ); add_action( 'wp_ajax_nopriv_acf/fields/related_terms/query', array( $this, 'ajax_query' ) ); add_action( 'wp_ajax_acf/fields/related_terms/add_term', array( $this, 'ajax_add_term' ) ); // actions add_filter( 'frontend_admin/prepare_field/type=taxonomy', array( $this, 'load_taxonomy_field' ) ); add_filter( 'acf/load_value/type=taxonomy', array( $this, 'load_value' ), 12, 3 ); //add default terms option to taxonomy field add_filter( 'acf/render_field_settings/type=taxonomy', array( $this, 'add_default_value' ) ); } function load_taxonomy_field( $field ) { $field['type'] = 'related_terms'; if ( ! empty( $field['load_terms'] ) ) { $field['load_post_terms'] = 1; $field['load_terms'] = 0; } if( !empty( $field['default_terms'] ) && empty( $field['default_value'] ) ){ //convert default_terms to default_value $field['default_value'] = $field['default_terms']; } return $field; } /* * ajax_query * * description * * @type function * @date 24/10/13 * @since 5.0.0 * * @param $post_id (int) * @return $post_id (int) */ function ajax_query() { $field_key = $_POST['field_key'] ?? ''; $nonce = $_POST['nonce'] ?? ''; $action = 'acf_field_' . $this->name . '_' . $field_key; // validate if ( ! feadmin_verify_ajax( $nonce, $action ) ) { die(); } // get choices $response = $this->get_ajax_query( $_POST ); // return acf_send_ajax_results( $response ); } /* * get_ajax_query * * This function will return an array of data formatted for use in a select2 AJAX response * * @type function * @date 15/10/2014 * @since 5.0.9 * * @param $options (array) * @return (array) */ function get_ajax_query( $options = array() ) { // defaults $options = acf_parse_args( $options, array( 'post_id' => 0, 's' => '', 'field_key' => '', 'taxonomy' => '', 'paged' => 0, ) ); // bail early if taxonomy does not exist if ( ! taxonomy_exists( $options['taxonomy'] ) ) { return false; } // vars $results = array(); $is_hierarchical = is_taxonomy_hierarchical( $options['taxonomy'] ); $is_pagination = ( $options['paged'] > 0 ); $is_search = false; $limit = 20; $offset = 20 * ( $options['paged'] - 1 ); // args $args = array( 'taxonomy' => $options['taxonomy'], 'hide_empty' => false, ); // pagination // - don't bother for hierarchial terms, we will need to load all terms anyway if ( $is_pagination && ! $is_hierarchical ) { $args['number'] = $limit; $args['offset'] = $offset; } // search if ( $options['s'] !== '' ) { // strip slashes (search may be integer) $s = wp_unslash( strval( $options['s'] ) ); // update vars $args['search'] = $s; $is_search = true; } $field = fea_instance()->frontend->get_field( $options['field_key'] ); if ( $field ) { $args = apply_filters( 'acf/fields/related_terms/query', $args, $field, $options['post_id'] ); } // get terms $terms = acf_get_terms( $args ); // sort into hierachial order! if ( $is_hierarchical ) { // update vars $limit = acf_maybe_get( $args, 'number', $limit ); $offset = acf_maybe_get( $args, 'offset', $offset ); // get parent $parent = acf_maybe_get( $args, 'parent', 0 ); $parent = acf_maybe_get( $args, 'child_of', $parent ); // this will fail if a search has taken place because parents wont exist if ( ! $is_search ) { // order terms $ordered_terms = _get_term_children( $parent, $terms, $options['taxonomy'] ); // check for empty array (possible if parent did not exist within original data) if ( ! empty( $ordered_terms ) ) { $terms = $ordered_terms; } } // fake pagination if ( $is_pagination ) { $terms = array_slice( $terms, $offset, $limit ); } } // append to r foreach ( $terms as $term ) { // add to json $results[] = array( 'id' => $term->term_id, 'text' => $this->get_term_title( $term, $options['taxonomy'], $options['post_id'], $field ), ); } // vars $response = array( 'results' => $results, 'limit' => $limit, ); // return return $response; } /* * get_term_title * * This function returns the HTML for a result * * @type function * @date 1/11/2013 * @since 5.0.0 * * @param $post (object) * @param $taxonomy (string)) * @param $post_id (int) the post_id to which this value is saved to * @return (string) */ function get_term_title( $term, $taxonomy, $post_id = 0, $field = false, $unescape = false ) { // get post_id if ( ! $post_id ) { $post_id = acf_get_form_data( 'post_id' ); } // vars $title = ''; // ancestors $ancestors = get_ancestors( $term->term_id, $taxonomy ); if ( ! empty( $ancestors ) ) { $title .= str_repeat( '- ', count( $ancestors ) ); } // title $title .= $term->name; // unescape for select2 output which handles the escaping. if ( ! $unescape ) { $title = html_entity_decode( $title ); } if ( $field ) { // return $title = apply_filters( 'acf/fields/related_terms/result', $title, $term, $field, $post_id ); } return $title; } /* * 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 = acf_get_terms( array( 'taxonomy' => $taxonomy, 'include' => $value, 'hide_empty' => false, ) ); } // 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'] ); if ( is_numeric( $post_id ) ) { if( empty( $field['load_terms'] ) && empty( $field['load_post_terms'] ) ) return $value; $value = acf_get_valid_terms( $value, $field['taxonomy'] ); // get terms $info = acf_get_post_id_info( $post_id ); $term_ids = wp_get_object_terms( $info['id'], $field['taxonomy'], array( 'fields' => 'ids', 'orderby' => 'none', ) ); // bail early if no terms if ( empty( $term_ids ) || is_wp_error( $term_ids ) ) { return false; } // sort if ( ! empty( $value ) ) { $order = array(); foreach ( $term_ids as $i => $v ) { $order[ $i ] = array_search( $v, $value ); } array_multisort( $order, $term_ids ); } // update value $value = $term_ids; } else { if ( ! empty( $field['default_value'] ) ) { if ( is_array( $field['default_value'] ) ) { return $field['default_value']; } else { //remove spaces $field['default_value'] = str_replace( ' ', '', $field['default_value'] ); return explode( ',', $field['default_value'] ); } } } 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 ); } // save_terms if ( $field['save_terms'] ) { // vars $taxonomy = $field['taxonomy']; // force value to array $term_ids = acf_get_array( $value ); // convert to int $term_ids = array_map( 'intval', $term_ids ); // get existing term id's (from a previously saved field) $old_term_ids = isset( $this->save_post_terms[ $taxonomy ] ) ? $this->save_post_terms[ $taxonomy ] : array(); // append $this->save_post_terms[ $taxonomy ] = array_merge( $old_term_ids, $term_ids ); // if called directly from frontend update_field() $this->save_post( $post_id ); return null; } // return return $value; } /* * save_post * * This function will save any terms in the save_post_terms array * * @type function * @date 26/11/2014 * @since 5.0.9 * * @param $post_id (int) * @return n/a */ function save_post( $post_id ) { // bail ealry if no terms if ( empty( $this->save_post_terms ) ) { return; } // vars $info = acf_get_post_id_info( $post_id ); // loop foreach ( $this->save_post_terms as $taxonomy => $term_ids ) { // save wp_set_object_terms( $info['id'], $term_ids, $taxonomy, false ); } // reset array ( WP saves twice ) $this->save_post_terms = array(); } /* * 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; } // force value to array $value = acf_get_array( $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; } /* * render_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 render_field( $field ) { // force value to array $field['value'] = acf_get_array( $field['value'] ); $field['nonce'] = wp_create_nonce( 'acf_field_' . $this->name . '_' . $field['key'] ); // vars $div = array( 'class' => 'acf-related-terms-field', 'data-save' => $field['save_terms'], 'data-ftype' => $field['field_type'], //'data-hierarchical' => $field['hierarchical'], 'data-taxonomy' => $field['taxonomy'], 'data-allow_null' => $field['allow_null'], ); ?>