| @@ -109,8 +109,174 @@ | ||
| 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 | + 'payment_gateways' => 'payments', | |
| 212 | + 'payment_failure' => 'payments', | |
| 213 | + 'grace_period' => 'payments', | |
| 214 | + 'switching' => 'switching', | |
| 215 | + 'role_based_settings' => 'customers', | |
| 216 | + 'guest_checkout' => 'customers', | |
| 217 | + 'live_qr_settings' => 'customers', | |
| 218 | + 'api_settings' => 'advanced', | |
| 219 | + 'health_queue' => 'advanced', | |
| 220 | + ); | |
| 221 | + | |
| 222 | + return $map[ $group_id ] ?? 'advanced'; | |
| 223 | + } | |
| 224 | + | |
| 225 | + /** | |
| 226 | + * Group keys bucketed by section, each list in the order the groups already | |
| 227 | + * sort in. | |
| 228 | + * | |
| 229 | + * Empty sections are dropped. Most of them are filled by Pro, and free | |
| 230 | + * alone would otherwise show rail items that open onto nothing. | |
| 231 | + * | |
| 232 | + * @param array $settings_fields Grouped, sorted settings fields. | |
| 233 | + * @return array<string,string[]> Section key => ordered group keys. | |
| 234 | + */ | |
| 235 | + public static function category_groups( array $settings_fields ) { | |
| 236 | + $out = array(); | |
| 237 | + foreach ( array_keys( self::categories() ) as $cat ) { | |
| 238 | + $out[ $cat ] = array(); | |
| 239 | + } | |
| 240 | + | |
| 241 | + foreach ( array_keys( $settings_fields ) as $group_id ) { | |
| 242 | + $cat = self::group_category( $group_id ); | |
| 243 | + $out[ $cat ][] = $group_id; | |
| 244 | + } | |
| 245 | + | |
| 246 | + return array_filter( | |
| 247 | + $out, | |
| 248 | + function ( $group_ids ) { | |
| 249 | + return ! empty( $group_ids ); | |
| 250 | + } | |
| 251 | + ); | |
| 252 | + } | |
| 253 | + | |
| 254 | + /** | |
| 255 | + * Whether every group in a section is locked behind Pro. | |
| 256 | + * | |
| 257 | + * Drives the "Pro" marker on the rail item, so a section none of which can | |
| 258 | + * be changed yet says so before it is opened. | |
| 259 | + * | |
| 260 | + * @param string[] $group_ids Group keys in the section. | |
| 261 | + * @param array $settings_fields Grouped settings fields. | |
| 262 | + * @return bool | |
| 263 | + */ | |
| 264 | + public static function category_is_pro_locked( array $group_ids, array $settings_fields ) { | |
| 265 | + if ( empty( $group_ids ) ) { | |
| 266 | + return false; | |
| 267 | + } | |
| 268 | + | |
| 269 | + foreach ( $group_ids as $group_id ) { | |
| 270 | + if ( ! self::group_is_pro_locked( $settings_fields[ $group_id ] ?? array() ) ) { | |
| 271 | + return false; | |
| 272 | + } | |
| 273 | + } | |
| 274 | + | |
| 275 | + return true; | |
| 276 | + } | |
| 277 | + | |
| 278 | + /** | |
| 113 | 279 | * Render specified settings field. |
| 114 | 280 | * |
| 115 | 281 | * @param string $field Field type. |
| 116 | 282 | * @param array $args Field arguments. |
| @@ -133,8 +299,10 @@ | ||
| 133 | 299 | case 'multi_select': |
| 134 | 300 | return self::render_multiselect_field( $args, $should_print ); |
| 135 | 301 | case 'join': |
| 136 | 302 | return self::render_joined_field( $args, $should_print ); |
| 303 | + case 'editlist': | |
| 304 | + return self::render_editlist_field( $args, $should_print ); | |
| 137 | 305 | case 'input': |
| 138 | 306 | default: |
| 139 | 307 | return self::render_input_field( $args, $should_print ); |
| 140 | 308 | } |
| @@ -139,9 +307,18 @@ | ||
| 139 | 307 | return self::render_input_field( $args, $should_print ); |
| 140 | 308 | } |
| 141 | 309 | } |
| 142 | 310 | |
| 311 | + /** | |
| 312 | + * Pro badge markup, shown beside settings that require WPSubscription Pro. | |
| 313 | + * | |
| 314 | + * @return string Pre-escaped badge HTML. | |
| 315 | + */ | |
| 316 | + public static function pro_badge_html() { | |
| 317 | + return '<span class="subscrpt-pro-badge" title="' . esc_attr__( 'WPSubscription Pro required', 'subscription' ) . '">' . esc_html__( 'Pro', 'subscription' ) . '</span>'; | |
| 318 | + } | |
| 143 | 319 | |
| 320 | + | |
| 144 | 321 | /** |
| 145 | 322 | * Text Element HTML. |
| 146 | 323 | * |
| 147 | 324 | * @param array $args Same as 'render_text_field'. |
| @@ -152,15 +329,13 @@ | ||
| 152 | 329 | $value = $args['value'] ?? ''; |
| 153 | 330 | $placeholder = $args['placeholder'] ?? ''; |
| 154 | 331 | $type = $args['type'] ?? 'text'; |
| 155 | 332 | |
| 156 | - $join_class = $join_item ? 'join-item mx-0!' : ''; | |
| 157 | - | |
| 158 | 333 | $disabled_attr = isset( $args['disabled'] ) && $args['disabled'] ? 'disabled' : ''; |
| 159 | 334 | |
| 160 | - $style_attr = 'outline-offset: 0.5px !important; outline-color: #e5e7eb !important;'; | |
| 335 | + $style_attr = ''; | |
| 161 | 336 | if ( isset( $args['style'] ) ) { |
| 162 | - $style_attr .= ' ' . $args['style']; | |
| 337 | + $style_attr = $args['style']; | |
| 163 | 338 | } |
| 164 | 339 | |
| 165 | 340 | $other_attrs_html = ''; |
| 166 | 341 | foreach ( ( $args['attributes'] ?? [] ) as $attr_key => $attr_value ) { |
| @@ -168,13 +343,16 @@ | ||
| 168 | 343 | } |
| 169 | 344 | |
| 170 | 345 | ob_start(); |
| 171 | 346 | ?> |
| 172 | - <input | |
| 347 | + <input | |
| 173 | 348 | id="<?php echo esc_attr( $id ); ?>" |
| 174 | 349 | name="<?php echo esc_attr( $id ); ?>" |
| 175 | - class="input! min-w-80! max-w-full! <?php echo esc_attr( $join_class ); ?>" | |
| 176 | - style="<?php echo esc_attr( $style_attr ); ?>" | |
| 350 | + class="wpsubs-input" | |
| 351 | + <?php | |
| 352 | + if ( $style_attr ) : | |
| 353 | + ?> | |
| 354 | + style="<?php echo esc_attr( $style_attr ); ?>"<?php endif; ?> | |
| 177 | 355 | type="<?php echo esc_attr( $type ); ?>" |
| 178 | 356 | placeholder="<?php echo esc_attr( $placeholder ); ?>" |
| 179 | 357 | value="<?php echo esc_attr( $value ); ?>" |
| 180 | 358 | <?php echo esc_attr( $disabled_attr ); ?> |
| @@ -190,88 +368,56 @@ | ||
| 190 | 368 | * @param array $args Same as 'render_select_field'. |
| 191 | 369 | * @param bool $join_item Whether to return element for 'join' container or not. |
| 192 | 370 | */ |
| 193 | 371 | public static function select_element( $args = [], $join_item = false ) { |
| 194 | - $id = $args['id']; | |
| 195 | - $value = $args['value'] ?? ''; | |
| 372 | + $id = $args['id']; | |
| 196 | 373 | |
| 197 | - $join_class = $join_item ? 'join-item mx-0!' : ''; | |
| 198 | - $wc_enhanced_class = isset( $args['enhanced'] ) && $args['enhanced']; | |
| 374 | + // Enhanced / multiselect → wpsubs-tag-select (pill input with filter). | |
| 375 | + if ( isset( $args['enhanced'] ) && $args['enhanced'] ) { | |
| 376 | + $multiple = isset( $args['attributes']['multiple'] ) && $args['attributes']['multiple']; | |
| 377 | + $adv_options = array(); | |
| 378 | + foreach ( ( $args['options'] ?? [] ) as $opt_value => $opt_label ) { | |
| 379 | + $adv_options[] = array( | |
| 380 | + 'value' => (string) $opt_value, | |
| 381 | + 'label' => $opt_label, | |
| 382 | + ); | |
| 383 | + } | |
| 199 | 384 | |
| 200 | - $basic_classes = 'select! min-w-80! max-w-full!'; | |
| 201 | - | |
| 202 | - // WC Select2 style (multiselect). | |
| 203 | - if ( $wc_enhanced_class ) { | |
| 204 | - // Enqueue WooCommerce enhanced select script & styles. | |
| 205 | - wp_enqueue_style( 'woocommerce_admin_styles' ); | |
| 206 | - wp_enqueue_script( 'wc-enhanced-select' ); | |
| 207 | - | |
| 208 | - // Update basic classes for wc-enhanced-select. | |
| 209 | - $basic_classes = 'min-w-80! max-w-full! wc-enhanced-select'; | |
| 385 | + ob_start(); | |
| 386 | + wpsubs_render_tag_select( | |
| 387 | + array( | |
| 388 | + 'name' => $id, | |
| 389 | + 'value' => $args['selected'] ?? ( $multiple ? array() : '' ), | |
| 390 | + 'options' => $adv_options, | |
| 391 | + 'multiple' => $multiple, | |
| 392 | + ) | |
| 393 | + ); | |
| 394 | + return ob_get_clean(); | |
| 210 | 395 | } |
| 211 | 396 | |
| 212 | - // Need to prefix name with [] for multiple select. | |
| 213 | - $name_prefix = ''; | |
| 214 | - if ( isset( $args['attributes']['multiple'] ) && $args['attributes']['multiple'] ) { | |
| 215 | - $name_prefix = '[]'; | |
| 216 | - } | |
| 217 | - | |
| 218 | - $style_attr = 'outline-offset: 0.5px !important; outline-color: #e5e7eb !important;'; | |
| 219 | - if ( isset( $args['style'] ) ) { | |
| 220 | - $style_attr .= ' ' . $args['style']; | |
| 221 | - } | |
| 222 | - | |
| 223 | - $other_attrs_html = ''; | |
| 224 | - foreach ( ( $args['attributes'] ?? [] ) as $attr_key => $attr_value ) { | |
| 225 | - $other_attrs_html .= sprintf( ' %s="%s" ', esc_attr( $attr_key ), esc_attr( $attr_value ) ); | |
| 226 | - } | |
| 227 | - | |
| 228 | - $options_html = ''; | |
| 229 | - foreach ( ( $args['options'] ?? [] ) as $value => $label ) { | |
| 230 | - $selected = false; | |
| 231 | - if ( isset( $args['selected'] ) ) { | |
| 232 | - if ( is_array( $args['selected'] ) ) { | |
| 233 | - $selected = in_array( $value, $args['selected'], true ); | |
| 234 | - } else { | |
| 235 | - $selected = $args['selected'] === $value; | |
| 236 | - } | |
| 237 | - } | |
| 238 | - | |
| 239 | - $disabled = false; | |
| 240 | - if ( isset( $args['disabled'] ) ) { | |
| 241 | - if ( is_array( $args['disabled'] ) ) { | |
| 242 | - $disabled = in_array( $value, $args['disabled'], true ); | |
| 243 | - } else { | |
| 244 | - $disabled = $args['disabled'] === $value; | |
| 245 | - } | |
| 246 | - } | |
| 247 | - | |
| 248 | - $options_tmp_html = sprintf( | |
| 249 | - '<option value="%s" %s %s>%s</option>', | |
| 250 | - esc_attr( $value ), | |
| 251 | - $selected ? 'selected' : '', | |
| 252 | - $disabled ? 'disabled' : '', | |
| 253 | - esc_html( $label ), | |
| 397 | + // Regular select → wpsubs-adv-select (button-based custom dropdown). | |
| 398 | + $selected = (string) ( $args['selected'] ?? '' ); | |
| 399 | + $adv_options = array(); | |
| 400 | + foreach ( ( $args['options'] ?? [] ) as $opt_value => $opt_label ) { | |
| 401 | + $adv_options[] = array( | |
| 402 | + 'value' => (string) $opt_value, | |
| 403 | + 'label' => $opt_label, | |
| 404 | + 'disabled' => isset( $args['disabled'] ) && ( is_array( $args['disabled'] ) | |
| 405 | + ? in_array( $opt_value, $args['disabled'], true ) | |
| 406 | + : $args['disabled'] === $opt_value ), | |
| 254 | 407 | ); |
| 255 | - $options_html .= $options_tmp_html; | |
| 256 | 408 | } |
| 257 | 409 | |
| 258 | 410 | ob_start(); |
| 259 | - ?> | |
| 260 | - <select | |
| 261 | - id="<?php echo esc_attr( $id ); ?>" | |
| 262 | - name="<?php echo esc_attr( $id . $name_prefix ); ?>" | |
| 263 | - class="<?php echo esc_attr( $basic_classes . ' ' . $join_class ); ?>" | |
| 264 | - style="<?php echo esc_attr( $style_attr ); ?>" | |
| 265 | - <?php echo wp_kses_post( $other_attrs_html ); ?> | |
| 266 | - > | |
| 267 | - <?php | |
| 268 | - // Output intentionally not escaped as options are already escaped during generation & re-escaping breaks the HTML structure. | |
| 269 | - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 270 | - echo $options_html; | |
| 271 | - ?> | |
| 272 | - </select> | |
| 273 | - <?php | |
| 411 | + wpsubs_render_adv_select( | |
| 412 | + array( | |
| 413 | + 'name' => $id, | |
| 414 | + 'value' => $selected, | |
| 415 | + 'options' => $adv_options, | |
| 416 | + 'align' => 'left', | |
| 417 | + 'class' => $args['class'] ?? '', | |
| 418 | + ) | |
| 419 | + ); | |
| 274 | 420 | return ob_get_clean(); |
| 275 | 421 | } |
| 276 | 422 | |
| 277 | 423 | /** |
| @@ -289,17 +435,14 @@ | ||
| 289 | 435 | $description = $args['description'] ?? ''; |
| 290 | 436 | |
| 291 | 437 | ob_start(); |
| 292 | 438 | ?> |
| 293 | - <div class="my-4 first-of-type:mt-0"> | |
| 294 | - <h2 class="m-0!"><?php echo esc_html( $title ); ?></h2> | |
| 295 | - | |
| 296 | - <?php if ( ! empty( $description ) ) : ?> | |
| 297 | - <p class="mb-0! mt-2! ml-0.5! text-[13px]! text-gray-500!"> | |
| 298 | - <?php echo wp_kses_post( $description ); ?> | |
| 299 | - </p> | |
| 300 | - <?php endif; ?> | |
| 301 | - </div> | |
| 439 | + <div class="wpsubs-settings-heading"> | |
| 440 | + <h3 class="wpsubs-settings-heading__title"><?php echo esc_html( $title ); ?></h3> | |
| 441 | + <?php if ( ! empty( $description ) ) : ?> | |
| 442 | + <p class="wpsubs-settings-heading__desc"><?php echo wp_kses_post( $description ); ?></p> | |
| 443 | + <?php endif; ?> | |
| 444 | + </div> | |
| 302 | 445 | <?php |
| 303 | 446 | $html_content = ob_get_clean(); |
| 304 | 447 | |
| 305 | 448 | // Output not escaped intentionally. Breaks the HTML structure when escaped. |
| @@ -337,25 +480,29 @@ | ||
| 337 | 480 | $text_el_html = self::inp_element( $args ); |
| 338 | 481 | |
| 339 | 482 | ob_start(); |
| 340 | 483 | ?> |
| 341 | - <div class="grid grid-cols-6 gap-4"> | |
| 342 | - <span class="font-semibold text-sm mt-0.5"><?php echo esc_html( $title ); ?></span> | |
| 343 | - | |
| 344 | - <div class="col-span-5"> | |
| 345 | - <?php | |
| 346 | - // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure. | |
| 347 | - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 348 | - echo $text_el_html; | |
| 349 | - ?> | |
| 350 | - <br/> | |
| 351 | - <?php if ( ! empty( $description ) ) : ?> | |
| 352 | - <p class="mb-0! mt-2! ml-0.5! text-[13px]! text-gray-500!"> | |
| 353 | - <?php echo wp_kses_post( $description ); ?> | |
| 354 | - </p> | |
| 355 | - <?php endif; ?> | |
| 356 | - </div> | |
| 484 | + <div class="wpsubs-settings-field<?php echo ! empty( $args['pro_locked'] ) ? ' wpsubs-settings-field--locked' : ''; ?>"> | |
| 485 | + <div class="wpsubs-settings-field__label"> | |
| 486 | + <?php | |
| 487 | + if ( ! empty( $args['pro_locked'] ) ) { | |
| 488 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup. | |
| 489 | + echo self::pro_badge_html(); | |
| 490 | + } | |
| 491 | + ?> | |
| 492 | + <?php echo esc_html( $title ); ?> | |
| 357 | 493 | </div> |
| 494 | + <div class="wpsubs-settings-field__control"> | |
| 495 | + <?php | |
| 496 | + // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure. | |
| 497 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 498 | + echo $text_el_html; | |
| 499 | + ?> | |
| 500 | + <?php if ( ! empty( $description ) ) : ?> | |
| 501 | + <p class="wpsubs-settings-field__hint"><?php echo wp_kses_post( $description ); ?></p> | |
| 502 | + <?php endif; ?> | |
| 503 | + </div> | |
| 504 | + </div> | |
| 358 | 505 | <?php |
| 359 | 506 | $html_content = ob_get_clean(); |
| 360 | 507 | |
| 361 | 508 | // Output not escaped intentionally. Breaks the HTML structure when escaped. |
| @@ -395,9 +542,9 @@ | ||
| 395 | 542 | |
| 396 | 543 | $description_html = ''; |
| 397 | 544 | if ( ! empty( $description ) ) { |
| 398 | 545 | $description_html = sprintf( |
| 399 | - '<p class="mb-0! mt-2! ml-0.5! text-[13px]! text-gray-500!">%s</p>', | |
| 546 | + '<p class="wpsubs-settings-field__hint">%s</p>', | |
| 400 | 547 | wp_kses_post( $description ) |
| 401 | 548 | ); |
| 402 | 549 | } |
| 403 | 550 | |
| @@ -415,37 +562,42 @@ | ||
| 415 | 562 | $disabled_attr = isset( $args['disabled'] ) && (bool) $args['disabled'] ? 'disabled' : ''; |
| 416 | 563 | |
| 417 | 564 | ob_start(); |
| 418 | 565 | ?> |
| 419 | - <div class="grid grid-cols-6 gap-4"> | |
| 420 | - <span class="font-semibold text-sm mt-0.5"><?php echo esc_html( $title ); ?></span> | |
| 421 | - | |
| 422 | - <div class="col-span-5"> | |
| 423 | - <label for="<?php echo esc_attr( $id ); ?>"> | |
| 424 | - <input | |
| 425 | - id="<?php echo esc_attr( $id ); ?>" | |
| 426 | - name="<?php echo esc_attr( $id ); ?>" | |
| 427 | - class="wp-subscription-toggle" | |
| 428 | - style="<?php echo esc_attr( $style_attr ); ?>" | |
| 429 | - type="checkbox" | |
| 430 | - value="<?php echo esc_attr( $value ); ?>" | |
| 431 | - <?php echo esc_attr( $checked_attr ); ?> | |
| 432 | - <?php echo esc_attr( $disabled_attr ); ?> | |
| 433 | - <?php | |
| 434 | - // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure. | |
| 435 | - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 436 | - echo $other_attrs_html; | |
| 437 | - ?> | |
| 438 | - /> | |
| 439 | - <span class="wp-subscription-toggle-ui" aria-hidden="true"></span> | |
| 440 | - | |
| 441 | - <span class="ml-2 text-sm align-middle"><?php echo esc_html( $label ); ?></span> | |
| 442 | - </label> | |
| 443 | - | |
| 444 | - <br/> | |
| 445 | - <?php echo wp_kses_post( $description_html ); ?> | |
| 446 | - </div> | |
| 566 | + <div class="wpsubs-settings-field<?php echo ! empty( $args['pro_locked'] ) ? ' wpsubs-settings-field--locked' : ''; ?>"> | |
| 567 | + <div class="wpsubs-settings-field__label"> | |
| 568 | + <?php | |
| 569 | + if ( ! empty( $args['pro_locked'] ) ) { | |
| 570 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup. | |
| 571 | + echo self::pro_badge_html(); | |
| 572 | + } | |
| 573 | + ?> | |
| 574 | + <?php echo esc_html( $title ); ?> | |
| 447 | 575 | </div> |
| 576 | + <div class="wpsubs-settings-field__control"> | |
| 577 | + <label class="wpsubs-settings-toggle-label" for="<?php echo esc_attr( $id ); ?>"> | |
| 578 | + <input | |
| 579 | + id="<?php echo esc_attr( $id ); ?>" | |
| 580 | + name="<?php echo esc_attr( $id ); ?>" | |
| 581 | + class="wpsubs-toggle" | |
| 582 | + type="checkbox" | |
| 583 | + value="<?php echo esc_attr( $value ); ?>" | |
| 584 | + <?php echo esc_attr( $checked_attr ); ?> | |
| 585 | + <?php echo esc_attr( $disabled_attr ); ?> | |
| 586 | + <?php | |
| 587 | + // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure. | |
| 588 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 589 | + echo $other_attrs_html; | |
| 590 | + ?> | |
| 591 | + /> | |
| 592 | + <span class="wpsubs-toggle-ui" aria-hidden="true"></span> | |
| 593 | + <?php if ( ! empty( $label ) ) : ?> | |
| 594 | + <span class="wpsubs-settings-toggle-label__text"><?php echo esc_html( $label ); ?></span> | |
| 595 | + <?php endif; ?> | |
| 596 | + </label> | |
| 597 | + <?php echo wp_kses_post( $description_html ); ?> | |
| 598 | + </div> | |
| 599 | + </div> | |
| 448 | 600 | <?php |
| 449 | 601 | $html_content = ob_get_clean(); |
| 450 | 602 | |
| 451 | 603 | // Output not escaped intentionally. Breaks the HTML structure when escaped. |
| @@ -483,25 +635,29 @@ | ||
| 483 | 635 | $select_el_html = self::select_element( $args ); |
| 484 | 636 | |
| 485 | 637 | ob_start(); |
| 486 | 638 | ?> |
| 487 | - <div class="grid grid-cols-6 gap-4"> | |
| 488 | - <span class="font-semibold text-sm mt-0.5"><?php echo esc_html( $title ); ?></span> | |
| 489 | - | |
| 490 | - <div class="col-span-5"> | |
| 491 | - <?php | |
| 492 | - // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure. | |
| 493 | - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 494 | - echo $select_el_html; | |
| 495 | - ?> | |
| 496 | - <br/> | |
| 497 | - <?php if ( ! empty( $description ) ) : ?> | |
| 498 | - <p class="mb-0! mt-2! ml-0.5! text-[13px]! text-gray-500!"> | |
| 499 | - <?php echo wp_kses_post( $description ); ?> | |
| 500 | - </p> | |
| 501 | - <?php endif; ?> | |
| 502 | - </div> | |
| 639 | + <div class="wpsubs-settings-field<?php echo ! empty( $args['pro_locked'] ) ? ' wpsubs-settings-field--locked' : ''; ?>"> | |
| 640 | + <div class="wpsubs-settings-field__label"> | |
| 641 | + <?php | |
| 642 | + if ( ! empty( $args['pro_locked'] ) ) { | |
| 643 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup. | |
| 644 | + echo self::pro_badge_html(); | |
| 645 | + } | |
| 646 | + ?> | |
| 647 | + <?php echo esc_html( $title ); ?> | |
| 503 | 648 | </div> |
| 649 | + <div class="wpsubs-settings-field__control"> | |
| 650 | + <?php | |
| 651 | + // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure. | |
| 652 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 653 | + echo $select_el_html; | |
| 654 | + ?> | |
| 655 | + <?php if ( ! empty( $description ) ) : ?> | |
| 656 | + <p class="wpsubs-settings-field__hint"><?php echo wp_kses_post( $description ); ?></p> | |
| 657 | + <?php endif; ?> | |
| 658 | + </div> | |
| 659 | + </div> | |
| 504 | 660 | <?php |
| 505 | 661 | $html_content = ob_get_clean(); |
| 506 | 662 | |
| 507 | 663 | // Output not escaped intentionally. Breaks the HTML structure when escaped. |
| @@ -545,33 +701,145 @@ | ||
| 545 | 701 | public static function render_joined_field( $args = [], $should_print = true ) { |
| 546 | 702 | $title = $args['title'] ?? ''; |
| 547 | 703 | $description = $args['description'] ?? ''; |
| 548 | 704 | |
| 549 | - $vertical_class = ( $args['vertical'] ?? false ) ? 'join-vertical' : ''; | |
| 705 | + $vertical_style = ( $args['vertical'] ?? false ) ? 'flex-direction:column;' : ''; | |
| 550 | 706 | |
| 551 | 707 | ob_start(); |
| 552 | 708 | ?> |
| 553 | - <div class="grid grid-cols-6 gap-4"> | |
| 554 | - <span class="font-semibold text-sm mt-0.5"><?php echo esc_html( $title ); ?></span> | |
| 709 | + <div class="wpsubs-settings-field<?php echo ! empty( $args['pro_locked'] ) ? ' wpsubs-settings-field--locked' : ''; ?>"> | |
| 710 | + <div class="wpsubs-settings-field__label"> | |
| 711 | + <?php | |
| 712 | + if ( ! empty( $args['pro_locked'] ) ) { | |
| 713 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup. | |
| 714 | + echo self::pro_badge_html(); | |
| 715 | + } | |
| 716 | + ?> | |
| 717 | + <?php echo esc_html( $title ); ?> | |
| 718 | + </div> | |
| 719 | + <div class="wpsubs-settings-field__control"> | |
| 720 | + <div class="wpsubs-input-group" | |
| 721 | + <?php | |
| 722 | + if ( $vertical_style ) : | |
| 723 | + ?> | |
| 724 | + style="<?php echo esc_attr( $vertical_style ); ?>"<?php endif; ?>> | |
| 725 | + <?php | |
| 726 | + foreach ( ( $args['elements'] ?? [] ) as $element_html ) { | |
| 727 | + // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure. | |
| 728 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 729 | + echo $element_html; | |
| 730 | + } | |
| 731 | + ?> | |
| 732 | + </div> | |
| 733 | + <?php if ( ! empty( $description ) ) : ?> | |
| 734 | + <p class="wpsubs-settings-field__hint"><?php echo wp_kses_post( $description ); ?></p> | |
| 735 | + <?php endif; ?> | |
| 736 | + </div> | |
| 737 | + </div> | |
| 738 | + <?php | |
| 739 | + $html_content = ob_get_clean(); | |
| 555 | 740 | |
| 556 | - <div class="col-span-5"> | |
| 557 | - <div class="join <?php echo esc_attr( $vertical_class ); ?>"> | |
| 741 | + // Output not escaped intentionally. Breaks the HTML structure when escaped. | |
| 742 | + // All form elements inside $html_content are pre-escaped during generation (esc_attr, esc_html). | |
| 743 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 744 | + return $should_print ? print( $html_content ) : $html_content; | |
| 745 | + } | |
| 746 | + | |
| 747 | + /** | |
| 748 | + * Render an editable, reorderable list field (the `wpsubs-editlist` component). | |
| 749 | + * | |
| 750 | + * Generic and reusable: a sortable list of text items with per-row remove/move | |
| 751 | + * controls and an inline input + add button. The ordered list is serialized as | |
| 752 | + * JSON (`[{ key, label }]`) into a hidden input so it submits with the form; | |
| 753 | + * behaviour is wired by `WPSubsEditList` (admin-components/editlist.js). All user-facing | |
| 754 | + * strings are overridable so the field carries no feature-specific text. | |
| 755 | + * | |
| 756 | + * When `modal` is true the list lives inside a `wpsubs-modal` (via the | |
| 757 | + * `WPSubsModal` component) and the settings row only shows a trigger button with | |
| 758 | + * a live item count. | |
| 759 | + * | |
| 760 | + * - Args: | |
| 761 | + * - id (string) - Field ID / option key. | |
| 762 | + * - title (string) | |
| 763 | + * - description (string) | |
| 764 | + * - value (array) - Ordered list of { key, label } entries. | |
| 765 | + * - add_placeholder (string) - Inline input placeholder. | |
| 766 | + * - add_label (string) - Add button accessible label. | |
| 767 | + * - empty_text (string) - Message shown when the list is empty. | |
| 768 | + * - modal (bool) - Present the list inside a modal (default false). | |
| 769 | + * - button_label (string) - Modal trigger button text (modal mode). | |
| 770 | + * - modal_title (string) - Modal header title (modal mode; defaults to title). | |
| 771 | + * - pro_locked (bool) | |
| 772 | + * | |
| 773 | + * @param array $args Field arguments. | |
| 774 | + * @param bool $should_print Whether to print the field or return as HTML string. | |
| 775 | + */ | |
| 776 | + public static function render_editlist_field( $args = [], $should_print = true ) { | |
| 777 | + $id = $args['id'] ?? ''; | |
| 778 | + $title = $args['title'] ?? ''; | |
| 779 | + $description = $args['description'] ?? ''; | |
| 780 | + $items = is_array( $args['value'] ?? null ) ? $args['value'] : []; | |
| 781 | + $locked = ! empty( $args['pro_locked'] ); | |
| 782 | + $modal = ! empty( $args['modal'] ); | |
| 783 | + | |
| 784 | + $add_placeholder = $args['add_placeholder'] ?? __( 'Add an item…', 'subscription' ); | |
| 785 | + $add_label = $args['add_label'] ?? __( 'Add item', 'subscription' ); | |
| 786 | + $empty_text = $args['empty_text'] ?? __( 'No items yet. Add one below.', 'subscription' ); | |
| 787 | + $button_label = $args['button_label'] ?? __( 'Manage list', 'subscription' ); | |
| 788 | + $modal_title = $args['modal_title'] ?? ( '' !== $title ? $title : __( 'Edit list', 'subscription' ) ); | |
| 789 | + | |
| 790 | + if ( empty( $id ) ) { | |
| 791 | + $field_hint = empty( $title ) ? 'Error' : $title; | |
| 792 | + $no_id_msg = '<p><strong>' . $field_hint . ':</strong> ' . __( 'Field ID is required.', 'subscription' ) . '</p>'; | |
| 793 | + return $should_print ? print wp_kses_post( $no_id_msg ) : $no_id_msg; | |
| 794 | + } | |
| 795 | + | |
| 796 | + $body = self::editlist_body_html( $items, $add_placeholder, $add_label, $empty_text, $locked ); | |
| 797 | + | |
| 798 | + ob_start(); | |
| 799 | + ?> | |
| 800 | + <div class="wpsubs-settings-field<?php echo $locked ? ' wpsubs-settings-field--locked' : ''; ?>"> | |
| 801 | + <div class="wpsubs-settings-field__label"> | |
| 802 | + <?php | |
| 803 | + if ( $locked ) { | |
| 804 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Pre-escaped badge markup. | |
| 805 | + echo self::pro_badge_html(); | |
| 806 | + } | |
| 807 | + ?> | |
| 808 | + <?php echo esc_html( $title ); ?> | |
| 809 | + </div> | |
| 810 | + <div class="wpsubs-settings-field__control"> | |
| 811 | + <div class="wpsubs-editlist<?php echo $locked ? ' wpsubs-editlist--locked' : ''; ?>"> | |
| 812 | + <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 ) ) ); ?>" /> | |
| 813 | + <?php if ( $modal ) : ?> | |
| 814 | + <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' : ''; ?>> | |
| 815 | + <?php echo esc_html( $button_label ); ?> | |
| 816 | + <span class="wpsubs-editlist__count"><?php echo esc_html( (string) count( $items ) ); ?></span> | |
| 817 | + </button> | |
| 558 | 818 | <?php |
| 559 | - foreach ( ( $args['elements'] ?? [] ) as $element_html ) { | |
| 560 | - // Output intentionally not escaped as element is already escaped during generation & re-escaping breaks the HTML structure. | |
| 561 | - // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 562 | - echo $element_html; | |
| 563 | - } | |
| 819 | + wpsubs_render_modal( | |
| 820 | + [ | |
| 821 | + 'id' => $id . '_modal', | |
| 822 | + 'title' => $modal_title, | |
| 823 | + 'body' => $body, | |
| 824 | + 'class' => 'wpsubs-modal--editlist', | |
| 825 | + 'footer' => '<button type="button" class="wpsubs-btn wpsubs-btn--primary" data-wpsubs-modal-close>' . esc_html__( 'Done', 'subscription' ) . '</button>', | |
| 826 | + ] | |
| 827 | + ); | |
| 564 | 828 | ?> |
| 565 | - </div> | |
| 566 | - <br/> | |
| 567 | - <?php if ( ! empty( $description ) ) : ?> | |
| 568 | - <p class="mb-0! mt-2! ml-0.5! text-[13px]! text-gray-500!"> | |
| 569 | - <?php echo wp_kses_post( $description ); ?> | |
| 570 | - </p> | |
| 829 | + <?php else : ?> | |
| 830 | + <?php | |
| 831 | + // Body markup is pre-escaped during generation. | |
| 832 | + // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped | |
| 833 | + echo $body; | |
| 834 | + ?> | |
| 571 | 835 | <?php endif; ?> |
| 572 | 836 | </div> |
| 837 | + <?php if ( ! empty( $description ) ) : ?> | |
| 838 | + <p class="wpsubs-settings-field__hint"><?php echo wp_kses_post( $description ); ?></p> | |
| 839 | + <?php endif; ?> | |
| 573 | 840 | </div> |
| 841 | + </div> | |
| 574 | 842 | <?php |
| 575 | 843 | $html_content = ob_get_clean(); |
| 576 | 844 | |
| 577 | 845 | // Output not escaped intentionally. Breaks the HTML structure when escaped. |
| @@ -577,6 +845,52 @@ | ||
| 577 | 845 | // Output not escaped intentionally. Breaks the HTML structure when escaped. |
| 578 | 846 | // All form elements inside $html_content are pre-escaped during generation (esc_attr, esc_html). |
| 579 | 847 | // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped |
| 580 | 848 | return $should_print ? print( $html_content ) : $html_content; |
| 849 | + } | |
| 850 | + | |
| 851 | + /** | |
| 852 | + * Build the inner markup of an edit list (items + empty message + add row). | |
| 853 | + * | |
| 854 | + * Shared by inline and modal presentations of {@see self::render_editlist_field}. | |
| 855 | + * | |
| 856 | + * @param array $items Ordered list of { key, label } entries. | |
| 857 | + * @param string $add_placeholder Inline input placeholder. | |
| 858 | + * @param string $add_label Add button accessible label. | |
| 859 | + * @param string $empty_text Message shown when the list is empty. | |
| 860 | + * @param bool $locked Whether the controls are disabled. | |
| 861 | + * @return string Pre-escaped HTML. | |
| 862 | + */ | |
| 863 | + private static function editlist_body_html( array $items, $add_placeholder, $add_label, $empty_text, $locked ) { | |
| 864 | + ob_start(); | |
| 865 | + ?> | |
| 866 | + <ul class="wpsubs-editlist__items"> | |
| 867 | + <?php foreach ( $items as $item ) : ?> | |
| 868 | + <?php | |
| 869 | + $item_key = isset( $item['key'] ) ? (string) $item['key'] : ''; | |
| 870 | + $item_label = isset( $item['label'] ) ? (string) $item['label'] : ''; | |
| 871 | + if ( '' === $item_label ) { | |
| 872 | + continue; | |
| 873 | + } | |
| 874 | + ?> | |
| 875 | + <li class="wpsubs-editlist__item" data-key="<?php echo esc_attr( $item_key ); ?>"> | |
| 876 | + <span class="wpsubs-editlist__handle" aria-hidden="true">⋮⋮</span> | |
| 877 | + <span class="wpsubs-editlist__label"><?php echo esc_html( $item_label ); ?></span> | |
| 878 | + <span class="wpsubs-editlist__actions"> | |
| 879 | + <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> | |
| 880 | + <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> | |
| 881 | + <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> | |
| 882 | + </span> | |
| 883 | + </li> | |
| 884 | + <?php endforeach; ?> | |
| 885 | + </ul> | |
| 886 | + <p class="wpsubs-editlist__empty"<?php echo empty( $items ) ? '' : ' hidden'; ?>><?php echo esc_html( $empty_text ); ?></p> | |
| 887 | + <div class="wpsubs-editlist__add"> | |
| 888 | + <input type="text" class="wpsubs-input wpsubs-editlist__input" placeholder="<?php echo esc_attr( $add_placeholder ); ?>"<?php echo $locked ? ' disabled' : ''; ?> /> | |
| 889 | + <button type="button" class="wpsubs-editlist__add-btn" data-editlist-add aria-label="<?php echo esc_attr( $add_label ); ?>"<?php echo $locked ? ' disabled' : ''; ?>> | |
| 890 | + <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> | |
| 891 | + </button> | |
| 892 | + </div> | |
| 893 | + <?php | |
| 894 | + return ob_get_clean(); | |
| 581 | 895 | } |
| 582 | 896 | } |
