PluginProbe
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More / trunk
Formidable Forms – WordPress Form Builder for Contact Forms, Calculators, Quizzes & More vtrunk
6.35 6.34 6.33.1 6.33 6.32.1 6.32 6.31 6.25 6.25.1 6.26 6.26.1 6.27 6.28 6.29 6.3 6.3.1 6.3.2 6.30 6.4 6.4.1 6.4.2 6.5 6.5.1 6.5.2 6.5.3 All 141 releases
← All changes | classes/models/FrmField.php +823 -312 6.5.2 → trunk View file →
@@ -4,73 +4,111 @@
4 4 }
5 5
6 6 class FrmField {
7 7
8 + /**
9 + * @var bool
10 + */
8 11 public static $use_cache = true;
12 +
13 + /**
14 + * @var int
15 + */
9 16 public static $transient_size = 200;
10 17
18 + /**
19 + * @return array
20 + */
11 21 public static function field_selection() {
12 22 $fields = array(
13 - 'text' => array(
23 + 'text' => array(
14 24 'name' => __( 'Text', 'formidable' ),
15 - 'icon' => 'frm_icon_font frm_text2_icon',
25 + 'icon' => 'frmfont frm_text2_icon',
16 26 ),
17 - 'textarea' => array(
27 + 'textarea' => array(
18 28 'name' => __( 'Paragraph', 'formidable' ),
19 - 'icon' => 'frm_icon_font frm_paragraph_icon',
29 + 'icon' => 'frmfont frm_paragraph_icon',
20 30 ),
21 - 'checkbox' => array(
31 + 'checkbox' => array(
22 32 'name' => __( 'Checkboxes', 'formidable' ),
23 - 'icon' => 'frm_icon_font frm_check_square_icon',
33 + 'icon' => 'frmfont frm_check_square_icon',
24 34 ),
25 - 'radio' => array(
35 + 'radio' => array(
26 36 'name' => __( 'Radio Buttons', 'formidable' ),
27 - 'icon' => 'frm_icon_font frm_radio_checked_icon',
37 + 'icon' => 'frmfont frm_radio_checked_icon',
28 38 ),
29 - 'select' => array(
39 + 'select' => array(
30 40 'name' => __( 'Dropdown', 'formidable' ),
31 - 'icon' => 'frm_icon_font frm_caret_square_down_icon',
41 + 'icon' => 'frmfont frm_dropdown_icon',
32 42 ),
33 - 'email' => array(
43 + 'email' => array(
34 44 'name' => __( 'Email', 'formidable' ),
35 - 'icon' => 'frm_icon_font frm_email_icon',
45 + 'icon' => 'frmfont frm_email2_icon',
36 46 ),
37 - 'url' => array(
47 + 'url' => array(
38 48 'name' => __( 'Website/URL', 'formidable' ),
39 - 'icon' => 'frm_icon_font frm_link_icon',
49 + 'icon' => 'frmfont frm_link2_icon',
40 50 ),
41 - 'number' => array(
51 + 'number' => array(
42 52 'name' => __( 'Number', 'formidable' ),
43 - 'icon' => 'frm_icon_font frm_hashtag_icon',
53 + 'icon' => 'frmfont frm_hashtag_icon',
44 54 ),
45 - 'name' => array(
55 + 'name' => array(
46 56 'name' => __( 'Name', 'formidable' ),
47 - 'icon' => 'frm_icon_font frm_user_name_icon',
57 + 'icon' => 'frmfont frm_user_name_icon',
48 58 ),
49 - 'phone' => array(
59 + 'phone' => array(
50 60 'name' => __( 'Phone', 'formidable' ),
51 - 'icon' => 'frm_icon_font frm_phone_icon',
61 + 'icon' => 'frmfont frm_phone_icon',
52 62 ),
53 - 'html' => array(
63 + 'html' => array(
54 64 'name' => __( 'HTML', 'formidable' ),
55 - 'icon' => 'frm_icon_font frm_code_icon',
65 + 'icon' => 'frmfont frm_code2_icon',
56 66 ),
57 - 'hidden' => array(
67 + 'hidden' => array(
58 68 'name' => __( 'Hidden', 'formidable' ),
59 - 'icon' => 'frm_icon_font frm_eye_slash_icon',
69 + 'icon' => 'frmfont frm_eye_slash2_icon',
60 70 ),
61 - 'user_id' => array(
71 + 'user_id' => array(
62 72 'name' => __( 'User ID', 'formidable' ),
63 - 'icon' => 'frm_icon_font frm_user_icon',
73 + 'icon' => 'frmfont frm_user2_icon',
64 74 ),
65 - 'captcha' => array(
75 + 'captcha' => array(
66 76 'name' => self::get_captcha_field_name(),
67 - 'icon' => 'frm_icon_font frm_shield_check_icon',
77 + 'icon' => 'frmfont frm_shield_check2_icon',
68 78 ),
69 - 'credit_card' => array(
70 - 'name' => __( 'Payment', 'formidable' ),
71 - 'icon' => 'frm_icon_font frm_credit_card_icon',
79 + 'credit_card' => array(
80 + 'name' => __( 'Payment', 'formidable' ),
81 + 'icon' => 'frmfont frm_credit_card2_icon',
72 82 ),
83 + 'address' => array(
84 + 'name' => __( 'Address', 'formidable' ),
85 + 'icon' => 'frmfont frm_location2_icon',
86 + ),
87 + FrmSubmitHelper::FIELD_TYPE => array(
88 + 'name' => __( 'Submit', 'formidable' ),
89 + 'hide' => true,
90 + ),
91 + FrmFieldGdprHelper::FIELD_TYPE => array(
92 + 'name' => __( 'GDPR', 'formidable' ),
93 + 'icon' => 'frmfont frm-gdpr-icon',
94 + 'hide' => FrmFieldGdprHelper::hide_gdpr_field(),
95 + ),
96 + 'product' => array(
97 + 'name' => __( 'Product', 'formidable' ),
98 + 'icon' => 'frmfont frm_product2_icon',
99 + 'section' => 'pricing',
100 + ),
101 + 'quantity' => array(
102 + 'name' => __( 'Quantity', 'formidable' ),
103 + 'icon' => 'frmfont frm_quantity_icon',
104 + 'section' => 'pricing',
105 + ),
106 + 'total' => array(
107 + 'name' => __( 'Total', 'formidable' ),
108 + 'icon' => 'frmfont frm_total2_icon',
109 + 'section' => 'pricing',
110 + ),
73 111 );
74 112
75 113 /**
76 114 * @param array $fields
@@ -83,164 +121,252 @@
83 121 *
84 122 * @return string
85 123 */
86 124 private static function get_captcha_field_name() {
87 - $frm_settings = FrmAppHelper::get_settings();
88 - $active_captcha = $frm_settings->active_captcha;
89 - if ( ! FrmFieldCaptcha::should_show_captcha() ) {
90 - $captcha_name = 'Captcha';
91 - } elseif ( $active_captcha === 'recaptcha' ) {
92 - $captcha_name = 'reCAPTCHA';
93 - } else {
94 - $captcha_name = 'hCaptcha';
95 - }
96 - return $captcha_name;
125 + return 'Captcha';
97 126 }
98 127
128 + /**
129 + * @return array
130 + */
99 131 public static function pro_field_selection() {
100 - $images_url = FrmAppHelper::plugin_url() . '/images/';
101 - $fields = array(
102 - 'file' => array(
103 - 'name' => __( 'File Upload', 'formidable' ),
104 - 'icon' => 'frm_icon_font frm_upload_icon',
105 - 'message' => 'Add file uploads to save time and cut down on back-and-forth. Upgrade to Pro to get Upload fields and more.',
132 + $upsell_images_url = FrmAppHelper::plugin_url() . '/images/upsell/';
133 + $fields = array(
134 + 'file' => array(
135 + 'name' => __( 'File Upload', 'formidable' ),
136 + 'icon' => 'frmfont frm_upload3_icon',
137 + 'message' => __( 'Add file uploads to save time and cut down on back-and-forth. Upgrade to Pro to get Upload fields and more.', 'formidable' ),
138 + 'upsell_image' => $upsell_images_url . 'file-upload-field-preview.webp',
139 + 'learn-more' => 'features/wordpress-multiple-file-upload-form',
106 140 ),
107 - 'rte' => array(
108 - 'name' => __( 'Rich Text', 'formidable' ),
109 - 'icon' => 'frm_icon_font frm_align_right_icon',
141 + 'ranking' => array(
142 + 'name' => __( 'Ranking', 'formidable' ),
143 + 'icon' => 'frmfont frm_chart_bar_icon frm_show_upgrade',
144 + 'message' => __( 'Now you can effortlessly gather insights, preferences, and opinions by allowing users to rank options.', 'formidable' ),
145 + 'upsell_image' => $upsell_images_url . 'ranking-field-preview.webp',
146 + 'addon' => 'surveys',
147 + 'learn-more' => 'ranking-survey',
110 148 ),
111 - 'date' => array(
112 - 'name' => __( 'Date', 'formidable' ),
113 - 'icon' => 'frm_icon_font frm_calendar_icon',
149 + 'rte' => array(
150 + 'name' => __( 'Rich Text', 'formidable' ),
151 + 'icon' => 'frmfont frm_align_right_icon',
152 + 'message' => __( 'Go beyond plain text, let your users format their content with bolding, italics, links, lists and more.', 'formidable' ),
153 + 'upsell_image' => $upsell_images_url . 'rich-text-field-preview.webp',
154 + 'learn-more' => 'rich-text',
114 155 ),
115 - 'time' => array(
116 - 'name' => __( 'Time', 'formidable' ),
117 - 'icon' => 'frm_icon_font frm_clock_icon',
156 + 'date' => array(
157 + 'name' => __( 'Date', 'formidable' ),
158 + 'icon' => 'frmfont frm_calendar2_icon',
159 + 'message' => __( 'Capture exact calendar dates effortlessly with a sleek pop-up date picker, ensuring clarity and consistency for scheduling, tracking deadlines, and more.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
160 + 'upsell_image' => $upsell_images_url . 'date-field-preview.webp',
161 + 'learn-more' => 'date',
118 162 ),
119 - 'scale' => array(
120 - 'name' => __( 'Scale', 'formidable' ),
121 - 'icon' => 'frm_icon_font frm_linear_scale_icon',
122 - 'message' => 'Add a set of radio buttons with whatever range you choose. <img src="' . esc_attr( $images_url ) . 'scale_field.png" alt="Scale Field" />',
163 + 'time' => array(
164 + 'name' => __( 'Time', 'formidable' ),
165 + 'icon' => 'frmfont frm_clock_icon',
166 + 'message' => __( 'Precisely log important moments with an intuitive time selection tool, perfect for managing events, availability, or operational hours.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
167 + 'upsell_image' => $upsell_images_url . 'time-field-preview.webp',
168 + 'learn-more' => 'time',
123 169 ),
124 - 'star' => array(
125 - 'name' => __( 'Star Rating', 'formidable' ),
126 - 'icon' => 'frm_icon_font frm_star_icon',
170 + 'scale' => array(
171 + 'name' => __( 'Scale', 'formidable' ),
172 + 'icon' => 'frmfont frm_linear_scale_icon',
173 + 'message' => esc_html__( 'Easily measure satisfaction or quantity using a simple, clear numerical scale, giving you fast, quantifiable insights into user feedback.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
174 + 'upsell_image' => $upsell_images_url . 'scale-field-preview.webp',
175 + 'learn-more' => 'scale',
127 176 ),
128 - 'range' => array(
129 - 'name' => __( 'Slider', 'formidable' ),
130 - 'icon' => 'frm_icon_font frm_code_commit_icon',
177 + 'star' => array(
178 + 'name' => __( 'Star Rating', 'formidable' ),
179 + 'icon' => 'frmfont frm_star2_icon',
180 + 'message' => esc_html__( 'Capture instant, appealing feedback with a familiar visual star system, providing immediate and engaging quality assessments from your users.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
181 + 'upsell_image' => $upsell_images_url . 'star-field-preview.webp',
182 + 'learn-more' => 'star-ratings',
131 183 ),
132 - 'toggle' => array(
133 - 'name' => __( 'Toggle', 'formidable' ),
134 - 'icon' => 'frm_icon_font frm_toggle_on_icon',
184 + 'range' => array(
185 + 'name' => __( 'Slider', 'formidable' ),
186 + 'icon' => 'frmfont frm_code_commit_icon',
187 + 'message' => esc_html__( 'Let users quickly select values within a range using a dynamic, interactive slider, creating a modern and enjoyable data input experience.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
188 + 'upsell_image' => $upsell_images_url . 'slider-field-preview.webp',
189 + 'learn-more' => 'slider',
135 190 ),
136 - 'data' => array(
137 - 'name' => __( 'Dynamic', 'formidable' ),
138 - 'icon' => 'frm_icon_font frm_sitemap_icon',
139 - 'message' => 'Create relationships between multiple forms. You can link a member to a team, a rating to a product, a comment to a submission, and much more.',
191 + 'toggle' => array(
192 + 'name' => __( 'Toggle', 'formidable' ),
193 + 'icon' => 'frmfont frm_toggle_on_icon',
194 + 'message' => esc_html__( 'Quickly and easily create cascading fields, populate fields by search and more.', 'formidable' ),
195 + 'upsell_image' => $upsell_images_url . 'toggle-field-preview.webp',
196 + 'learn-more' => 'toggle',
140 197 ),
141 - 'lookup' => array(
142 - 'name' => __( 'Lookup', 'formidable' ),
143 - 'icon' => 'frm_icon_font frm_search_icon',
144 - 'message' => 'Filter the options in the next field and automatically add values to other fields. Upgrade to Pro to get Lookup fields and more. <img src="' . esc_attr( $images_url ) . 'look-up_year-make-model.gif" alt="cascading lookup fields" />',
198 + 'data' => array(
199 + 'name' => __( 'Dynamic', 'formidable' ),
200 + 'icon' => 'frmfont frm_dynamic_icon',
201 + 'message' => __( 'Link entries together, dynamic display information, and even make selections from data entered on another form.', 'formidable' ),
202 + 'upsell_image' => $upsell_images_url . 'dynamic-field-preview.webp',
203 + 'learn-more' => 'dynamic',
145 204 ),
146 - 'divider|repeat' => array(
147 - 'name' => __( 'Repeater', 'formidable' ),
148 - 'icon' => 'frm_icon_font frm_repeater_icon',
149 - 'message' => 'Allow your visitors to add new sets of fields while filling out forms. Increase conversions while saving building time and server resources. <img src="' . esc_attr( $images_url ) . 'repeatable-section_frontend.gif" alt="Dynamically Add Form Fields with repeatable sections" />',
205 + 'lookup' => array(
206 + 'name' => __( 'Lookup', 'formidable' ),
207 + 'icon' => 'frmfont frm_search_icon',
208 + 'message' => esc_html__( 'Link entries together, dynamic display information, and even make selections from data entered on another form.', 'formidable' ),
209 + 'upsell_image' => $upsell_images_url . 'lookup-field-preview.webp',
210 + 'learn-more' => 'lookup',
150 211 ),
151 - 'end_divider' => array(
212 + 'divider|repeat' => array(
213 + 'name' => __( 'Repeater', 'formidable' ),
214 + 'icon' => 'frmfont frm_refresh_icon',
215 + 'message' => esc_html__( 'Allow users to add rows of fields dynamically as needed (like for multiple attendees or items), making complex data entry flexible and intuitive.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
216 + 'upsell_image' => $upsell_images_url . 'repeater-field-preview.webp',
217 + 'learn-more' => 'repeatable-section',
218 + ),
219 + 'end_divider' => array(
152 220 'name' => __( 'Section Buttons', 'formidable' ),
153 221 'switch_from' => 'divider',
154 222 ),
155 - 'divider' => array(
156 - 'name' => __( 'Section', 'formidable' ),
157 - 'icon' => 'frm_icon_font frm_header_icon',
223 + 'divider' => array(
224 + 'name' => __( 'Section', 'formidable' ),
225 + 'icon' => 'frmfont frm_header_icon',
226 + 'message' => esc_html__( 'Enhance the user experience and improve completion rates by dividing long surveys into clean, manageable steps with distinct pages.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
227 + 'upsell_image' => $upsell_images_url . 'section-field-preview.webp',
228 + 'learn-more' => 'section-heading',
158 229 ),
159 - 'break' => array(
160 - 'name' => __( 'Page Break', 'formidable' ),
161 - 'icon' => 'frm_icon_font frm_page_break_icon',
162 - 'message' => 'Get multi-paged forms with progress bars. Did you know you can upgrade to PRO to unlock multi-step forms with more awesome features?',
230 + 'break' => array(
231 + 'name' => __( 'Page Break', 'formidable' ),
232 + 'icon' => 'frmfont frm_page_break_icon',
233 + 'message' => esc_html__( 'Enhance the user experience and improve completion rates by dividing long surveys into clean, manageable steps with distinct pages.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
234 + 'upsell_image' => $upsell_images_url . 'page-break-field-preview.webp',
235 + 'learn-more' => 'page-breaks',
163 236 ),
164 - 'form' => array(
165 - 'name' => __( 'Embed Form', 'formidable' ),
166 - 'icon' => 'frm_icon_font frm_file_text_icon',
237 + 'form' => array(
238 + 'name' => __( 'Embed Form', 'formidable' ),
239 + 'icon' => 'frmfont frm_file_text2_icon',
240 + 'message' => esc_html__( 'Seamlessly integrate other existing forms or external content directly inside your current form, creating powerful, interconnected workflows.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
241 + 'upsell_image' => $upsell_images_url . 'embed-form-field-preview.webp',
242 + 'learn-more' => 'embed-form',
167 243 ),
168 - 'likert' => array(
169 - 'name' => __( 'Likert Scale', 'formidable' ),
170 - 'icon' => 'frm_icon_font frm_likert_scale frm_show_upgrade',
171 - 'addon' => 'surveys',
244 + 'likert' => array(
245 + 'name' => __( 'Likert Scale', 'formidable' ),
246 + 'icon' => 'frmfont frm_likert_scale frm_show_upgrade',
247 + 'addon' => 'surveys',
248 + 'message' => esc_html__( 'Get nuanced, detailed opinions using standardized agreement scales, unlocking deeper insights beyond simple yes/no answers.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
249 + 'upsell_image' => $upsell_images_url . 'likert-field-preview.webp',
250 + 'learn-more' => 'likert-scale',
172 251 ),
173 - 'nps' => array(
174 - 'name' => __( 'NPS', 'formidable' ),
175 - 'icon' => 'frm_icon_font frm_nps frm_show_upgrade',
176 - 'addon' => 'surveys',
252 + 'nps' => array(
253 + 'name' => __( 'NPS', 'formidable' ),
254 + 'icon' => 'frmfont frm_nps frm_show_upgrade',
255 + 'addon' => 'surveys',
256 + 'message' => esc_html__( 'Directly measure customer loyalty with the industry-standard Net Promoter Score® field, giving you a single, vital metric for business growth.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
257 + 'upsell_image' => $upsell_images_url . 'nps-field-preview.webp',
258 + 'learn-more' => 'net-promoter-score',
177 259 ),
178 - 'password' => array(
179 - 'name' => __( 'Password', 'formidable' ),
180 - 'icon' => 'frm_icon_font frm_lock_open_icon',
260 + 'password' => array(
261 + 'name' => __( 'Password', 'formidable' ),
262 + 'icon' => 'frmfont frm_lock_closed2_icon',
263 + 'message' => esc_html__( 'Confidently collect sensitive credentials or create secure sections with a dedicated field that masks input for privacy and security.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
264 + 'upsell_image' => $upsell_images_url . 'password-field-preview.webp',
265 + 'learn-more' => 'password-2',
181 266 ),
182 - 'tag' => array(
183 - 'name' => __( 'Tags', 'formidable' ),
184 - 'icon' => 'frm_icon_font frm_price_tags_icon',
267 + 'tag' => array(
268 + 'name' => __( 'Tags', 'formidable' ),
269 + 'icon' => 'frmfont frm_price_tags2_icon',
270 + 'message' => esc_html__( 'Facilitate easy categorization and analysis by letting users select or create multiple relevant keywords or labels for their entry.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
271 + 'upsell_image' => $upsell_images_url . 'tags-field-preview.webp',
272 + 'learn-more' => 'tags',
185 273 ),
186 274 // This is no longer a Pro field, but without this here, Pro triggers "undefined index" notices.
187 275 // Right now it leaves a gap. Maybe we can skip anything without a name or something.
188 - 'credit_card' => array(
189 - 'name' => '',
190 - 'icon' => '',
276 + 'credit_card' => array(
277 + 'name' => '',
278 + 'icon' => '',
191 279 ),
192 - 'address' => array(
193 - 'name' => __( 'Address', 'formidable' ),
194 - 'icon' => 'frm_icon_font frm_location_icon',
280 + 'address' => array(
281 + 'name' => __( 'Address', 'formidable' ),
282 + 'icon' => 'frmfont frm_location2_icon',
283 + 'message' => esc_html__( 'Instantly capture location information, simplifying logistics and contact collection. (Or go further with our Geolocation add-on!)', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
284 + 'upsell_image' => $upsell_images_url . 'address-field-preview.webp',
285 + 'learn-more' => 'address',
195 286 ),
196 - 'summary' => array(
197 - 'name' => __( 'Summary', 'formidable' ),
198 - 'icon' => 'frm_icon_font frm_file_text_icon',
199 - 'message' => 'Allow visitors to review their responses before a form is submitted. Upgrade to Pro to get Summary fields and more.',
287 + 'summary' => array(
288 + 'name' => __( 'Summary', 'formidable' ),
289 + 'icon' => 'frmfont frm_file_text3_icon',
290 + 'message' => __( 'Provide users with a clean, final review of all their entered data before submission, reducing errors and improving data quality.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
291 + 'upsell_image' => $upsell_images_url . 'summary-field-preview.webp',
292 + 'learn-more' => 'summary-review-before-submit',
200 293 ),
201 - 'signature' => array(
202 - 'name' => __( 'Signature', 'formidable' ),
203 - 'icon' => 'frm_icon_font frm_signature_icon frm_show_upgrade',
204 - 'addon' => 'signature',
294 + 'signature' => array(
295 + 'name' => __( 'Signature', 'formidable' ),
296 + 'icon' => 'frmfont frm_signature_icon frm_show_upgrade',
297 + 'addon' => 'signature',
298 + 'message' => __( 'Capture digital e-signatures directly within your form, making official agreements and authorizations straightforward.', 'formidable' ),
299 + 'upsell_image' => $upsell_images_url . 'signature-field-preview.webp',
300 + 'learn-more' => 'formidable-signature',
205 301 ),
206 - 'ai' => array(
207 - 'name' => __( 'AI', 'formidable' ),
208 - 'icon' => 'frm_icon_font frm_eye_icon frm_show_upgrade',
209 - 'addon' => 'ai',
210 - 'message' => 'Streamline workflows and reclaim valuable time with the power of AI. You can effortlessly respond to your visitors in real-time with ChatGPT as your automated assistant. Upgrade to Pro and unlock AI-powered fields.',
302 + 'ai' => array(
303 + 'name' => __( 'AI', 'formidable' ),
304 + 'icon' => 'frmfont frm-ai-icon frm_show_upgrade',
305 + 'addon' => 'ai',
306 + 'message' => __( 'Harness artificial intelligence by taking user input and let the model of your choice create an output, quickly and easily.', 'formidable' ),
307 + 'upsell_image' => $upsell_images_url . 'ai-field-preview.webp',
308 + 'learn-more' => 'form-ai',
211 309 ),
212 310 'ssa-appointment' => array(
213 - 'name' => __( 'Appointment', 'formidable' ),
214 - 'icon' => 'frm_icon_font frm_calendar_icon frm_show_upgrade',
215 - 'require' => 'Simply Schedule Appointments',
216 - 'message' => 'Appointment fields are an integration with <a href="https://simplyscheduleappointments.com/meet/formidable/">Simply Schedule Appointments</a>. Get started now to schedule appointments directly from your forms.
217 - <img src="' . esc_attr( $images_url ) . 'appointments.png" alt="Scheduling" />',
218 - 'link' => 'https://simplyscheduleappointments.com/meet/formidable/',
311 + 'name' => __( 'Appointment', 'formidable' ),
312 + 'icon' => 'frmfont frm_schedule_icon frm_show_upgrade',
313 + 'require' => 'Simply Schedule Appointments',
314 + 'message' => sprintf(
315 + /* translators: %1$s: Link opening HTML, %2$s: Link tag closing */
316 + esc_html__( 'Appointment fields are an integration with %1$sSimply Schedule Appointments%2$s. Get started now to schedule appointments directly from your forms.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
317 + '<a class="frm-inline-flex" href="https://simplyscheduleappointments.com/meet/formidable/" target="_blank" rel="noopener">',
318 + '</a>'
319 + ),
320 + 'link' => 'https://simplyscheduleappointments.com/meet/formidable/',
321 + 'upsell_image' => $upsell_images_url . 'appointment-field-preview.webp',
322 + 'learn-more' => 'simply-schedule-appointments-forms',
219 323 ),
220 - 'product' => array(
221 - 'name' => __( 'Product', 'formidable' ),
222 - 'icon' => 'frm_icon_font frm_product_icon',
223 - 'section' => 'pricing',
324 + 'virtual' => array(
325 + 'name' => __( 'Virtual', 'formidable' ),
326 + 'icon' => 'frmfont frm-virtual-field-icon',
327 + 'message' => esc_html__( 'Protect sensitive data by storing field values server-side only, preventing users from viewing or manipulating them in their browser.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
328 + 'upsell_image' => $upsell_images_url . 'virtual-field-preview.webp',
329 + 'learn-more' => '/virtual',
330 + 'is_new' => self::field_is_new( 'virtual' ),
224 331 ),
225 - 'quantity' => array(
226 - 'name' => __( 'Quantity', 'formidable' ),
227 - 'icon' => 'frm_icon_font frm_quantity_icon',
228 - 'section' => 'pricing',
332 + 'product' => array(
333 + 'name' => __( 'Product', 'formidable' ),
334 + 'icon' => 'frmfont frm_product2_icon',
335 + 'section' => 'pricing',
336 + 'message' => __( 'Turn your form into a simple storefront by adding fields to list products, choose quantities, and calculate totals, enabling direct sales.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
337 + 'upsell_image' => $upsell_images_url . 'product-field-preview.webp',
338 + 'learn-more' => 'features/pricing-fields',
229 339 ),
230 - 'total' => array(
231 - 'name' => __( 'Total', 'formidable' ),
232 - 'icon' => 'frm_icon_font frm_total_icon',
340 + 'quantity' => array(
341 + 'name' => __( 'Quantity', 'formidable' ),
342 + 'icon' => 'frmfont frm_quantity_icon',
343 + 'section' => 'pricing',
344 + 'message' => __( 'Turn your form into a simple storefront by adding fields to list products, choose quantities, and calculate totals, enabling direct sales.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
345 + 'upsell_image' => $upsell_images_url . 'quantity-field-preview.webp',
346 + 'learn-more' => 'features/pricing-fields',
347 + ),
348 + 'total' => array(
349 + 'name' => __( 'Total', 'formidable' ),
350 + 'icon' => 'frmfont frm_total2_icon',
351 + 'section' => 'pricing',
352 + 'message' => __( 'Turn your form into a simple storefront by adding fields to list products, choose quantities, and calculate totals, enabling direct sales.', 'formidable' ), // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
353 + 'upsell_image' => $upsell_images_url . 'total-field-preview.webp',
354 + 'learn-more' => 'features/pricing-fields',
355 + ),
356 + 'coupon' => array(
357 + 'name' => __( 'Coupon', 'formidable' ),
358 + 'icon' => 'frm_icon_font frm_coupon_icon frm_show_upgrade',
359 + 'addon' => 'coupons',
233 360 'section' => 'pricing',
361 + 'limit' => 1,
362 + 'is_new' => self::field_is_new( 'coupon' ),
234 363 ),
235 364 );
236 365
237 - if ( ! FrmAppHelper::show_new_feature( 'ai' ) ) {
238 - unset( $fields['ai'] );
239 - }
240 -
241 366 // Since the signature field may be in a different section, don't show it twice.
242 367 $lite_fields = self::field_selection();
368 +
243 369 if ( isset( $lite_fields['signature'] ) ) {
244 370 unset( $fields['signature'] );
245 371 }
246 372
@@ -247,13 +373,87 @@
247 373 return apply_filters( 'frm_pro_available_fields', $fields );
248 374 }
249 375
250 376 /**
377 + * Flag Pro field types that require a newer Pro version with frm_show_update.
378 + *
379 + * @since 6.29
380 + *
381 + * @param array $fields Available Pro field types.
382 + *
383 + * @return array
384 + */
385 + public static function show_update_for_pro_fields( $fields ) {
386 + if ( FrmAppHelper::pro_is_installed() && ! class_exists( 'FrmProVirtualFieldController', false ) ) {
387 + $fields['virtual']['icon'] .= ' frm_show_update';
388 + }
389 +
390 + return $fields;
391 + }
392 +
393 + /**
394 + * Gets field section labels in the form builder.
395 + *
396 + * @since 6.30
397 + *
398 + * @return array
399 + */
400 + public static function field_section_labels() {
401 + return apply_filters(
402 + 'frm_available_field_sections',
403 + array(
404 + 'pricing' => __( 'Pricing Fields', 'formidable' ),
405 + )
406 + );
407 + }
408 +
409 + /**
410 + * Consider a field new for 90 days after the release date.
411 + *
412 + * @since 6.8.3
413 + *
414 + * @param string $type
415 + *
416 + * @return bool
417 + */
418 + private static function field_is_new( $type ) {
419 + $release_dates = array(
420 + 'virtual' => '2026-03-10',
421 + );
422 +
423 + if ( ! isset( $release_dates[ $type ] ) ) {
424 + return false;
425 + }
426 +
427 + $release_date = $release_dates[ $type ];
428 + $three_months_after_release = gmdate( 'Y-m-d', strtotime( $release_date . ' + 90 days' ) );
429 + return gmdate( 'Y-m-d' ) < $three_months_after_release;
430 + }
431 +
432 + /**
433 + * Remove field types that are moved from Pro to Lite.
434 + *
435 + * @since 6.30
436 + *
437 + * @param array $pro_fields
438 + *
439 + * @return void
440 + */
441 + public static function remove_moved_field_types_from_pro( &$pro_fields ) {
442 + unset( $pro_fields['credit_card'] );
443 + unset( $pro_fields['product'] );
444 + unset( $pro_fields['quantity'] );
445 + unset( $pro_fields['total'] );
446 + unset( $pro_fields['address'] );
447 + }
448 +
449 + /**
251 450 * @since 4.0
451 + *
452 + * @return array
252 453 */
253 454 public static function all_field_selection() {
254 - $pro_field_selection = self::pro_field_selection();
255 - return array_merge( $pro_field_selection, self::field_selection() );
455 + return array_merge( self::pro_field_selection(), self::field_selection() );
256 456 }
257 457
258 458 /**
259 459 * Create a field.
@@ -259,28 +459,37 @@
259 459 * Create a field.
260 460 *
261 461 * @param array $values
262 462 * @param bool $return
263 - * @return int|false
463 + *
464 + * @return false|int
264 465 */
265 466 public static function create( $values, $return = true ) {
266 467 global $wpdb, $frm_duplicate_ids;
267 468
268 469 $new_values = array();
269 - $key = isset( $values['field_key'] ) ? $values['field_key'] : $values['name'];
470 + $key = $values['field_key'] ?? $values['name'];
270 471 $new_values['field_key'] = FrmAppHelper::get_unique_key( $key, $wpdb->prefix . 'frm_fields', 'field_key' );
271 472
272 473 $values = FrmAppHelper::maybe_filter_array( $values, array( 'name', 'description' ) );
273 474
274 475 foreach ( array( 'name', 'description', 'type', 'default_value' ) as $col ) {
275 - $new_values[ $col ] = $values[ $col ];
476 + if ( isset( $values[ $col ] ) ) {
477 + $new_values[ $col ] = $values[ $col ];
478 + }
276 479 }
277 480
278 - $new_values['options'] = self::maybe_filter_options( $values['options'] );
481 + // Both option columns are stored serialized, but they do not accept the same shapes.
482 + // Choice fields pass options already serialized, as does FrmFieldsHelper::fill_field
483 + // when a field is duplicated, and fields with no choices pass an empty string, so a
484 + // missing key is the only thing worth defaulting. An is_array check here would throw
485 + // every one of those defaults away. field_options is always an array, so anything
486 + // else is invalid input, and replacing it stops consumers getting null.
487 + $new_values['options'] = self::maybe_filter_options( $values['options'] ?? array() );
279 488 $new_values['field_order'] = isset( $values['field_order'] ) ? (int) $values['field_order'] : null;
280 489 $new_values['required'] = isset( $values['required'] ) ? (int) $values['required'] : 0;
281 490 $new_values['form_id'] = isset( $values['form_id'] ) ? (int) $values['form_id'] : null;
282 - $new_values['field_options'] = $values['field_options'];
491 + $new_values['field_options'] = isset( $values['field_options'] ) && is_array( $values['field_options'] ) ? $values['field_options'] : array();
283 492 $new_values['created_at'] = current_time( 'mysql', 1 );
284 493
285 494 if ( isset( $values['id'] ) ) {
286 495 $frm_duplicate_ids[ $values['field_key'] ] = $new_values['field_key'];
@@ -290,13 +499,9 @@
290 499 self::preserve_format_option_backslashes( $new_values );
291 500
292 501 foreach ( $new_values as $k => $v ) {
293 502 if ( is_array( $v ) ) {
294 - if ( $k === 'default_value' ) {
295 - $new_values[ $k ] = FrmAppHelper::maybe_json_encode( $v );
296 - } else {
297 - $new_values[ $k ] = serialize( $v );
298 - }
503 + $new_values[ $k ] = $k === 'default_value' ? FrmAppHelper::maybe_json_encode( $v ) : serialize( $v );
299 504 }
300 505 unset( $k, $v );
301 506 }
302 507
@@ -306,14 +511,15 @@
306 511 return false;
307 512 }
308 513
309 514 self::delete_form_transient( $new_values['form_id'] );
310 - $new_id = $wpdb->insert_id;
311 515
312 516 if ( ! $return ) {
313 517 return false;
314 518 }
315 519
520 + $new_id = $wpdb->insert_id;
521 +
316 522 if ( isset( $values['id'] ) ) {
317 523 $frm_duplicate_ids[ $values['id'] ] = $new_id;
318 524 }
319 525
@@ -320,24 +526,110 @@
320 526 return $new_id;
321 527 }
322 528
323 529 /**
530 + * Maybe filter HTML in field options data.
531 + * HTML is only filtered when unsafe HTML is disallowed.
532 + * See FrmAppHelper::allow_unfiltered_html.
533 + *
324 534 * @since 5.0.08
325 535 *
326 - * @param array $options
536 + * @param array|string $options Already serialized for choice fields, and an empty string for fields with no choices.
537 + *
327 538 * @return array
328 539 */
329 540 private static function maybe_filter_options( $options ) {
330 - return FrmAppHelper::maybe_filter_array( $options, array( 'custom_html' ) );
541 + $options = FrmAppHelper::maybe_filter_array( $options, array( 'custom_html' ) );
542 +
543 + if ( ! empty( $options['custom_html'] ) ) {
544 + $options['custom_html'] = self::maybe_filter_custom_html_input_attributes( $options['custom_html'] );
545 + }
546 +
547 + if ( ! empty( $options['classes'] ) ) {
548 + $options['classes'] = implode( ' ', array_map( 'FrmFormsHelper::sanitize_layout_class', explode( ' ', $options['classes'] ) ) );
549 + }
550 +
551 + return $options;
331 552 }
332 553
333 554 /**
555 + * Prevent users who do not have permission to insert JavaScript attributes in input elements.
556 + * This is triggered when a field is updated.
557 + *
558 + * @since 6.11.2
559 + *
560 + * @param string $html
561 + *
562 + * @return string
563 + */
564 + private static function maybe_filter_custom_html_input_attributes( $html ) {
565 + if ( FrmAppHelper::allow_unfiltered_html() ) {
566 + return $html;
567 + }
568 +
569 + $pattern = get_shortcode_regex( array( 'input' ) );
570 + return preg_replace_callback(
571 + "/$pattern/",
572 + /**
573 + * @param array $match Shortcode data.
574 + *
575 + * @return string
576 + */
577 + function ( $match ) {
578 + $attr = shortcode_parse_atts( $match[3] );
579 +
580 + if ( ! is_array( $attr ) ) {
581 + // In old versions of WordPress (older than 6.5), this might not be an array.
582 + return '[input]';
583 + }
584 +
585 + $safe_atts = array();
586 +
587 + foreach ( $attr as $attr_key => $att ) {
588 + if ( is_numeric( $attr_key ) ) {
589 + // Some data is mapped like 0 => 'placeholder="Placeholder"'.
590 + $split = explode( '=', $att, 2 );
591 +
592 + if ( 2 !== count( $split ) ) {
593 + continue;
594 + }
595 +
596 + $key = trim( $split[0] );
597 + $value = trim( $split[1], '"' );
598 + } else {
599 + // opt=1 without parentheses for example is mapped like 'opt' => 1.
600 + $key = $attr_key;
601 + $value = $att;
602 + }
603 +
604 + if ( FrmAppHelper::input_key_is_safe( $key, 'update' ) ) {
605 + $safe_atts[ $key ] = $value;
606 + }
607 + }//end foreach
608 +
609 + if ( ! $safe_atts ) {
610 + return '[input]';
611 + }
612 +
613 + return '[input ' . FrmAppHelper::array_to_html_params( $safe_atts ) . ']';
614 + },
615 + $html
616 + );
617 + }
618 +
619 + /**
334 620 * Process the field duplication.
335 621 *
336 622 * @since 5.0.05
623 + *
624 + * @param int|string $field_id Field ID.
625 + * @param int|string $form_id Form ID.
626 + *
627 + * @return array|false
337 628 */
338 629 public static function duplicate_single_field( $field_id, $form_id ) {
339 630 $copy_field = self::getOne( $field_id );
631 +
340 632 if ( ! $copy_field ) {
341 633 return false;
342 634 }
343 635
@@ -347,10 +639,9 @@
347 639 $values = array(
348 640 'id' => $copy_field->id,
349 641 );
350 642 FrmFieldsHelper::fill_field( $values, $copy_field, $copy_field->form_id );
351 - $values = apply_filters( 'frm_prepare_single_field_for_duplication', $values );
352 -
643 + $values = apply_filters( 'frm_prepare_single_field_for_duplication', $values );
353 644 $field_id = self::create( $values );
354 645
355 646 /**
356 647 * Fires after duplicating a field.
@@ -370,8 +661,16 @@
370 661
371 662 return compact( 'field_id', 'values' );
372 663 }
373 664
665 + /**
666 + * @param int|string $old_form_id
667 + * @param int|string $form_id
668 + * @param bool $copy_keys
669 + * @param false|int $blog_id
670 + *
671 + * @return void
672 + */
374 673 public static function duplicate( $old_form_id, $form_id, $copy_keys = false, $blog_id = false ) {
375 674 global $frm_duplicate_ids;
376 675
377 676 $where = array(
@@ -384,8 +683,10 @@
384 683 $fields = self::getAll( $where, 'field_order', '', $blog_id );
385 684
386 685 foreach ( (array) $fields as $field ) {
387 686 $new_key = $copy_keys ? $field->field_key : '';
687 +
688 + // phpcs:ignore Universal.Operators.StrictComparisons
388 689 if ( $copy_keys && substr( $field->field_key, - 1 ) == 2 ) {
389 690 $new_key = rtrim( $new_key, 2 );
390 691 }
391 692
@@ -393,9 +694,9 @@
393 694 FrmFieldsHelper::fill_field( $values, $field, $form_id, $new_key );
394 695
395 696 // If this is a repeating section, create new form
396 697 if ( self::is_repeating_field( $field ) ) {
397 - // create the repeatable form
698 + // Create the repeatable form
398 699 $new_repeat_form_id = apply_filters(
399 700 'frm_create_repeat_form',
400 701 0,
401 702 array(
@@ -411,9 +712,9 @@
411 712 $values['field_options']['form_select'] = $new_repeat_form_id;
412 713 }
413 714
414 715 // If this is a field inside of a repeating section, associate it with the correct form
415 - if ( $field->form_id != $old_form_id && isset( $old_repeat_form_id ) && isset( $new_repeat_form_id ) && $field->form_id == $old_repeat_form_id ) {
716 + if ( (int) $field->form_id !== (int) $old_form_id && isset( $old_repeat_form_id ) && isset( $new_repeat_form_id ) && (int) $field->form_id === (int) $old_repeat_form_id ) { // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
416 717 $values['form_id'] = $new_repeat_form_id;
417 718 }
418 719
419 720 $values['description'] = FrmFieldsHelper::switch_field_ids( $values['description'] );
@@ -422,11 +723,17 @@
422 723 $new_id = self::create( $values );
423 724 $frm_duplicate_ids[ $field->id ] = $new_id;
424 725 $frm_duplicate_ids[ $field->field_key ] = $new_id;
425 726 unset( $field );
426 - }
727 + }//end foreach
427 728 }
428 729
730 + /**
731 + * @param int|string $id
732 + * @param array $values
733 + *
734 + * @return false|int
735 + */
429 736 public static function update( $id, $values ) {
430 737 global $wpdb;
431 738
432 739 $id = absint( $id );
@@ -442,36 +749,53 @@
442 749
443 750 self::preserve_format_option_backslashes( $values );
444 751
445 752 if ( isset( $values['type'] ) ) {
446 - $values = apply_filters( 'frm_clean_' . $values['type'] . '_field_options_before_update', $values );
753 + if ( 'dropdown' === $values['type'] ) {
754 + // To avoid conflicts with security plugins the value "dropdown" is sent for select fields.
755 + // This is because "select" gets matched for SQL injection attempts.
756 + $values['type'] = 'select';
757 + }
447 758
759 + /**
760 + * @since 6.9 The Field ID param was added.
761 + *
762 + * @param array $values
763 + * @param int $id Field ID.
764 + */
765 + $values = apply_filters( 'frm_clean_' . $values['type'] . '_field_options_before_update', $values, $id );
766 +
448 767 if ( $values['type'] === 'hidden' && isset( $values['field_options'] ) && isset( $values['field_options']['clear_on_focus'] ) ) {
449 - // don't keep the old placeholder setting for hidden fields
768 + // Don't keep the old placeholder setting for hidden fields
450 769 $values['field_options']['clear_on_focus'] = 0;
451 770 }
452 771 }
453 772
454 - // serialize array values
773 + // Serialize array values
455 774 foreach ( array( 'field_options', 'options' ) as $opt ) {
456 - if ( isset( $values[ $opt ] ) && is_array( $values[ $opt ] ) ) {
457 - if ( 'field_options' === $opt ) {
458 - $values[ $opt ] = self::maybe_filter_options( $values[ $opt ] );
459 - }
460 - $values[ $opt ] = serialize( $values[ $opt ] );
775 + if ( ! isset( $values[ $opt ] ) || ! is_array( $values[ $opt ] ) ) {
776 + continue;
461 777 }
778 +
779 + if ( 'field_options' === $opt ) {
780 + $values[ $opt ] = self::maybe_filter_options( $values[ $opt ] );
781 + }
782 +
783 + $values[ $opt ] = serialize( $values[ $opt ] );
462 784 }
785 +
463 786 if ( isset( $values['default_value'] ) && is_array( $values['default_value'] ) ) {
464 787 $values['default_value'] = json_encode( $values['default_value'] );
465 788 }
466 789
467 790 $query_results = $wpdb->update( $wpdb->prefix . 'frm_fields', $values, array( 'id' => $id ) );
791 + $form_id = 0;
468 792
469 - $form_id = 0;
470 793 if ( isset( $values['form_id'] ) ) {
471 794 $form_id = absint( $values['form_id'] );
472 795 } else {
473 796 $field = self::getOne( $id );
797 +
474 798 if ( $field ) {
475 799 $form_id = $field->form_id;
476 800 }
477 801 unset( $field );
@@ -479,8 +803,9 @@
479 803 unset( $values );
480 804
481 805 if ( $query_results ) {
482 806 wp_cache_delete( $id, 'frm_field' );
807 +
483 808 if ( $form_id ) {
484 809 self::delete_form_transient( $form_id );
485 810 }
486 811 }
@@ -492,9 +817,11 @@
492 817 * Keep backslashes in the phone format option
493 818 *
494 819 * @since 2.0.8
495 820 *
496 - * @param $values array - pass by reference
821 + * @param array $values Pass by reference.
822 + *
823 + * @return void
497 824 */
498 825 private static function preserve_format_option_backslashes( &$values ) {
499 826 if ( isset( $values['field_options']['format'] ) ) {
500 827 $values['field_options']['format'] = FrmAppHelper::preserve_backslashes( $values['field_options']['format'] );
@@ -500,8 +827,13 @@
500 827 $values['field_options']['format'] = FrmAppHelper::preserve_backslashes( $values['field_options']['format'] );
501 828 }
502 829 }
503 830
831 + /**
832 + * @param int|string $id
833 + *
834 + * @return bool|int
835 + */
504 836 public static function destroy( $id ) {
505 837 global $wpdb;
506 838
507 839 do_action( 'frm_before_destroy_field', $id );
@@ -507,8 +839,9 @@
507 839 do_action( 'frm_before_destroy_field', $id );
508 840
509 841 wp_cache_delete( $id, 'frm_field' );
510 842 $field = self::getOne( $id );
843 +
511 844 if ( ! $field ) {
512 845 return false;
513 846 }
514 847
@@ -518,8 +851,13 @@
518 851
519 852 return $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->prefix . 'frm_fields WHERE id=%d', $id ) );
520 853 }
521 854
855 + /**
856 + * @param int|string $form_id
857 + *
858 + * @return void
859 + */
522 860 public static function delete_form_transient( $form_id ) {
523 861 $form_id = absint( $form_id );
524 862 delete_transient( 'frm_form_fields_' . $form_id . 'excludeinclude' );
525 863 delete_transient( 'frm_form_fields_' . $form_id . 'includeinclude' );
@@ -526,14 +864,15 @@
526 864 delete_transient( 'frm_form_fields_' . $form_id . 'includeexclude' );
527 865 delete_transient( 'frm_form_fields_' . $form_id . 'excludeexclude' );
528 866
529 867 global $wpdb;
530 - $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->options . ' WHERE option_name LIKE %s OR option_name LIKE %s OR option_name LIKE %s OR option_name LIKE %s', '_transient_timeout_frm_form_fields_' . $form_id . 'ex%', '_transient_frm_form_fields_' . $form_id . 'ex%', '_transient_timeout_frm_form_fields_' . $form_id . 'in%', '_transient_frm_form_fields_' . $form_id . 'in%' ) );
868 + $wpdb->query( $wpdb->prepare( 'DELETE FROM ' . $wpdb->options . ' WHERE option_name LIKE %s OR option_name LIKE %s OR option_name LIKE %s OR option_name LIKE %s', '_transient_timeout_frm_form_fields_' . $form_id . 'ex%', '_transient_frm_form_fields_' . $form_id . 'ex%', '_transient_timeout_frm_form_fields_' . $form_id . 'in%', '_transient_frm_form_fields_' . $form_id . 'in%' ) ); // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
531 869
532 870 FrmDb::cache_delete_group( 'frm_field' );
533 871
534 872 $form = FrmForm::getOne( $form_id );
535 - if ( $form && $form->parent_form_id && $form->parent_form_id != $form_id ) {
873 +
874 + if ( $form && $form->parent_form_id && (int) $form->parent_form_id !== $form_id ) {
536 875 self::delete_form_transient( $form->parent_form_id );
537 876 }
538 877 }
539 878
@@ -538,8 +877,12 @@
538 877 }
539 878
540 879 /**
541 880 * If $field is numeric, get the field object
881 + *
882 + * @param int|object|string $field
883 + *
884 + * @return void
542 885 */
543 886 public static function maybe_get_field( &$field ) {
544 887 if ( ! is_object( $field ) ) {
545 888 $field = self::getOne( $field );
@@ -546,13 +889,15 @@
546 889 }
547 890 }
548 891
549 892 /**
550 - * @param string|int $id The field id or key.
551 - * @param bool $filter When true, run the frm_field filter.
893 + * @param int|string $id The field id or key.
894 + * @param bool $filter When true, run the frm_field filter.
895 + *
896 + * @return object|null
552 897 */
553 898 public static function getOne( $id, $filter = false ) {
554 - if ( empty( $id ) ) {
899 + if ( ! $id ) {
555 900 return null;
556 901 }
557 902
558 903 global $wpdb;
@@ -561,9 +906,9 @@
561 906 $query = $wpdb->prepare( 'SELECT * FROM ' . $wpdb->prefix . 'frm_fields WHERE ' . $where, $id ); // phpcs:ignore WordPress.DB.PreparedSQL.NotPrepared
562 907
563 908 $results = FrmDb::check_cache( $id, 'frm_field', $query, 'get_row', 0 );
564 909
565 - if ( empty( $results ) ) {
910 + if ( ! $results ) {
566 911 self::filter_field( $filter, $results );
567 912 return $results;
568 913 }
569 914
@@ -580,10 +925,13 @@
580 925 }
581 926
582 927 /**
583 928 * @since 3.06.01
929 + *
584 930 * @param bool $filter When true, run the frm_field filter.
585 931 * @param object $results
932 + *
933 + * @return void
586 934 */
587 935 private static function filter_field( $filter, &$results ) {
588 936 if ( $filter ) {
589 937 /**
@@ -595,27 +943,33 @@
595 943
596 944 /**
597 945 * Get the field type by key or id
598 946 *
599 - * @param int|string The field id or key
600 - * @param mixed $col The name of the column in the fields database table
947 + * @param int|string $id The field id or key.
948 + * @param mixed $col The name of the column in the fields database table.
949 + *
950 + * @return mixed
601 951 */
602 952 public static function get_type( $id, $col = 'type' ) {
603 953 $field = FrmDb::check_cache( $id, 'frm_field' );
954 +
604 955 if ( $field ) {
605 - $type = $field->{$col};
606 - } else {
607 - $where = array(
608 - 'or' => 1,
609 - 'id' => $id,
610 - 'field_key' => $id,
611 - );
612 - $type = FrmDb::get_var( 'frm_fields', $where, $col );
956 + return $field->{$col};
613 957 }
614 958
615 - return $type;
959 + $where = is_numeric( $id ) ? array( 'id' => $id ) : array( 'field_key' => $id );
960 +
961 + return FrmDb::get_var( 'frm_fields', $where, $col );
616 962 }
617 963
964 + /**
965 + * @param int|string $form_id
966 + * @param string $type
967 + * @param int|string $limit
968 + * @param string $inc_sub
969 + *
970 + * @return array|object
971 + */
618 972 public static function get_all_types_in_form( $form_id, $type, $limit = '', $inc_sub = 'exclude' ) {
619 973 if ( ! $form_id ) {
620 974 return array();
621 975 }
@@ -626,24 +980,28 @@
626 980 'inc_embed' => $inc_sub,
627 981 'inc_repeat' => $inc_sub,
628 982 )
629 983 );
630 - if ( ! empty( $results ) ) {
984 +
985 + if ( $results ) {
631 986 $fields = array();
632 987 $count = 0;
988 +
633 989 foreach ( $results as $result ) {
634 - if ( $type != $result->type ) {
990 + if ( $type !== $result->type ) {
635 991 continue;
636 992 }
637 993
638 994 $fields[ $result->id ] = $result;
639 - $count ++;
995 + ++$count;
996 +
997 + // phpcs:ignore Universal.Operators.StrictComparisons
640 998 if ( $limit == 1 ) {
641 999 $fields = $result;
642 1000 break;
643 1001 }
644 1002
645 - if ( ! empty( $limit ) && $count >= $limit ) {
1003 + if ( $limit && $count >= $limit ) {
646 1004 break;
647 1005 }
648 1006
649 1007 unset( $result );
@@ -649,9 +1007,9 @@
649 1007 unset( $result );
650 1008 }
651 1009
652 1010 return wp_unslash( $fields );
653 - }
1011 + }//end if
654 1012
655 1013 self::$use_cache = false;
656 1014
657 1015 $where = array(
@@ -665,8 +1023,16 @@
665 1023
666 1024 return $results;
667 1025 }
668 1026
1027 + /**
1028 + * @param int|string $form_id
1029 + * @param int|string $limit
1030 + * @param string $inc_embed
1031 + * @param string $inc_repeat
1032 + *
1033 + * @return array
1034 + */
669 1035 public static function get_all_for_form( $form_id, $limit = '', $inc_embed = 'exclude', $inc_repeat = 'include' ) {
670 1036 if ( ! (int) $form_id ) {
671 1037 return array();
672 1038 }
@@ -671,19 +1037,22 @@
671 1037 return array();
672 1038 }
673 1039
674 1040 $results = self::get_fields_from_transients( $form_id, compact( 'inc_embed', 'inc_repeat' ) );
675 - if ( ! empty( $results ) ) {
676 - if ( empty( $limit ) ) {
1041 +
1042 + if ( $results ) {
1043 + if ( ! $limit ) {
677 1044 return $results;
678 1045 }
679 1046
680 1047 $fields = array();
681 1048 $count = 0;
1049 +
682 1050 foreach ( $results as $result ) {
683 - $count ++;
1051 + ++$count;
684 1052 $fields[ $result->id ] = $result;
685 - if ( ! empty( $limit ) && $count >= $limit ) {
1053 +
1054 + if ( $limit && $count >= $limit ) {
686 1055 break;
687 1056 }
688 1057 }
689 1058
@@ -699,9 +1068,9 @@
699 1068 self::$use_cache = true;
700 1069
701 1070 self::include_sub_fields( $results, $inc_embed, 'all', $form_id );
702 1071
703 - if ( empty( $limit ) ) {
1072 + if ( ! $limit ) {
704 1073 self::set_field_transient( $results, $form_id, 0, compact( 'inc_embed', 'inc_repeat' ) );
705 1074 }
706 1075
707 1076 return $results;
@@ -710,41 +1079,56 @@
710 1079 /**
711 1080 * If repeating fields should be included, adjust $where accordingly
712 1081 *
713 1082 * @param string $inc_repeat
714 - * @param array $where - pass by reference
1083 + * @param array $where Pass by reference.
1084 + *
1085 + * @return void
715 1086 */
716 1087 private static function maybe_include_repeating_fields( $inc_repeat, &$where ) {
717 - if ( $inc_repeat == 'include' ) {
718 - $form_id = $where['fi.form_id'];
719 - $where[] = array(
720 - 'or' => 1,
721 - 'fi.form_id' => $form_id,
722 - 'fr.parent_form_id' => $form_id,
723 - );
724 - unset( $where['fi.form_id'] );
1088 + if ( $inc_repeat !== 'include' ) {
1089 + return;
725 1090 }
1091 +
1092 + $form_id = $where['fi.form_id'];
1093 + $where[] = array(
1094 + 'or' => 1,
1095 + 'fi.form_id' => $form_id,
1096 + 'fr.parent_form_id' => $form_id,
1097 + );
1098 + unset( $where['fi.form_id'] );
726 1099 }
727 1100
1101 + /**
1102 + * @param array $results
1103 + * @param string $inc_embed
1104 + * @param string $type
1105 + * @param int|string $form_id
1106 + *
1107 + * @return void
1108 + */
728 1109 public static function include_sub_fields( &$results, $inc_embed, $type = 'all', $form_id = '' ) {
729 - $no_sub_forms = empty( $results ) && $type === 'all';
730 - if ( 'include' != $inc_embed || $no_sub_forms ) {
1110 + $no_sub_forms = ! $results && $type === 'all';
1111 +
1112 + if ( 'include' !== $inc_embed || $no_sub_forms ) {
731 1113 return;
732 1114 }
733 1115
734 - $form_fields = $results;
735 - $should_get_subforms = ( $type !== 'all' && $type !== 'form' && ! empty( $form_id ) );
1116 + $form_fields = $results;
1117 + $should_get_subforms = $type !== 'all' && $type !== 'form' && $form_id;
1118 +
736 1119 if ( $should_get_subforms ) {
737 1120 $form_fields = self::get_all_types_in_form( $form_id, 'form' );
738 1121 }
739 1122
740 1123 $index_offset = 1;
1124 +
741 1125 foreach ( $form_fields as $k => $field ) {
742 - if ( 'form' != $field->type || ! isset( $field->field_options['form_select'] ) ) {
1126 + if ( 'form' !== $field->type || ! isset( $field->field_options['form_select'] ) ) {
743 1127 continue;
744 1128 }
745 1129
746 - if ( $type == 'all' ) {
1130 + if ( $type === 'all' ) {
747 1131 $sub_fields = self::get_all_for_form( $field->field_options['form_select'] );
748 1132 } else {
749 1133 $sub_fields = self::get_all_types_in_form( $field->field_options['form_select'], $type );
750 1134 }
@@ -749,9 +1133,9 @@
749 1133 $sub_fields = self::get_all_types_in_form( $field->field_options['form_select'], $type );
750 1134 }
751 1135
752 1136 if ( ! empty( $sub_fields ) ) {
753 - $index = $k + $index_offset;
1137 + $index = $k + $index_offset;
754 1138 $index_offset += count( $sub_fields );
755 1139 array_splice( $results, $index, 0, $sub_fields );
756 1140 }
757 1141 unset( $field, $sub_fields );
@@ -757,13 +1141,23 @@
757 1141 unset( $field, $sub_fields );
758 1142 }
759 1143 }
760 1144
1145 + /**
1146 + * @param array|string $where
1147 + * @param string $order_by
1148 + * @param string $limit
1149 + * @param false|int $blog_id
1150 + *
1151 + * @return array|object|null
1152 + */
761 1153 public static function getAll( $where = array(), $order_by = '', $limit = '', $blog_id = false ) {
762 1154 $cache_key = FrmAppHelper::maybe_json_encode( $where ) . $order_by . 'l' . $limit . 'b' . $blog_id;
1155 +
763 1156 if ( self::$use_cache ) {
764 - // make sure old cache doesn't get saved as a transient
1157 + // Make sure old cache doesn't get saved as a transient
765 1158 $results = wp_cache_get( $cache_key, 'frm_field' );
1159 +
766 1160 if ( false !== $results ) {
767 1161 return wp_unslash( $results );
768 1162 }
769 1163 }
@@ -770,15 +1164,9 @@
770 1164
771 1165 global $wpdb;
772 1166
773 1167 if ( $blog_id && is_multisite() ) {
774 - global $wpmuBaseTablePrefix;
775 - if ( $wpmuBaseTablePrefix ) {
776 - $prefix = $wpmuBaseTablePrefix . $blog_id . '_';
777 - } else {
778 - $prefix = $wpdb->get_blog_prefix( $blog_id );
779 - }
780 -
1168 + $prefix = $wpdb->get_blog_prefix( $blog_id );
781 1169 $table_name = $prefix . 'frm_fields';
782 1170 $form_table_name = $prefix . 'frm_forms';
783 1171 } else {
784 1172 $table_name = $wpdb->prefix . 'frm_fields';
@@ -784,28 +1172,27 @@
784 1172 $table_name = $wpdb->prefix . 'frm_fields';
785 1173 $form_table_name = $wpdb->prefix . 'frm_forms';
786 1174 }
787 1175
788 - if ( ! empty( $order_by ) && strpos( $order_by, 'ORDER BY' ) === false ) {
1176 + if ( $order_by && ! str_contains( $order_by, 'ORDER BY' ) ) {
789 1177 $order_by = ' ORDER BY ' . $order_by;
790 1178 }
791 1179
792 - $limit = FrmDb::esc_limit( $limit );
1180 + $limit = FrmDb::esc_limit( $limit );
1181 + $query = "SELECT fi.*, fr.name as form_name FROM {$table_name} fi JOIN {$form_table_name} fr ON fi.form_id=fr.id";
1182 + $query_type = $limit === ' LIMIT 1' || $limit == 1 ? 'row' : 'results'; // phpcs:ignore Universal.Operators.StrictComparisons
793 1183
794 - $query = "SELECT fi.*, fr.name as form_name FROM {$table_name} fi LEFT OUTER JOIN {$form_table_name} fr ON fi.form_id=fr.id";
795 - $query_type = ( $limit == ' LIMIT 1' || $limit == 1 ) ? 'row' : 'results';
796 -
797 1184 if ( is_array( $where ) ) {
798 1185 $args = array(
799 1186 'order_by' => $order_by,
800 1187 'limit' => $limit,
801 1188 );
802 - $results = FrmDb::get_var( $table_name . ' fi LEFT OUTER JOIN ' . $form_table_name . ' fr ON fi.form_id=fr.id', $where, 'fi.*, fr.name as form_name', $args, '', $query_type );
1189 + $results = FrmDb::get_var( $table_name . ' fi JOIN ' . $form_table_name . ' fr ON fi.form_id=fr.id', $where, 'fi.*, fr.name as form_name', $args, '', $query_type );
803 1190 } else {
804 - // if the query is not an array, then it has already been prepared
1191 + // If the query is not an array, then it has already been prepared
805 1192 $query .= FrmDb::prepend_and_or_where( ' WHERE ', $where ) . $order_by . $limit;
806 1193
807 - $function_name = ( $query_type == 'row' ) ? 'get_row' : 'get_results';
1194 + $function_name = $query_type === 'row' ? 'get_row' : 'get_results';
808 1195 $results = $wpdb->$function_name( $query );
809 1196 }
810 1197 unset( $where );
811 1198
@@ -817,12 +1204,18 @@
817 1204 }
818 1205
819 1206 /**
820 1207 * @since 2.0.8
1208 + *
1209 + * @param array|object|null $results Results.
1210 + *
1211 + * @return void
821 1212 */
822 1213 private static function format_field_results( &$results ) {
823 1214 if ( is_array( $results ) ) {
824 1215 foreach ( $results as $r_key => $result ) {
1216 + self::add_slashes_to_format_before_setting_field_cache( $result );
1217 +
825 1218 FrmDb::set_cache( $result->id, $result, 'frm_field' );
826 1219 FrmDb::set_cache( $result->field_key, $result, 'frm_field' );
827 1220
828 1221 self::prepare_options( $result );
@@ -840,11 +1233,34 @@
840 1233 }
841 1234 }
842 1235
843 1236 /**
1237 + * When $result->field_options is an array and not a serialized string there is only a single backslash.
1238 + * Cached results are unslashed in FrmField::getAll, so we need to make sure that the cached object has an extra backslash.
1239 + * Otherwise the backslash is stripped away on load.
1240 + *
1241 + * @since 6.15
1242 + *
1243 + * @param stdClass $result
1244 + *
1245 + * @return void
1246 + */
1247 + private static function add_slashes_to_format_before_setting_field_cache( $result ) {
1248 + if ( ! isset( $result->field_options ) || ! is_array( $result->field_options ) || empty( $result->field_options['format'] ) ) {
1249 + return;
1250 + }
1251 +
1252 + $result->field_options['format'] = addslashes( $result->field_options['format'] );
1253 + }
1254 +
1255 + /**
844 1256 * Unserialize all the serialized field data
845 1257 *
846 1258 * @since 2.0
1259 + *
1260 + * @param object $results
1261 + *
1262 + * @return void
847 1263 */
848 1264 private static function prepare_options( &$results ) {
849 1265 FrmAppHelper::unserialize_or_decode( $results->field_options );
850 1266 FrmAppHelper::unserialize_or_decode( $results->options );
@@ -850,19 +1266,32 @@
850 1266 FrmAppHelper::unserialize_or_decode( $results->options );
851 1267
852 1268 // Allow a single box to be checked for the default value.
853 1269 $before = $results->default_value;
1270 +
1271 + $field_object = FrmFieldFactory::get_field_type( $results->type );
1272 +
1273 + if ( ! $field_object->should_unserialize_value() ) {
1274 + return;
1275 + }
1276 +
854 1277 FrmAppHelper::unserialize_or_decode( $results->default_value );
855 - if ( $before === $results->default_value && ! is_array( $before ) && strpos( $before, '["' ) === 0 ) {
1278 +
1279 + if ( $before === $results->default_value && is_string( $before ) && str_starts_with( $before, '["' ) ) {
856 1280 $results->default_value = FrmAppHelper::maybe_json_decode( $results->default_value );
857 1281 }
858 1282 }
859 1283
860 1284 /**
861 - * If a form has too many fields, thay won't all save into a single transient.
1285 + * If a form has too many fields, they won't all save into a single transient.
862 1286 * We'll break them into groups of 200
863 1287 *
864 1288 * @since 2.0.1
1289 + *
1290 + * @param int|string $form_id Form ID.
1291 + * @param array $args Additional arguments.
1292 + *
1293 + * @return array
865 1294 */
866 1295 private static function get_fields_from_transients( $form_id, $args ) {
867 1296 $fields = array();
868 1297 self::get_next_transient( $fields, 'frm_form_fields_' . $form_id . $args['inc_embed'] . $args['inc_repeat'] );
@@ -873,22 +1302,32 @@
873 1302 /**
874 1303 * Called by get_fields_from_transients
875 1304 *
876 1305 * @since 2.0.1
1306 + *
1307 + * @param array $fields Array of fields.
1308 + * @param string $base_name Base name.
1309 + * @param int $next Next transient number.
1310 + *
1311 + * @return void
877 1312 */
878 1313 private static function get_next_transient( &$fields, $base_name, $next = 0 ) {
879 1314 $name = $next ? $base_name . $next : $base_name;
880 1315 $next_fields = get_transient( $name );
881 1316
882 - if ( $next_fields ) {
883 - $fields = array_merge( $fields, $next_fields );
1317 + if ( ! $next_fields ) {
1318 + return;
1319 + }
884 1320
885 - if ( count( $next_fields ) >= self::$transient_size ) {
886 - // if this transient is full, check for another
887 - $next ++;
888 - self::get_next_transient( $fields, $base_name, $next );
889 - }
1321 + $fields = array_merge( $fields, $next_fields );
1322 +
1323 + if ( count( $next_fields ) < self::$transient_size ) {
1324 + return;
890 1325 }
1326 +
1327 + // If this transient is full, check for another
1328 + ++$next;
1329 + self::get_next_transient( $fields, $base_name, $next );
891 1330 }
892 1331
893 1332 /**
894 1333 * Save the transients in chunks for large forms
@@ -893,8 +1332,15 @@
893 1332 /**
894 1333 * Save the transients in chunks for large forms
895 1334 *
896 1335 * @since 2.0.1
1336 + *
1337 + * @param array $fields Array of fields.
1338 + * @param int|string $form_id Form ID.
1339 + * @param int $next Next transient number.
1340 + * @param array $args Additional arguments.
1341 + *
1342 + * @return void
897 1343 */
898 1344 private static function set_field_transient( &$fields, $form_id, $next = 0, $args = array() ) {
899 1345 $base_name = 'frm_form_fields_' . $form_id . $args['inc_embed'] . $args['inc_repeat'];
900 1346 $field_chunks = array_chunk( $fields, self::$transient_size );
@@ -901,12 +1347,13 @@
901 1347
902 1348 foreach ( $field_chunks as $field ) {
903 1349 $name = $next ? $base_name . $next : $base_name;
904 1350 $set = set_transient( $name, $field, 60 * 60 * 6 );
1351 +
905 1352 if ( ! $set ) {
906 - // the transient didn't save
907 - if ( $name != $base_name ) {
908 - // if the first saved an others fail, this will show an incmoplete form
1353 + // The transient didn't save
1354 + if ( $name !== $base_name ) {
1355 + // If the first saved an others fail, this will show an incomplete form
909 1356 self::delete_form_transient( $form_id );
910 1357 }
911 1358
912 1359 return;
@@ -911,18 +1358,26 @@
911 1358
912 1359 return;
913 1360 }
914 1361
915 - $next ++;
1362 + ++$next;
916 1363 }
917 1364 }
918 1365
1366 + /**
1367 + * @param string $type
1368 + *
1369 + * @return bool
1370 + */
919 1371 public static function is_no_save_field( $type ) {
920 - return in_array( $type, self::no_save_fields() );
1372 + return in_array( $type, self::no_save_fields(), true );
921 1373 }
922 1374
1375 + /**
1376 + * @return string[]
1377 + */
923 1378 public static function no_save_fields() {
924 - return array( 'divider', 'end_divider', 'captcha', 'break', 'html', 'form', 'summary' );
1379 + return array( 'divider', 'end_divider', 'captcha', 'break', 'html', 'form', 'summary', FrmSubmitHelper::FIELD_TYPE );
925 1380 }
926 1381
927 1382 /**
928 1383 * Check if this field can hold an array of values
@@ -930,9 +1385,9 @@
930 1385 * @since 2.0.9
931 1386 *
932 1387 * @param array|object $field
933 1388 *
934 - * @return boolean
1389 + * @return bool
935 1390 */
936 1391 public static function is_field_with_multiple_values( $field ) {
937 1392 if ( ! $field ) {
938 1393 return false;
@@ -939,19 +1394,16 @@
939 1394 }
940 1395
941 1396 $field_type = self::get_original_field_type( $field );
942 1397
943 - $is_multi_value_field = (
944 - self::is_checkbox( $field ) ||
945 - $field_type == 'address' ||
946 - self::is_multiple_select( $field )
947 - );
948 -
949 - return $is_multi_value_field;
1398 + return self::is_checkbox( $field ) || $field_type === 'address' || self::is_multiple_select( $field );
950 1399 }
951 1400
952 1401 /**
953 1402 * @since 3.0
1403 + *
1404 + * @param array|object $field
1405 + *
954 1406 * @return string
955 1407 */
956 1408 public static function get_field_type( $field ) {
957 1409 return is_array( $field ) ? $field['type'] : $field->type;
@@ -958,8 +1410,11 @@
958 1410 }
959 1411
960 1412 /**
961 1413 * @since 3.0
1414 + *
1415 + * @param array|object $field
1416 + *
962 1417 * @return string
963 1418 */
964 1419 public static function get_original_field_type( $field ) {
965 1420 $field_type = self::get_field_type( $field );
@@ -964,10 +1419,11 @@
964 1419 public static function get_original_field_type( $field ) {
965 1420 $field_type = self::get_field_type( $field );
966 1421 $original_type = self::get_option( $field, 'original_type' );
967 1422
968 - if ( ! empty( $original_type ) && $original_type != $field_type ) {
969 - $field_type = $original_type; // check the original type for arrays
1423 + if ( $original_type && $original_type !== $field_type ) {
1424 + // Check the original type for arrays.
1425 + return $original_type;
970 1426 }
971 1427
972 1428 return $field_type;
973 1429 }
@@ -975,14 +1431,15 @@
975 1431 /**
976 1432 * Check if this is a multiselect dropdown field
977 1433 *
978 1434 * @since 2.0.9
979 - * @return boolean
1435 + *
1436 + * @param array|object $field Field object.
1437 + *
1438 + * @return bool
980 1439 */
981 1440 public static function is_multiple_select( $field ) {
982 - $field_type = self::get_field_type( $field );
983 - $is_multiple = self::is_option_true( $field, 'multiple' ) && self::is_field_type( $field, 'select' ) && $field_type !== 'hidden';
984 -
1441 + $is_multiple = self::is_option_true( $field, 'multiple' ) && self::is_field_type( $field, 'select' ) && self::get_field_type( $field ) !== 'hidden';
985 1442 return apply_filters( 'frm_is_multiple_select', $is_multiple, $field );
986 1443 }
987 1444
988 1445 /**
@@ -989,82 +1446,134 @@
989 1446 * Check if a field is read only. Read only can be set in the field options,
990 1447 * but disabled with the shortcode options
991 1448 *
992 1449 * @since 2.0.9
1450 + *
1451 + * @param array|object $field
1452 + *
1453 + * @return bool
993 1454 */
994 1455 public static function is_read_only( $field ) {
995 1456 global $frm_vars;
996 -
997 - return ( self::is_option_true( $field, 'read_only' ) && ( ! isset( $frm_vars['readonly'] ) || $frm_vars['readonly'] != 'disabled' ) );
1457 + return self::is_option_true( $field, 'read_only' ) && ( ! isset( $frm_vars['readonly'] ) || $frm_vars['readonly'] !== 'disabled' );
998 1458 }
999 1459
1000 1460 /**
1001 1461 * @since 2.0.9
1462 + *
1463 + * @param array $field
1464 + *
1465 + * @return bool
1002 1466 */
1003 1467 public static function is_required( $field ) {
1004 - $required = ( $field['required'] != '0' );
1005 - $required = apply_filters( 'frm_is_field_required', $required, $field );
1468 + $required = $field['required'] != '0'; // phpcs:ignore Universal.Operators.StrictComparisons
1006 1469
1007 - return $required;
1470 + /**
1471 + * @param bool $required
1472 + * @param array $field
1473 + */
1474 + return (bool) apply_filters( 'frm_is_field_required', $required, $field );
1008 1475 }
1009 1476
1010 1477 /**
1011 1478 * @since 2.0.9
1479 + *
1480 + * @param array|object $field
1481 + * @param string $option
1482 + *
1483 + * @return bool
1012 1484 */
1013 1485 public static function is_option_true( $field, $option ) {
1014 1486 if ( is_array( $field ) ) {
1015 1487 return self::is_option_true_in_array( $field, $option );
1016 - } else {
1017 - return self::is_option_true_in_object( $field, $option );
1018 1488 }
1489 + return self::is_option_true_in_object( $field, $option );
1019 1490 }
1020 1491
1021 1492 /**
1022 1493 * @since 2.0.9
1494 + *
1495 + * @param array|object $field
1496 + * @param string $option
1497 + *
1498 + * @return bool
1023 1499 */
1024 1500 public static function is_option_empty( $field, $option ) {
1025 1501 if ( is_array( $field ) ) {
1026 1502 return self::is_option_empty_in_array( $field, $option );
1027 - } else {
1028 - return self::is_option_empty_in_object( $field, $option );
1029 1503 }
1504 + return self::is_option_empty_in_object( $field, $option );
1030 1505 }
1031 1506
1507 + /**
1508 + * @param array $field
1509 + * @param string $option
1510 + *
1511 + * @return bool
1512 + */
1032 1513 public static function is_option_true_in_array( $field, $option ) {
1033 - return isset( $field[ $option ] ) && $field[ $option ];
1514 + return ! empty( $field[ $option ] );
1034 1515 }
1035 1516
1517 + /**
1518 + * @param object $field
1519 + * @param string $option
1520 + *
1521 + * @return bool
1522 + */
1036 1523 public static function is_option_true_in_object( $field, $option ) {
1037 - return isset( $field->field_options[ $option ] ) && $field->field_options[ $option ];
1524 + return ! empty( $field->field_options[ $option ] );
1038 1525 }
1039 1526
1527 + /**
1528 + * @param array $field
1529 + * @param string $option
1530 + *
1531 + * @return bool
1532 + */
1040 1533 public static function is_option_empty_in_array( $field, $option ) {
1041 - return ! isset( $field[ $option ] ) || empty( $field[ $option ] );
1534 + return empty( $field[ $option ] );
1042 1535 }
1043 1536
1537 + /**
1538 + * @param object $field
1539 + * @param string $option
1540 + *
1541 + * @return bool
1542 + */
1044 1543 public static function is_option_empty_in_object( $field, $option ) {
1045 - return ! isset( $field->field_options[ $option ] ) || empty( $field->field_options[ $option ] );
1544 + return empty( $field->field_options[ $option ] );
1046 1545 }
1047 1546
1547 + /**
1548 + * @param stdClass $field
1549 + * @param string $option
1550 + *
1551 + * @return bool
1552 + */
1048 1553 public static function is_option_value_in_object( $field, $option ) {
1049 - return isset( $field->field_options[ $option ] ) && $field->field_options[ $option ] != '';
1554 + return isset( $field->field_options[ $option ] ) && $field->field_options[ $option ] != ''; // phpcs:ignore Universal.Operators.StrictComparisons
1050 1555 }
1051 1556
1052 1557 /**
1053 1558 * @since 2.0.18
1559 + *
1560 + * @param array|object $field
1561 + * @param string $option
1562 + *
1563 + * @return mixed
1054 1564 */
1055 1565 public static function get_option( $field, $option ) {
1056 - if ( is_array( $field ) ) {
1057 - $option = self::get_option_in_array( $field, $option );
1058 - } else {
1059 - $option = self::get_option_in_object( $field, $option );
1060 - }
1061 -
1062 - return $option;
1566 + return is_array( $field ) ? self::get_option_in_array( $field, $option ) : self::get_option_in_object( $field, $option );
1063 1567 }
1064 1568
1569 + /**
1570 + * @param array $field
1571 + * @param string $option
1572 + *
1573 + * @return mixed
1574 + */
1065 1575 public static function get_option_in_array( $field, $option ) {
1066 -
1067 1576 if ( isset( $field[ $option ] ) ) {
1068 1577 $this_option = $field[ $option ];
1069 1578 } elseif ( isset( $field['field_options'] ) && is_array( $field['field_options'] ) && isset( $field['field_options'][ $option ] ) ) {
1070 1579 $this_option = $field['field_options'][ $option ];
@@ -1074,23 +1583,28 @@
1074 1583
1075 1584 return $this_option;
1076 1585 }
1077 1586
1587 + /**
1588 + * @param object $field
1589 + * @param string $option
1590 + *
1591 + * @return mixed
1592 + */
1078 1593 public static function get_option_in_object( $field, $option ) {
1079 - return isset( $field->field_options[ $option ] ) ? $field->field_options[ $option ] : '';
1594 + return $field->field_options[ $option ] ?? '';
1080 1595 }
1081 1596
1082 1597 /**
1083 1598 * @since 2.0.09
1599 + *
1600 + * @param array|object $field
1601 + *
1602 + * @return bool
1084 1603 */
1085 1604 public static function is_repeating_field( $field ) {
1086 - if ( is_array( $field ) ) {
1087 - $is_repeating_field = ( 'divider' == $field['type'] );
1088 - } else {
1089 - $is_repeating_field = ( 'divider' == $field->type );
1090 - }
1091 -
1092 - return ( $is_repeating_field && self::is_option_true( $field, 'repeat' ) );
1605 + $is_repeating_field = is_array( $field ) ? 'divider' === $field['type'] : 'divider' === $field->type;
1606 + return $is_repeating_field && self::is_option_true( $field, 'repeat' );
1093 1607 }
1094 1608
1095 1609 /**
1096 1610 * @param string $key
@@ -1098,9 +1612,8 @@
1098 1612 * @return int field id
1099 1613 */
1100 1614 public static function get_id_by_key( $key ) {
1101 1615 $id = FrmDb::get_var( 'frm_fields', array( 'field_key' => sanitize_title( $key ) ) );
1102 -
1103 1616 return (int) $id;
1104 1617 }
1105 1618
1106 1619 /**
@@ -1105,18 +1618,22 @@
1105 1618
1106 1619 /**
1107 1620 * @param string $id
1108 1621 *
1109 - * @return null|string
1622 + * @return string|null
1110 1623 */
1111 1624 public static function get_key_by_id( $id ) {
1112 1625 return FrmDb::get_var( 'frm_fields', array( 'id' => $id ), 'field_key' );
1113 1626 }
1114 1627
1628 + /**
1629 + * @param array|object $field
1630 + *
1631 + * @return bool
1632 + */
1115 1633 public static function is_image( $field ) {
1116 1634 $type = self::get_field_type( $field );
1117 -
1118 - return ( $type == 'url' && self::get_option( $field, 'show_image' ) );
1635 + return $type === 'url' && self::get_option( $field, 'show_image' );
1119 1636 }
1120 1637
1121 1638 /**
1122 1639 * Check if field is radio or Dynamic radio
@@ -1124,9 +1641,9 @@
1124 1641 * @since 3.0
1125 1642 *
1126 1643 * @param array|object $field
1127 1644 *
1128 - * @return boolean true if field type is radio or Dynamic radio
1645 + * @return bool true if field type is radio or Dynamic radio
1129 1646 */
1130 1647 public static function is_radio( $field ) {
1131 1648 return self::is_field_type( $field, 'radio' );
1132 1649 }
@@ -1137,9 +1654,9 @@
1137 1654 * @since 3.0
1138 1655 *
1139 1656 * @param array|object $field
1140 1657 *
1141 - * @return boolean true if field type is checkbox or Dynamic checkbox
1658 + * @return bool true if field type is checkbox or Dynamic checkbox
1142 1659 */
1143 1660 public static function is_checkbox( $field ) {
1144 1661 return self::is_field_type( $field, 'checkbox' );
1145 1662 }
@@ -1149,23 +1666,17 @@
1149 1666 *
1150 1667 * @since 3.0
1151 1668 *
1152 1669 * @param array|object $field
1153 - * @param string $is_type Options include radio, checkbox, text
1670 + * @param string $is_type Options include radio, checkbox, text.
1154 1671 *
1155 - * @return boolean true if field type is checkbox or Dynamic checkbox
1672 + * @return bool true if field type is checkbox or Dynamic checkbox
1156 1673 */
1157 1674 public static function is_field_type( $field, $is_type ) {
1158 - $field_type = self::get_original_field_type( $field );
1159 - $data_type = self::get_option( $field, 'data_type' );
1675 + $field_type = self::get_original_field_type( $field );
1676 + $data_type = self::get_option( $field, 'data_type' );
1677 + $is_field_type = $is_type === $field_type || ( 'data' === $field_type && $is_type === $data_type ) || ( 'lookup' === $field_type && $is_type === $data_type ) || ( 'product' === $field_type && $is_type === $data_type ); // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
1160 1678
1161 - $is_field_type = (
1162 - $is_type === $field_type ||
1163 - ( 'data' === $field_type && $is_type === $data_type ) ||
1164 - ( 'lookup' === $field_type && $is_type === $data_type ) ||
1165 - ( 'product' === $field_type && $is_type === $data_type )
1166 - );
1167 -
1168 1679 /**
1169 1680 * When a field type is checked, allow individual fields
1170 1681 * to set the type.
1171 1682 *
@@ -1179,12 +1690,12 @@
1179 1690 *
1180 1691 * @since 4.10.02
1181 1692 *
1182 1693 * @param array $field Field array.
1694 + *
1183 1695 * @return bool
1184 1696 */
1185 1697 public static function is_combo_field( $field ) {
1186 1698 $field_type_obj = FrmFieldFactory::get_field_factory( $field );
1187 -
1188 1699 return ! empty( $field_type_obj->is_combo_field );
1189 1700 }
1190 1701 }