class-jetpack-pre-connection-jitms.php — Jetpack – WP Security, Backup, Speed, & Growth 11.1.1

jetpack / class-jetpack-pre-connection-jitms.php

jetpack Last commit date

class-jetpack-pre-connection-jitms.php

164 lines

1	<?php
2	/**
3	* Jetpack's Pre-Connection JITMs class.
4	*
5	* @package jetpack
6	*/
7
8	use Automattic\Jetpack\Partner_Coupon as Jetpack_Partner_Coupon;
9	use Automattic\Jetpack\Redirect;
10
11	/**
12	* Jetpack's Pre-Connection JITMs. These can be displayed with the JITM package.
13	*/
14	class Jetpack_Pre_Connection_JITMs {
15
16	/**
17	* Returns all the pre-connection messages.
18	*
19	* @return array An array containing the pre-connection JITM messages.
20	*/
21	private function get_raw_messages() {
22	$button_caption = __( 'Set up Jetpack', 'jetpack' );
23	/* Translators: placeholders are links. */
24	$media_description = __( 'Click on the <strong>Set up Jetpack</strong> button to agree to our <a href="%1$s" target="_blank" rel="noopener noreferrer">Terms of Service</a> and to <a href="%2$s" target="_blank" rel="noopener noreferrer">share details</a> with WordPress.com, and gain access to Site Accelerator.', 'jetpack' );
25	/* Translators: placeholders are links. */
26	$widgets_description = __( 'Click on the <strong>Set up Jetpack</strong> button to agree to our <a href="%1$s" target="_blank" rel="noopener noreferrer">Terms of Service</a> and to <a href="%2$s" target="_blank" rel="noopener noreferrer">share details</a> with WordPress.com, and gain access to great additional widgets.', 'jetpack' );
27	/* Translators: placeholders are links. */
28	$posts_description = __( 'Click on the <strong>Set up Jetpack</strong> button to agree to our <a href="%1$s" target="_blank" rel="noopener noreferrer">Terms of Service</a> and to <a href="%2$s" target="_blank" rel="noopener noreferrer">share details</a> with WordPress.com, and gain access to in-depth stats about your site.', 'jetpack' );
29
30	$messages = array(
31	array(
32	'id' => 'jpsetup-upload',
33	'message_path' => '/wp:upload:admin_notices/',
34	'message' => __( 'Do you want lightning-fast images?', 'jetpack' ),
35	'description' => $this->generate_description_with_tos( $media_description ),
36	'button_caption' => $button_caption,
37	),
38	array(
39	'id' => 'jpsetup-widgets',
40	'message_path' => '/wp:widgets:admin_notices/',
41	'message' => __( 'Looking for even more widgets?', 'jetpack' ),
42	'description' => $this->generate_description_with_tos( $widgets_description ),
43	'button_caption' => $button_caption,
44	),
45	);
46
47	if ( wp_count_posts()->publish >= 5 ) {
48	$messages[] = array(
49	'id' => 'jpsetup-posts',
50	'message_path' => '/wp:edit-post:admin_notices/',
51	'message' => __( 'Do you know which of these posts gets the most traffic?', 'jetpack' ),
52	'description' => $this->generate_description_with_tos( $posts_description ),
53	'button_caption' => $button_caption,
54	);
55	}
56
57	foreach ( $messages as $key => $message ) {
58	/*
59	* Add Connect URL to each message, with from including jitm id.
60	*/
61	$jetpack_setup_url = $this->generate_admin_url(
62	array(
63	'page' => 'jetpack#/setup',
64	'from' => sprintf( 'pre-connection-jitm-%s', $message['id'] ),
65	)
66	);
67	$messages[ $key ]['button_link'] = $jetpack_setup_url;
68	}
69
70	return $messages;
71	}
72
73	/**
74	* Generate a description text with links to ToS documents.
75	*
76	* Those messages must mention the ToS agreement message,
77	* but do not use the standard message defined in jetpack_render_tos_blurb.
78	* Instead, they use their own custom messages.
79	*
80	* @param string $description Description string with placeholders.
81	*
82	* @return string
83	*/
84	private function generate_description_with_tos( $description ) {
85	return sprintf(
86	wp_kses(
87	$description,
88	array(
89	'a' => array(
90	'href' => array(),
91	'target' => array(),
92	'rel' => array(),
93	),
94	'strong' => true,
95	)
96	),
97	esc_url( Redirect::get_url( 'wpcom-tos' ) ),
98	esc_url( Redirect::get_url( 'jetpack-support-what-data-does-jetpack-sync' ) )
99	);
100	}
101
102	/**
103	* Returns partnership related pre-connection messages.
104	*
105	* @since 10.4
106	*
107	* @return array An array containing the pre-connection JITM messages.
108	*/
109	private function maybe_get_raw_partnership_messages() {
110	$partner_coupon = Jetpack_Partner_Coupon::get_coupon();
111
112	if ( ! $partner_coupon ) {
113	return array();
114	}
115
116	return array(
117	array(
118	'id' => 'jpsetup-partner-coupon',
119	'message_path' => '/wp:(plugin-install\|themes\|update-core\|upload\|users\|tools\|options-general):admin_notices/',
120	/* Translators: 1: Product name, 2: Partner name. */
121	'message' => sprintf( esc_html__( 'Get %1$s with your %2$s account', 'jetpack' ), $partner_coupon['product']['title'], $partner_coupon['partner']['name'] ),
122	'description' => $partner_coupon['product']['description'],
123	'button_caption' => esc_html__( 'Redeem coupon', 'jetpack' ),
124	'button_link' => $this->generate_admin_url(
125	array(
126	'page' => 'jetpack#/dashboard',
127	'from' => 'pre-connection-jitm--jpsetup-partner-coupon',
128	)
129	),
130	),
131	);
132	}
133
134	/**
135	* Adds the input query arguments to the admin url.
136	*
137	* @param array $args The query arguments.
138	*
139	* @return string The admin url.
140	*/
141	private function generate_admin_url( $args ) {
142	$url = add_query_arg( $args, admin_url( 'admin.php' ) );
143	return $url;
144	}
145
146	/**
147	* Add the Jetpack pre-connection JITMs to the list of pre-connection JITM messages.
148	*
149	* @param array $pre_connection_messages An array of pre-connection JITMs.
150	*
151	* @return array The array of pre-connection JITMs.
152	*/
153	public function add_pre_connection_jitms( $pre_connection_messages ) {
154	$jetpack_messages = array_merge( $this->get_raw_messages(), $this->maybe_get_raw_partnership_messages() );
155
156	if ( ! is_array( $pre_connection_messages ) ) {
157	// The incoming messages aren't an array, so just return Jetpack's messages.
158	return $jetpack_messages;
159	}
160
161	return array_merge( $pre_connection_messages, $jetpack_messages );
162	}
163	}
164