Completed
Pull Request — trunk (#722)
by José Carlos
07:13
created
includes/CMB2_Field.php 1 patch
Spacing   +80 added lines, -80 removed lines patch added patch discarded remove patch
@@ -110,21 +110,21 @@  discard block
 block discarded – undo
110 110
 	 */
111 111
 	public function __construct( $args ) {
112 112
 
113
-		if ( ! empty( $args['group_field'] ) ) {
114
-			$this->group       = $args['group_field'];
113
+		if ( ! empty( $args[ 'group_field' ] ) ) {
114
+			$this->group       = $args[ 'group_field' ];
115 115
 			$this->object_id   = $this->group->object_id;
116 116
 			$this->object_type = $this->group->object_type;
117 117
 			$this->cmb_id      = $this->group->cmb_id;
118 118
 		} else {
119
-			$this->object_id   = isset( $args['object_id'] ) && '_' !== $args['object_id'] ? $args['object_id'] : 0;
120
-			$this->object_type = isset( $args['object_type'] ) ? $args['object_type'] : 'post';
119
+			$this->object_id   = isset( $args[ 'object_id' ] ) && '_' !== $args[ 'object_id' ] ? $args[ 'object_id' ] : 0;
120
+			$this->object_type = isset( $args[ 'object_type' ] ) ? $args[ 'object_type' ] : 'post';
121 121
 
122
-			if ( isset( $args['cmb_id'] ) ) {
123
-				$this->cmb_id = $args['cmb_id'];
122
+			if ( isset( $args[ 'cmb_id' ] ) ) {
123
+				$this->cmb_id = $args[ 'cmb_id' ];
124 124
 			}
125 125
 		}
126 126
 
127
-		$this->args = $this->_set_field_defaults( $args['field_args'], $args );
127
+		$this->args = $this->_set_field_defaults( $args[ 'field_args' ], $args );
128 128
 
129 129
 		if ( $this->object_id ) {
130 130
 			$this->value = $this->get_data();
@@ -143,7 +143,7 @@  discard block
 block discarded – undo
143 143
 			return call_user_func_array( array( $this, 'get_string' ), $arguments );
144 144
 		}
145 145
 
146
-		$key = isset( $arguments[0] ) ? $arguments[0] : false;
146
+		$key = isset( $arguments[ 0 ] ) ? $arguments[ 0 ] : false;
147 147
 		return $this->args( $name, $key );
148 148
 	}
149 149
 
@@ -214,9 +214,9 @@  discard block
 block discarded – undo
214 214
 	 */
215 215
 	public function get_data( $field_id = '', $args = array() ) {
216 216
 		if ( $field_id ) {
217
-			$args['field_id'] = $field_id;
217
+			$args[ 'field_id' ] = $field_id;
218 218
 		} else if ( $this->group ) {
219
-			$args['field_id'] = $this->group->id();
219
+			$args[ 'field_id' ] = $this->group->id();
220 220
 		}
221 221
 
222 222
 		$a = $this->data_args( $args );
@@ -257,13 +257,13 @@  discard block
 block discarded – undo
257 257
 		 *
258 258
 		 * @since 2.0.0
259 259
 		 */
260
-		$data = apply_filters( "cmb2_override_{$a['field_id']}_meta_value", $data, $this->object_id, $a, $this );
260
+		$data = apply_filters( "cmb2_override_{$a[ 'field_id' ]}_meta_value", $data, $this->object_id, $a, $this );
261 261
 
262 262
 		// If no override, get value normally
263 263
 		if ( 'cmb2_field_no_override_val' === $data ) {
264
-			$data = 'options-page' === $a['type']
265
-				? cmb2_options( $a['id'] )->get( $a['field_id'] )
266
-				: get_metadata( $a['type'], $a['id'], $a['field_id'], ( $a['single'] || $a['repeat'] ) );
264
+			$data = 'options-page' === $a[ 'type' ]
265
+				? cmb2_options( $a[ 'id' ] )->get( $a[ 'field_id' ] )
266
+				: get_metadata( $a[ 'type' ], $a[ 'id' ], $a[ 'field_id' ], ( $a[ 'single' ] || $a[ 'repeat' ] ) );
267 267
 		}
268 268
 
269 269
 		if ( $this->group ) {
@@ -285,7 +285,7 @@  discard block
 block discarded – undo
285 285
 	public function update_data( $new_value, $single = true ) {
286 286
 		$a = $this->data_args( array( 'single' => $single ) );
287 287
 
288
-		$a['value'] = $a['repeat'] ? array_values( $new_value ) : $new_value;
288
+		$a[ 'value' ] = $a[ 'repeat' ] ? array_values( $new_value ) : $new_value;
289 289
 
290 290
 		/**
291 291
 		 * Filter whether to override saving of meta value.
@@ -321,7 +321,7 @@  discard block
 block discarded – undo
321 321
 		 *
322 322
 		 * @since 2.0.0
323 323
 		 */
324
-		$override = apply_filters( "cmb2_override_{$a['field_id']}_meta_save", $override, $a, $this->args(), $this );
324
+		$override = apply_filters( "cmb2_override_{$a[ 'field_id' ]}_meta_save", $override, $a, $this->args(), $this );
325 325
 
326 326
 		// If override, return that
327 327
 		if ( null !== $override ) {
@@ -329,22 +329,22 @@  discard block
 block discarded – undo
329 329
 		}
330 330
 
331 331
 		// Options page handling (or temp data store)
332
-		if ( 'options-page' === $a['type'] || empty( $a['id'] ) ) {
333
-			return cmb2_options( $a['id'] )->update( $a['field_id'], $a['value'], false, $a['single'] );
332
+		if ( 'options-page' === $a[ 'type' ] || empty( $a[ 'id' ] ) ) {
333
+			return cmb2_options( $a[ 'id' ] )->update( $a[ 'field_id' ], $a[ 'value' ], false, $a[ 'single' ] );
334 334
 		}
335 335
 
336 336
 		// Add metadata if not single
337
-		if ( ! $a['single'] ) {
338
-			return add_metadata( $a['type'], $a['id'], $a['field_id'], $a['value'], false );
337
+		if ( ! $a[ 'single' ] ) {
338
+			return add_metadata( $a[ 'type' ], $a[ 'id' ], $a[ 'field_id' ], $a[ 'value' ], false );
339 339
 		}
340 340
 
341 341
 		// Delete meta if we have an empty array
342
-		if ( is_array( $a['value'] ) && empty( $a['value'] ) ) {
343
-			return delete_metadata( $a['type'], $a['id'], $a['field_id'], $this->value );
342
+		if ( is_array( $a[ 'value' ] ) && empty( $a[ 'value' ] ) ) {
343
+			return delete_metadata( $a[ 'type' ], $a[ 'id' ], $a[ 'field_id' ], $this->value );
344 344
 		}
345 345
 
346 346
 		// Update metadata
347
-		return update_metadata( $a['type'], $a['id'], $a['field_id'], $a['value'] );
347
+		return update_metadata( $a[ 'type' ], $a[ 'id' ], $a[ 'field_id' ], $a[ 'value' ] );
348 348
 	}
349 349
 
350 350
 	/**
@@ -394,19 +394,19 @@  discard block
 block discarded – undo
394 394
 		 * @param array $field_args All field arguments
395 395
 		 * @param CMB2_Field object $field This field object
396 396
 		 */
397
-		$override = apply_filters( "cmb2_override_{$a['field_id']}_meta_remove", $override, $a, $this->args(), $this );
397
+		$override = apply_filters( "cmb2_override_{$a[ 'field_id' ]}_meta_remove", $override, $a, $this->args(), $this );
398 398
 
399 399
 		// If no override, remove as usual
400 400
 		if ( null !== $override ) {
401 401
 			return $override;
402 402
 		}
403 403
 		// Option page handling
404
-		elseif ( 'options-page' === $a['type'] || empty( $a['id'] ) ) {
405
-			return cmb2_options( $a['id'] )->remove( $a['field_id'] );
404
+		elseif ( 'options-page' === $a[ 'type' ] || empty( $a[ 'id' ] ) ) {
405
+			return cmb2_options( $a[ 'id' ] )->remove( $a[ 'field_id' ] );
406 406
 		}
407 407
 
408 408
 		// Remove metadata
409
-		return delete_metadata( $a['type'], $a['id'], $a['field_id'], $old );
409
+		return delete_metadata( $a[ 'type' ], $a[ 'id' ], $a[ 'field_id' ], $old );
410 410
 	}
411 411
 
412 412
 	/**
@@ -858,7 +858,7 @@  discard block
 block discarded – undo
858 858
 
859 859
 		foreach ( $conditional_classes as $class => $condition ) {
860 860
 			if ( $condition ) {
861
-				$classes[] = $class;
861
+				$classes[ ] = $class;
862 862
 			}
863 863
 		}
864 864
 
@@ -869,7 +869,7 @@  discard block
 block discarded – undo
869 869
 		}
870 870
 
871 871
 		if ( $added_classes ) {
872
-			$classes[] = esc_attr( $added_classes );
872
+			$classes[ ] = esc_attr( $added_classes );
873 873
 		}
874 874
 
875 875
 		/**
@@ -969,10 +969,10 @@  discard block
 block discarded – undo
969 969
 	public function get_string( $text_key, $fallback ) {
970 970
 		// If null, populate with our field strings values.
971 971
 		if ( null === $this->strings ) {
972
-			$this->strings = (array) $this->args['text'];
972
+			$this->strings = (array) $this->args[ 'text' ];
973 973
 
974
-			if ( is_callable( $this->args['text_cb'] ) ) {
975
-				$strings = call_user_func( $this->args['text_cb'], $this );
974
+			if ( is_callable( $this->args[ 'text_cb' ] ) ) {
975
+				$strings = call_user_func( $this->args[ 'text_cb' ], $this );
976 976
 
977 977
 				if ( $strings && is_array( $strings ) ) {
978 978
 					$this->strings += $strings;
@@ -1006,10 +1006,10 @@  discard block
 block discarded – undo
1006 1006
 			return $this->field_options;
1007 1007
 		}
1008 1008
 
1009
-		$this->field_options = (array) $this->args['options'];
1009
+		$this->field_options = (array) $this->args[ 'options' ];
1010 1010
 
1011
-		if ( is_callable( $this->args['options_cb'] ) ) {
1012
-			$options = call_user_func( $this->args['options_cb'], $this );
1011
+		if ( is_callable( $this->args[ 'options_cb' ] ) ) {
1012
+			$options = call_user_func( $this->args[ 'options_cb' ], $this );
1013 1013
 
1014 1014
 			if ( $options && is_array( $options ) ) {
1015 1015
 				$this->field_options = $options + $this->field_options;
@@ -1030,7 +1030,7 @@  discard block
 block discarded – undo
1030 1030
 	 */
1031 1031
 	public function add_js_dependencies( $dependencies = array() ) {
1032 1032
 		foreach ( (array) $dependencies as $dependency ) {
1033
-			$this->args['js_dependencies'][ $dependency ] = $dependency;
1033
+			$this->args[ 'js_dependencies' ][ $dependency ] = $dependency;
1034 1034
 		}
1035 1035
 
1036 1036
 		CMB2_JS::add_dependencies( $dependencies );
@@ -1044,17 +1044,17 @@  discard block
 block discarded – undo
1044 1044
 	 * @return mixed  Default field value
1045 1045
 	 */
1046 1046
 	public function get_default() {
1047
-		if ( null !== $this->args['default'] ) {
1048
-			return $this->args['default'];
1047
+		if ( null !== $this->args[ 'default' ] ) {
1048
+			return $this->args[ 'default' ];
1049 1049
 		}
1050 1050
 
1051
-		$param = is_callable( $this->args['default_cb'] ) ? 'default_cb' : 'default';
1051
+		$param = is_callable( $this->args[ 'default_cb' ] ) ? 'default_cb' : 'default';
1052 1052
 		$default = $this->get_param_callback_result( $param );
1053 1053
 
1054 1054
 		// Allow a filter override of the default value
1055
-		$this->args['default'] = apply_filters( 'cmb2_default_filter', $default, $this );
1055
+		$this->args[ 'default' ] = apply_filters( 'cmb2_default_filter', $default, $this );
1056 1056
 
1057
-		return $this->args['default'];
1057
+		return $this->args[ 'default' ];
1058 1058
 	}
1059 1059
 
1060 1060
 	/**
@@ -1084,18 +1084,18 @@  discard block
 block discarded – undo
1084 1084
 			'classes_cb'        => '',
1085 1085
 			'select_all_button' => true,
1086 1086
 			'multiple'          => false,
1087
-			'repeatable'        => isset( $args['type'] ) && 'group' == $args['type'],
1087
+			'repeatable'        => isset( $args[ 'type' ] ) && 'group' == $args[ 'type' ],
1088 1088
 			'inline'            => false,
1089 1089
 			'on_front'          => true,
1090 1090
 			'show_names'        => true,
1091 1091
 			'save_field'        => true, // Will not save if false
1092 1092
 			'date_format'       => 'm\/d\/Y',
1093 1093
 			'time_format'       => 'h:i A',
1094
-			'description'       => isset( $args['desc'] ) ? $args['desc'] : '',
1095
-			'preview_size'      => 'file' == $args['type'] ? array( 350, 350 ) : array( 50, 50 ),
1094
+			'description'       => isset( $args[ 'desc' ] ) ? $args[ 'desc' ] : '',
1095
+			'preview_size'      => 'file' == $args[ 'type' ] ? array( 350, 350 ) : array( 50, 50 ),
1096 1096
 			'render_row_cb'     => array( $this, 'render_field_callback' ),
1097 1097
 			'display_cb'        => array( $this, 'display_value_callback' ),
1098
-			'label_cb'          => 'title' != $args['type'] ? array( $this, 'label' ) : '',
1098
+			'label_cb'          => 'title' != $args[ 'type' ] ? array( $this, 'label' ) : '',
1099 1099
 			'column'            => false,
1100 1100
 			'js_dependencies'   => array(),
1101 1101
 		) );
@@ -1109,48 +1109,48 @@  discard block
 block discarded – undo
1109 1109
 		 */
1110 1110
 		$args = $this->convert_deprecated_params( $args );
1111 1111
 
1112
-		$args['repeatable'] = $args['repeatable'] && ! $this->repeatable_exception( $args['type'] );
1113
-		$args['inline']     = $args['inline'] || false !== stripos( $args['type'], '_inline' );
1112
+		$args[ 'repeatable' ] = $args[ 'repeatable' ] && ! $this->repeatable_exception( $args[ 'type' ] );
1113
+		$args[ 'inline' ]     = $args[ 'inline' ] || false !== stripos( $args[ 'type' ], '_inline' );
1114 1114
 
1115
-		$args['options']    = 'group' == $args['type'] ? wp_parse_args( $args['options'], array(
1115
+		$args[ 'options' ]    = 'group' == $args[ 'type' ] ? wp_parse_args( $args[ 'options' ], array(
1116 1116
 			'add_button'    => esc_html__( 'Add Group', 'cmb2' ),
1117 1117
 			'remove_button' => esc_html__( 'Remove Group', 'cmb2' ),
1118
-		) ) : $args['options'];
1118
+		) ) : $args[ 'options' ];
1119 1119
 
1120
-		$args['_id']        = $args['id'];
1121
-		$args['_name']      = $args['id'];
1120
+		$args[ '_id' ]        = $args[ 'id' ];
1121
+		$args[ '_name' ]      = $args[ 'id' ];
1122 1122
 
1123 1123
 		if ( $this->group ) {
1124 1124
 
1125
-			$args['id']    = $this->group->args( 'id' ) . '_' . $this->group->index . '_' . $args['id'];
1126
-			$args['_name'] = $this->group->args( 'id' ) . '[' . $this->group->index . '][' . $args['_name'] . ']';
1125
+			$args[ 'id' ]    = $this->group->args( 'id' ) . '_' . $this->group->index . '_' . $args[ 'id' ];
1126
+			$args[ '_name' ] = $this->group->args( 'id' ) . '[' . $this->group->index . '][' . $args[ '_name' ] . ']';
1127 1127
 		}
1128 1128
 
1129
-		if ( 'wysiwyg' == $args['type'] ) {
1130
-			$args['id'] = strtolower( str_ireplace( '-', '_', $args['id'] ) );
1131
-			$args['options']['textarea_name'] = $args['_name'];
1129
+		if ( 'wysiwyg' == $args[ 'type' ] ) {
1130
+			$args[ 'id' ] = strtolower( str_ireplace( '-', '_', $args[ 'id' ] ) );
1131
+			$args[ 'options' ][ 'textarea_name' ] = $args[ '_name' ];
1132 1132
 		}
1133 1133
 
1134
-		if( 'text_money' === $args['type'] ) {
1135
- 			$args['before_field'] = apply_filters( 'cmb2_text_money_before_field_filter', ( isset($args['before_field']) ? $args['before_field'] : '$' ), $this );
1134
+		if ( 'text_money' === $args[ 'type' ] ) {
1135
+ 			$args[ 'before_field' ] = apply_filters( 'cmb2_text_money_before_field_filter', ( isset( $args[ 'before_field' ] ) ? $args[ 'before_field' ] : '$' ), $this );
1136 1136
  		}
1137 1137
 
1138 1138
 		$option_types = apply_filters( 'cmb2_all_or_nothing_types', array( 'select', 'radio', 'radio_inline', 'taxonomy_select', 'taxonomy_radio', 'taxonomy_radio_inline' ), $this );
1139 1139
 
1140
-		if ( in_array( $args['type'], $option_types, true ) ) {
1140
+		if ( in_array( $args[ 'type' ], $option_types, true ) ) {
1141 1141
 
1142
-			$args['show_option_none'] = isset( $args['show_option_none'] ) ? $args['show_option_none'] : null;
1143
-			$args['show_option_none'] = true === $args['show_option_none'] ? esc_html__( 'None', 'cmb2' ) : $args['show_option_none'];
1142
+			$args[ 'show_option_none' ] = isset( $args[ 'show_option_none' ] ) ? $args[ 'show_option_none' ] : null;
1143
+			$args[ 'show_option_none' ] = true === $args[ 'show_option_none' ] ? esc_html__( 'None', 'cmb2' ) : $args[ 'show_option_none' ];
1144 1144
 
1145
-			if ( null === $args['show_option_none'] ) {
1146
-				$off_by_default = in_array( $args['type'], array( 'select', 'radio', 'radio_inline' ), true );
1147
-				$args['show_option_none'] = $off_by_default ? false : esc_html__( 'None', 'cmb2' );
1145
+			if ( null === $args[ 'show_option_none' ] ) {
1146
+				$off_by_default = in_array( $args[ 'type' ], array( 'select', 'radio', 'radio_inline' ), true );
1147
+				$args[ 'show_option_none' ] = $off_by_default ? false : esc_html__( 'None', 'cmb2' );
1148 1148
 			}
1149 1149
 
1150 1150
 		}
1151 1151
 
1152
-		$args['has_supporting_data'] = in_array(
1153
-			$args['type'],
1152
+		$args[ 'has_supporting_data' ] = in_array(
1153
+			$args[ 'type' ],
1154 1154
 			array(
1155 1155
 				// CMB2_Sanitize::_save_file_id_value()/CMB2_Sanitize::_get_group_file_value_array()
1156 1156
 				'file',
@@ -1173,10 +1173,10 @@  discard block
 block discarded – undo
1173 1173
 	protected function get_default_args( $field_args, $field_group = null ) {
1174 1174
 		$args = parent::get_default_args( array(), $this->group );
1175 1175
 
1176
-		if ( isset( $field_args['field_args'] ) ) {
1176
+		if ( isset( $field_args[ 'field_args' ] ) ) {
1177 1177
 			$args = wp_parse_args( $field_args, $args );
1178 1178
 		} else {
1179
-			$args['field_args'] = wp_parse_args( $field_args, $this->args );
1179
+			$args[ 'field_args' ] = wp_parse_args( $field_args, $this->args );
1180 1180
 		}
1181 1181
 
1182 1182
 		return $args;
@@ -1219,43 +1219,43 @@  discard block
 block discarded – undo
1219 1219
 	 */
1220 1220
 	protected function convert_deprecated_params( $args ) {
1221 1221
 
1222
-		if ( isset( $args['row_classes'] ) ) {
1222
+		if ( isset( $args[ 'row_classes' ] ) ) {
1223 1223
 
1224 1224
 			$this->deprecated_param( __CLASS__ . '::__construct()', '2.2.3', self::DEPRECATED_PARAM, 'row_classes', 'classes' );
1225 1225
 
1226 1226
 			// row_classes param could be a callback
1227
-			if ( is_callable( $args['row_classes'] ) ) {
1227
+			if ( is_callable( $args[ 'row_classes' ] ) ) {
1228 1228
 
1229 1229
 				$this->deprecated_param( __CLASS__ . '::__construct()', '2.2.3', self::DEPRECATED_CB_PARAM, 'row_classes', 'classes_cb' );
1230 1230
 
1231
-				$args['classes_cb'] = $args['row_classes'];
1232
-				$args['classes'] = null;
1231
+				$args[ 'classes_cb' ] = $args[ 'row_classes' ];
1232
+				$args[ 'classes' ] = null;
1233 1233
 			} else {
1234 1234
 
1235 1235
 
1236
-				$args['classes'] = $args['row_classes'];
1236
+				$args[ 'classes' ] = $args[ 'row_classes' ];
1237 1237
 			}
1238 1238
 
1239
-			unset( $args['row_classes'] );
1239
+			unset( $args[ 'row_classes' ] );
1240 1240
 		}
1241 1241
 
1242 1242
 
1243 1243
 		// default param can be passed a callback as well
1244
-		if ( is_callable( $args['default'] ) ) {
1244
+		if ( is_callable( $args[ 'default' ] ) ) {
1245 1245
 
1246 1246
 			$this->deprecated_param( __CLASS__ . '::__construct()', '2.2.3', self::DEPRECATED_CB_PARAM, 'default', 'default_cb' );
1247 1247
 
1248
-			$args['default_cb'] = $args['default'];
1249
-			$args['default'] = null;
1248
+			$args[ 'default_cb' ] = $args[ 'default' ];
1249
+			$args[ 'default' ] = null;
1250 1250
 		}
1251 1251
 
1252 1252
 		// options param can be passed a callback as well
1253
-		if ( is_callable( $args['options'] ) ) {
1253
+		if ( is_callable( $args[ 'options' ] ) ) {
1254 1254
 
1255 1255
 			$this->deprecated_param( __CLASS__ . '::__construct()', '2.2.3', self::DEPRECATED_CB_PARAM, 'options', 'options_cb' );
1256 1256
 
1257
-			$args['options_cb'] = $args['options'];
1258
-			$args['options'] = array();
1257
+			$args[ 'options_cb' ] = $args[ 'options' ];
1258
+			$args[ 'options' ] = array();
1259 1259
 		}
1260 1260
 
1261 1261
 		return $args;
Please login to merge, or discard this patch.