validation.php 7.03 KB
Newer Older
imac's avatar
imac committed
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
<?php 

if( ! defined( 'ABSPATH' ) ) exit; // Exit if accessed directly

if( ! class_exists('acf_validation') ) :

class acf_validation {
	
	
	/*
	*  __construct
	*
	*  This function will setup the class functionality
	*
	*  @type	function
	*  @date	5/03/2014
	*  @since	5.0.0
	*
	*  @param	n/a
	*  @return	n/a
	*/
	
	function __construct() {
		
		// vars
		$this->errors = array();
		
		
		// ajax
		add_action('wp_ajax_acf/validate_save_post',			array($this, 'ajax_validate_save_post'));
		add_action('wp_ajax_nopriv_acf/validate_save_post',		array($this, 'ajax_validate_save_post'));
		
		
		// filters
		add_filter('acf/validate_save_post',					array($this, 'acf_validate_save_post'), 5);
		
	}
	
	
	/*
	*  add_error
	*
	*  This function will add an error message for a field
	*
	*  @type	function
	*  @date	25/11/2013
	*  @since	5.0.0
	*
	*  @param	$input (string) name attribute of DOM elmenet
	*  @param	$message (string) error message
	*  @return	$post_id (int)
	*/
	
	function add_error( $input, $message ) {
		
		// add to array
		$this->errors[] = array(
			'input'		=> $input,
			'message'	=> $message
		);
		
	}
	
	
	/*
	*  get_error
	*
	*  This function will return an error for a given input
	*
	*  @type	function
	*  @date	5/03/2016
	*  @since	5.3.2
	*
	*  @param	$input (string) name attribute of DOM elmenet
	*  @return	(mixed)
	*/
	
	function get_error( $input ) {
		
		// bail early if no errors
		if( empty($this->errors) ) return false;
		
		
		// loop
		foreach( $this->errors as $error ) {
			
			if( $error['input'] === $input ) return $error;
			
		}
		
		
		// return
		return false;
				
	}
	
	
	/*
	*  get_errors
	*
	*  This function will return validation errors
	*
	*  @type	function
	*  @date	25/11/2013
	*  @since	5.0.0
	*
	*  @param	n/a
	*  @return	(array|boolean)
	*/
	
	function get_errors() {
		
		// bail early if no errors
		if( empty($this->errors) ) return false;
		
		
		// return
		return $this->errors;
		
	}
	
	
	/*
	*  reset_errors
	*
	*  This function will remove all errors
	*
	*  @type	function
	*  @date	4/03/2016
	*  @since	5.3.2
	*
	*  @param	n/a
	*  @return	n/a
	*/
	
	function reset_errors() {
		
		$this->errors = array();
		
	}
	
	
	/*
	*  ajax_validate_save_post
	*
	*  This function will validate the $_POST data via AJAX
	*
	*  @type	function
	*  @date	27/10/2014
	*  @since	5.0.9
	*
	*  @param	n/a
	*  @return	n/a
	*/
	
	function ajax_validate_save_post() {
		
		// validate
		if( !acf_verify_ajax() ) die();
		
		
		// vars
		$json = array(
			'valid'		=> 1,
			'errors'	=> 0
		);
		
		
		// success
		if( acf_validate_save_post() ) {
			
			wp_send_json_success($json);
			
		}
		
		
		// update vars
		$json['valid'] = 0;
		$json['errors'] = acf_get_validation_errors();
		
		
		// return
		wp_send_json_success($json);
		
	}
	
	
	/*
	*  validate_value
	*
	*  This function will validate a field's value
	*
	*  @type	function
	*  @date	27/10/2014
	*  @since	5.0.9
	*
	*  @param	$value (mixed)
	*  @param	$field (array)
	*  @param	$input (string) name attribute of DOM elmenet
	*  @return	(boolean)
	*/
	
