-
Notifications
You must be signed in to change notification settings - Fork 67
/
class-wc-payments-admin-settings.php
104 lines (94 loc) · 2.91 KB
/
class-wc-payments-admin-settings.php
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
<?php
/**
* Class WC_Payments_Admin_Settings
*
* @package WooCommerce\Payments\Admin
*/
/**
* WC_Payments_Admin_Settings class.
*/
class WC_Payments_Admin_Settings {
/**
* WC_Payment_Gateway_WCPay.
*
* @var WC_Payment_Gateway_WCPay
*/
private $gateway;
/**
* Set of parameters to build the URL to the gateway's settings page.
*
* @var string[]
*/
private static $settings_url_params = [
'page' => 'wc-settings',
'tab' => 'checkout',
'section' => WC_Payment_Gateway_WCPay::GATEWAY_ID,
];
/**
* Initialize class actions.
*
* @param WC_Payment_Gateway_WCPay $gateway Payment Gateway.
*/
public function __construct( WC_Payment_Gateway_WCPay $gateway ) {
$this->gateway = $gateway;
}
/**
* Initializes this class's WP hooks.
*
* @return void
*/
public function init_hooks() {
add_action( 'woocommerce_woocommerce_payments_admin_notices', [ $this, 'display_test_mode_notice' ] );
add_filter( 'plugin_action_links_' . plugin_basename( WCPAY_PLUGIN_FILE ), [ $this, 'add_plugin_links' ] );
}
/**
* Add notice explaining test mode when it's enabled.
*/
public function display_test_mode_notice() {
if ( WC_Payments::mode()->is_test() ) {
?>
<div id="wcpay-test-mode-notice" class="notice notice-warning">
<p>
<b><?php esc_html_e( 'Test mode active: ', 'woocommerce-payments' ); ?></b>
<?php
printf(
/* translators: %s: WooPayments */
esc_html__( "All transactions are simulated. Customers can't make real purchases through %s.", 'woocommerce-payments' ),
'WooPayments'
);
?>
</p>
</div>
<?php
}
}
/**
* Adds links to the plugin's row in the "Plugins" Wp-Admin page.
*
* @see https://codex.wordpress.org/Plugin_API/Filter_Reference/plugin_action_links_(plugin_file_name)
* @param array $links The existing list of links that will be rendered.
* @return array The list of links that will be rendered, after adding some links specific to this plugin.
*/
public function add_plugin_links( $links ) {
$plugin_links = [
'<a href="' . esc_attr( self::get_settings_url() ) . '">' . esc_html__( 'Settings', 'woocommerce-payments' ) . '</a>',
];
return array_merge( $plugin_links, $links );
}
/**
* Whether the current page is the WooPayments settings page.
*
* @return bool
*/
public static function is_current_page_settings() {
return count( self::$settings_url_params ) === count( array_intersect_assoc( $_GET, self::$settings_url_params ) ); // phpcs:ignore WordPress.Security.NonceVerification.Recommended
}
/**
* Returns the URL of the configuration screen for this gateway, for use in internal links.
*
* @return string URL of the configuration screen for this gateway
*/
public static function get_settings_url() {
return admin_url( add_query_arg( self::$settings_url_params, 'admin.php' ) ); // nosemgrep: audit.php.wp.security.xss.query-arg -- constant string is passed in.
}
}