class-wc-validation.php — WooCommerce 10.8.1

woocommerce / includes / class-wc-validation.php

woocommerce / includes Last commit date

class-wc-validation.php

203 lines

1	<?php
2	/**
3	* General user data validation methods
4	*
5	* @package WooCommerce\Classes
6	* @version 2.4.0
7	*/
8
9	defined( 'ABSPATH' ) \|\| exit;
10
11	/**
12	* Validation class.
13	*/
14	class WC_Validation {
15
16	/**
17	* Validates an email using WordPress native is_email function.
18	*
19	* @param string $email Email address to validate.
20	* @return bool
21	*/
22	public static function is_email( $email ) {
23	return is_email( $email );
24	}
25
26	/**
27	* Validates a phone number using a regular expression.
28	*
29	* @param string $phone Phone number to validate.
30	* @return bool
31	*/
32	public static function is_phone( $phone ) {
33	if ( 0 < strlen( trim( preg_replace( '/[\s\#0-9_\-\+\/\.]/', '', $phone ) ) ) ) {
34	return false;
35	}
36
37	return true;
38	}
39
40	/**
41	* Checks for a valid postcode.
42	*
43	* @param string $postcode Postcode to validate.
44	* @param string $country Country to validate the postcode for.
45	* @return bool
46	*/
47	public static function is_postcode( $postcode, $country ) {
48	if ( strlen( trim( preg_replace( '/[\s\-A-Za-z0-9]/', '', $postcode ) ) ) > 0 ) {
49	return false;
50	}
51
52	switch ( $country ) {
53	case 'AT':
54	case 'BE':
55	case 'CH':
56	case 'HU':
57	case 'NO':
58	$valid = (bool) preg_match( '/^([0-9]{4})$/', $postcode );
59	break;
60	case 'BA':
61	$valid = (bool) preg_match( '/^([7-8]{1})([0-9]{4})$/', $postcode );
62	break;
63	case 'BR':
64	$valid = (bool) preg_match( '/^([0-9]{5})([-])?([0-9]{3})$/', $postcode );
65	break;
66	case 'DE':
67	$valid = (bool) preg_match( '/^([0]{1}[1-9]{1}\|[1-9]{1}[0-9]{1})[0-9]{3}$/', $postcode );
68	break;
69	case 'DK':
70	$valid = (bool) preg_match( '/^(DK-)?([1-24-9]\d{3}\|3[0-8]\d{2})$/', $postcode );
71	break;
72	case 'ES':
73	case 'FI':
74	case 'EE':
75	case 'FR':
76	case 'IT':
77	$valid = (bool) preg_match( '/^([0-9]{5})$/i', $postcode );
78	break;
79	case 'GB':
80	$valid = self::is_gb_postcode( $postcode );
81	break;
82	case 'IE':
83	$valid = (bool) preg_match( '/([AC-FHKNPRTV-Y]\d{2}\|D6W)[0-9AC-FHKNPRTV-Y]{4}/', wc_normalize_postcode( $postcode ) );
84	break;
85	case 'IN':
86	$valid = (bool) preg_match( '/^[1-9]{1}[0-9]{2}\s{0,1}[0-9]{3}$/', $postcode );
87	break;
88	case 'JP':
89	$valid = (bool) preg_match( '/^([0-9]{3})([-]?)([0-9]{4})$/', $postcode );
90	break;
91	case 'PT':
92	$valid = (bool) preg_match( '/^([0-9]{4})([-])([0-9]{3})$/', $postcode );
93	break;
94	case 'PR':
95	case 'US':
96	$valid = (bool) preg_match( '/^([0-9]{5})(-[0-9]{4})?$/i', $postcode );
97	break;
98	case 'CA':
99	// CA Postal codes cannot contain D,F,I,O,Q,U and cannot start with W or Z. https://en.wikipedia.org/wiki/Postal_codes_in_Canada#Number_of_possible_postal_codes.
100	$valid = (bool) preg_match( '/^([ABCEGHJKLMNPRSTVXY]\d[ABCEGHJKLMNPRSTVWXYZ])([\ ])?(\d[ABCEGHJKLMNPRSTVWXYZ]\d)$/i', $postcode );
101	break;
102	case 'PL':
103	$valid = (bool) preg_match( '/^([0-9]{2})([-])([0-9]{3})$/', $postcode );
104	break;
105	case 'CZ':
106	case 'SE':
107	case 'SK':
108	$valid = (bool) preg_match( "/^($country-)?([0-9]{3})(\s?)([0-9]{2})$/", $postcode );
109	break;
110	case 'NL':
111	$valid = (bool) preg_match( '/^([1-9][0-9]{3})(\s?)(?!SA\|SD\|SS)[A-Z]{2}$/i', $postcode );
112	break;
113	case 'SI':
114	$valid = (bool) preg_match( '/^([1-9][0-9]{3})$/', $postcode );
115	break;
116	case 'LI':
117	$valid = (bool) preg_match( '/^(94[8-9][0-9])$/', $postcode );
118	break;
119	default:
120	$valid = true;
121	break;
122	}
123
124	return apply_filters( 'woocommerce_validate_postcode', $valid, $postcode, $country );
125	}
126
127	/**
128	* Check if is a GB postcode.
129	*
130	* @param string $to_check A postcode.
131	* @return bool
132	*/
133	public static function is_gb_postcode( $to_check ) {
134
135	// Permitted letters depend upon their position in the postcode.
136	// https://en.wikipedia.org/wiki/Postcodes_in_the_United_Kingdom#Validation.
137	$alpha1 = '[abcdefghijklmnoprstuwyz]'; // Character 1.
138	$alpha2 = '[abcdefghklmnopqrstuvwxy]'; // Character 2.
139	$alpha3 = '[abcdefghjkpstuw]'; // Character 3 == ABCDEFGHJKPSTUW.
140	$alpha4 = '[abehmnprvwxy]'; // Character 4 == ABEHMNPRVWXY.
141	$alpha5 = '[abdefghjlnpqrstuwxyz]'; // Character 5 != CIKMOV.
142
143	$pcexp = array();
144
145	// Expression for postcodes: AN NAA, ANN NAA, AAN NAA, and AANN NAA.
146	$pcexp[0] = '/^(' . $alpha1 . '{1}' . $alpha2 . '{0,1}[0-9]{1,2})([0-9]{1}' . $alpha5 . '{2})$/';
147
148	// Expression for postcodes: ANA NAA.
149	$pcexp[1] = '/^(' . $alpha1 . '{1}[0-9]{1}' . $alpha3 . '{1})([0-9]{1}' . $alpha5 . '{2})$/';
150
151	// Expression for postcodes: AANA NAA.
152	$pcexp[2] = '/^(' . $alpha1 . '{1}' . $alpha2 . '[0-9]{1}' . $alpha4 . ')([0-9]{1}' . $alpha5 . '{2})$/';
153
154	// Exception for the special postcode GIR 0AA.
155	$pcexp[3] = '/^(gir)(0aa)$/';
156
157	// Standard BFPO numbers.
158	$pcexp[4] = '/^(bfpo)([0-9]{1,4})$/';
159
160	// c/o BFPO numbers.
161	$pcexp[5] = '/^(bfpo)(c\/o[0-9]{1,3})$/';
162
163	// Load up the string to check, converting into lowercase and removing spaces.
164	$postcode = strtolower( $to_check );
165	$postcode = str_replace( ' ', '', $postcode );
166
167	// Assume we are not going to find a valid postcode.
168	$valid = false;
169
170	// Check the string against the six types of postcodes.
171	foreach ( $pcexp as $regexp ) {
172	if ( preg_match( $regexp, $postcode, $matches ) ) {
173	// Remember that we have found that the code is valid and break from loop.
174	$valid = true;
175	break;
176	}
177	}
178
179	return $valid;
180	}
181
182	/**
183	* Format the postcode according to the country and length of the postcode.
184	*
185	* @param string $postcode Postcode to format.
186	* @param string $country Country to format the postcode for.
187	* @return string Formatted postcode.
188	*/
189	public static function format_postcode( $postcode, $country ) {
190	return wc_format_postcode( $postcode, $country );
191	}
192
193	/**
194	* Format a given phone number.
195	*
196	* @param mixed $tel Phone number to format.
197	* @return string
198	*/
199	public static function format_phone( $tel ) {
200	return wc_format_phone_number( $tel );
201	}
202	}
203