compatibility
2 years ago
controls
2 years ago
pa-display-conditions
2 years ago
templates
2 years ago
acf-helper.php
2 years ago
addons-cross-cp.php
2 years ago
addons-integration.php
2 years ago
assets-manager.php
2 years ago
class-pa-core.php
2 years ago
class-premium-template-tags.php
2 years ago
helper-functions.php
2 years ago
live-editor-modal.php
2 years ago
module-base.php
2 years ago
pa-nav-menu-walker.php
2 years ago
acf-helper.php
232 lines
| 1 | <?php |
| 2 | /** |
| 3 | * ACF Handler |
| 4 | * |
| 5 | * Contains helper functions for ACF fields. |
| 6 | */ |
| 7 | |
| 8 | namespace PremiumAddons\Includes; |
| 9 | |
| 10 | if ( ! defined( 'ABSPATH' ) ) { |
| 11 | exit; // Exit if accessed directly. |
| 12 | } |
| 13 | |
| 14 | /** |
| 15 | * Class ACF_Helper. |
| 16 | */ |
| 17 | class ACF_Helper { |
| 18 | |
| 19 | /** |
| 20 | * Format Acf Options. |
| 21 | * |
| 22 | * @since 4.4.8 |
| 23 | * @access public |
| 24 | * |
| 25 | * @param array $posts query objects - available custom fields -. |
| 26 | * @param array $options display options. |
| 27 | * |
| 28 | * @return array $results formated control options. |
| 29 | */ |
| 30 | public static function format_acf_query_result( $posts, $options ) { |
| 31 | |
| 32 | $results = array(); |
| 33 | $show_type = $options['show_type']; |
| 34 | $show_field_type = $options['show_field_type']; |
| 35 | $show_group = $options['show_group']; |
| 36 | |
| 37 | foreach ( $posts as $post ) { |
| 38 | |
| 39 | $acf_settings = unserialize( $post->post_content, array( 'allowed_classes' => false ) ); // TODO:: check for a safer method. |
| 40 | |
| 41 | $acf_type = $show_field_type ? ucwords( $acf_settings['type'] ) . ': ' : ''; |
| 42 | |
| 43 | if ( ! in_array( $acf_settings['type'], self::get_allowed_field_types( $options['field_type'] ), true ) ) { |
| 44 | continue; } |
| 45 | |
| 46 | $acf_group = $show_group ? ' ( ' . get_the_title( $post->post_parent ) . ' ) ' : ''; |
| 47 | |
| 48 | $option_label = $acf_type . $post->post_title . $acf_group; |
| 49 | |
| 50 | $results[ $post->post_name ] = $option_label; |
| 51 | } |
| 52 | |
| 53 | return $results; |
| 54 | } |
| 55 | |
| 56 | /** |
| 57 | * Get ACF Options Pages Ids. |
| 58 | * |
| 59 | * List of ids of all options pages registered. |
| 60 | * |
| 61 | * @access public |
| 62 | * @since 4.4.8 |
| 63 | * @return array $options_page_groups_ids pages id |
| 64 | */ |
| 65 | public static function get_acf_options_pages_ids() { |
| 66 | |
| 67 | $options_page_groups_ids = array(); |
| 68 | |
| 69 | if ( function_exists( 'acf_options_page' ) ) { |
| 70 | $pages = acf_options_page()->get_pages(); |
| 71 | |
| 72 | foreach ( $pages as $slug => $page ) { |
| 73 | $options_page_groups = acf_get_field_groups( |
| 74 | array( |
| 75 | 'options_page' => $slug, |
| 76 | ) |
| 77 | ); |
| 78 | |
| 79 | foreach ( $options_page_groups as $options_page_group ) { |
| 80 | $options_page_groups_ids[] = $options_page_group['ID']; |
| 81 | } |
| 82 | } |
| 83 | } |
| 84 | |
| 85 | return $options_page_groups_ids; |
| 86 | } |
| 87 | |
| 88 | /** |
| 89 | * Check if the ACF field is in an options page. |
| 90 | * |
| 91 | * @access public |
| 92 | * @since 4.4.8 |
| 93 | * |
| 94 | * @param int $parent field parent id. |
| 95 | * @return bool |
| 96 | */ |
| 97 | public static function in_option_page( $parent ) { |
| 98 | |
| 99 | $option_pgs_ids = self::get_acf_options_pages_ids(); |
| 100 | |
| 101 | return in_array( $parent, $option_pgs_ids, true ); |
| 102 | } |
| 103 | |
| 104 | /** |
| 105 | * Returns allowed field types |
| 106 | * |
| 107 | * @access public |
| 108 | * @since 4.4.8 |
| 109 | * |
| 110 | * @param string $type field category. |
| 111 | * @return array |
| 112 | */ |
| 113 | public static function get_allowed_field_types( $type ) { |
| 114 | |
| 115 | $default_types = array( |
| 116 | 'textual' => array( |
| 117 | 'text', |
| 118 | 'textarea', |
| 119 | 'number', |
| 120 | 'range', |
| 121 | 'email', |
| 122 | 'url', |
| 123 | 'password', |
| 124 | 'wysiwyg', |
| 125 | ), |
| 126 | 'date' => array( |
| 127 | 'date_picker', |
| 128 | 'date_time_picker', |
| 129 | ), |
| 130 | 'choice' => array( |
| 131 | 'select', |
| 132 | 'checkbox', |
| 133 | 'radio', |
| 134 | ), |
| 135 | 'boolean' => array( |
| 136 | 'true_false', |
| 137 | ), |
| 138 | ); |
| 139 | |
| 140 | return $default_types[ $type ]; |
| 141 | } |
| 142 | |
| 143 | /** |
| 144 | * Format Acf Values into array ['val : lablel'] || ['val : val'] |
| 145 | * |
| 146 | * @access public |
| 147 | * @since 4.4.8 |
| 148 | * |
| 149 | * @param string $values acf choice field value/s. |
| 150 | * @param string $return_format acf field return format. |
| 151 | * @param boolean $is_radio true if the field is radio button. |
| 152 | * @param boolean $single_select true if the field is a select option and multiple value is disabled. |
| 153 | * |
| 154 | * @return array |
| 155 | */ |
| 156 | public static function format_acf_values( $values, $return_format, $is_radio, $single_select = false ) { |
| 157 | |
| 158 | $formated_values = array(); |
| 159 | |
| 160 | if ( $is_radio || $single_select ) { |
| 161 | |
| 162 | if ( 'array' === $return_format ) { |
| 163 | array_push( $formated_values, $values['value'] . ' : ' . $values['label'] ); |
| 164 | } else { |
| 165 | array_push( $formated_values, $values . ' : ' . $values ); |
| 166 | } |
| 167 | } else { |
| 168 | |
| 169 | $values = acf_decode_choices( $values ); |
| 170 | |
| 171 | foreach ( $values as $index => $value ) { |
| 172 | if ( 'array' === $return_format ) { |
| 173 | array_push( $formated_values, $value['value'] . ' : ' . $value['label'] ); |
| 174 | } else { |
| 175 | array_push( $formated_values, $value . ' : ' . $value ); |
| 176 | } |
| 177 | } |
| 178 | } |
| 179 | |
| 180 | return $formated_values; |
| 181 | } |
| 182 | |
| 183 | /** |
| 184 | * Get ACF field value. |
| 185 | * |
| 186 | * @access public |
| 187 | * @since 4.4.8 |
| 188 | * |
| 189 | * @param string $field_key acf key. |
| 190 | * @param int $parent acf parent id. |
| 191 | */ |
| 192 | public function get_acf_field_value( $field_key, $parent ) { |
| 193 | |
| 194 | if ( self::in_option_page( $parent ) ) { |
| 195 | |
| 196 | return get_field_object( $field_key, 'option' )['value']; |
| 197 | } else { |
| 198 | |
| 199 | if ( is_preview() ) { |
| 200 | add_filter( 'acf/pre_load_post_id', array( $this, 'fix_post_id_on_preview' ), 10, 2 ); |
| 201 | } |
| 202 | |
| 203 | return get_field_object( $field_key )['value']; |
| 204 | } |
| 205 | } |
| 206 | |
| 207 | |
| 208 | /** |
| 209 | * Fix PostId conflict on Preview. |
| 210 | * |
| 211 | * @access public |
| 212 | * @since 4.4.8 |
| 213 | * |
| 214 | * @param null $null $null. |
| 215 | * @param int $post_id post id. |
| 216 | */ |
| 217 | public static function fix_post_id_on_preview( $null, $post_id ) { |
| 218 | |
| 219 | if ( is_preview() ) { |
| 220 | return get_the_ID(); |
| 221 | } else { |
| 222 | $acf_post_id = isset( $post_id->ID ) ? $post_id->ID : $post_id; |
| 223 | |
| 224 | if ( ! empty( $acf_post_id ) ) { |
| 225 | return $acf_post_id; |
| 226 | } else { |
| 227 | return $null; |
| 228 | } |
| 229 | } |
| 230 | } |
| 231 | } |
| 232 |