← All changes | classes/models/FrmPluginSearch.php +34 -44 6.35 → 6.8 View file →

		@@ -25,25 +25,23 @@
25	25
26	26	/**
27	27	* Add actions and filters only if this is the plugin installation screen and it's the first page.
28	28	*
	29	+ * @param object $screen WP Screen object.
	30	+ *
29	31	* @since 4.12
30	32	*
31		- * @param object $screen WP Screen object.
32		- *
33	33	* @return void
34	34	*/
35	35	public function start( $screen ) {
36	36	// phpcs:ignore WordPress.Security.NonceVerification.Recommended
37		- if ( 'plugin-install' !== $screen->base || ( isset( $_GET['paged'] ) && 1 !== intval( $_GET['paged'] ) ) ) {
38		- return;
	37	+ if ( 'plugin-install' === $screen->base && ( ! isset( $_GET['paged'] ) || 1 === intval( $_GET['paged'] ) ) ) {
	38	+ add_filter( 'plugins_api_result', array( $this, 'inject_suggestion' ), 10, 3 );
	39	+ add_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
	40	+ add_filter( 'plugin_install_action_links', array( $this, 'insert_related_links' ), 10, 2 );
	41	+ add_action( 'admin_enqueue_scripts', array( $this, 'load_plugins_search_script' ) );
	42	+ $this->maybe_dismiss();
39	43	}
40		-
41		- add_filter( 'plugins_api_result', array( $this, 'inject_suggestion' ), 10, 3 );
42		- add_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
43		- add_filter( 'plugin_install_action_links', array( $this, 'insert_related_links' ), 10, 2 );
44		- add_action( 'admin_enqueue_scripts', array( $this, 'load_plugins_search_script' ) );
45		- $this->maybe_dismiss();
46	44	}
47	45
48	46	/**
49	47	* Intercept the plugins API response and add in an appropriate card.
		@@ -59,19 +57,13 @@
59	57	if ( empty( $args->search ) ) {
60	58	return $result;
61	59	}
62	60
63		- if ( is_wp_error( $result ) ) {
64		- // This may happen if the request failed due to an internet connection issue.
65		- return $result;
66		- }
67		-
68	61	$addon_list = $this->get_addons();
69	62
70	63	// Lowercase, trim, remove punctuation/special chars, decode url, remove 'formidable'.
71	64	$normalized_term = $this->search_to_array( $args->search );
72		-
73		- if ( ! $normalized_term ) {
	65	+ if ( empty( $normalized_term ) ) {
74	66	// Don't add anything extra.
75	67	return $result;
76	68	}
77	69
		@@ -76,9 +68,9 @@
76	68	}
77	69
78	70	$matching_addon = $this->matching_addon( $addon_list, $normalized_term );
79	71
80		- if ( ! $matching_addon || ! $this->should_display_hint( $matching_addon ) ) {
	72	+ if ( empty( $matching_addon ) || ! $this->should_display_hint( $matching_addon ) ) {
81	73	return $result;
82	74	}
83	75
84	76	$inject = (array) $this->get_plugin_data();
		@@ -84,17 +76,17 @@
84	76	$inject = (array) $this->get_plugin_data();
85	77	$overrides = array(
86	78	// Helps to determine if that an injected card.
87	79	'plugin-search' => true,
88		- 'name' => sprintf(
	80	+ 'name' => sprintf(
89	81	/* translators: Formidable addon name */
90	82	esc_html_x( 'Formidable %s', 'Formidable Addon Name', 'formidable' ),
91	83	$addon_list[ $matching_addon ]['name']
92	84	),
93		- 'addon' => $addon_list[ $matching_addon ]['slug'],
94		- 'short_description' => $addon_list[ $matching_addon ]['excerpt'],
95		- 'slug' => self::$slug,
96		- 'version' => $addon_list[ $matching_addon ]['version'],
	85	+ 'addon' => $addon_list[ $matching_addon ]['slug'],
	86	+ 'short_description' => $addon_list[ $matching_addon ]['excerpt'],
	87	+ 'slug' => self::$slug,
	88	+ 'version' => $addon_list[ $matching_addon ]['version'],