	function validate_value( $value, $field, $input ) {
		
		// vars
		$valid = true;
		$message = sprintf( __( '%s value is required', 'acf' ), $field['label'] );
		
		
		// valid
		if( $field['required'] ) {
			
			// valid is set to false if the value is empty, but allow 0 as a valid value
			if( empty($value) && !is_numeric($value) ) {
				
				$valid = false;
				
			}
			
		}
		
		
		// filter for 3rd party customization
		$valid = apply_filters( "acf/validate_value", $valid, $value, $field, $input );
		$valid = apply_filters( "acf/validate_value/type={$field['type']}", $valid, $value, $field, $input );
		$valid = apply_filters( "acf/validate_value/name={$field['name']}", $valid, $value, $field, $input );
		$valid = apply_filters( "acf/validate_value/key={$field['key']}", $valid, $value, $field, $input );
		
		
		// allow $valid to be a custom error message
		if( !empty($valid) && is_string($valid) ) {
			
			$message = $valid;
			$valid = false;
			
		}
		
		
		if( !$valid ) {
			
			acf_add_validation_error( $input, $message );
			return false;
			
		}
		
		
		// return
		return true;
		
	}
	

	/*
	*  acf_validate_save_post
	*
	*  This function will loop over $_POST data and validate
	*
	*  @type	action 'acf/validate_save_post' 5
	*  @date	7/09/2016
	*  @since	5.4.0
	*
	*  @param	n/a
	*  @return	n/a
	*/
	
	function acf_validate_save_post() {
		
		// bail early if no $_POST
		if( empty($_POST['acf']) ) return;
		
		
		// loop
		foreach( $_POST['acf'] as $field_key => $value ) {
			
			// get field
			$field = acf_get_field( $field_key );
			$input = 'acf[' . $field_key . ']';
			
			
			// bail early if not found
			if( !$field ) continue;
			
			
			// validate
			acf_validate_value( $value, $field, $input );
			
		}
		
	}
	
	
	/*
	*  validate_save_post
	*
	*  This function will validate $_POST data and add errors
	*
	*  @type	function
	*  @date	25/11/2013
	*  @since	5.0.0
	*
	*  @param	$show_errors (boolean) if true, errors will be shown via a wp_die screen
	*  @return	(boolean)
	*/
	
	function validate_save_post( $show_errors = false ) {
		
		// action
		do_action('acf/validate_save_post');
		
		
		// vars
		$errors = acf_get_validation_errors();
		
		
		// bail ealry if no errors
		if( !$errors ) return true;
		
		
		// show errors
		if( $show_errors ) {
				
			$message = '<h2>' . __('Validation failed', 'acf') . '</h2>';
			$message .= '<ul>';
			foreach( $errors as $error ) {
				
				$message .= '<li>' . $error['message'] . '</li>';
				
			}
			$message .= '</ul>';
			
			
			// die
			wp_die( $message, 'Validation failed' );
			
		}
		
		
		// return
		return false;
		
	}
	
}

// initialize
acf()->validation = new acf_validation();

endif; // class_exists check




/*
*  acf_add_validation_error
*
*  alias of acf()->validation->add_error()
*
*  @type	function
*  @date	6/10/13
*  @since	5.0.0
*
*  @param	n/a
*  @return	n/a
*/

function acf_add_validation_error( $input, $message = '' ) {
	
	return acf()->validation->add_error( $input, $message );
	
}


/*
*  acf_get_validation_errors
*
*  alias of acf()->validation->get_errors()
*
*  @type	function
*  @date	6/10/13
*  @since	5.0.0
*
*  @param	n/a
*  @return	n/a
*/

function acf_get_validation_errors() {
	
	return acf()->validation->get_errors();
	
}


/*
*  acf_reset_validation_errors
*
*  alias of acf()->validation->reset_errors()
*
*  @type	function
*  @date	6/10/13
*  @since	5.0.0
*
*  @param	n/a
*  @return	n/a
*/

function acf_reset_validation_errors() {
	
	return acf()->validation->reset_errors();
	
}


/*
*  acf_validate_save_post
*
*  alias of acf()->validation->validate_save_post()
*
*  @type	function
*  @date	6/10/13
*  @since	5.0.0
*
*  @param	n/a
*  @return	n/a
*/

function acf_validate_save_post( $show_errors = false ) {
	
	return acf()->validation->validate_save_post( $show_errors );
	
}


/*
*  acf_validate_value
*
*  alias of acf()->validation->validate_value()
*
*  @type	function
*  @date	6/10/13
*  @since	5.0.0
*
*  @param	n/a
*  @return	n/a
*/

function acf_validate_value( $value, $field, $input ) {
	
	return acf()->validation->validate_value( $value, $field, $input );
	
}