*/ namespace RankMath; use RankMath\Traits\Hooker; use RankMath\Admin\Watcher; use MyThemeShop\Helpers\WordPress; use RankMath\Role_Manager\Capability_Manager; defined( 'ABSPATH' ) || exit; /** * Installer class. */ class Installer { use Hooker; /** * Bind all events. */ public function __construct() { register_activation_hook( RANK_MATH_FILE, [ $this, 'activation' ] ); register_deactivation_hook( RANK_MATH_FILE, [ $this, 'deactivation' ] ); $this->action( 'wp', 'create_cron_jobs' ); $this->action( 'wpmu_new_blog', 'activate_blog' ); $this->action( 'activate_blog', 'activate_blog' ); $this->filter( 'wpmu_drop_tables', 'on_delete_blog' ); } /** * Do things when activating Rank Math. * * @param bool $network_wide Whether the plugin is being activated network-wide. */ public function activation( $network_wide = false ) { if ( ! is_multisite() || ! $network_wide ) { $this->activate(); return; } $this->network_activate_deactivate( true ); } /** * Do things when deactivating Rank Math. * * @param bool $network_wide Whether the plugin is being activated network-wide. */ public function deactivation( $network_wide = false ) { if ( ! is_multisite() || ! $network_wide ) { $this->deactivate(); return; } $this->network_activate_deactivate( false ); } /** * Fired when a new site is activated with a WPMU environment. * * @param int $blog_id ID of the new blog. */ public function activate_blog( $blog_id ) { if ( 1 !== did_action( 'wpmu_new_blog' ) ) { return; } switch_to_blog( $blog_id ); $this->activate(); restore_current_blog(); } /** * Uninstall tables when MU blog is deleted. * * @param array $tables List of tables that will be deleted by WP. * @return array */ public function on_delete_blog( $tables ) { global $wpdb; $tables[] = $wpdb->prefix . 'rank_math_404_logs'; $tables[] = $wpdb->prefix . 'rank_math_redirections'; $tables[] = $wpdb->prefix . 'rank_math_redirections_cache'; $tables[] = $wpdb->prefix . 'rank_math_internal_links'; $tables[] = $wpdb->prefix . 'rank_math_internal_meta'; $tables[] = $wpdb->prefix . 'rank_math_sc_analytics'; return $tables; } /** * Run network-wide activation/deactivation of the plugin. * * @param bool $activate True for plugin activation, false for de-activation. */ private function network_activate_deactivate( $activate ) { global $wpdb; $blog_ids = $wpdb->get_col( "SELECT blog_id FROM $wpdb->blogs WHERE archived = '0' AND spam = '0' AND deleted = '0'" ); if ( empty( $blog_ids ) ) { return; } foreach ( $blog_ids as $blog_id ) { $func = true === $activate ? 'activate' : 'deactivate'; switch_to_blog( $blog_id ); $this->$func(); restore_current_blog(); } } /** * Runs on activation of the plugin. */ private function activate() { $current_version = get_option( 'rank_math_version', null ); $current_db_version = get_option( 'rank_math_db_version', null ); $this->create_tables(); $this->create_options(); $this->set_capabilities(); $this->create_cron_jobs(); if ( is_null( $current_version ) && is_null( $current_db_version ) ) { set_transient( '_rank_math_activation_redirect', 1, 30 ); } // Update to latest version. update_option( 'rank_math_version', rank_math()->version ); update_option( 'rank_math_db_version', rank_math()->db_version ); // Save install date. if ( false == get_option( 'rank_math_install_date' ) ) { update_option( 'rank_math_install_date', current_time( 'timestamp' ) ); } // Activate Watcher. $watcher = new Watcher; $watcher->check_activated_plugin(); $this->clear_rewrite_rules( true ); Helper::clear_cache(); $this->do_action( 'activate' ); } /** * Runs on deactivation of the plugin. */ private function deactivate() { $this->clear_rewrite_rules( false ); $this->remove_cron_jobs(); Helper::clear_cache(); $this->do_action( 'deactivate' ); } /** * Set up the database tables. */ private function create_tables() { global $wpdb; $collate = $wpdb->get_charset_collate(); $table_schema = [ "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}rank_math_404_logs ( id BIGINT(20) unsigned NOT NULL AUTO_INCREMENT, uri VARCHAR(255) NOT NULL, accessed DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00', times_accessed BIGINT(20) unsigned NOT NULL DEFAULT 1, ip VARCHAR(50) NOT NULL DEFAULT '', referer VARCHAR(255) NOT NULL DEFAULT '', user_agent VARCHAR(255) NOT NULL DEFAULT '', PRIMARY KEY (id), KEY uri (uri(191)) ) $collate;", "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}rank_math_redirections ( id BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT, sources TEXT NOT NULL, url_to TEXT NOT NULL, header_code SMALLINT(4) UNSIGNED NOT NULL, hits BIGINT(20) UNSIGNED NOT NULL DEFAULT '0', status VARCHAR(25) NOT NULL DEFAULT 'active', created DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00', updated DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00', last_accessed DATETIME NOT NULL DEFAULT '0000-00-00 00:00:00', PRIMARY KEY (id), KEY (status) ) $collate;", "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}rank_math_redirections_cache ( id BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT, from_url TEXT NOT NULL, redirection_id BIGINT(20) UNSIGNED NOT NULL, object_id BIGINT(20) UNSIGNED NOT NULL DEFAULT '0', object_type VARCHAR(10) NOT NULL DEFAULT 'post', is_redirected TINYINT(1) NOT NULL DEFAULT '0', PRIMARY KEY (id), KEY (redirection_id) ) $collate;", // Link Storage. "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}rank_math_internal_links ( id BIGINT(20) unsigned NOT NULL AUTO_INCREMENT, url VARCHAR(255) NOT NULL, post_id bigint(20) unsigned NOT NULL, target_post_id bigint(20) unsigned NOT NULL, type VARCHAR(8) NOT NULL, PRIMARY KEY (id), KEY link_direction (post_id, type) ) $collate;", // Link meta. "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}rank_math_internal_meta ( object_id bigint(20) UNSIGNED NOT NULL, internal_link_count int(10) UNSIGNED NULL DEFAULT 0, external_link_count int(10) UNSIGNED NULL DEFAULT 0, incoming_link_count int(10) UNSIGNED NULL DEFAULT 0, UNIQUE KEY object_id (object_id) ) $collate;", "CREATE TABLE IF NOT EXISTS {$wpdb->prefix}rank_math_sc_analytics ( id BIGINT(20) UNSIGNED NOT NULL AUTO_INCREMENT, date DATETIME NOT NULL, property TEXT NOT NULL, clicks mediumint(6) NOT NULL, impressions mediumint(6) NOT NULL, position double NOT NULL, ctr double NOT NULL, dimension VARCHAR(25) NOT NULL, PRIMARY KEY (id), KEY property (property(191)) ) $collate;", ]; require_once( ABSPATH . 'wp-admin/includes/upgrade.php' ); foreach ( $table_schema as $table ) { dbDelta( $table ); } } /** * Create options. */ private function create_options() { $this->create_misc_options(); $this->create_general_options(); $this->create_titles_sitemaps_options(); } /** * Create misc options. */ private function create_misc_options() { add_option( 'rank_math_search_console_data', [ 'authorized' => false, 'profiles' => [], ]); // Update "known CPTs" list, so we can send notice about new ones later. add_option( 'rank_math_known_post_types', Helper::get_accessible_post_types() ); $modules = [ 'link-counter', 'search-console', 'seo-analysis', 'sitemap', 'rich-snippet', 'woocommerce', ]; // Role Manager. $users = get_users( [ 'role__in' => [ 'administrator', 'editor', 'author', 'contributor' ] ] ); if ( count( $users ) > 1 ) { $modules[] = 'role-manager'; } // If AMP plugin is installed. if ( function_exists( 'is_amp_endpoint' ) || class_exists( 'Better_AMP' ) || class_exists( 'Weeblramp_Api' ) || class_exists( 'AMPHTML' ) ) { $modules[] = 'amp'; } // If 404-monitor is active as plugin. if ( false !== get_option( 'rank_math_monitor_version', false ) ) { $modules[] = '404-monitor'; } add_option( 'rank_math_modules', $modules ); } /** * Add defaults for general options. */ private function create_general_options() { add_option( 'rank-math-options-general', $this->do_filter( 'settings/defaults/general', [ 'strip_category_base' => 'off', 'attachment_redirect_urls' => 'on', 'attachment_redirect_default' => get_home_url(), 'url_strip_stopwords' => 'off', 'nofollow_external_links' => 'off', 'nofollow_image_links' => 'on', 'new_window_external_links' => 'on', 'add_img_alt' => 'off', 'img_alt_format' => '%title% %count(alt)%', 'add_img_title' => 'off', 'img_title_format' => '%title% %count(title)%', 'breadcrumbs' => 'off', 'breadcrumbs_separator' => '-', 'breadcrumbs_home' => 'on', 'breadcrumbs_home_label' => esc_html__( 'Home', 'rank-math' ), /* translators: Archive title */ 'breadcrumbs_archive_format' => esc_html__( 'Archives for %s', 'rank-math' ), /* translators: Search query term */ 'breadcrumbs_search_format' => esc_html__( 'Results for %s', 'rank-math' ), 'breadcrumbs_404_label' => esc_html__( '404 Error: page not found', 'rank-math' ), 'breadcrumbs_ancestor_categories' => 'off', '404_monitor_mode' => 'simple', '404_monitor_limit' => 100, '404_monitor_ignore_query_parameters' => 'on', 'redirections_header_code' => '301', 'redirections_debug' => 'off', 'console_profile' => '', 'console_caching_control' => '90', 'link_builder_links_per_page' => '7', 'link_builder_links_per_target' => '1', 'wc_remove_product_base' => 'off', 'wc_remove_category_base' => 'off', 'wc_remove_category_parent_slugs' => 'off', 'rss_before_content' => '', 'rss_after_content' => '', 'usage_tracking' => 'on', 'wc_remove_generator' => 'on', 'remove_shop_snippet_data' => 'on', 'frontend_seo_score' => 'off', 'frontend_seo_score_post_types' => [ 'post' ], 'frontend_seo_score_position' => 'top', ])); } /** * Add default values. */ private function create_titles_sitemaps_options() { $sitemap = [ 'items_per_page' => 200, 'include_images' => 'on', 'include_featured_image' => 'off', 'ping_search_engines' => 'on', 'exclude_roles' => $this->get_excluded_roles(), ]; $titles = [ 'noindex_empty_taxonomies' => 'on', 'title_separator' => '-', 'capitalize_titles' => 'off', 'twitter_card_type' => 'summary_large_image', 'knowledgegraph_type' => class_exists( 'Easy_Digital_Downloads' ) || class_exists( 'WooCommerce' ) ? 'company' : 'person', 'knowledgegraph_name' => get_bloginfo( 'name' ), 'local_business_type' => 'Organization', 'local_address_format' => '{address} {locality}, {region} {postalcode}', 'opening_hours' => $this->get_opening_hours(), 'opening_hours_format' => 'off', 'homepage_title' => '%sitename% %page% %sep% %sitedesc%', 'homepage_description' => '', 'homepage_custom_robots' => 'off', 'disable_author_archives' => 'off', 'url_author_base' => 'author', 'author_custom_robots' => 'on', 'author_robots' => [ 'noindex' ], 'author_archive_title' => '%name% %sep% %sitename% %page%', 'author_add_meta_box' => 'on', 'disable_date_archives' => 'off', 'date_archive_title' => '%date% %page% %sep% %sitename%', 'search_title' => '%search_query% %page% %sep% %sitename%', '404_title' => 'Page Not Found %sep% %sitename%', 'date_archive_robots' => [ 'noindex' ], 'noindex_search' => 'on', 'noindex_archive_subpages' => 'off', 'noindex_password_protected' => 'off', ]; $this->create_post_type_options( $titles, $sitemap ); $this->create_taxonomy_options( $titles, $sitemap ); add_option( 'rank-math-options-titles', $this->do_filter( 'settings/defaults/titles', $titles ) ); add_option( 'rank-math-options-sitemap', $this->do_filter( 'settings/defaults/sitemap', $sitemap ) ); } /** * Create post type options. * * @param array $titles Hold title settings. * @param array $sitemap Hold sitemap settings. */ private function create_post_type_options( &$titles, &$sitemap ) { $post_types = Helper::get_accessible_post_types(); $post_types[] = 'product'; foreach ( $post_types as $post_type ) { $defaults = $this->get_post_type_defaults( $post_type ); $titles[ 'pt_' . $post_type . '_title' ] = '%title% %sep% %sitename%'; $titles[ 'pt_' . $post_type . '_description' ] = '%excerpt%'; $titles[ 'pt_' . $post_type . '_robots' ] = $defaults['robots']; $titles[ 'pt_' . $post_type . '_custom_robots' ] = $defaults['is_custom']; $titles[ 'pt_' . $post_type . '_default_rich_snippet' ] = $defaults['rich_snippet']; $titles[ 'pt_' . $post_type . '_default_article_type' ] = $defaults['article_type']; $titles[ 'pt_' . $post_type . '_default_snippet_name' ] = '%title%'; $titles[ 'pt_' . $post_type . '_default_snippet_desc' ] = '%excerpt%'; if ( $this->has_archive( $post_type ) ) { $titles[ 'pt_' . $post_type . '_archive_title' ] = '%title% %page% %sep% %sitename%'; } if ( 'attachment' === $post_type ) { $sitemap[ 'pt_' . $post_type . '_sitemap' ] = 'off'; $titles[ 'pt_' . $post_type . '_add_meta_box' ] = 'off'; continue; } $sitemap[ 'pt_' . $post_type . '_sitemap' ] = 'on'; $titles[ 'pt_' . $post_type . '_ls_use_fk' ] = 'titles'; $titles[ 'pt_' . $post_type . '_add_meta_box' ] = 'on'; $titles[ 'pt_' . $post_type . '_bulk_editing' ] = 'editing'; $titles[ 'pt_' . $post_type . '_link_suggestions' ] = 'on'; // Primary Taxonomy. $taxonomy_hash = [ 'post' => 'category', 'product' => 'product_cat', ]; if ( isset( $taxonomy_hash[ $post_type ] ) ) { $titles[ 'pt_' . $post_type . '_primary_taxonomy' ] = $taxonomy_hash[ $post_type ]; } } } /** * Get robots default for post type. * * @param string $post_type Post type. * @return array */ private function get_post_type_defaults( $post_type ) { $rich_snippets = [ 'post' => 'article', 'page' => 'article', 'product' => 'product', ]; $defaults = [ 'robots' => [], 'is_custom' => 'off', 'rich_snippet' => isset( $rich_snippets[ $post_type ] ) ? $rich_snippets[ $post_type ] : 'off', 'article_type' => 'post' === $post_type ? 'BlogPosting' : 'Article', ]; if ( 'attachment' === $post_type ) { $defaults['is_custom'] = 'on'; $defaults['robots'] = [ 'noindex' ]; } return $defaults; } /** * Check post type has archive. * * @param string $post_type Post type. * @return bool */ private function has_archive( $post_type ) { $post_type_obj = get_post_type_object( $post_type ); return ! is_null( $post_type_obj ) && $post_type_obj->has_archive; } /** * Create post type options. * * @param array $titles Hold title settings. * @param array $sitemap Hold sitemap settings. */ private function create_taxonomy_options( &$titles, &$sitemap ) { $taxonomies = Helper::get_accessible_taxonomies(); foreach ( $taxonomies as $taxonomy => $object ) { $defaults = $this->get_taxonomy_defaults( $taxonomy ); $titles[ 'tax_' . $taxonomy . '_title' ] = '%term% %sep% %sitename%'; $titles[ 'tax_' . $taxonomy . '_robots' ] = $defaults['robots']; $titles[ 'tax_' . $taxonomy . '_add_meta_box' ] = $defaults['metabox']; $titles[ 'tax_' . $taxonomy . '_custom_robots' ] = $defaults['is_custom']; $sitemap[ 'tax_' . $taxonomy . '_sitemap' ] = 'category' === $taxonomy ? 'on' : 'off'; } } /** * Get robots default for post type. * * @param string $taxonomy Taxonomy. * @return array */ private function get_taxonomy_defaults( $taxonomy ) { $defaults = [ 'robots' => [], 'is_custom' => 'off', 'metabox' => 'category' === $taxonomy ? 'on' : 'off', ]; if ( in_array( $taxonomy, [ 'post_tag', 'post_format', 'product_tag' ], true ) ) { $defaults['is_custom'] = 'on'; $defaults['robots'] = [ 'noindex' ]; } return $defaults; } /** * Create capabilities. */ private function set_capabilities() { $admin = get_role( 'administrator' ); if ( ! is_null( $admin ) ) { $admin->add_cap( 'rank_math_edit_htaccess', true ); } Capability_Manager::get()->create_capabilities(); } /** * Create cron jobs. */ public function create_cron_jobs() { $midnight = strtotime( 'tomorrow midnight' ); foreach ( $this->get_cron_jobs() as $job => $recurrence ) { if ( ! wp_next_scheduled( "rank_math/{$job}" ) ) { wp_schedule_event( $midnight, $this->do_filter( "{$job}_recurrence", $recurrence ), "rank_math/{$job}" ); } } } /** * Remove cron jobs. */ private function remove_cron_jobs() { foreach ( $this->get_cron_jobs() as $job => $recurrence ) { wp_clear_scheduled_hook( "rank_math/{$job}" ); } } /** * Get cron jobs. * * @return array */ private function get_cron_jobs() { return [ 'tracker/send_event' => 'weekly', // Add cron job for Usage Tracking (clear it first). 'search_console/get_analytics' => 'daily', // Add cron job for Get Search Console Analytics Data. 'redirection/clean_trashed' => 'daily', // Add cron for cleaning trashed redirects. 'links/internal_links' => 'daily', // Add cron for counting links. ]; } /** * Get opening hours. * * @return array */ private function get_opening_hours() { $hours = []; $days = [ 'Monday', 'Tuesday', 'Wednesday', 'Thursday', 'Friday', 'Saturday', 'Sunday' ]; foreach ( $days as $day ) { $hours[] = [ 'day' => $day, 'time' => '09:00-17:00', ]; } return $hours; } /** * Get roles to exclude. * * @return array */ private function get_excluded_roles() { $roles = WordPress::get_roles(); unset( $roles['administrator'], $roles['editor'], $roles['author'] ); return $roles; } /** * Clear rewrite rules. * * @param bool $activate True for plugin activation, false for de-activation. */ private function clear_rewrite_rules( $activate ) { if ( is_multisite() && ms_is_switched() ) { delete_option( 'rewrite_rules' ); Helper::schedule_flush_rewrite(); return; } // On activation. if ( $activate ) { Helper::schedule_flush_rewrite(); return; } // On deactivation. add_action( 'shutdown', 'flush_rewrite_rules' ); } }