forked from jcchavezs/cmb2-conditionals
/
cmb2-conditionals.php
executable file
·267 lines (232 loc) · 8.33 KB
/
cmb2-conditionals.php
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
<?php
/**
* CMB2 Conditionals.
*
* @package WordPress\Plugins\CMB2 Conditionals
* @author José Carlos Chávez <jcchavezs@gmail.com>
* @link https://github.com/jcchavezs/cmb2-conditionals
* @version 1.0.4
*
* @copyright 2015 José Carlos Chávez
* @license http://creativecommons.org/licenses/GPL/2.0/ GNU General Public License, version 3 or higher
*
* @wordpress-plugin
* Plugin Name: CMB2 Conditionals
* Plugin URI: https://github.com/jcchavezs/cmb2-conditionals
* Description: Plugin to establish conditional relationships between fields in a CMB2 metabox.
* Author: José Carlos Chávez <jcchavezs@gmail.com>
* Author URI: http://github.com/jcchavezs
* Github Plugin URI: https://github.com/jcchavezs/cmb2-conditionals
* Github Branch: master
* Version: 1.0.4
* License: GPL v3
*
* Copyright (C) 2015, José Carlos Chávez - jcchavezs@gmail.com
*
* GNU General Public License, Free Software Foundation <http://creativecommons.org/licenses/GPL/3.0/>
*
* This program is free software: you can redistribute it and/or modify
* it under the terms of the GNU General Public License as published by
* the Free Software Foundation, either version 3 of the License, or
* (at your option) any later version.
*
* This program is distributed in the hope that it will be useful,
* but WITHOUT ANY WARRANTY; without even the implied warranty of
* MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
* GNU General Public License for more details.
*
* You should have received a copy of the GNU General Public License
* along with this program. If not, see <http://www.gnu.org/licenses/>.
*/
if ( ! class_exists( 'CMB2_Conditionals' ) ) {
/**
* CMB2_Conditionals Plugin.
*/
class CMB2_Conditionals {
/**
* Priority on which our actions are hooked in.
*
* @const int
*/
const PRIORITY = 99999;
/**
* Version number of the plugin.
*
* @const string
*/
const VERSION = '1.0.4';
/**
* CMB2 Form elements which can be set to "required".
*
* @var array
*/
protected $maybe_required_form_elms = array(
'list_input',
'input',
'textarea',
'input',
'select',
'checkbox',
'radio',
'radio_inline',
'taxonomy_radio',
'taxonomy_multicheck',
'multicheck_inline',
);
/**
* Constructor - Set up the actions for the plugin.
*/
public function __construct() {
if ( ! defined( 'CMB2_LOADED' ) || false === CMB2_LOADED ) {
return;
}
add_action( 'admin_init', array( $this, 'admin_init' ), self::PRIORITY );
add_action( 'admin_footer', array( $this, 'admin_footer' ), self::PRIORITY );
foreach ( $this->maybe_required_form_elms as $element ) {
add_filter( "cmb2_{$element}_attributes", array( $this, 'maybe_set_required_attribute' ), self::PRIORITY );
}
}
/**
* Decide whether to include the js-script or not.
*/
public function admin_footer() {
if ( ! in_array( $GLOBALS['pagenow'], array( 'post-new.php', 'post.php' ), true ) ) {
return;
}
wp_enqueue_script(
'cmb2-conditionals',
plugins_url( '/cmb2-conditionals.js', __FILE__ ),
array( 'jquery', 'cmb2-scripts' ),
self::VERSION,
true
);
}
/**
* Ensure valid html for the required attribute.
*
* @param array $args Array of HTML attributes.
*
* @return array
*/
public function maybe_set_required_attribute( $args ) {
if ( ! isset( $args['required'] ) ) {
return $args;
}
// Comply with HTML specs.
if ( true === $args['required'] ) {
$args['required'] = 'required';
}
return $args;
}
/**
* Hook in the filtering of the data being saved.
*/
public function admin_init() {
$cmb2_boxes = CMB2_Boxes::get_all();
foreach ( $cmb2_boxes as $cmb_id => $cmb2_box ) {
add_action(
"cmb2_{$cmb2_box->object_type()}_process_fields_{$cmb_id}",
array( $this, 'filter_data_to_save' ),
self::PRIORITY,
2
);
}
}
/**
* Filter the data received from the form in order to remove those values
* which are not suppose to be enabled to edit according to the declared conditionals.
*
* @param \CMB2 $cmb2 An instance of the CMB2 class.
* @param int $object_id The id of the object being saved, could post_id, comment_id, user_id.
*
* The potentially adjusted array is returned via reference $cmb2.
*/
public function filter_data_to_save( CMB2 $cmb2, $object_id ) {
foreach ( $cmb2->prop( 'fields' ) as $field_args ) {
if ( ! ( 'group' === $field_args['type'] || ( array_key_exists( 'attributes', $field_args ) && array_key_exists( 'data-conditional-id', $field_args['attributes'] ) ) ) ) {
continue;
}
if ( 'group' === $field_args['type'] ) {
foreach ( $field_args['fields'] as $group_field ) {
if ( ! ( array_key_exists( 'attributes', $group_field ) && array_key_exists( 'data-conditional-id', $group_field['attributes'] ) ) ) {
continue;
}
$field_id = $group_field['id'];
$conditional_id = $group_field['attributes']['data-conditional-id'];
$decoded_conditional_id = @json_decode( $conditional_id );
if ( $decoded_conditional_id ) {
$conditional_id = $decoded_conditional_id;
}
if ( is_array( $conditional_id ) && ! empty( $conditional_id ) && ! empty( $cmb2->data_to_save[ $conditional_id[0] ] ) ) {
foreach ( $cmb2->data_to_save[ $conditional_id[0] ] as $key => $group_data ) {
$cmb2->data_to_save[ $conditional_id[0] ][ $key ] = $this->filter_field_data_to_save( $group_data, $field_id, $conditional_id[1], $group_field['attributes'] );
}
}
continue;
}
} else {
$field_id = $field_args['id'];
$conditional_id = $field_args['attributes']['data-conditional-id'];
$cmb2->data_to_save = $this->filter_field_data_to_save( $cmb2->data_to_save, $field_id, $conditional_id, $field_args['attributes'] );
}
}
}
/**
* Determine if the data for one individual field should be saved or not.
*
* @param array $data_to_save The received $_POST data.
* @param string $field_id The CMB2 id of this field.
* @param string $conditional_id The CMB2 id of the field this field is conditional on.
* @param array $attributes The CMB2 field attributes.
*
* @return array Array of data to save.
*/
protected function filter_field_data_to_save( $data_to_save, $field_id, $conditional_id, $attributes ) {
if ( array_key_exists( 'data-conditional-value', $attributes ) ) {
$conditional_value = $attributes['data-conditional-value'];
$decoded_conditional_value = @json_decode( $conditional_value );
if ( $decoded_conditional_value ) {
$conditional_value = $decoded_conditional_value;
}
if ( ! isset( $data_to_save[ $conditional_id ] ) ) {
if ( 'off' !== $conditional_value ) {
unset( $data_to_save[ $field_id ] );
}
return $data_to_save;
}
if ( ( ! is_array( $conditional_value ) && ! is_array( $data_to_save[ $conditional_id ] ) ) && $data_to_save[ $conditional_id ] != $conditional_value ) {
unset( $data_to_save[ $field_id ] );
return $data_to_save;
}
if ( is_array( $conditional_value ) || is_array( $data_to_save[ $conditional_id ] ) ) {
$match = array_intersect( (array) $conditional_value, (array) $data_to_save[ $conditional_id ] );
if ( empty( $match ) ) {
unset( $data_to_save[ $field_id ] );
return $data_to_save;
}
}
}
if ( ! isset( $data_to_save[ $conditional_id ] ) || ! $data_to_save[ $conditional_id ] ) {
unset( $data_to_save[ $field_id ] );
}
return $data_to_save;
}
} /* End of class. */
/**
* Instantiate our class.
*
* {@internal wp_installing() function was introduced in WP 4.4. The function exists and constant
* check can be removed once the min version for this plugin has been upped to 4.4.}}
*/
if ( ( function_exists( 'wp_installing' ) && wp_installing() === false ) || ( ! function_exists( 'wp_installing' ) && ( ! defined( 'WP_INSTALLING' ) || WP_INSTALLING === false ) ) ) {
add_action( 'plugins_loaded', 'cmb2_conditionals_init' );
}
if ( ! function_exists( 'cmb2_conditionals_init' ) ) {
/**
* Initialize the class.
*/
function cmb2_conditionals_init() {
$cmb2_conditionals = new CMB2_Conditionals();
}
}
} /* End of class-exists wrapper. */