97	89	);
98	90
99	91	if ( ! empty( $addon_list[ $matching_addon ]['external'] ) ) {
100	92	unset( $overrides['name'] );
		@@ -131,9 +123,10 @@
131	123	if ( ! isset( $addon_opts['search_terms'] ) ) {
132	124	$addon_opts['search_terms'] = '';
133	125	}
134	126
135		- $addon_terms = $this->search_to_array( $addon_opts['search_terms'] . ' ' . $addon_opts['name'] );
	127	+ $addon_terms = $this->search_to_array( $addon_opts['search_terms'] . ' ' . $addon_opts['name'] );
	128	+
136	129	$matched_terms = array_intersect( $addon_terms, $normalized_term );
137	130
138	131	if ( count( $matched_terms ) === count( $normalized_term ) ) {
139	132	$matching_addon = $addon_id;
		@@ -189,20 +182,18 @@
189	182
190	183	/**
191	184	* Modify URL used to fetch to plugin information so it pulls Formidable plugin page.
192	185	*
	186	+ * @param string $url URL to load in dialog pulling the plugin page from wporg.
	187	+ *
193	188	* @since 4.12
194	189	*
195		- * @param string $url URL to load in dialog pulling the plugin page from wporg.
196		- *
197	190	* @return string The URL with 'formidable' instead of 'frm-plugin-search'.
198	191	*/
199	192	public function plugin_details( $url ) {
200		- // phpcs:disable Generic.WhiteSpace.ScopeIndent
201	193	return false !== stripos( $url, 'tab=plugin-information&plugin=' . self::$slug )
202	194	? 'plugin-install.php?tab=plugin-information&plugin=formidable&TB_iframe=true&width=600&height=550'
203	195	: $url;
204		- // phpcs:enable Generic.WhiteSpace.ScopeIndent
205	196	}
206	197
207	198	/**
208	199	* @since 4.12
		@@ -210,10 +201,9 @@
210	201	* @return void
211	202	*/
212	203	private function maybe_dismiss() {
213	204	$addon = FrmAppHelper::get_param( 'frm-dismiss', '', 'get', 'absint' );
214		-
215		- if ( $addon ) {
	205	+ if ( ! empty( $addon ) ) {
216	206	$this->add_to_dismissed_hints( $addon );
217	207	}
218	208	}
219	209
		@@ -225,9 +215,9 @@
225	215	* @return array List of dismissed hints.
226	216	*/
227	217	protected function get_dismissed_hints() {
228	218	$dismissed_hints = get_option( self::$dismissed_opt );
229		- return $dismissed_hints && is_array( $dismissed_hints ) ? $dismissed_hints : array();
	219	+ return ! empty( $dismissed_hints ) && is_array( $dismissed_hints ) ? $dismissed_hints : array();
230	220	}
231	221
232	222	/**
233	223	* Save the hint in the list of dismissed hints.
		@@ -239,9 +229,9 @@
239	229	* @return bool Whether the card was added to the list and hence dismissed.
240	230	*/
241	231	protected function add_to_dismissed_hints( $hint ) {
242	232	$hints = array_merge( $this->get_dismissed_hints(), array( $hint ) );
243		- return update_option( self::$dismissed_opt, $hints, false );
	233	+ return update_option( self::$dismissed_opt, $hints, 'no' );
244	234	}
245	235
246	236	/**
247	237	* Checks that the addon slug passed should be displayed.
		@@ -269,19 +259,20 @@
269	259	* Take a raw search query and return something a bit more standardized and
270	260	* easy to work with.
271	261	*
272	262	* @param string $term The raw search term.
273		- *
274	263	* @return string A simplified/sanitized version.
275	264	*/
276	265	private function sanitize_search_term( $term ) {
277	266	$term = strtolower( urldecode( $term ) );
278	267
279		- // Remove non-alpha/space chars.
	268	+ // remove non-alpha/space chars.
280	269	$term = preg_replace( '/[^a-z ]/', '', $term );
281	270
282		- // Remove strings that don't help matches.
283		- return trim( str_replace( array( 'formidable', 'free', 'wordpress', 'wp ', 'plugin' ), '', $term ) );
	271	+ // remove strings that don't help matches.
	272	+ $term = trim( str_replace( array( 'formidable', 'free', 'wordpress', 'wp ', 'plugin' ), '', $term ) );
	273	+
	274	+ return $term;
284	275	}
285	276
286	277	/**
287	278	* @since 4.12
		@@ -286,9 +277,8 @@
286	277	/**
287	278	* @since 4.12
288	279	*
289	280	* @param string $terms
290		- *
291	281	* @return array
292	282	*/
293	283	private function search_to_array( $terms ) {
294	284	$terms = $this->sanitize_search_term( $terms );
		@@ -310,9 +300,9 @@
310	300
311	301	// By the time this filter is applied, self_admin_url was already applied and we don't need it anymore.
312	302	remove_filter( 'self_admin_url', array( $this, 'plugin_details' ) );
313	303
314		- $links = array();
	304	+ $links = array();
315	305	$is_installed = $this->is_installed( $plugin['plugin'] );
316	306	$is_active = is_plugin_active( $plugin['plugin'] );
317	307
318	308	// Plugin installed, active, feature not enabled; prompt to enable.
		@@ -317,17 +307,17 @@
317	307
318	308	// Plugin installed, active, feature not enabled; prompt to enable.
319	309	if ( ! $is_active && $is_installed ) {
320	310	if ( current_user_can( 'activate_plugins' ) ) {
321		- $activate_url = add_query_arg(
	311	+ $activate_url = add_query_arg(
322	312	array(
323		- 'action' => 'activate',
	313	+ 'action' => 'activate',
324	314	'_wpnonce' => wp_create_nonce( 'activate-plugin_' . $plugin['plugin'] ),
325	315	'plugin' => $plugin['plugin'],
326	316	),
327	317	admin_url( 'plugins.php' )
328	318	);
329		- $links['frm_get_started'] = '<a href="' . esc_url( $activate_url ) . '" class="button activate-now" aria-label="Activate ' . esc_attr( $plugin['name'] ) . '">' . esc_html__( 'Activate', 'formidable' ) . '</a>'; // phpcs:ignore SlevomatCodingStandard.Files.LineLength.LineTooLong
	319	+ $links['frm_get_started'] = '<a href="' . esc_url( $activate_url ) . '" class="button activate-now" aria-label="Activate ' . esc_attr( $plugin['name'] ) . '">' . __( 'Activate', 'formidable' ) . '</a>';
330	320	}
331	321	} elseif ( ! $is_active && isset( $plugin['url'] ) ) {
332	322	// Go to the add-ons page to install.
333	323	$links[] = '<a
		@@ -332,9 +322,10 @@
332	322	// Go to the add-ons page to install.
333	323	$links[] = '<a
334	324	class="button-secondary"
335	325	href="' . esc_url( admin_url( 'admin.php?page=formidable-addons' ) ) . '"
336		- >' . esc_html__( 'Install Now', 'formidable' ) . '</a>';
	326	+ >' . __( 'Install Now', 'formidable' ) . '</a>';
	327	+
337	328	} elseif ( ! empty( $plugin['link'] ) ) {
338	329	// Add link pointing to a relevant doc page in formidable.com.
339	330	$links[] = '<a
340	331	class="button-primary frm-plugin-search__learn-more"
		@@ -346,9 +337,9 @@
346	337
347	338	// Dismiss link.
348	339	$dismiss = add_query_arg( array( 'frm-dismiss' => $plugin['id'] ) );
349	340	$links[] = '<a
350		- href="' . esc_url( $dismiss ) . '"
	341	+ href="' . $dismiss . '"
351	342	class="frm-plugin-search__dismiss"
352	343	data-addon="' . esc_attr( $plugin['addon'] ) . '"
353	344	>' . esc_html__( 'Hide this suggestion', 'formidable' ) . '</a>';
354	345
		@@ -356,9 +347,8 @@
356	347	}
357	348
358	349	/**
359	350	* @param string $plugin
360		- *
361	351	* @return bool
362	352	*/
363	353	protected function is_installed( $plugin ) {
364	354	$all_plugins = FrmAppHelper::get_plugins();