class-learndash-payment-button.php
17 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
<?php
/**
* Class for mapping payment button markup.
*
* @since 4.5.0
*
* @package LearnDash
*/
if ( ! defined( 'ABSPATH' ) ) {
exit;
}
use LearnDash\Core\Models\Product;
if ( ! class_exists( 'Learndash_Payment_Button' ) ) {
/**
* Class for mapping payment button HTML markup.
*
* @since 4.5.0
*/
class Learndash_Payment_Button {
private const BUTTON_CLASS = 'btn-join';
private const BUTTON_ID = 'btn-join';
/**
* Current product.
*
* @since 4.7.0
*
* @var Product|null
*/
protected $product;
/**
* Current post.
*
* @since 4.5.0
*
* @var WP_Post|null
*/
private $post;
/**
* Current user.
*
* @since 4.5.0
*
* @var WP_User
*/
private $current_user;
/**
* Default payment button params for filters.
* They are here with these keys for backward compatibility.
*
* @since 4.5.0
*
* @var array{
* type?: string,
* price?: float,
* }
*/
private $default_payment_params = array();
/**
* Registration page ID.
*
* @since 4.5.0
*
* @var int
*/
private $registration_page_id;
/**
* True if the registration page is set, otherwise false.
*
* @since 4.5.0
*
* @var bool
*/
private $registration_page_is_set;
/**
* True if a user is on the registration page, otherwise false.
*
* @since 4.5.0
*
* @var bool
*/
private $is_on_registration_page;
/**
* Button label.
*
* @since 4.5.0
*
* @var string
*/
private $button_label = '';
/**
* Construct.
*
* @since 4.5.0
*
* @param int|WP_Post|null $post Post ID or `WP_Post` object.
*
* @return void
*/
public function __construct( $post ) {
if ( $post instanceof WP_Post ) {
$this->post = $post;
} elseif ( is_numeric( $post ) ) {
$this->post = get_post( $post );
} else {
$this->post = get_post();
}
if ( $this->post instanceof WP_Post ) {
try {
$this->product = Product::create_from_post( $this->post );
} catch ( Exception $e ) { // phpcs:ignore Generic.CodeAnalysis.EmptyStatement.DetectedCatch
// We don't want to throw an error in templates.
}
}
$this->current_user = wp_get_current_user();
$this->registration_page_id = learndash_registration_page_get_id();
$this->registration_page_is_set = learndash_registration_page_is_set();
$this->is_on_registration_page = $this->is_on_registration_page();
$this->button_label = $this->map_label();
}
/**
* Returns payment button class name.
*
* @since 4.5.0
*
* @param string $additional_class Additional class. Default empty string.
*
* @return string
*/
public static function map_button_class_name( string $additional_class = '' ): string {
$classes = self::BUTTON_CLASS;
if ( ! empty( $additional_class ) ) {
$classes .= " $additional_class";
}
/**
* Filters the payment button classes.
*
* @since 4.6.0
*
* @param string $classes Payment button classes.
*
* @return string Payment button classes.
*/
return (string) apply_filters( 'learndash_payment_button_classes', $classes );
}
/**
* Returns payment button ID.
*
* @since 4.5.0
*
* @param string $additional_id Additional ID. Default empty string.
*
* @return string
*/
public static function map_button_id( string $additional_id = '' ): string {
$result = self::BUTTON_ID;
if ( ! empty( $additional_id ) ) {
$result .= " $additional_id";
}
return $result;
}
/**
* Returns payment button HTML output.
*
* @since 4.5.0
*
* @return string
*/
public function map(): string {
if (
! $this->post instanceof WP_Post
|| ! $this->product instanceof Product
) {
return '';
}
if ( $this->product->user_has_access( $this->current_user ) ) {
return '';
}
$product_pricing = $this->product->get_pricing( $this->current_user );
$this->default_payment_params = array(
'type' => $this->product->get_pricing_type(),
'price' => $product_pricing->price,
);
if ( $this->product->is_price_type_open() ) {
return $this->button_open();
}
if ( ! $this->product->can_be_purchased() ) {
return $this->button_disabled();
}
if ( $this->product->is_price_type_closed() ) {
return $this->button_closed();
}
if ( $this->product->is_price_type_free() ) {
return $this->button_free();
}
if (
$this->product->is_price_type_paynow()
|| $this->product->is_price_type_subscribe()
) {
if ( empty( $product_pricing->price ) ) {
return '';
}
if ( $this->registration_page_is_set && ! $this->is_on_registration_page ) {
return $this->button_registration_page_link();
}
return $this->button_paid();
}
return '';
}
/**
* Returns a disabled button that does not react.
*
* @since 4.7.0
*
* @return string
*/
protected function button_disabled(): string {
$button = sprintf(
'<span class="%s" id="%s">%s</span>',
esc_attr( $this->map_button_class_name( 'btn-disabled' ) ),
esc_attr( $this->map_button_id() ),
esc_html( $this->button_label )
);
/**
* Filters disabled payment button HTML markup.
*
* @since 4.7.0
*
* @param string $button Disabled payment button HTML markup.
* @param array{ type?: string, price?: float } $params Payment parameters.
*
* @return string Payment button HTML markup.
*/
return (string) apply_filters( 'learndash_payment_button_disabled', $button, $this->default_payment_params );
}
/**
* Returns a button for open posts.
*
* @since 4.5.0
*
* @return string
*/
private function button_open(): string {
/**
* Filters payment button HTML markup for open price type.
*
* @since 4.5.0
*
* @param string $button Payment button HTML markup for open price type. Default empty.
* @param array $params Payment parameters.
*
* @return string Payment button HTML markup.
*/
return (string) apply_filters( 'learndash_payment_button_open', '', $this->default_payment_params );
}
/**
* Returns a button for closed posts.
*
* @since 4.5.0
*
* @return string
*/
private function button_closed(): string {
/**
* Post settings.
*
* @var array{
* custom_button_url?: string
* } $post_settings
*/
$post_settings = learndash_get_setting( $this->post->ID ); // @phpstan-ignore-line -- $this->post is checked before in the map().
$button_url = $post_settings['custom_button_url'] ?? '';
$button = '';
if ( ! empty( $button_url ) ) {
// If the value does NOT start with [http://, https://, /] we prepend the home URL.
if (
stripos( $button_url, 'http://', 0 ) !== 0
&& stripos( $button_url, 'https://', 0 ) !== 0
&& strpos( $button_url, '/' ) !== 0
) {
$button_url = get_home_url( null, $button_url );
}
$button = sprintf(
'<a class="%s" id="%s" href="%s">%s</a>',
esc_attr( $this->map_button_class_name( 'learndash-button-closed' ) ),
esc_attr( $this->map_button_id() ),
esc_url( $button_url ),
$this->button_label
);
}
/**
* Filters payment button HTML markup for closed price type.
*
* @since 2.1.0
* @deprecated 4.5.0 Use the {@see 'learndash_payment_button_closed'} filter instead.
*
* @param string $button Payment button HTML markup.
* @param array $payment_params Payment parameters.
*
* @return string Payment button HTML markup.
*/
$button = (string) apply_filters_deprecated(
'learndash_payment_closed_button',
array(
$button,
array_merge(
$this->default_payment_params,
array(
'custom_button_url' => $button_url,
)
),
),
'4.5.0',
'learndash_payment_button_closed'
);
/**
* Filters payment button HTML markup for closed price type.
*
* @since 4.5.0
*
* @param string $button Payment button HTML markup.
* @param array $params Payment parameters.
*
* @return string Payment button HTML markup.
*/
return (string) apply_filters(
'learndash_payment_button_closed',
$button,
array_merge(
$this->default_payment_params,
array(
'custom_button_url' => $button_url,
)
)
);
}
/**
* Returns a button for free posts.
*
* @since 4.5.0
*
* @return string
*/
private function button_free(): string {
$post_type_prefix = LDLMS_Post_Types::get_post_type_key( $this->post->post_type ); // @phpstan-ignore-line -- $this->post is checked before in the map().
$post_id = $this->post->ID; // @phpstan-ignore-line -- $this->post is checked before in the map().
$permalink = (string) get_permalink( $this->post ); // @phpstan-ignore-line -- $this->post is checked before in the map().
$button = '
<form action="' . esc_url( $permalink ) . '" method="post">
<input type="hidden" value="' . esc_attr( (string) $post_id ) . '" name="' . esc_attr( $post_type_prefix . '_id' ) . '" />
<input type="hidden" name="' . esc_attr( $post_type_prefix . '_join' ) . '" value="' . esc_attr( wp_create_nonce( $post_type_prefix . '_join_' . $this->current_user->ID . '_' . $post_id ) ) . '" />
<input type="submit" class="' . esc_attr( $this->map_button_class_name( 'learndash-button-free' ) ) . '" id="' . esc_attr( $this->map_button_id() ) . '" value="' . esc_attr( $this->button_label ) . '" />
</form>
';
/**
* Filters payment button HTML markup for free price type.
*
* @since 4.5.0
*
* @param string $button Payment button HTML markup.
* @param array $params Payment parameters.
*
* @return string Payment button HTML markup.
*/
return (string) apply_filters( 'learndash_payment_button_free', $button, $this->default_payment_params );
}
/**
* Returns a button for paid posts.
*
* @since 4.5.0
*
* @return string
*/
private function button_paid(): string {
/**
* Filters payment buttons list.
*
* @since 4.5.0
*
* @param array $buttons Payment buttons. An associative array where a key is a payment gateway name, and a value is payment button HTML markup.
* @param WP_Post $post Post being processing.
* @param array $params Payment params.
*
* @return array Payment buttons list.
*/
$buttons = (array) apply_filters( // @phpstan-ignore-line -- $this->post is checked before in the map().
'learndash_payment_buttons',
array(),
$this->post,
$this->default_payment_params
);
$buttons = array_filter( $buttons );
if ( empty( $buttons ) ) {
/**
* Filters payment button HTML markup.
*
* @since 2.1.0
*
* @param string $payment_button Payment button HTML markup.
* @param array $params Payment parameters.
*
* @return string Payment button HTML markup.
*/
return (string) apply_filters( 'learndash_payment_button', '', $this->default_payment_params );
}
$wrapper_start = '<div class="learndash_checkout_buttons">';
$wrapper_end = '</div>';
/** This filter is documented in includes/payments/class-learndash-payment-button.php */
$button_html = (string) apply_filters(
'learndash_payment_button',
implode(
'',
array_map(
function( string $button ) {
return '<div>' . $button . '</div>';
},
$buttons
)
),
$this->default_payment_params
);
if ( 1 === count( $buttons ) ) {
return $wrapper_start . $button_html . $wrapper_end;
}
if ( ! $this->registration_page_is_set || $this->is_on_registration_page ) {
$this->print_dropdown_buttons_in_footer( $button_html );
}
$button_dropdown_trigger = sprintf(
'<button class="%s" id="%s" data-jq-dropdown="#learndash-payment-button-dropdown">%s</button>',
esc_attr( $this->map_button_class_name( 'learndash_checkout_button' ) ),
esc_attr( $this->map_button_id() ),
esc_attr( $this->button_label )
);
/**
* Filters dropdown payment button HTML markup.
*
* @deprecated 4.5.0 Use the {@see 'learndash_payment_button_dropdown_trigger'} filter instead.
*
* @param string $button Dropdown payment button HTML markup.
*
* @return string Dropdown payment button HTML markup.
*/
$button = (string) apply_filters_deprecated(
'learndash_dropdown_payment_button',
array( $wrapper_start . $button_dropdown_trigger . $wrapper_end ),
'4.5.0',
'learndash_payment_button_dropdown_trigger'
);
/**
* Filters payment button dropdown trigger HTML markup.
*
* @since 4.5.0
*
* @param string $button Payment button dropdown trigger HTML markup.
*
* @return string Payment button dropdown trigger HTML markup.
*/
return (string) apply_filters( 'learndash_payment_button_dropdown_trigger', $button );
}
/**
* Maps the payment button label.
*
* @since 4.5.0
*
* @return string
*/
private function map_label(): string {
if (
! $this->post instanceof WP_Post
|| ! $this->product instanceof Product
) {
return '';
}
if ( learndash_is_group_post( $this->post ) ) {
$label = $this->map_group_label();
} elseif ( learndash_is_course_post( $this->post ) ) {
$label = $this->map_course_label();
} else {
$label = '';
}
/* This filter is documented in includes/payments/gateways/class-learndash-payment-gateway.php */
return (string) apply_filters( 'learndash_payment_button_label', $label, '' );
}
/**
* Prints dropdown buttons in footer.
*
* @since 4.5.0
*
* @param string $button_html Payment button HTML markup.
*
* @return void
*/
private function print_dropdown_buttons_in_footer( string $button_html ): void {
$dropdown_buttons = '<div id="learndash-payment-button-dropdown" class="jq-dropdown jq-dropdown-tip checkout-dropdown-button">';
$dropdown_buttons .= '<ul class="jq-dropdown-menu"><li>' . $button_html . '</li></ul>';
$dropdown_buttons .= '</div>';
/**
* Filters payment button dropdown HTML markup.
*
* @since 4.5.0
*
* @param string $dropdown_buttons Payment button dropdown HTML markup.
*
* @return string Payment button dropdown HTML markup.
*/
$dropdown_buttons = (string) apply_filters( 'learndash_payment_button_dropdown', $dropdown_buttons );
add_action(
'wp_footer',
function () use ( $dropdown_buttons ) {
echo $dropdown_buttons; // phpcs:ignore WordPress.Security.EscapeOutput.OutputNotEscaped -- Need to output HTML.
}
);
}
/**
* Returns a button link to the registration page.
*
* @since 4.5.0
*
* @return string
*/
private function button_registration_page_link(): string {
$button = '<form action="' . esc_url( (string) get_permalink( $this->registration_page_id ) ) . '" method="get">';
if ( empty( get_option( 'permalink_structure' ) ) ) {
$button .= '<input type="hidden" value="' . esc_attr( (string) $this->registration_page_id ) . '" name="page_id" />';
}
$button .= '<input type="hidden" value="' . esc_attr( (string) $this->post->ID ) . '" name="ld_register_id" />'; // @phpstan-ignore-line -- $this->post is checked before in the map().
$button .= '<input type="submit" class="' . esc_attr( $this->map_button_class_name() ) . '" id="' . esc_attr( $this->map_button_id() ) . '" value="' . esc_attr( $this->button_label ) . '" />';
$button .= '</form>';
return $button;
}
/**
* Returns true if a user is on the registration page.
*
* @since 4.5.0
*
* @return bool
*/
private function is_on_registration_page(): bool {
if ( ! $this->registration_page_is_set ) {
return false;
}
return (int) get_the_ID() === $this->registration_page_id;
}
/**
* Maps the group payment button label.
*
* @since 4.7.0
*
* @return string
*/
protected function map_group_label(): string {
return LearnDash_Custom_Label::get_label(
LearnDash_Custom_Label::$button_take_group
);
}
/**
* Maps the course payment button label.
*
* @since 4.7.0
*
* @return string
*/
protected function map_course_label(): string {
if ( ! $this->product ) {
return '';
}
if ( $this->product->has_ended() ) {
return sprintf(
// translators: placeholder: Course label.
esc_html_x( '%s ended', 'placeholder: Course label', 'learndash' ),
LearnDash_Custom_Label::get_label( 'course' )
);
}
if ( $this->product->is_pre_ordered( $this->current_user ) ) {
return sprintf(
// translators: placeholder: Course label.
esc_html_x( '%s pre-ordered', 'placeholder: Course label', 'learndash' ),
LearnDash_Custom_Label::get_label( 'course' )
);
}
if ( $this->product->get_seats_available() === 0 ) {
return sprintf(
// translators: placeholder: Course label.
esc_html_x( '%s is full', 'placeholder: Course label', 'learndash' ),
LearnDash_Custom_Label::get_label( 'course' )
);
}
return LearnDash_Custom_Label::get_label( LearnDash_Custom_Label::$button_take_course );
}
}
}