class-acf-field-range.php
6.65 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
<?php
if ( ! class_exists( 'acf_field_range' ) ) :
class acf_field_range extends acf_field_number {
/**
* 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 initialize() {
// vars
$this->name = 'range';
$this->label = __( 'Range', 'acf' );
$this->description = __( 'An input for selecting a numerical value within a specified range using a range slider element.', 'acf' );
$this->preview_image = acf_get_url() . '/assets/images/field-type-previews/field-preview-range.png';
$this->doc_url = acf_add_url_utm_tags( 'https://www.advancedcustomfields.com/resources/range/', 'docs', 'field-type-selection' );
$this->defaults = array(
'default_value' => '',
'min' => '',
'max' => '',
'step' => '',
'prepend' => '',
'append' => '',
);
}
/**
* 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
$atts = array();
$keys = array( 'type', 'id', 'class', 'name', 'value', 'min', 'max', 'step' );
$keys2 = array( 'readonly', 'disabled', 'required' );
// step
if ( ! $field['step'] ) {
$field['step'] = 1;
}
// min / max
if ( ! $field['min'] ) {
$field['min'] = 0;
}
if ( ! $field['max'] ) {
$field['max'] = 100;
}
// allow for prev 'non numeric' value
if ( ! is_numeric( $field['value'] ) ) {
$field['value'] = 0;
}
// constrain within max and min
$field['value'] = max( $field['value'], $field['min'] );
$field['value'] = min( $field['value'], $field['max'] );
// atts (value="123")
foreach ( $keys as $k ) {
if ( isset( $field[ $k ] ) ) {
$atts[ $k ] = $field[ $k ];
}
}
// atts2 (disabled="disabled")
foreach ( $keys2 as $k ) {
if ( ! empty( $field[ $k ] ) ) {
$atts[ $k ] = $k;
}
}
// remove empty atts
$atts = acf_clean_atts( $atts );
// open
$html = '<div class="acf-range-wrap">';
// prepend
if ( $field['prepend'] !== '' ) {
$html .= '<div class="acf-prepend">' . acf_esc_html( $field['prepend'] ) . '</div>';
}
// range
$html .= acf_get_text_input( $atts );
// Calculate input width based on the largest possible input character length.
// Also take into account the step size for decimal steps minus - 1.5 chars for leading "0.".
$len = max(
strlen( strval( $field['min'] ) ),
strlen( strval( $field['max'] ) )
);
if ( floatval( $atts['step'] ) < 1 ) {
$len += strlen( strval( $field['step'] ) ) - 1.5;
}
// input
$html .= acf_get_text_input(
array(
'type' => 'number',
'id' => $atts['id'] . '-alt',
'value' => $atts['value'],
'step' => $atts['step'],
// 'min' => $atts['min'], // removed to avoid browser validation errors
// 'max' => $atts['max'],
'style' => 'width: ' . ( 1.8 + $len * 0.7 ) . 'em;',
)
);
// append
if ( $field['append'] !== '' ) {
$html .= '<div class="acf-append">' . acf_esc_html( $field['append'] ) . '</div>';
}
// close
$html .= '</div>';
// return
echo $html; //phpcs:ignore WordPress.Security.EscapeOutput -- Only populated with already escaped HTML.
}
/**
* 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 ) {
acf_render_field_setting(
$field,
array(
'label' => __( 'Default Value', 'acf' ),
'instructions' => __( 'Appears when creating a new post', 'acf' ),
'type' => 'number',
'name' => 'default_value',
)
);
}
/**
* Renders the field settings used in the "Validation" tab.
*
* @since 6.0
*
* @param array $field The field settings array.
* @return void
*/
function render_field_validation_settings( $field ) {
acf_render_field_setting(
$field,
array(
'label' => __( 'Minimum Value', 'acf' ),
'instructions' => '',
'type' => 'number',
'name' => 'min',
'placeholder' => '0',
)
);
acf_render_field_setting(
$field,
array(
'label' => __( 'Maximum Value', 'acf' ),
'instructions' => '',
'type' => 'number',
'name' => 'max',
'placeholder' => '100',
)
);
}
/**
* Renders the field settings used in the "Presentation" tab.
*
* @since 6.0
*
* @param array $field The field settings array.
* @return void
*/
function render_field_presentation_settings( $field ) {
acf_render_field_setting(
$field,
array(
'label' => __( 'Step Size', 'acf' ),
'instructions' => '',
'type' => 'number',
'name' => 'step',
'placeholder' => '1',
)
);
acf_render_field_setting(
$field,
array(
'label' => __( 'Prepend', 'acf' ),
'instructions' => __( 'Appears before the input', 'acf' ),
'type' => 'text',
'name' => 'prepend',
)
);
acf_render_field_setting(
$field,
array(
'label' => __( 'Append', 'acf' ),
'instructions' => __( 'Appears after the input', 'acf' ),
'type' => 'text',
'name' => 'append',
)
);
}
/**
* Return the schema array for the REST API.
*
* @param array $field
* @return array
*/
public function get_rest_schema( array $field ) {
$schema = array(
'type' => array( 'number', 'null' ),
'required' => ! empty( $field['required'] ),
'minimum' => empty( $field['min'] ) ? 0 : (int) $field['min'],
'maximum' => empty( $field['max'] ) ? 100 : (int) $field['max'],
);
if ( isset( $field['default_value'] ) && is_numeric( $field['default_value'] ) ) {
$schema['default'] = (int) $field['default_value'];
}
return $schema;
}
/**
* Apply basic formatting to prepare the value for default REST output.
*
* @param mixed $value
* @param string|integer $post_id
* @param array $field
* @return mixed
*/
public function format_value_for_rest( $value, $post_id, array $field ) {
return acf_format_numerics( $value );
}
}
// initialize
acf_register_field_type( 'acf_field_range' );
endif; // class_exists check