module_id}_list_item_class", array( $this, 'modules_list_item_class' ) ); if ( $this->has_shortcode ) { add_action( 'wp', array( $this, 'setup_product_object' ) ); add_shortcode( 'merchant_module_' . str_replace( '-', '_', $this->module_id ), array( $this, 'shortcode_handler' ) ); } // Remove merchant shortcodes from Botiga product card short description add_filter( 'botiga_loop_product_elements', function( $elements ) { add_filter( 'get_the_excerpt', function( $excerpt ) { return preg_replace( '/\[merchant_[^]]+]/', '', $excerpt ); } ); return $elements; } ); } /** * Check if the module has analytics. * * @return bool */ public function has_analytics() { return $this->has_analytics; } /** * Get all analytics metrics and allow modules to filter them. * * @return array List of available metrics. */ public function analytics_metrics() { /** * Hook: merchant_analytics_module_metrics * * @param array $metrics List of available metrics. * @param string $module_id Module ID. * * @since 2.0 */ return apply_filters( 'merchant_analytics_module_metrics', $this->default_analytics_metrics(), $this->module_id, $this ); } /** * Get analytics metrics. * * @return array List of available metrics. */ protected function default_analytics_metrics() { return array( 'campaigns' => true, 'impressions' => true, 'clicks' => true, 'ctr' => true, 'revenue' => true, 'orders_count' => true, 'aov' => true, ); } /** * Active modules class handler. * */ public function add_module_activation_status_class( $classes ) { if ( ! $this->is_module_settings_page() ) { return $classes; } if ( Merchant_Modules::is_module_active( $this->module_id ) ) { $classes = $classes . ' merchant-module-enabled'; } else { $classes = $classes . ' merchant-module-disabled'; } return $classes; } /** * Modules list item class. * * @param string $module_class * * @return string */ public function modules_list_item_class( $module_class ) { if ( $this->wc_only && ! class_exists( 'Woocommerce' ) ) { $module_class = $module_class . ' merchant-module-wc-only'; } return $module_class; } /** * Is module settings page. * * @return bool */ public function is_module_settings_page() { return isset( $_GET['page'] ) && 'merchant' === $_GET['page'] // phpcs:ignore WordPress.Security.NonceVerification.Recommended && isset( $_GET['module'] ) && $this->module_id === $_GET['module']; // phpcs:ignore WordPress.Security.NonceVerification.Recommended } /** * Get module settings. * */ public function get_module_settings() { $settings = get_option( 'merchant', array() ); // Default settings. $defaults = $this->module_default_settings; if ( empty( $settings[ $this->module_id ] ) ) { $settings[ $this->module_id ] = $defaults; } // Parse settings with defaults. // Todo: check if recursive_parse_args() works for all modules and remove the condition. $settings = $this->module_id === 'product-labels' ? $this->recursive_parse_args( $settings[ $this->module_id ], $defaults ) : wp_parse_args( $settings[ $this->module_id ], $defaults ); /** * Hook: merchant_module_settings * * @param array $settings Module settings. * @param string $module_id Module ID. * * @since 1.9.16 */ $settings = apply_filters( 'merchant_module_settings', $settings, $this->module_id ); return $settings; } /** * Update module settings. * * @param array $module_settings * * @return void */ public function update_module_settings( $module_settings ) { $settings = get_option( 'merchant', array() ); $settings[ $this->module_id ] = $module_settings; /** * Hook: merchant_module_settings_update * * @param array $settings Module settings. * @param string $module_id Module ID. * * @since 2.0.0 */ $settings = apply_filters( 'merchant_module_settings_update', $settings, $this->module_id ); update_option( 'merchant', $settings ); } /** * Add module. * */ public function add_module( $modules ) { $modules[ $this->module_section ]['modules'][ $this->module_id ] = $this->module_data; return $modules; } /** * Add module options. * */ public function add_module_options( $module_path, $merchant_module ) { if ( $this->module_id === $merchant_module ) { return $this->module_options_path; } return $module_path; } /** * Display error message if the shortcode is placed in the wrong place. * * @return mixed|null */ public function shortcode_placement_error() { /* * translators: %s: module id */ $message = __( 'The shortcode [merchant_module_%s] can only be used on single product pages.', 'merchant' ); $message = sprintf( $message, str_replace( '-', '_', $this->module_id ) ); $message = wp_kses( $message, array( 'strong' => array(), ) ); /** * Filter the shortcode error message html content. * * @param string $message_content * @param string $module_id * * @since 1.8 */ return apply_filters( 'merchant_module_shortcode_error_message_html', '