class-wc-payments-admin.php
37.1 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
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
1001
1002
1003
1004
1005
1006
1007
1008
1009
1010
1011
1012
1013
1014
1015
1016
1017
1018
1019
1020
1021
1022
1023
1024
1025
1026
1027
1028
1029
1030
1031
1032
1033
1034
1035
1036
1037
<?php
/**
* Set up top-level menus for WCPay.
*
* @package WooCommerce\Payments\Admin
*/
use Automattic\Jetpack\Identity_Crisis as Jetpack_Identity_Crisis;
use WCPay\Database_Cache;
defined( 'ABSPATH' ) || exit;
/**
* WC_Payments_Admin Class.
*/
class WC_Payments_Admin {
/**
* Badge with number "1" displayed next to a menu item when there is something important to communicate on a page.
*
* @var string
*/
const MENU_NOTIFICATION_BADGE = ' <span class="wcpay-menu-badge awaiting-mod count-1"><span class="plugin-count">1</span></span>';
/**
* Badge with a count (number of unresolved items) displayed next to a menu item.
* Unresolved refers to items that are unread or need action.
*
* @var string
*/
const UNRESOLVED_NOTIFICATION_BADGE_FORMAT = ' <span class="wcpay-menu-badge awaiting-mod count-%1$s"><span class="plugin-count">%1$d</span></span>';
/**
* WC Payments WordPress Admin menu slug.
*
* @var string
*/
const PAYMENTS_SUBMENU_SLUG = 'wc-admin&path=/payments/overview';
/**
* Client for making requests to the WooCommerce Payments API.
*
* @var WC_Payments_API_Client
*/
protected $payments_api_client;
/**
* WCPay Gateway instance to get information regarding WooCommerce Payments setup.
*
* @var WC_Payment_Gateway_WCPay
*/
private $wcpay_gateway;
/**
* WC_Payments_Account instance to get information about the account
*
* @var WC_Payments_Account
*/
private $account;
/**
* WCPay admin child pages.
*
* @var array
*/
private $admin_child_pages;
/**
* Database_Cache instance.
*
* @var Database_Cache
*/
private $database_cache;
/**
* Hook in admin menu items.
*
* @param WC_Payments_API_Client $payments_api_client WooCommerce Payments API client.
* @param WC_Payment_Gateway_WCPay $gateway WCPay Gateway instance to get information regarding WooCommerce Payments setup.
* @param WC_Payments_Account $account Account instance.
* @param Database_Cache $database_cache Database Cache instance.
*/
public function __construct(
WC_Payments_API_Client $payments_api_client,
WC_Payment_Gateway_WCPay $gateway,
WC_Payments_Account $account,
Database_Cache $database_cache
) {
$this->payments_api_client = $payments_api_client;
$this->wcpay_gateway = $gateway;
$this->account = $account;
$this->database_cache = $database_cache;
add_action( 'admin_notices', [ $this, 'display_not_supported_currency_notice' ], 9999 );
// Add menu items.
add_action( 'admin_menu', [ $this, 'add_payments_menu' ], 0 );
add_action( 'admin_init', [ $this, 'maybe_redirect_to_onboarding' ], 11 ); // Run this after the WC setup wizard and onboarding redirection logic.
add_action( 'admin_enqueue_scripts', [ $this, 'enqueue_payments_scripts' ] );
add_action( 'woocommerce_admin_field_payment_gateways', [ $this, 'payment_gateways_container' ] );
add_action( 'woocommerce_admin_order_totals_after_total', [ $this, 'show_woopay_payment_method_name_admin' ] );
$this->admin_child_pages = [
'wc-payments-overview' => [
'id' => 'wc-payments-overview',
'title' => __( 'Overview', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/overview',
'nav_args' => [
'parent' => 'wc-payments',
'order' => 10,
],
],
'wc-payments-deposits' => [
'id' => 'wc-payments-deposits',
'title' => __( 'Deposits', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/deposits',
'nav_args' => [
'parent' => 'wc-payments',
'order' => 20,
],
],
'wc-payments-transactions' => [
'id' => 'wc-payments-transactions',
'title' => __( 'Transactions', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/transactions',
'nav_args' => [
'parent' => 'wc-payments',
'order' => 30,
],
],
'wc-payments-disputes' => [
'id' => 'wc-payments-disputes',
'title' => __( 'Disputes', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/disputes',
'nav_args' => [
'parent' => 'wc-payments',
'order' => 40,
],
],
];
}
/**
* Add notice explaining that the selected currency is not available.
*/
public function display_not_supported_currency_notice() {
if ( ! current_user_can( 'manage_woocommerce' ) ) {
return;
}
if ( ! $this->wcpay_gateway->is_available_for_current_currency() ) {
?>
<div id="wcpay-unsupported-currency-notice" class="notice notice-warning">
<p>
<b>
<?php esc_html_e( 'Unsupported currency:', 'woocommerce-payments' ); ?>
<?php esc_html( ' ' . get_woocommerce_currency() ); ?>
</b>
<?php esc_html_e( 'The selected currency is not available for the country set in your WooCommerce Payments account.', 'woocommerce-payments' ); ?>
</p>
</div>
<?php
}
}
/**
* Add deposits and transactions menus for wcpay_empty_state_preview_mode_v1 experiment's treatment group.
* This code can be removed once we're done with the experiment.
*/
public function add_payments_menu_for_treatment() {
wc_admin_register_page(
[
'id' => 'wc-payments',
'title' => __( 'Payments', 'woocommerce-payments' ),
'capability' => 'manage_woocommerce',
'path' => '/payments/deposits',
'position' => '55.7', // After WooCommerce & Product menu items.
'nav_args' => [
'title' => __( 'WooCommerce Payments', 'woocommerce-payments' ),
'is_category' => true,
'menuId' => 'plugins',
'is_top_level' => true,
],
]
);
wc_admin_register_page( $this->admin_child_pages['wc-payments-deposits'] );
wc_admin_register_page( $this->admin_child_pages['wc-payments-transactions'] );
wc_admin_register_page(
[
'id' => 'wc-payments-connect',
'title' => __( 'Connect', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/connect',
'nav_args' => [
'parent' => 'wc-payments',
'order' => 10,
],
]
);
wp_enqueue_style(
'wcpay-admin-css',
plugins_url( 'assets/css/admin.css', WCPAY_PLUGIN_FILE ),
[],
WC_Payments::get_file_version( 'assets/css/admin.css' )
);
$this->add_menu_notification_badge();
}
/**
* Add payments menu items.
*/
public function add_payments_menu() {
global $submenu;
try {
$should_render_full_menu = $this->account->is_stripe_account_valid();
} catch ( Exception $e ) {
// There is an issue with connection but render full menu anyways to provide access to settings.
$should_render_full_menu = true;
}
// When the account is not connected, see if the user is in an A/B test treatment mode.
if ( false === $should_render_full_menu && $this->is_in_treatment_mode() ) {
$this->add_payments_menu_for_treatment();
return;
}
$top_level_link = $should_render_full_menu ? '/payments/overview' : '/payments/connect';
$menu_icon = 'data:image/svg+xml;base64,PD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0iVVRGLTgiIHN0YW5kYWxvbmU9Im5vIj8+CjxzdmcKICAgdmVyc2lvbj0iMS4xIgogICBpZD0ic3ZnNjciCiAgIHNvZGlwb2RpOmRvY25hbWU9IndjcGF5X21lbnVfaWNvbi5zdmciCiAgIHdpZHRoPSI4NTIiCiAgIGhlaWdodD0iNjg0IgogICBpbmtzY2FwZTp2ZXJzaW9uPSIxLjEgKGM0ZThmOWUsIDIwMjEtMDUtMjQpIgogICB4bWxuczppbmtzY2FwZT0iaHR0cDovL3d3dy5pbmtzY2FwZS5vcmcvbmFtZXNwYWNlcy9pbmtzY2FwZSIKICAgeG1sbnM6c29kaXBvZGk9Imh0dHA6Ly9zb2RpcG9kaS5zb3VyY2Vmb3JnZS5uZXQvRFREL3NvZGlwb2RpLTAuZHRkIgogICB4bWxucz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciCiAgIHhtbG5zOnN2Zz0iaHR0cDovL3d3dy53My5vcmcvMjAwMC9zdmciPgogIDxkZWZzCiAgICAgaWQ9ImRlZnM3MSIgLz4KICA8c29kaXBvZGk6bmFtZWR2aWV3CiAgICAgaWQ9Im5hbWVkdmlldzY5IgogICAgIHBhZ2Vjb2xvcj0iI2ZmZmZmZiIKICAgICBib3JkZXJjb2xvcj0iIzY2NjY2NiIKICAgICBib3JkZXJvcGFjaXR5PSIxLjAiCiAgICAgaW5rc2NhcGU6cGFnZXNoYWRvdz0iMiIKICAgICBpbmtzY2FwZTpwYWdlb3BhY2l0eT0iMC4wIgogICAgIGlua3NjYXBlOnBhZ2VjaGVja2VyYm9hcmQ9IjAiCiAgICAgc2hvd2dyaWQ9ImZhbHNlIgogICAgIGZpdC1tYXJnaW4tdG9wPSIwIgogICAgIGZpdC1tYXJnaW4tbGVmdD0iMCIKICAgICBmaXQtbWFyZ2luLXJpZ2h0PSIwIgogICAgIGZpdC1tYXJnaW4tYm90dG9tPSIwIgogICAgIGlua3NjYXBlOnpvb209IjI1NiIKICAgICBpbmtzY2FwZTpjeD0iLTg0Ljg1NzQyMiIKICAgICBpbmtzY2FwZTpjeT0iLTgzLjI5NDkyMiIKICAgICBpbmtzY2FwZTp3aW5kb3ctd2lkdGg9IjEzMTIiCiAgICAgaW5rc2NhcGU6d2luZG93LWhlaWdodD0iMTA4MSIKICAgICBpbmtzY2FwZTp3aW5kb3cteD0iMTE2IgogICAgIGlua3NjYXBlOndpbmRvdy15PSIyMDIiCiAgICAgaW5rc2NhcGU6d2luZG93LW1heGltaXplZD0iMCIKICAgICBpbmtzY2FwZTpjdXJyZW50LWxheWVyPSJzdmc2NyIgLz4KICA8cGF0aAogICAgIHRyYW5zZm9ybT0ic2NhbGUoLTEsIDEpIHRyYW5zbGF0ZSgtODUwLCAwKSIKICAgICBkPSJNIDc2OCw4NiBWIDU5OCBIIDg0IFYgODYgWiBtIDAsNTk4IGMgNDgsMCA4NCwtMzggODQsLTg2IFYgODYgQyA4NTIsMzggODE2LDAgNzY4LDAgSCA4NCBDIDM2LDAgMCwzOCAwLDg2IHYgNTEyIGMgMCw0OCAzNiw4NiA4NCw4NiB6IE0gMzg0LDEyOCB2IDQ0IGggLTg2IHYgODQgaCAxNzAgdiA0NCBIIDM0MCBjIC0yNCwwIC00MiwxOCAtNDIsNDIgdiAxMjggYyAwLDI0IDE4LDQyIDQyLDQyIGggNDQgdiA0NCBoIDg0IHYgLTQ0IGggODYgViA0MjggSCAzODQgdiAtNDQgaCAxMjggYyAyNCwwIDQyLC0xOCA0MiwtNDIgViAyMTQgYyAwLC0yNCAtMTgsLTQyIC00MiwtNDIgaCAtNDQgdiAtNDQgeiIKICAgICBmaWxsPSIjYTJhYWIyIgogICAgIGlkPSJwYXRoNjUiIC8+Cjwvc3ZnPgo=';
wc_admin_register_page(
[
'id' => 'wc-payments',
'title' => __( 'Payments', 'woocommerce-payments' ),
'capability' => 'manage_woocommerce',
'path' => $top_level_link,
'position' => '55.7', // After WooCommerce & Product menu items.
'icon' => $menu_icon,
'nav_args' => [
'title' => __( 'WooCommerce Payments', 'woocommerce-payments' ),
'is_category' => $should_render_full_menu,
'menuId' => 'plugins',
'is_top_level' => true,
],
]
);
if ( $this->account->is_account_rejected() ) {
// If the account is rejected, only show the overview page.
wc_admin_register_page( $this->admin_child_pages['wc-payments-overview'] );
return;
}
if ( WC_Payments_Utils::is_in_onboarding_treatment_mode() && ! $should_render_full_menu ) {
wc_admin_register_page(
[
'id' => 'wc-payments-onboarding',
'title' => __( 'Onboarding', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/onboarding',
'capability' => 'manage_woocommerce',
'nav_args' => [
'parent' => 'wc-payments',
],
]
);
global $submenu;
remove_submenu_page( 'wc-admin&path=/payments/connect', 'wc-admin&path=/payments/onboarding' );
}
if ( $should_render_full_menu ) {
if ( $this->account->is_card_present_eligible() && $this->account->has_card_readers_available() ) {
$this->admin_child_pages['wc-payments-card-readers'] = [
'id' => 'wc-payments-card-readers',
'title' => __( 'Card Readers', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/card-readers',
'nav_args' => [
'parent' => 'wc-payments',
'order' => 50,
],
];
}
if ( $this->account->get_capital()['has_previous_loans'] ) {
$this->admin_child_pages['wc-payments-capital'] = [
'id' => 'wc-payments-capital',
'title' => __( 'Capital Loans', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/loans',
'nav_args' => [
'parent' => 'wc-payments',
'order' => 60,
],
];
}
if ( WC_Payments_Features::is_documents_section_enabled() ) {
$this->admin_child_pages['wc-payments-documents'] = [
'id' => 'wc-payments-documents',
'title' => __( 'Documents', 'woocommerce-payments' ),
'parent' => 'wc-payments',
'path' => '/payments/documents',
'nav_args' => [
'parent' => 'wc-payments',
'order' => 50,
],
];
}
/**
* Please note that if any other page is registered first and it's
* path is different from the $top_level_link it will make
* wc_admin_register_page to duplicate "Payments" menu item as a
* first item in the sub-menu.
*/
foreach ( $this->admin_child_pages as $admin_child_page ) {
wc_admin_register_page( $admin_child_page );
}
wc_admin_connect_page(
[
'id' => 'woocommerce-settings-payments-woocommerce-payments',
'parent' => 'woocommerce-settings-payments',
'screen_id' => 'woocommerce_page_wc-settings-checkout-woocommerce_payments',
'title' => __( 'WooCommerce Payments', 'woocommerce-payments' ),
'nav_args' => [
'parent' => 'wc-payments',
'title' => __( 'Settings', 'woocommerce-payments' ),
'url' => 'wc-settings&tab=checkout§ion=woocommerce_payments',
'order' => 99,
],
]
);
// Add the Settings submenu directly to the array, it's the only way to make it link to an absolute URL.
$submenu_keys = array_keys( $submenu );
$last_submenu_key = $submenu_keys[ count( $submenu ) - 1 ];
$submenu[ $last_submenu_key ][] = [ // PHPCS:Ignore WordPress.WP.GlobalVariablesOverride.Prohibited
$this->get_settings_menu_item_name(),
'manage_woocommerce',
WC_Payments_Admin_Settings::get_settings_url(),
];
// Temporary fix to settings menu disappearance is to register the page after settings menu has been manually added.
// TODO: More robust solution is to be implemented by https://github.com/Automattic/woocommerce-payments/issues/231.
wc_admin_register_page(
[
'id' => 'wc-payments-deposit-details',
'title' => __( 'Deposit details', 'woocommerce-payments' ),
'parent' => 'wc-payments-transactions', // Not (top level) deposits, as workaround for showing up as submenu page.
'path' => '/payments/deposits/details',
]
);
wc_admin_register_page(
[
'id' => 'wc-payments-transaction-details',
'title' => __( 'Payment details', 'woocommerce-payments' ),
'parent' => 'wc-payments-transactions',
'path' => '/payments/transactions/details',
]
);
wc_admin_register_page(
[
'id' => 'wc-payments-disputes-details',
'title' => __( 'Dispute details', 'woocommerce-payments' ),
'parent' => 'wc-payments-disputes',
'path' => '/payments/disputes/details',
]
);
wc_admin_register_page(
[
'id' => 'wc-payments-disputes-challenge',
'title' => __( 'Challenge dispute', 'woocommerce-payments' ),
'parent' => 'wc-payments-disputes-details',
'path' => '/payments/disputes/challenge',
]
);
wc_admin_register_page(
[
'id' => 'wc-payments-additional-payment-methods',
'parent' => 'woocommerce-settings-payments',
'title' => __( 'Add new payment methods', 'woocommerce-payments' ),
'path' => '/payments/additional-payment-methods',
]
);
wc_admin_register_page(
[
'id' => 'wc-payments-multi-currency-setup',
'parent' => 'woocommerce-settings-payments',
'title' => __( 'Set up multiple currencies', 'woocommerce-payments' ),
'path' => '/payments/multi-currency-setup',
]
);
wc_admin_register_page(
[
'id' => 'wc-payments-card-readers-preview-receipt',
'parent' => 'wc-payments-card-readers',
'title' => __( 'Preview a printed receipt', 'woocommerce-payments' ),
'path' => '/payments/card-readers/preview-receipt',
]
);
}
wp_enqueue_style(
'wcpay-admin-css',
plugins_url( 'assets/css/admin.css', WCPAY_PLUGIN_FILE ),
[],
WC_Payments::get_file_version( 'assets/css/admin.css' )
);
$this->add_menu_notification_badge();
$this->add_disputes_notification_badge();
if ( \WC_Payments_Features::is_auth_and_capture_enabled() && $this->wcpay_gateway->get_option( 'manual_capture' ) === 'yes' ) {
$this->add_transactions_notification_badge();
}
}
/**
* Register the CSS and JS scripts
*/
public function register_payments_scripts() {
$script_src_url = plugins_url( 'dist/index.js', WCPAY_PLUGIN_FILE );
$script_asset_path = WCPAY_ABSPATH . 'dist/index.asset.php';
$script_asset = file_exists( $script_asset_path ) ? require $script_asset_path : [ 'dependencies' => [] ];
wp_register_script(
'WCPAY_DASH_APP',
$script_src_url,
$script_asset['dependencies'],
WC_Payments::get_file_version( 'dist/index.js' ),
true
);
// Has on-boarding been disabled? Set the flag for use in the front-end so messages and notices can be altered
// as appropriate.
$on_boarding_disabled = WC_Payments_Account::is_on_boarding_disabled();
$error_message = get_transient( WC_Payments_Account::ERROR_MESSAGE_TRANSIENT );
delete_transient( WC_Payments_Account::ERROR_MESSAGE_TRANSIENT );
/**
* This is a work around to pass the current user's email address to WCPay's settings until we do not need to rely
* on backwards compatibility and can use `getCurrentUser` from `@wordpress/core-data`.
*/
$current_user = wp_get_current_user();
$current_user_email = $current_user && $current_user->user_email ? $current_user->user_email : get_option( 'admin_email' );
if ( version_compare( WC_VERSION, '6.0', '<' ) ) {
$path = WCPAY_ABSPATH . 'i18n/locale-info.php';
} else {
$path = WC()->plugin_path() . '/i18n/locale-info.php';
}
$locale_info = include $path;
// Get symbols for those currencies without a short one.
$symbols = get_woocommerce_currency_symbols();
$currency_data = [];
foreach ( $locale_info as $key => $value ) {
$currency_code = $value['currency_code'] ?? '';
$currency_data[ $key ] = [
'code' => $currency_code,
'symbol' => $value['short_symbol'] ?? $symbols[ $currency_code ] ?? '',
'symbolPosition' => $value['currency_pos'] ?? '',
'thousandSeparator' => $value['thousand_sep'] ?? '',
'decimalSeparator' => $value['decimal_sep'] ?? '',
'precision' => $value['num_decimals'],
];
}
$account_status_data = $this->account->get_account_status_data();
$wcpay_settings = [
'connectUrl' => WC_Payments_Account::get_connect_url(),
'connect' => [
'country' => WC()->countries->get_base_country(),
'availableCountries' => WC_Payments_Utils::supported_countries(),
'availableStates' => WC()->countries->get_states(),
],
'testMode' => $this->wcpay_gateway->is_in_test_mode(),
// set this flag for use in the front-end to alter messages and notices if on-boarding has been disabled.
'onBoardingDisabled' => WC_Payments_Account::is_on_boarding_disabled(),
'errorMessage' => $error_message,
'featureFlags' => $this->get_frontend_feature_flags(),
'isSubscriptionsActive' => class_exists( 'WC_Subscriptions' ) && version_compare( WC_Subscriptions::$version, '2.2.0', '>=' ),
// used in the settings page by the AccountFees component.
'zeroDecimalCurrencies' => WC_Payments_Utils::zero_decimal_currencies(),
'fraudServices' => $this->account->get_fraud_services_config(),
'isJetpackConnected' => $this->payments_api_client->is_server_connected(),
'isJetpackIdcActive' => Jetpack_Identity_Crisis::has_identity_crisis(),
'accountStatus' => $account_status_data,
'accountFees' => $this->account->get_fees(),
'accountLoans' => $this->account->get_capital(),
'accountEmail' => $this->account->get_account_email(),
'showUpdateDetailsTask' => $this->get_should_show_update_business_details_task( $account_status_data ),
'wpcomReconnectUrl' => $this->payments_api_client->is_server_connected() && ! $this->payments_api_client->has_server_connection_owner() ? WC_Payments_Account::get_wpcom_reconnect_url() : null,
'additionalMethodsSetup' => [
'isUpeEnabled' => WC_Payments_Features::is_upe_enabled(),
],
'multiCurrencySetup' => [
'isSetupCompleted' => get_option( 'wcpay_multi_currency_setup_completed' ),
],
'isMultiCurrencyEnabled' => WC_Payments_Features::is_customer_multi_currency_enabled(),
'isClientEncryptionEligible' => WC_Payments_Features::is_client_secret_encryption_eligible(),
'shouldUseExplicitPrice' => WC_Payments_Explicit_Price_Formatter::should_output_explicit_price(),
'overviewTasksVisibility' => [
'dismissedTodoTasks' => get_option( 'woocommerce_dismissed_todo_tasks', [] ),
'deletedTodoTasks' => get_option( 'woocommerce_deleted_todo_tasks', [] ),
'remindMeLaterTodoTasks' => get_option( 'woocommerce_remind_me_later_todo_tasks', [] ),
],
'currentUserEmail' => $current_user_email,
'currencyData' => $currency_data,
'restUrl' => get_rest_url( null, '' ), // rest url to concatenate when merchant use Plain permalinks.
'numDisputesNeedingResponse' => $this->get_disputes_awaiting_response_count(),
];
wp_localize_script(
'WCPAY_DASH_APP',
'wcpaySettings',
$wcpay_settings
);
wp_set_script_translations( 'WCPAY_DASH_APP', 'woocommerce-payments' );
wp_register_style(
'WCPAY_DASH_APP',
plugins_url( 'dist/index.css', WCPAY_PLUGIN_FILE ),
[ 'wc-components' ],
WC_Payments::get_file_version( 'dist/index.css' )
);
$tos_script_src_url = plugins_url( 'dist/tos.js', WCPAY_PLUGIN_FILE );
$tos_script_asset_path = WCPAY_ABSPATH . 'dist/tos.asset.php';
$tos_script_asset = file_exists( $tos_script_asset_path ) ? require $tos_script_asset_path : [ 'dependencies' => [] ];
wp_register_script(
'WCPAY_TOS',
$tos_script_src_url,
$tos_script_asset['dependencies'],
WC_Payments::get_file_version( 'dist/tos.js' ),
true
);
wp_set_script_translations( 'WCPAY_TOS', 'woocommerce-payments' );
wp_register_style(
'WCPAY_TOS',
plugins_url( 'dist/tos.css', WCPAY_PLUGIN_FILE ),
[],
WC_Payments::get_file_version( 'dist/tos.css' )
);
wp_register_script(
'WCPAY_ADMIN_ORDER_ACTIONS',
plugins_url( 'dist/order.js', WCPAY_PLUGIN_FILE ),
array_merge( $script_asset['dependencies'], [ 'jquery-tiptip' ] ),
WC_Payments::get_file_version( 'dist/order.js' ),
true
);
wp_register_style(
'WCPAY_ADMIN_ORDER_ACTIONS',
plugins_url( 'dist/order.css', WCPAY_PLUGIN_FILE ),
[],
WC_Payments::get_file_version( 'dist/order.css' )
);
$settings_script_src_url = plugins_url( 'dist/settings.js', WCPAY_PLUGIN_FILE );
$settings_script_asset_path = WCPAY_ABSPATH . 'dist/settings.asset.php';
$settings_script_asset = file_exists( $settings_script_asset_path ) ? require $settings_script_asset_path : [ 'dependencies' => [] ];
wp_register_script(
'WCPAY_ADMIN_SETTINGS',
$settings_script_src_url,
$settings_script_asset['dependencies'],
WC_Payments::get_file_version( 'dist/settings.js' ),
true
);
wp_localize_script(
'WCPAY_ADMIN_SETTINGS',
'wcpayPaymentRequestParams',
[
'stripe' => [
'publishableKey' => $this->account->get_publishable_key( $this->wcpay_gateway->is_in_test_mode() ),
'accountId' => $this->account->get_stripe_account_id(),
'locale' => WC_Payments_Utils::convert_to_stripe_locale( get_locale() ),
],
]
);
wp_localize_script(
'WCPAY_ADMIN_SETTINGS',
'wcpaySettings',
$wcpay_settings
);
wp_set_script_translations( 'WCPAY_ADMIN_SETTINGS', 'woocommerce-payments' );
wp_register_style(
'WCPAY_ADMIN_SETTINGS',
plugins_url( 'dist/settings.css', WCPAY_PLUGIN_FILE ),
[ 'wc-components' ],
WC_Payments::get_file_version( 'dist/settings.css' )
);
$payment_gateways_script_src_url = plugins_url( 'dist/payment-gateways.js', WCPAY_PLUGIN_FILE );
$payment_gateways_script_asset_path = WCPAY_ABSPATH . 'dist/payment-gateways.asset.php';
$payment_gateways_script_asset = file_exists( $payment_gateways_script_asset_path ) ? require $payment_gateways_script_asset_path : [ 'dependencies' => [] ];
wp_register_script(
'WCPAY_PAYMENT_GATEWAYS_PAGE',
$payment_gateways_script_src_url,
$payment_gateways_script_asset['dependencies'],
WC_Payments::get_file_version( 'dist/payment-gateways.js' ),
true
);
wp_register_style(
'WCPAY_PAYMENT_GATEWAYS_PAGE',
plugins_url( 'dist/payment-gateways.css', WCPAY_PLUGIN_FILE ),
[ 'wc-components' ],
WC_Payments::get_file_version( 'dist/payment-gateways.css' )
);
}
/**
* Load the assets
*/
public function enqueue_payments_scripts() {
global $current_tab, $current_section;
// TODO: Add check to see if user can manage_woocommerce and exit early if they cannot.
$this->register_payments_scripts();
if ( WC_Payments_Utils::is_payments_settings_page() ) {
// Output the settings JS and CSS only on the settings page.
wp_enqueue_script( 'WCPAY_ADMIN_SETTINGS' );
wp_enqueue_style( 'WCPAY_ADMIN_SETTINGS' );
}
// TODO: Try to enqueue the JS and CSS bundles lazily (will require changes on WC-Admin).
if ( wc_admin_is_registered_page() ) {
wp_enqueue_script( 'WCPAY_DASH_APP' );
wp_enqueue_style( 'WCPAY_DASH_APP' );
}
// TODO: Update conditions when ToS script is enqueued.
$tos_agreement_declined = (
$current_tab
&& 'checkout' === $current_tab
&& isset( $_GET['tos-disabled'] ) // phpcs:ignore WordPress.Security.NonceVerification
);
$tos_agreement_required = (
$this->is_tos_agreement_required() &&
(
WC_Payments_Utils::is_payments_settings_page() ||
// Or a WC Admin page?
// Note: Merchants can navigate from analytics to payments w/o reload,
// which is why this is neccessary.
wc_admin_is_registered_page()
)
);
$track_stripe_connected = get_option( '_wcpay_onboarding_stripe_connected' );
if ( $tos_agreement_declined || $tos_agreement_required || $track_stripe_connected ) {
// phpcs:ignore WordPress.Security.NonceVerification
wp_localize_script(
'WCPAY_TOS',
'wcpay_tos_settings',
[
'settingsUrl' => WC_Payments_Admin_Settings::get_settings_url(),
'tosAgreementRequired' => $tos_agreement_required,
'tosAgreementDeclined' => $tos_agreement_declined,
'trackStripeConnected' => $track_stripe_connected,
]
);
wp_enqueue_script( 'WCPAY_TOS' );
wp_enqueue_style( 'WCPAY_TOS' );
}
$is_payment_methods_page = (
is_admin() &&
$current_tab && ! $current_section
&& 'checkout' === $current_tab
);
if ( $is_payment_methods_page ) {
wp_enqueue_script( 'WCPAY_PAYMENT_GATEWAYS_PAGE' );
wp_enqueue_style( 'WCPAY_PAYMENT_GATEWAYS_PAGE' );
}
$screen = get_current_screen();
if ( 'shop_order' === $screen->id ) {
$order = wc_get_order();
if ( WC_Payment_Gateway_WCPay::GATEWAY_ID === $order->get_payment_method() ) {
$refund_amount = $order->get_remaining_refund_amount();
wp_localize_script(
'WCPAY_ADMIN_ORDER_ACTIONS',
'wcpay_order_config',
[
'disableManualRefunds' => ! $this->wcpay_gateway->has_refund_failed( $order ),
'manualRefundsTip' => __( 'Refunding manually requires reimbursing your customer offline via cash, check, etc. The refund amounts entered here will only be used to balance your analytics.', 'woocommerce-payments' ),
'refundAmount' => $refund_amount,
'formattedRefundAmount' => wp_strip_all_tags( wc_price( $refund_amount, [ 'currency' => $order->get_currency() ] ) ),
'refundedAmount' => $order->get_total_refunded(),
'canRefund' => $this->wcpay_gateway->can_refund_order( $order ),
]
);
wp_enqueue_script( 'WCPAY_ADMIN_ORDER_ACTIONS' );
wp_enqueue_style( 'WCPAY_ADMIN_ORDER_ACTIONS' );
}
}
}
/**
* Creates an array of features enabled only when external dependencies are of certain versions.
*
* @return array An associative array containing the flags as booleans.
*/
private function get_frontend_feature_flags() {
return array_merge(
[
'paymentTimeline' => self::version_compare( WC_ADMIN_VERSION_NUMBER, '1.4.0', '>=' ),
'customSearch' => self::version_compare( WC_ADMIN_VERSION_NUMBER, '1.3.0', '>=' ),
],
WC_Payments_Features::to_array()
);
}
/**
* A wrapper around version_compare to allow comparing two version numbers even when they are suffixed with a dash and a string, for example 1.3.0-beta.
*
* @param string $version1 First version number.
* @param string $version2 Second version number.
* @param string $operator A boolean operator to use when comparing.
*
* @return bool True if the relationship is the one specified by the operator.
*/
private static function version_compare( $version1, $version2, string $operator ): bool {
// Attempt to extract version numbers.
$version_regex = '/^([\d\.]+)(-.*)?$/';
if ( preg_match( $version_regex, $version1, $matches1 ) && preg_match( $version_regex, $version2, $matches2 ) ) {
// Only compare the numeric parts of the versions, ignore the bit after the dash.
$version1 = $matches1[1];
$version2 = $matches2[1];
}
return (bool) version_compare( $version1, $version2, $operator );
}
/**
* Checks whether it's necessary to display a ToS agreement modal.
*
* @return bool
*/
private function is_tos_agreement_required() {
// The gateway might already be disabled because of ToS.
if ( ! $this->wcpay_gateway->is_enabled() ) {
return false;
}
// Retrieve the latest agreement and check whether it's regarding the latest ToS version.
$agreement = $this->account->get_latest_tos_agreement();
if ( empty( $agreement ) ) {
// Account data couldn't be fetched, let the merchant solve that first.
return false;
}
return ! $agreement['is_current_version'];
}
/**
* Attempts to add a notification badge on WordPress menu next to Payments menu item
* to remind user that setup is required.
*/
public function add_menu_notification_badge() {
global $menu;
if ( 'yes' === get_option( 'wcpay_menu_badge_hidden', 'no' ) ) {
return;
}
// If plugin activation date is less than 3 days, do not show the badge.
$past_3_days = time() - get_option( 'wcpay_activation_timestamp', 0 ) >= ( 3 * DAY_IN_SECONDS );
if ( false === $past_3_days ) {
return;
}
if ( $this->account->is_stripe_connected() ) {
update_option( 'wcpay_menu_badge_hidden', 'yes' );
return;
}
foreach ( $menu as $index => $menu_item ) {
if ( 'wc-admin&path=/payments/connect' === $menu_item[2] ) {
$menu[ $index ][0] .= self::MENU_NOTIFICATION_BADGE; // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
break;
}
}
}
/**
* Check whether a setup task needs to be displayed prompting the user to update
* their business details.
*
* @param array $account_status_data An array containing the account status data.
*
* @return bool True if we should show the task, false otherwise.
*/
public function get_should_show_update_business_details_task( array $account_status_data ) {
$status = $account_status_data['status'] ?? '';
$current_deadline = $account_status_data['currentDeadline'] ?? false;
$past_due = $account_status_data['pastDue'] ?? false;
// If the account is restricted_soon, but there's no current deadline, no action is needed.
if ( ( 'restricted_soon' === $status && $current_deadline ) || ( 'restricted' === $status && $past_due ) ) {
return true;
}
return false;
}
/**
* Adds a container to the "payment gateways" page.
* This is where the "Are you sure you want to disable WCPay?" confirmation dialog is rendered.
*/
public function payment_gateways_container() {
?>
<div id="wcpay-payment-gateways-container" />
<?php
}
/**
* Returns the name to display for the "Payments > Settings" submenu item.
*
* The name will also contain a notification badge if the UPE settings preview is enabled but UPE is not.
*
* @return string
*/
private function get_settings_menu_item_name() {
return __( 'Settings', 'woocommerce' ); // PHPCS:Ignore WordPress.WP.I18n.TextDomainMismatch
}
/**
* Check to see if the current user is in an A/B test treatment mode.
*
* @return bool
*/
private function is_in_treatment_mode() {
if ( ! isset( $_COOKIE['tk_ai'] ) ) {
return false;
}
$abtest = new \WCPay\Experimental_Abtest(
sanitize_text_field( wp_unslash( $_COOKIE['tk_ai'] ) ),
'woocommerce',
'yes' === get_option( 'woocommerce_allow_tracking' )
);
return 'treatment' === $abtest->get_variation( 'wcpay_empty_state_preview_mode_v5' );
}
/**
* Checks if Stripe account is connected and redirects to the onboarding page
* if it is not and the user is attempting to view a WCPay admin page.
*/
public function maybe_redirect_to_onboarding() {
if ( wp_doing_ajax() ) {
return;
}
if ( $this->is_in_treatment_mode() ) {
return;
}
$url_params = wp_unslash( $_GET ); // phpcs:ignore WordPress.Security.NonceVerification
if ( empty( $url_params['page'] ) || 'wc-admin' !== $url_params['page'] ) {
return;
}
$current_path = ! empty( $url_params['path'] ) ? $url_params['path'] : '';
if ( empty( $current_path ) ) {
return;
}
$page_paths = [];
foreach ( $this->admin_child_pages as $payments_child_page ) {
$page_paths[] = preg_quote( $payments_child_page['path'], '/' );
}
if ( ! preg_match( '/^(' . implode( '|', $page_paths ) . ')/', $current_path ) ) {
return;
}
if ( $this->account->is_stripe_connected( true ) ) {
return;
}
$this->account->redirect_to_onboarding_page();
}
/**
* Add woopay as a payment method to the edit order on admin.
*
* @param int $order_id order_id.
*/
public function show_woopay_payment_method_name_admin( $order_id ) {
$order = wc_get_order( $order_id );
if ( ! $order || ! $order->get_meta( 'is_woopay' ) ) {
return;
}
?>
<div class="wc-payment-gateway-method-name-woopay-wrapper">
<?php echo esc_html_e( 'Paid with', 'woocommerce-payments' ) . ' '; ?>
<img alt="WooPay" src="<?php echo esc_url_raw( plugins_url( 'assets/images/woopay.svg', WCPAY_PLUGIN_FILE ) ); ?>">
<?php
if ( $order->get_meta( 'last4' ) ) {
echo esc_html_e( 'Card ending in', 'woocommerce-payments' ) . ' ';
echo esc_html( $order->get_meta( 'last4' ) );
}
?>
</div>
<?php
}
/**
* Adds a notification badge to the Payments > Disputes admin menu item to
* indicate the number of disputes that need a response.
*/
public function add_disputes_notification_badge() {
global $submenu;
if ( ! isset( $submenu[ self::PAYMENTS_SUBMENU_SLUG ] ) ) {
return;
}
$disputes_needing_response = $this->get_disputes_awaiting_response_count();
if ( $disputes_needing_response <= 0 ) {
return;
}
foreach ( $submenu[ self::PAYMENTS_SUBMENU_SLUG ] as $index => $menu_item ) {
if ( 'wc-admin&path=/payments/disputes' === $menu_item[2] ) {
// Direct the user to the disputes which need a response by default.
$submenu[ self::PAYMENTS_SUBMENU_SLUG ][ $index ][2] = admin_url( add_query_arg( [ 'filter' => 'awaiting_response' ], 'admin.php?page=' . $menu_item[2] ) ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
// Append the dispute notification badge to indicate the number of disputes needing a response.
$submenu[ self::PAYMENTS_SUBMENU_SLUG ][ $index ][0] .= sprintf( self::UNRESOLVED_NOTIFICATION_BADGE_FORMAT, esc_html( $disputes_needing_response ) ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
break;
}
}
}
/**
* Adds a notification badge to the Payments > Transactions admin menu item to
* indicate the number of transactions that need to be captured.
*
* @return void
*/
public function add_transactions_notification_badge() {
global $submenu;
if ( ! isset( $submenu[ self::PAYMENTS_SUBMENU_SLUG ] ) ) {
return;
}
$uncaptured_transactions = $this->get_uncaptured_transactions_count();
if ( $uncaptured_transactions <= 0 ) {
return;
}
foreach ( $submenu[ self::PAYMENTS_SUBMENU_SLUG ] as $index => $menu_item ) {
if ( 'wc-admin&path=/payments/transactions' === $menu_item[2] ) {
$submenu[ self::PAYMENTS_SUBMENU_SLUG ][ $index ][0] .= sprintf( self::UNRESOLVED_NOTIFICATION_BADGE_FORMAT, esc_html( $uncaptured_transactions ) ); // phpcs:ignore WordPress.WP.GlobalVariablesOverride.Prohibited
break;
}
}
}
/**
* Gets the number of disputes which need a response. ie have a 'needs_response' or 'warning_needs_response' status.
*
* @return int The number of disputes which need a response.
*/
private function get_disputes_awaiting_response_count() {
$disputes_status_counts = $this->database_cache->get_or_add(
Database_Cache::DISPUTE_STATUS_COUNTS_KEY,
[ $this->payments_api_client, 'get_dispute_status_counts' ],
// We'll consider all array values to be valid as the cache is only invalidated when it is deleted or it expires.
'is_array'
);
if ( empty( $disputes_status_counts ) ) {
return 0;
}
$needs_response_statuses = [ 'needs_response', 'warning_needs_response' ];
return (int) array_sum( array_intersect_key( $disputes_status_counts, array_flip( $needs_response_statuses ) ) );
}
/**
* Gets the number of uncaptured transactions, that is authorizations that need to be captured within 7 days.
*
* @return int The number of uncaptured transactions.
*/
private function get_uncaptured_transactions_count() {
$test_mode = $this->wcpay_gateway->is_in_test_mode();
$cache_key = $test_mode ? DATABASE_CACHE::AUTHORIZATION_SUMMARY_KEY_TEST_MODE : DATABASE_CACHE::AUTHORIZATION_SUMMARY_KEY;
$authorization_summary = $this->database_cache->get_or_add(
$cache_key,
[ $this->payments_api_client, 'get_authorizations_summary' ],
// We'll consider all array values to be valid as the cache is only invalidated when it is deleted or it expires.
'is_array'
);
if ( empty( $authorization_summary ) ) {
return 0;
}
return $authorization_summary['count'];
}
}