PluginProbe
Subscriptions for WooCommerce with Stripe Recurring Payments / 2.4.0
Subscriptions for WooCommerce with Stripe Recurring Payments v2.4.0
2.4.0 2.3.0 2.2.0 2.1.0 2.0.0 1.11.2 1.11.1 1.11.0 1.10.9 1.10.8 1.10.7 1.10.6 1.10.5 1.10.4 1.10.3 1.10.2 1.10.1 1.10.0 1.9.6 1.9.5 trunk 1.3.0 1.3.1 1.3.2 1.4.0 All 65 releases
← All changes | includes/Admin/SettingsHelper.php +369 -8 1.10.2 → 2.4.0 View file →
@@ -109,8 +109,175 @@
109 109 return $fields;
110 110 }
111 111
112 112 /**
113 + * Label a settings group for its tab.
114 + *
115 + * The label is the group's `heading` field, which is also what the panel
116 + * shows, so a tab and its panel can never disagree. An add-on that adds a
117 + * group without a heading still gets a usable tab rather than a blank one:
118 + * `live_qr_settings` reads as "Live Qr Settings", which is wrong-ish but
119 + * findable, and the fix is for that add-on to add a heading.
120 + *
121 + * `main` is the exception. It is what a field with no `group` falls back to,
122 + * so it holds whatever nobody placed rather than anything named "Main". No
123 + * field ships in it — this plugin has no settings that are merely general —
124 + * and it only becomes a tab when something lands there uninvited.
125 + *
126 + * @param string $group_id Group key.
127 + * @param array $group Group data: `fields`, `priority`.
128 + * @return string Unescaped label.
129 + */
130 + public static function group_label( $group_id, array $group ) {
131 + foreach ( $group['fields'] ?? array() as $field ) {
132 + if ( 'heading' === ( $field['type'] ?? '' ) && ! empty( $field['field_data']['title'] ) ) {
133 + return $field['field_data']['title'];
134 + }
135 + }
136 +
137 + if ( 'main' === $group_id ) {
138 + return __( 'General', 'subscription' );
139 + }
140 +
141 + return ucwords( str_replace( array( '_', '-' ), ' ', (string) $group_id ) );
142 + }
143 +
144 + /**
145 + * Whether every field in a group is locked behind Pro.
146 + *
147 + * Drives the "Pro" marker on the tab, so the whole panel does not have to be
148 + * opened to find out that none of it can be changed yet.
149 + *
150 + * @param array $group Group data.
151 + * @return bool
152 + */
153 + public static function group_is_pro_locked( array $group ) {
154 + $has_field = false;
155 +
156 + foreach ( $group['fields'] ?? array() as $field ) {
157 + if ( 'heading' === ( $field['type'] ?? '' ) ) {
158 + continue;
159 + }
160 + $has_field = true;
161 + if ( empty( $field['field_data']['pro_locked'] ) ) {
162 + return false;
163 + }
164 + }
165 +
166 + return $has_field;
167 + }
168 +
169 + /**
170 + * The settings sections, in display order.
171 + *
172 + * One level, named for the job a merchant came to do rather than for the
173 + * plugin's internals. Each section is one rail item and one panel; the
174 + * groups inside it stack, so nothing is ever two clicks deep.
175 + *
176 + * There is deliberately no "All settings" entry. It duplicated every panel
177 + * on one page, which made the rail beside it look like decoration and gave
178 + * every setting two addresses.
179 + *
180 + * @return array<string,string> Section key => label.
181 + */
182 + public static function categories() {
183 + return array(
184 + 'renewals' => __( 'Renewals', 'subscription' ),
185 + 'payments' => __( 'Payments', 'subscription' ),
186 + 'switching' => __( 'Switching & Upgrades', 'subscription' ),
187 + 'customers' => __( 'Customers', 'subscription' ),
188 + 'advanced' => __( 'Advanced', 'subscription' ),
189 + );
190 + }
191 +
192 + /**
193 + * Which section a settings group belongs to.
194 + *
195 + * Groups are merged rather than mapped one-to-one: a section holding a
196 + * single option is a wasted click, so `health_queue` sits with the other
197 + * plumbing in Advanced, and everything the customer meets — the role they
198 + * are given, checking out as a guest, what their subscription's quick view
199 + * shows — is in Customers.
200 + *
201 + * Unmapped groups, including any an add-on registers without knowing
202 + * sections exist, fall into `advanced`, so a new group is always reachable.
203 + *
204 + * @param string $group_id Group key.
205 + * @return string Section key.
206 + */
207 + public static function group_category( $group_id ) {
208 + $map = array(
209 + 'renewals' => 'renewals',
210 + 'license_settings' => 'renewals',
211 + 'stock_management' => 'renewals',
212 + 'payment_gateways' => 'payments',
213 + 'payment_failure' => 'payments',
214 + 'grace_period' => 'payments',
215 + 'switching' => 'switching',
216 + 'role_based_settings' => 'customers',
217 + 'guest_checkout' => 'customers',
218 + 'live_qr_settings' => 'customers',
219 + 'api_settings' => 'advanced',
220 + 'health_queue' => 'advanced',
221 + );
222 +
223 + return $map[ $group_id ] ?? 'advanced';
224 + }
225 +
226 + /**
227 + * Group keys bucketed by section, each list in the order the groups already
228 + * sort in.
229 + *
230 + * Empty sections are dropped. Most of them are filled by Pro, and free
231 + * alone would otherwise show rail items that open onto nothing.
232 + *
233 + * @param array $settings_fields Grouped, sorted settings fields.
234 + * @return array<string,string[]> Section key => ordered group keys.
235 + */
236 + public static function category_groups( array $settings_fields ) {
237 + $out = array();
238 + foreach ( array_keys( self::categories() ) as $cat ) {
239 + $out[ $cat ] = array();
240 + }
241 +
242 + foreach ( array_keys( $settings_fields ) as $group_id ) {
243 + $cat = self::group_category( $group_id );
244 + $out[ $cat ][] = $group_id;
245 + }
246 +
247 + return array_filter(
248 + $out,
249 + function ( $group_ids ) {
250 + return ! empty( $group_ids );
251 + }
252 + );
253 + }
254 +
255 + /**
256 + * Whether every group in a section is locked behind Pro.
257 + *
258 + * Drives the "Pro" marker on the rail item, so a section none of which can
259 + * be changed yet says so before it is opened.
260 + *
261 + * @param string[] $group_ids Group keys in the section.
262 + * @param array $settings_fields Grouped settings fields.
263 + * @return bool
264 + */
265 + public static function category_is_pro_locked( array $group_ids, array $settings_fields ) {
266 + if ( empty( $group_ids ) ) {
267 + return false;
268 + }
269 +
270 + foreach ( $group_ids as $group_id ) {
271 + if ( ! self::group_is_pro_locked( $settings_fields[ $group_id ] ?? array() ) ) {
272 + return false;
273 + }
274 + }
275 +
276 + return true;
277 + }
278 +
279 + /**
113 280 * Render specified settings field.
114 281 *
115 282 * @param string $field Field type.
116 283 * @param array $args Field arguments.
@@ -133,8 +300,10 @@
133 300 case 'multi_select':
134 301 return self::render_multiselect_field( $args, $should_print );
135 302 case 'join':
136 303 return self::render_joined_field( $args, $should_print );
304 + case 'editlist':
305 + return self::render_editlist_field( $args, $should_print );
137 306 case 'input':
138 307 default:
139 308 return self::render_input_field( $args, $should_print );
140 309 }
@@ -139,9 +308,18 @@
139 308 return self::render_input_field( $args, $should_print );
140 309 }
141 310 }
142 311
312 + /**
313 + * Pro badge markup, shown beside settings that require WPSubscription Pro.
314 + *
315 + * @return string Pre-escaped badge HTML.
316 + */
317 + public static function pro_badge_html() {
318 + return '<span class="subscrpt-pro-badge" title="' . esc_attr__( 'WPSubscription Pro required', 'subscription' ) . '">' . esc_html__( 'Pro', 'subscription' ) . '</span>';
319 + }
143 320
321 +
144 322 /**
145 323 * Text Element HTML.
146 324 *
147 325 * @param array $args Same as 'render_text_field'.
@@ -236,8 +414,9 @@
236 414 'name' => $id,
237 415 'value' => $selected,
238 416 'options' => $adv_options,
239 417 'align' => 'left',
418 + 'class' => $args['class'] ?? '',
240 419 )
241 420 );
242 421 return ob_get_clean();
243 422 }
@@ -302,10 +481,18 @@
302 481 $text_el_html = self::inp_element( $args );
303 482
304 483 ob_start();
305 484 ?>
306 - <div class="wpsubs-settings-field">
307 - <div class="wpsubs-settings-field__label"><?php echo esc_html( $title ); ?></div>
485 + <div class="wpsubs-settings-field<?php echo ! empty( $args['pro_locked'] ) ? ' wpsubs-settings-field--locked' : ''; ?>">
486 + <div class="wpsubs-settings-field__label">
487 + <?php
488 + if ( ! empty( $args['pro_locked'] ) ) {
489 + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup.
490 + echo self::pro_badge_html();
491 + }
492 + ?>
493 + <?php echo esc_html( $title ); ?>
494 + </div>
308 495 <div class="wpsubs-settings-field__control">
309 496 <?php
310 497 // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure.
311 498 // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
@@ -376,10 +563,18 @@
376 563 $disabled_attr = isset( $args['disabled'] ) && (bool) $args['disabled'] ? 'disabled' : '';
377 564
378 565 ob_start();
379 566 ?>
380 - <div class="wpsubs-settings-field">
381 - <div class="wpsubs-settings-field__label"><?php echo esc_html( $title ); ?></div>
567 + <div class="wpsubs-settings-field<?php echo ! empty( $args['pro_locked'] ) ? ' wpsubs-settings-field--locked' : ''; ?>">
568 + <div class="wpsubs-settings-field__label">
569 + <?php
570 + if ( ! empty( $args['pro_locked'] ) ) {
571 + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup.
572 + echo self::pro_badge_html();
573 + }
574 + ?>
575 + <?php echo esc_html( $title ); ?>
576 + </div>
382 577 <div class="wpsubs-settings-field__control">
383 578 <label class="wpsubs-settings-toggle-label" for="<?php echo esc_attr( $id ); ?>">
384 579 <input
385 580 id="<?php echo esc_attr( $id ); ?>"
@@ -441,10 +636,18 @@
441 636 $select_el_html = self::select_element( $args );
442 637
443 638 ob_start();
444 639 ?>
445 - <div class="wpsubs-settings-field">
446 - <div class="wpsubs-settings-field__label"><?php echo esc_html( $title ); ?></div>
640 + <div class="wpsubs-settings-field<?php echo ! empty( $args['pro_locked'] ) ? ' wpsubs-settings-field--locked' : ''; ?>">
641 + <div class="wpsubs-settings-field__label">
642 + <?php
643 + if ( ! empty( $args['pro_locked'] ) ) {
644 + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup.
645 + echo self::pro_badge_html();
646 + }
647 + ?>
648 + <?php echo esc_html( $title ); ?>
649 + </div>
447 650 <div class="wpsubs-settings-field__control">
448 651 <?php
449 652 // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure.
450 653 // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
@@ -503,10 +706,18 @@
503 706 $vertical_style = ( $args['vertical'] ?? false ) ? 'flex-direction:column;' : '';
504 707
505 708 ob_start();
506 709 ?>
507 - <div class="wpsubs-settings-field">
508 - <div class="wpsubs-settings-field__label"><?php echo esc_html( $title ); ?></div>
710 + <div class="wpsubs-settings-field<?php echo ! empty( $args['pro_locked'] ) ? ' wpsubs-settings-field--locked' : ''; ?>">
711 + <div class="wpsubs-settings-field__label">
712 + <?php
713 + if ( ! empty( $args['pro_locked'] ) ) {
714 + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup.
715 + echo self::pro_badge_html();
716 + }
717 + ?>
718 + <?php echo esc_html( $title ); ?>
719 + </div>
509 720 <div class="wpsubs-settings-field__control">
510 721 <div class="wpsubs-input-group"
511 722 <?php
512 723 if ( $vertical_style ) :
@@ -531,6 +742,156 @@
531 742 // Output not escaped intentionally. Breaks the HTML structure when escaped.
532 743 // All form elements inside $html_content are pre-escaped during generation (esc_attr, esc_html).
533 744 // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
534 745 return $should_print ? print( $html_content ) : $html_content;
746 + }
747 +
748 + /**
749 + * Render an editable, reorderable list field (the `wpsubs-editlist` component).
750 + *
751 + * Generic and reusable: a sortable list of text items with per-row remove/move
752 + * controls and an inline input + add button. The ordered list is serialized as
753 + * JSON (`[{ key, label }]`) into a hidden input so it submits with the form;
754 + * behaviour is wired by `WPSubsEditList` (admin-components/editlist.js). All user-facing
755 + * strings are overridable so the field carries no feature-specific text.
756 + *
757 + * When `modal` is true the list lives inside a `wpsubs-modal` (via the
758 + * `WPSubsModal` component) and the settings row only shows a trigger button with
759 + * a live item count.
760 + *
761 + * - Args:
762 + * - id (string) - Field ID / option key.
763 + * - title (string)
764 + * - description (string)
765 + * - value (array) - Ordered list of { key, label } entries.
766 + * - add_placeholder (string) - Inline input placeholder.
767 + * - add_label (string) - Add button accessible label.
768 + * - empty_text (string) - Message shown when the list is empty.
769 + * - modal (bool) - Present the list inside a modal (default false).
770 + * - button_label (string) - Modal trigger button text (modal mode).
771 + * - modal_title (string) - Modal header title (modal mode; defaults to title).
772 + * - pro_locked (bool)
773 + *
774 + * @param array $args Field arguments.
775 + * @param bool $should_print Whether to print the field or return as HTML string.
776 + */
777 + public static function render_editlist_field( $args = [], $should_print = true ) {
778 + $id = $args['id'] ?? '';
779 + $title = $args['title'] ?? '';
780 + $description = $args['description'] ?? '';
781 + $items = is_array( $args['value'] ?? null ) ? $args['value'] : [];
782 + $locked = ! empty( $args['pro_locked'] );
783 + $modal = ! empty( $args['modal'] );
784 +
785 + $add_placeholder = $args['add_placeholder'] ?? __( 'Add an item…', 'subscription' );
786 + $add_label = $args['add_label'] ?? __( 'Add item', 'subscription' );
787 + $empty_text = $args['empty_text'] ?? __( 'No items yet. Add one below.', 'subscription' );
788 + $button_label = $args['button_label'] ?? __( 'Manage list', 'subscription' );
789 + $modal_title = $args['modal_title'] ?? ( '' !== $title ? $title : __( 'Edit list', 'subscription' ) );
790 +
791 + if ( empty( $id ) ) {
792 + $field_hint = empty( $title ) ? 'Error' : $title;
793 + $no_id_msg = '<p><strong>' . $field_hint . ':</strong> ' . __( 'Field ID is required.', 'subscription' ) . '</p>';
794 + return $should_print ? print wp_kses_post( $no_id_msg ) : $no_id_msg;
795 + }
796 +
797 + $body = self::editlist_body_html( $items, $add_placeholder, $add_label, $empty_text, $locked );
798 +
799 + ob_start();
800 + ?>
801 + <div class="wpsubs-settings-field<?php echo $locked ? ' wpsubs-settings-field--locked' : ''; ?>">
802 + <div class="wpsubs-settings-field__label">
803 + <?php
804 + if ( $locked ) {
805 + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup.
806 + echo self::pro_badge_html();
807 + }
808 + ?>
809 + <?php echo esc_html( $title ); ?>
810 + </div>
811 + <div class="wpsubs-settings-field__control">
812 + <div class="wpsubs-editlist<?php echo $locked ? ' wpsubs-editlist--locked' : ''; ?>">
813 + <input type="hidden" id="<?php echo esc_attr( $id ); ?>" name="<?php echo esc_attr( $id ); ?>" value="<?php echo esc_attr( wp_json_encode( array_values( $items ) ) ); ?>" />
814 + <?php if ( $modal ) : ?>
815 + <button type="button" class="wpsubs-btn wpsubs-btn--outline wpsubs-editlist__trigger" data-wpsubs-modal-open="<?php echo esc_attr( $id . '_modal' ); ?>"<?php echo $locked ? ' disabled' : ''; ?>>
816 + <?php echo esc_html( $button_label ); ?>
817 + <span class="wpsubs-editlist__count"><?php echo esc_html( (string) count( $items ) ); ?></span>
818 + </button>
819 + <?php
820 + wpsubs_render_modal(
821 + [
822 + 'id' => $id . '_modal',
823 + 'title' => $modal_title,
824 + 'body' => $body,
825 + 'class' => 'wpsubs-modal--editlist',
826 + 'footer' => '<button type="button" class="wpsubs-btn wpsubs-btn--primary" data-wpsubs-modal-close>' . esc_html__( 'Done', 'subscription' ) . '</button>',
827 + ]
828 + );
829 + ?>
830 + <?php else : ?>
831 + <?php
832 + // Body markup is pre-escaped during generation.
833 + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
834 + echo $body;
835 + ?>
836 + <?php endif; ?>
837 + </div>
838 + <?php if ( ! empty( $description ) ) : ?>
839 + <p class="wpsubs-settings-field__hint"><?php echo wp_kses_post( $description ); ?></p>
840 + <?php endif; ?>
841 + </div>
842 + </div>
843 + <?php
844 + $html_content = ob_get_clean();
845 +
846 + // Output not escaped intentionally. Breaks the HTML structure when escaped.
847 + // All form elements inside $html_content are pre-escaped during generation (esc_attr, esc_html).
848 + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped
849 + return $should_print ? print( $html_content ) : $html_content;
850 + }
851 +
852 + /**
853 + * Build the inner markup of an edit list (items + empty message + add row).
854 + *
855 + * Shared by inline and modal presentations of {@see self::render_editlist_field}.
856 + *
857 + * @param array $items Ordered list of { key, label } entries.
858 + * @param string $add_placeholder Inline input placeholder.
859 + * @param string $add_label Add button accessible label.
860 + * @param string $empty_text Message shown when the list is empty.
861 + * @param bool $locked Whether the controls are disabled.
862 + * @return string Pre-escaped HTML.
863 + */
864 + private static function editlist_body_html( array $items, $add_placeholder, $add_label, $empty_text, $locked ) {
865 + ob_start();
866 + ?>
867 + <ul class="wpsubs-editlist__items">
868 + <?php foreach ( $items as $item ) : ?>
869 + <?php
870 + $item_key = isset( $item['key'] ) ? (string) $item['key'] : '';
871 + $item_label = isset( $item['label'] ) ? (string) $item['label'] : '';
872 + if ( '' === $item_label ) {
873 + continue;
874 + }
875 + ?>
876 + <li class="wpsubs-editlist__item" data-key="<?php echo esc_attr( $item_key ); ?>">
877 + <span class="wpsubs-editlist__handle" aria-hidden="true">&#8942;&#8942;</span>
878 + <span class="wpsubs-editlist__label"><?php echo esc_html( $item_label ); ?></span>
879 + <span class="wpsubs-editlist__actions">
880 + <button type="button" class="wpsubs-editlist__btn" data-editlist-up aria-label="<?php esc_attr_e( 'Move up', 'subscription' ); ?>"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><polyline points="18 15 12 9 6 15"/></svg></button>
881 + <button type="button" class="wpsubs-editlist__btn" data-editlist-down aria-label="<?php esc_attr_e( 'Move down', 'subscription' ); ?>"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><polyline points="6 9 12 15 18 9"/></svg></button>
882 + <button type="button" class="wpsubs-editlist__btn wpsubs-editlist__btn--danger" data-editlist-remove aria-label="<?php esc_attr_e( 'Remove', 'subscription' ); ?>"><svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M3 6h18"/><path d="M19 6l-1 14a2 2 0 0 1-2 2H8a2 2 0 0 1-2-2L5 6"/><path d="M8 6V4a2 2 0 0 1 2-2h4a2 2 0 0 1 2 2v2"/></svg></button>
883 + </span>
884 + </li>
885 + <?php endforeach; ?>
886 + </ul>
887 + <p class="wpsubs-editlist__empty"<?php echo empty( $items ) ? '' : ' hidden'; ?>><?php echo esc_html( $empty_text ); ?></p>
888 + <div class="wpsubs-editlist__add">
889 + <input type="text" class="wpsubs-input wpsubs-editlist__input" placeholder="<?php echo esc_attr( $add_placeholder ); ?>"<?php echo $locked ? ' disabled' : ''; ?> />
890 + <button type="button" class="wpsubs-editlist__add-btn" data-editlist-add aria-label="<?php echo esc_attr( $add_label ); ?>"<?php echo $locked ? ' disabled' : ''; ?>>
891 + <svg xmlns="http://www.w3.org/2000/svg" width="16" height="16" viewBox="0 0 24 24" fill="none" stroke="currentColor" stroke-width="2.5" stroke-linecap="round" stroke-linejoin="round" aria-hidden="true"><path d="M20 6 9 17l-5-5"/></svg>
892 + </button>
893 + </div>
894 + <?php
895 + return ob_get_clean();
535 896 }
536 897 }