* @package WPSEO\Internal
* This code handles the option upgrades.
* @var \Yoast\WP\SEO\Helpers\Taxonomy_Helper
private $taxonomy_helper;
public function __construct() {
$this->taxonomy_helper = YoastSEO()->helpers->taxonomy;
$version = WPSEO_Options::get( 'version' );
WPSEO_Options::maybe_set_multisite_defaults( false );
'7.0-RC0' => 'upgrade_70',
'7.1-RC0' => 'upgrade_71',
'7.3-RC0' => 'upgrade_73',
'7.4-RC0' => 'upgrade_74',
'7.5.3' => 'upgrade_753',
'7.7-RC0' => 'upgrade_77',
'7.7.2-RC0' => 'upgrade_772',
'9.0-RC0' => 'upgrade_90',
'10.0-RC0' => 'upgrade_100',
'11.1-RC0' => 'upgrade_111',
// Reset notifications because we removed the AMP Glue plugin notification.
'12.1-RC0' => 'clean_all_notifications',
'12.3-RC0' => 'upgrade_123',
'12.4-RC0' => 'upgrade_124',
'12.8-RC0' => 'upgrade_128',
'13.2-RC0' => 'upgrade_132',
'14.0.3-RC0' => 'upgrade_1403',
'14.1-RC0' => 'upgrade_141',
'14.2-RC0' => 'upgrade_142',
'14.5-RC0' => 'upgrade_145',
'14.9-RC0' => 'upgrade_149',
'15.1-RC0' => 'upgrade_151',
'15.3-RC0' => 'upgrade_153',
'15.5-RC0' => 'upgrade_155',
'15.7-RC0' => 'upgrade_157',
'15.9.1-RC0' => 'upgrade_1591',
'16.2-RC0' => 'upgrade_162',
'16.5-RC0' => 'upgrade_165',
'17.1-RC0' => 'upgrade_171',
'17.2-RC0' => 'upgrade_172',
array_walk( $routines, [ $this, 'run_upgrade_routine' ], $version );
if ( version_compare( $version, '12.5-RC0', '<' ) ) {
* We have to run this by hook, because otherwise:
* - the theme support check isn't available.
* - the notification center notifications are not filled yet.
add_action( 'init', [ $this, 'upgrade_125' ] );
$upsell_notice = new WPSEO_Product_Upsell_Notice();
$upsell_notice->set_upgrade_notice();
* Filter: 'wpseo_run_upgrade' - Runs the upgrade hook which are dependent on Yoast SEO.
* @api string - The current version of Yoast SEO
do_action( 'wpseo_run_upgrade', $version );
$this->finish_up( $version );
* Runs the upgrade routine.
* @param string $routine The method to call.
* @param string $version The new version.
* @param string $current_version The current set version.
protected function run_upgrade_routine( $routine, $version, $current_version ) {
if ( version_compare( $current_version, $version, '<' ) ) {
$this->$routine( $current_version );
* Adds a new upgrade history entry.
* @param string $current_version The old version from which we are upgrading.
* @param string $new_version The version we are upgrading to.
protected function add_upgrade_history( $current_version, $new_version ) {
$upgrade_history = new WPSEO_Upgrade_History();
$upgrade_history->add( $current_version, $new_version, array_keys( WPSEO_Options::$options ) );
* Runs the needed cleanup after an update, setting the DB version to latest version, flushing caches etc.
* @param string|null $previous_version The previous version.
protected function finish_up( $previous_version = null ) {
if ( $previous_version ) {
WPSEO_Options::set( 'previous_version', $previous_version );
WPSEO_Options::set( 'version', WPSEO_VERSION );
// Just flush rewrites, always, to at least make them work after an upgrade.
add_action( 'shutdown', 'flush_rewrite_rules' );
// Flush the sitemap cache.
WPSEO_Sitemaps_Cache::clear();
// Make sure all our options always exist - issue #1245.
WPSEO_Options::ensure_options_exist();
* Run the Yoast SEO 1.5 upgrade routine.
* @param string $version Current plugin version.
private function upgrade_15( $version ) {
// Clean up options and meta.
WPSEO_Options::clean_up( null, $version );
* Moves options that moved position in WPSEO 2.0.
private function upgrade_20() {
* Clean up stray wpseo_ms options from the options table, option should only exist in the sitemeta table.
* This could have been caused in many version of Yoast SEO, so deleting it for everything below 2.0.
delete_option( 'wpseo_ms' );
$wpseo = $this->get_option_from_database( 'wpseo' );
$this->save_option_setting( $wpseo, 'pinterestverify' );
// Re-save option to trigger sanitization.
$this->cleanup_option_data( 'wpseo' );
* Detects if taxonomy terms were split and updates the corresponding taxonomy meta's accordingly.
private function upgrade_21() {
$taxonomies = get_option( 'wpseo_taxonomy_meta', [] );
if ( ! empty( $taxonomies ) ) {
foreach ( $taxonomies as $taxonomy => $tax_metas ) {
foreach ( $tax_metas as $term_id => $tax_meta ) {
if ( function_exists( 'wp_get_split_term' ) ) {
$new_term_id = wp_get_split_term( $term_id, $taxonomy );
if ( $new_term_id !== false ) {
$taxonomies[ $taxonomy ][ $new_term_id ] = $taxonomies[ $taxonomy ][ $term_id ];
unset( $taxonomies[ $taxonomy ][ $term_id ] );
update_option( 'wpseo_taxonomy_meta', $taxonomies );
* Performs upgrade functions to Yoast SEO 2.2.
private function upgrade_22() {
// Unschedule our tracking.
wp_clear_scheduled_hook( 'yoast_tracking' );
$this->cleanup_option_data( 'wpseo' );
* Schedules upgrade function to Yoast SEO 2.3.
private function upgrade_23() {
add_action( 'wp', [ $this, 'upgrade_23_query' ], 90 );
add_action( 'admin_head', [ $this, 'upgrade_23_query' ], 90 );
* Performs upgrade query to Yoast SEO 2.3.
public function upgrade_23_query() {
$wp_query = new WP_Query( 'post_type=any&meta_key=_yoast_wpseo_sitemap-include&meta_value=never&order=ASC' );
if ( ! empty( $wp_query->posts ) ) {
$options = get_option( 'wpseo_xml' );
if ( $options['excluded-posts'] !== '' ) {
$excluded_posts = explode( ',', $options['excluded-posts'] );
foreach ( $wp_query->posts as $post ) {
if ( ! in_array( (string) $post->ID, $excluded_posts, true ) ) {
$excluded_posts[] = $post->ID;
// Updates the meta value.
$options['excluded-posts'] = implode( ',', $excluded_posts );
update_option( 'wpseo_xml', $options );
// Remove the meta fields.
delete_post_meta_by_key( '_yoast_wpseo_sitemap-include' );
* Performs upgrade functions to Yoast SEO 3.0.
private function upgrade_30() {
// Remove the meta fields for sitemap prio.
delete_post_meta_by_key( '_yoast_wpseo_sitemap-prio' );
* Performs upgrade functions to Yoast SEO 3.3.
private function upgrade_33() {
// Notification dismissals have been moved to User Meta instead of global option.
delete_option( Yoast_Notification_Center::STORAGE_KEY );
* Performs upgrade functions to Yoast SEO 3.6.
private function upgrade_36() {
// Between 3.2 and 3.4 the sitemap options were saved with autoloading enabled.
$wpdb->query( 'DELETE FROM ' . $wpdb->options . ' WHERE option_name LIKE "wpseo_sitemap_%" AND autoload = "yes"' );
* Removes the about notice when its still in the database.
private function upgrade_40() {
$center = Yoast_Notification_Center::get();
$center->remove_notification_by_id( 'wpseo-dismiss-about' );
* Moves the content-analysis-active and keyword-analysis-acive options from wpseo-titles to wpseo.
private function upgrade_44() {
$wpseo_titles = $this->get_option_from_database( 'wpseo_titles' );
$this->save_option_setting( $wpseo_titles, 'content-analysis-active', 'content_analysis_active' );
$this->save_option_setting( $wpseo_titles, 'keyword-analysis-active', 'keyword_analysis_active' );
// Remove irrelevant content from the option.
$this->cleanup_option_data( 'wpseo_titles' );
* Renames the meta name for the cornerstone content. It was a public meta field and it has to be private.
private function upgrade_47() {
// The meta key has to be private, so prefix it.
'UPDATE ' . $wpdb->postmeta . ' SET meta_key = %s WHERE meta_key = "yst_is_cornerstone"',
WPSEO_Cornerstone_Filter::META_NAME
* Removes the 'wpseo-dismiss-about' notice for every user that still has it.
private function upgrade_49() {
* Using a filter to remove the notification for the current logged in user. The notification center is
* initializing the notifications before the upgrade routine has been executedd and is saving the stored
* notifications on shutdown. This causes the returning notification. By adding this filter the shutdown
* routine on the notification center will remove the notification.
add_filter( 'yoast_notifications_before_storage', [ $this, 'remove_about_notice' ] );
$meta_key = $wpdb->get_blog_prefix() . Yoast_Notification_Center::STORAGE_KEY;
$usermetas = $wpdb->get_results(
SELECT user_id, meta_value
FROM ' . $wpdb->usermeta . '
WHERE meta_key = %s AND meta_value LIKE %s
if ( empty( $usermetas ) ) {
foreach ( $usermetas as $usermeta ) {
$notifications = maybe_unserialize( $usermeta['meta_value'] );
foreach ( $notifications as $notification_key => $notification ) {
if ( ! empty( $notification['options']['id'] ) && $notification['options']['id'] === 'wpseo-dismiss-about' ) {
unset( $notifications[ $notification_key ] );
update_user_option( $usermeta['user_id'], Yoast_Notification_Center::STORAGE_KEY, array_values( $notifications ) );
* Removes the wpseo-dismiss-about notice from a list of notifications.
* @param Yoast_Notification[] $notifications The notifications to filter.
* @return Yoast_Notification[] The filtered list of notifications. Excluding the wpseo-dismiss-about notification.
public function remove_about_notice( $notifications ) {
foreach ( $notifications as $notification_key => $notification ) {
if ( $notification->get_id() === 'wpseo-dismiss-about' ) {
unset( $notifications[ $notification_key ] );
* Adds the yoast_seo_links table to the database.
private function upgrade_50() {
// Deletes the post meta value, which might created in the RC.
$wpdb->query( 'DELETE FROM ' . $wpdb->postmeta . ' WHERE meta_key = "_yst_content_links_processed"' );
* Register new capabilities and roles.
private function upgrade_55() {
do_action( 'wpseo_register_roles' );
WPSEO_Role_Manager_Factory::get()->add();
// Register capabilities.
do_action( 'wpseo_register_capabilities' );
WPSEO_Capability_Manager_Factory::get()->add();
* Removes some no longer used options for noindexing subpages and for meta keywords and its associated templates.
private function upgrade_63() {
$this->cleanup_option_data( 'wpseo_titles' );
* Perform the 7.0 upgrade, moves settings around, deletes several options.
private function upgrade_70() {
$wpseo_permalinks = $this->get_option_from_database( 'wpseo_permalinks' );
$wpseo_xml = $this->get_option_from_database( 'wpseo_xml' );
$wpseo_rss = $this->get_option_from_database( 'wpseo_rss' );
$wpseo = $this->get_option_from_database( 'wpseo' );
$wpseo_internallinks = $this->get_option_from_database( 'wpseo_internallinks' );
// Move some permalink settings, then delete the option.
$this->save_option_setting( $wpseo_permalinks, 'redirectattachment', 'disable-attachment' );
$this->save_option_setting( $wpseo_permalinks, 'stripcategorybase' );
// Move one XML sitemap setting, then delete the option.
$this->save_option_setting( $wpseo_xml, 'enablexmlsitemap', 'enable_xml_sitemap' );
// Move the RSS settings to the search appearance settings, then delete the RSS option.
$this->save_option_setting( $wpseo_rss, 'rssbefore' );
$this->save_option_setting( $wpseo_rss, 'rssafter' );
$this->save_option_setting( $wpseo, 'company_logo' );
$this->save_option_setting( $wpseo, 'company_name' );
$this->save_option_setting( $wpseo, 'company_or_person' );
$this->save_option_setting( $wpseo, 'person_name' );
// Remove the website name and altername name as we no longer need them.
$this->cleanup_option_data( 'wpseo' );
// All the breadcrumbs settings have moved to the search appearance settings.
foreach ( array_keys( $wpseo_internallinks ) as $key ) {
$this->save_option_setting( $wpseo_internallinks, $key );
// Convert hidden metabox options to display metabox options.
$title_options = get_option( 'wpseo_titles' );
foreach ( $title_options as $key => $value ) {
if ( strpos( $key, 'hideeditbox-tax-' ) === 0 ) {
$taxonomy = substr( $key, strlen( 'hideeditbox-tax-' ) );
WPSEO_Options::set( 'display-metabox-tax-' . $taxonomy, ! $value );
if ( strpos( $key, 'hideeditbox-' ) === 0 ) {
$post_type = substr( $key, strlen( 'hideeditbox-' ) );
WPSEO_Options::set( 'display-metabox-pt-' . $post_type, ! $value );
// Cleanup removed options.
delete_option( 'wpseo_xml' );
delete_option( 'wpseo_permalinks' );
delete_option( 'wpseo_rss' );
delete_option( 'wpseo_internallinks' );
// Remove possibly present plugin conflict notice for plugin that was removed from the list of conflicting plugins.
$yoast_plugin_conflict = WPSEO_Plugin_Conflict::get_instance();
$yoast_plugin_conflict->clear_error( 'header-footer/plugin.php' );
// Moves the user meta for excluding from the XML sitemap to a noindex.
$wpdb->query( "UPDATE $wpdb->usermeta SET meta_key = 'wpseo_noindex_author' WHERE meta_key = 'wpseo_excludeauthorsitemap'" );
* Perform the 7.1 upgrade.
private function upgrade_71() {
$this->cleanup_option_data( 'wpseo_social' );
// Move the breadcrumbs setting and invert it.
$title_options = $this->get_option_from_database( 'wpseo_titles' );
if ( array_key_exists( 'breadcrumbs-blog-remove', $title_options ) ) {
WPSEO_Options::set( 'breadcrumbs-display-blog-page', ! $title_options['breadcrumbs-blog-remove'] );
$this->cleanup_option_data( 'wpseo_titles' );
* Perform the 7.3 upgrade.