_functions.php
12.7 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
<?php
/*
* Field Functions
*
* @description: The API for all fields
* @since: 3.6
* @created: 23/01/13
*/
class acf_field_functions
{
/*
* __construct
*
* @description:
* @since 3.1.8
* @created: 23/06/12
*/
function __construct()
{
//value
add_filter('acf/load_value', array($this, 'load_value'), 5, 3);
add_action('acf/update_value', array($this, 'update_value'), 5, 3);
add_action('acf/delete_value', array($this, 'delete_value'), 5, 2);
add_action('acf/format_value', array($this, 'format_value'), 5, 3);
add_action('acf/format_value_for_api', array($this, 'format_value_for_api'), 5, 3);
// field
add_filter('acf/load_field', array($this, 'load_field'), 5, 3);
add_action('acf/update_field', array($this, 'update_field'), 5, 2);
add_action('acf/delete_field', array($this, 'delete_field'), 5, 2);
add_action('acf/create_field', array($this, 'create_field'), 5, 1);
add_action('acf/create_field_options', array($this, 'create_field_options'), 5, 1);
// extra
add_filter('acf/load_field_defaults', array($this, 'load_field_defaults'), 5, 1);
}
/*
* load_value
*
* @description: loads basic value from the db
* @since: 3.6
* @created: 23/01/13
*/
function load_value($value, $post_id, $field)
{
$found = false;
$cache = wp_cache_get( 'load_value/post_id=' . $post_id . '/name=' . $field['name'], 'acf', false, $found );
if( $found )
{
return $cache;
}
// set default value
$value = false;
// if $post_id is a string, then it is used in the everything fields and can be found in the options table
if( is_numeric($post_id) )
{
$v = get_post_meta( $post_id, $field['name'], false );
// value is an array
if( isset($v[0]) )
{
$value = $v[0];
}
}
elseif( strpos($post_id, 'user_') !== false )
{
$post_id = str_replace('user_', '', $post_id);
$v = get_user_meta( $post_id, $field['name'], false );
// value is an array
if( isset($v[0]) )
{
$value = $v[0];
}
}
else
{
$v = get_option( $post_id . '_' . $field['name'], false );
if( !is_null($value) )
{
$value = $v;
}
}
// no value?
if( $value === false )
{
if( isset($field['default_value']) && $field['default_value'] !== "" )
{
$value = $field['default_value'];
}
}
// if value was duplicated, it may now be a serialized string!
$value = maybe_unserialize($value);
// apply filters
foreach( array('type', 'name', 'key') as $key )
{
// run filters
$value = apply_filters('acf/load_value/' . $key . '=' . $field[ $key ], $value, $post_id, $field); // new filter
}
//update cache
wp_cache_set( 'load_value/post_id=' . $post_id . '/name=' . $field['name'], $value, 'acf' );
return $value;
}
/*
* format_value
*
* @description: uses the basic value and allows the field type to format it
* @since: 3.6
* @created: 26/01/13
*/
function format_value( $value, $post_id, $field )
{
$value = apply_filters('acf/format_value/type=' . $field['type'], $value, $post_id, $field);
return $value;
}
/*
* format_value_for_api
*
* @description: uses the basic value and allows the field type to format it or the api functions
* @since: 3.6
* @created: 26/01/13
*/
function format_value_for_api( $value, $post_id, $field )
{
$value = apply_filters('acf/format_value_for_api/type=' . $field['type'], $value, $post_id, $field);
return $value;
}
/*
* update_value
*
* updates a value into the db
*
* @type action
* @date 23/01/13
*
* @param {mixed} $value the value to be saved
* @param {int} $post_id the post ID to save the value to
* @param {array} $field the field array
* @param {boolean} $exact allows the update_value filter to be skipped
* @return N/A
*/
function update_value( $value, $post_id, $field )
{
// strip slashes
// - not needed? http://support.advancedcustomfields.com/discussion/3168/backslashes-stripped-in-wysiwyg-filed
//if( get_magic_quotes_gpc() )
//{
$value = stripslashes_deep($value);
//}
// apply filters
foreach( array('key', 'name', 'type') as $key )
{
// run filters
$value = apply_filters('acf/update_value/' . $key . '=' . $field[ $key ], $value, $post_id, $field); // new filter
}
// if $post_id is a string, then it is used in the everything fields and can be found in the options table
if( is_numeric($post_id) )
{
// allow ACF to save to revision!
update_metadata('post', $post_id, $field['name'], $value );
update_metadata('post', $post_id, '_' . $field['name'], $field['key']);
}
elseif( strpos($post_id, 'user_') !== false )
{
$user_id = str_replace('user_', '', $post_id);
update_metadata('user', $user_id, $field['name'], $value);
update_metadata('user', $user_id, '_' . $field['name'], $field['key']);
}
else
{
// for some reason, update_option does not use stripslashes_deep.
// update_metadata -> http://core.trac.wordpress.org/browser/tags/3.4.2/wp-includes/meta.php#L82: line 101 (does use stripslashes_deep)
// update_option -> http://core.trac.wordpress.org/browser/tags/3.5.1/wp-includes/option.php#L0: line 215 (does not use stripslashes_deep)
$value = stripslashes_deep($value);
$this->update_option( $post_id . '_' . $field['name'], $value );
$this->update_option( '_' . $post_id . '_' . $field['name'], $field['key'] );
}
// update the cache
wp_cache_set( 'load_value/post_id=' . $post_id . '/name=' . $field['name'], $value, 'acf' );
}
/*
* update_option
*
* This function is a wrapper for the WP update_option but provides logic for a 'no' autoload
*
* @type function
* @date 4/01/2014
* @since 5.0.0
*
* @param $option (string)
* @param $value (mixed)
* @return (boolean)
*/
function update_option( $option = '', $value = false, $autoload = 'no' ) {
// vars
$deprecated = '';
$return = false;
if( get_option($option) !== false )
{
$return = update_option( $option, $value );
}
else
{
$return = add_option( $option, $value, $deprecated, $autoload );
}
// return
return $return;
}
/*
* delete_value
*
* @description: deletes a value from the database
* @since: 3.6
* @created: 23/01/13
*/
function delete_value( $post_id, $key )
{
// if $post_id is a string, then it is used in the everything fields and can be found in the options table
if( is_numeric($post_id) )
{
delete_post_meta( $post_id, $key );
delete_post_meta( $post_id, '_' . $key );
}
elseif( strpos($post_id, 'user_') !== false )
{
$post_id = str_replace('user_', '', $post_id);
delete_user_meta( $post_id, $key );
delete_user_meta( $post_id, '_' . $key );
}
else
{
delete_option( $post_id . '_' . $key );
delete_option( '_' . $post_id . '_' . $key );
}
wp_cache_delete( 'load_value/post_id=' . $post_id . '/name=' . $key, 'acf' );
}
/*
* load_field
*
* @description: loads a field from the database
* @since 3.5.1
* @created: 14/10/12
*/
function load_field( $field, $field_key, $post_id = false )
{
// load cache
if( !$field )
{
$field = wp_cache_get( 'load_field/key=' . $field_key, 'acf' );
}
// load from DB
if( !$field )
{
// vars
global $wpdb;
// get field from postmeta
$sql = $wpdb->prepare("SELECT post_id, meta_value FROM $wpdb->postmeta WHERE meta_key = %s", $field_key);
if( $post_id )
{
$sql .= $wpdb->prepare("AND post_id = %d", $post_id);
}
$rows = $wpdb->get_results( $sql, ARRAY_A );
// nothing found?
if( !empty($rows) )
{
$row = $rows[0];
/*
* WPML compatibility
*
* If WPML is active, and the $post_id (Field group ID) was not defined,
* it is assumed that the load_field functio has been called from the API (front end).
* In this case, the field group ID is never known and we can check for the correct translated field group
*/
if( defined('ICL_LANGUAGE_CODE') && !$post_id )
{
$wpml_post_id = icl_object_id($row['post_id'], 'acf', true, ICL_LANGUAGE_CODE);
foreach( $rows as $r )
{
if( $r['post_id'] == $wpml_post_id )
{
// this row is a field from the translated field group
$row = $r;
}
}
}
// return field if it is not in a trashed field group
if( get_post_status( $row['post_id'] ) != "trash" )
{
$field = $row['meta_value'];
$field = maybe_unserialize( $field );
$field = maybe_unserialize( $field ); // run again for WPML
// add field_group ID
$field['field_group'] = $row['post_id'];
}
}
}
// apply filters
$field = apply_filters('acf/load_field_defaults', $field);
// apply filters
foreach( array('type', 'name', 'key') as $key )
{
// run filters
$field = apply_filters('acf/load_field/' . $key . '=' . $field[ $key ], $field); // new filter
}
// set cache
wp_cache_set( 'load_field/key=' . $field_key, $field, 'acf' );
return $field;
}
/*
* load_field_defaults
*
* @description: applies default values to the field after it has been loaded
* @since 3.5.1
* @created: 14/10/12
*/
function load_field_defaults( $field )
{
// validate $field
if( !is_array($field) )
{
$field = array();
}
// defaults
$defaults = array(
'key' => '',
'label' => '',
'name' => '',
'_name' => '',
'type' => 'text',
'order_no' => 1,
'instructions' => '',
'required' => 0,
'id' => '',
'class' => '',
'conditional_logic' => array(
'status' => 0,
'allorany' => 'all',
'rules' => 0
),
);
$field = array_merge($defaults, $field);
// Parse Values
$field = apply_filters( 'acf/parse_types', $field );
// field specific defaults
$field = apply_filters('acf/load_field_defaults/type=' . $field['type'] , $field);
// class
if( !$field['class'] )
{
$field['class'] = $field['type'];
}
// id
if( !$field['id'] )
{
$id = $field['name'];
$id = str_replace('][', '_', $id);
$id = str_replace('fields[', '', $id);
$id = str_replace('[', '-', $id); // location rules (select) does'nt have "fields[" in it
$id = str_replace(']', '', $id);
$field['id'] = 'acf-field-' . $id;
}
// _name
if( !$field['_name'] )
{
$field['_name'] = $field['name'];
}
// clean up conditional logic keys
if( !empty($field['conditional_logic']['rules']) )
{
$field['conditional_logic']['rules'] = array_values($field['conditional_logic']['rules']);
}
// return
return $field;
}
/*
* update_field
*
* @description: updates a field in the database
* @since: 3.6
* @created: 24/01/13
*/
function update_field( $field, $post_id )
{
// sanitize field name
// - http://support.advancedcustomfields.com/discussion/5262/sanitize_title-on-field-name
// - issue with camel case! Replaced with JS
//$field['name'] = sanitize_title( $field['name'] );
// filters
$field = apply_filters('acf/update_field/type=' . $field['type'], $field, $post_id ); // new filter
// clear cache
wp_cache_delete( 'load_field/key=' . $field['key'], 'acf' );
// save
update_post_meta( $post_id, $field['key'], $field );
}
/*
* delete_field
*
* @description: deletes a field in the database
* @since: 3.6
* @created: 24/01/13
*/
function delete_field( $post_id, $field_key )
{
// clear cache
wp_cache_delete( 'load_field/key=' . $field['key'], 'acf' );
// delete
delete_post_meta($post_id, $field_key);
}
/*
* create_field
*
* @description: renders a field into a HTML interface
* @since: 3.6
* @created: 23/01/13
*/
function create_field( $field )
{
// load defaults
// if field was loaded from db, these default will already be appield
// if field was written by hand, it may be missing keys
$field = apply_filters('acf/load_field_defaults', $field);
// create field specific html
do_action('acf/create_field/type=' . $field['type'], $field);
// conditional logic
if( $field['conditional_logic']['status'] )
{
$field['conditional_logic']['field'] = $field['key'];
?>
<script type="text/javascript">
(function($) {
if( typeof acf !== 'undefined' )
{
acf.conditional_logic.items.push(<?php echo json_encode($field['conditional_logic']); ?>);
}
})(jQuery);
</script>
<?php
}
}
/*
* create_field_options
*
* @description: renders a field into a HTML interface
* @since: 3.6
* @created: 23/01/13
*/
function create_field_options($field)
{
// load standard + field specific defaults
$field = apply_filters('acf/load_field_defaults', $field);
// render HTML
do_action('acf/create_field_options/type=' . $field['type'], $field);
}
}
new acf_field_functions();
?>