is_from_partner( $product ) ) { return false; } if ( $product->is_wordpress_available() ) { return false; } return ! apply_filters( 'themeisle_sdk_disable_featured_plugins', false ); } /** * Load the module for the selected product. * * @param Product $product Product data. * * @return void */ public function load( $product ) { $this->product = $product; if ( ! current_user_can( 'install_plugins' ) ) { return; } // bail if we already registered a filter for the plugin API. if ( apply_filters( 'themeisle_sdk_plugin_api_filter_registered', false ) ) { return; } add_filter( 'themeisle_sdk_plugin_api_filter_registered', '__return_true' ); add_filter( 'plugins_api_result', [ $this, 'filter_plugin_api_results' ], 11, 3 ); // Enqueue inline JS only on plugin-install.php. add_action( 'admin_enqueue_scripts', [ $this, 'maybe_add_inline_js' ] ); } /** * Enqueue inline JavaScript only on plugin-install.php. * * @return void */ public function maybe_add_inline_js() { $screen = get_current_screen(); if ( isset( $screen->base ) && 'plugin-install' === $screen->base ) { add_action( 'admin_footer', function() { $text = esc_html( sprintf( Loader::$labels['promotions']['recommended'], $this->product->get_friendly_name() ) ); echo ''; } ); } } /** * Filter the plugin API results to include the featured plugins. * * @param object $res The result object. * @param string $action The type of information being requested from the Plugin Install API. * @param object $args Plugin API arguments. * * @return object */ public function filter_plugin_api_results( $res, $action, $args ) { if ( 'query_plugins' !== $action ) { return $res; } if ( isset( $args->page ) && 1 === (int) $args->page && isset( $args->search ) && ! empty( $args->search ) ) { $original_count = count( (array) $res->plugins ); $res->plugins = $this->maybe_prepend_lms_plugin( $res->plugins, $args ); return $this->adjust_results_count( $res, count( (array) $res->plugins ) - $original_count ); } if ( ! isset( $args->browse ) || $args->browse !== 'featured' ) { return $res; } // Inject only on the first page so the same plugins are not repeated on every page. if ( isset( $args->page ) && (int) $args->page > 1 ) { return $res; } $featured = $this->query_plugins_by_author( $args ); $original_count = count( (array) $res->plugins ); $plugins = $this->remove_plugins_by_slug( (array) $res->plugins, $this->get_plugin_slugs( $featured ) ); $res->plugins = array_merge( $featured, $plugins ); return $this->adjust_results_count( $res, count( $res->plugins ) - $original_count ); } /** * Prepend the LMS plugin if the search query matches LMS-related terms. * * @param array $plugins The plugins array. * @param object $args The plugin API arguments. * @return array */ private function maybe_prepend_lms_plugin( $plugins, $args ) { $search = isset( $args->search ) ? strtolower( $args->search ) : ''; if ( $this->matches_lms_search_keywords( $search ) ) { $filter_slugs = apply_filters( 'themeisle_sdk_masteriyo_filter_slugs', [ 'learning-management-system' ] ); $masteriyo = $this->get_plugins_filtered_from_author( $args, $filter_slugs, 'masteriyo' ); if ( ! empty( $masteriyo ) ) { // Remove existing copies of the injected plugins to avoid duplicates. $plugins = $this->remove_plugins_by_slug( (array) $plugins, $this->get_plugin_slugs( $masteriyo ) ); $plugins = array_merge( $masteriyo, $plugins ); } } return $plugins; } /** * Extract the slugs from a list of plugin entries. * * @param array $plugins The plugins list. * * @return array */ private function get_plugin_slugs( $plugins ) { $slugs = []; foreach ( $plugins as $plugin ) { $plugin = (array) $plugin; if ( isset( $plugin['slug'] ) ) { $slugs[] = $plugin['slug']; } } return $slugs; } /** * Remove the plugins matching the provided slugs from the list. * * @param array $plugins The plugins list. * @param array $slugs The slugs to remove. * * @return array */ private function remove_plugins_by_slug( $plugins, $slugs ) { return array_values( array_filter( $plugins, function( $plugin ) use ( $slugs ) { $plugin = (array) $plugin; return ! isset( $plugin['slug'] ) || ! in_array( $plugin['slug'], $slugs, true ); } ) ); } /** * Adjust the reported total results count after injecting plugins. * * @param object $res The result object. * @param int $delta The net number of plugins added to the list. * * @return object */ private function adjust_results_count( $res, $delta ) { if ( 0 !== $delta && isset( $res->info['results'] ) && is_numeric( $res->info['results'] ) ) { $res->info['results'] = max( 0, (int) $res->info['results'] + $delta ); } return $res; } /** * Check if a plugin search query matches LMS-related terms. * * @param string $search Search query. * * @return bool True if the search query matches LMS-related terms. */ private function matches_lms_search_keywords( $search ) { $lms_keywords = array( 'lms', 'learn', 'course', 'courses', 'learning', 'academy', 'training', 'student', 'students', 'quiz', ); foreach ( $lms_keywords as $keyword ) { if ( preg_match( '/(^|[^a-z0-9])' . preg_quote( $keyword, '/' ) . '([^a-z0-9]|$)/', $search ) === 1 ) { return true; } } return false; } /** * Query plugins by author. * * @param object $args The arguments for the query. * * @return array */ private function query_plugins_by_author( $args ) { $featured = []; $optimole_filter_slugs = apply_filters( 'themeisle_sdk_optimole_filter_slugs', [ 'optimole-wp' ] ); $filtered_from_optimole = $this->get_plugins_filtered_from_author( $args, $optimole_filter_slugs, 'Optimole' ); $featured = array_merge( $featured, $filtered_from_optimole ); $themeisle_filter_slugs = apply_filters( 'themeisle_sdk_themeisle_filter_slugs', [ 'otter-blocks', 'wp-cloudflare-page-cache' ] ); $filtered_from_themeisle = $this->get_plugins_filtered_from_author( $args, $themeisle_filter_slugs ); $featured = array_merge( $featured, $filtered_from_themeisle ); return $featured; } /** * Get plugins filtered from an author. * * @param object $args The arguments for the query. * @param array $filter_slugs The slugs to filter. * @param string $author The author to filter. * * @return array */ protected function get_plugins_filtered_from_author( $args, $filter_slugs = [], $author = 'Themeisle' ) { $cached = get_transient( $this->transient_key . $author ); if ( false !== $cached ) { return (array) $cached; } $new_args = [ 'page' => 1, 'per_page' => 36, 'locale' => get_user_locale(), 'author' => $author, 'wp_version' => isset( $args->wp_version ) ? $args->wp_version : get_bloginfo( 'version' ), ]; $api = plugins_api( 'query_plugins', $new_args ); if ( is_wp_error( $api ) ) { // Cache the failure for a shorter period to avoid hammering the API on every request. set_transient( $this->transient_key . $author, [], HOUR_IN_SECONDS ); return []; } $filtered = array_values( array_filter( $api->plugins, function( $plugin ) use ( $filter_slugs ) { $array_plugin = (array) $plugin; return in_array( $array_plugin['slug'], $filter_slugs ); } ) ); set_transient( $this->transient_key . $author, $filtered, 12 * HOUR_IN_SECONDS ); return $filtered; } }