Skip to content

Commit

Permalink
Merge pull request #84 from humanmade/yoast-migration-script
Browse files Browse the repository at this point in the history 
Handle migrating from WP SEO to Yoast SEO
  • Loading branch information
Chris Reynolds authored Jul 12, 2021
2 parents 2e67927 + 3d7c7c7 commit d41430d
Showing 1 changed file with 187 additions and 0 deletions.
187 changes: 187 additions & 0 deletions inc/namespace.php
View file
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,8 @@

use Altis;
use Altis\Module;
use WP_CLI;
use WP_Query;

/**
* Bootstrap SEO Module.
Expand Down Expand Up @@ -67,6 +69,9 @@ function bootstrap( Module $module ) {
add_action( 'admin_enqueue_scripts', __NAMESPACE__ . '\\enqueue_yoast_css_overrides', 11 );
add_action( 'wpseo_configuration_wizard_head', __NAMESPACE__ . '\\override_wizard_styles' );
add_action( 'admin_head', __NAMESPACE__ . '\\hide_yoast_premium_social_previews' );

// Migrations.
add_action( 'altis.migrate', __NAMESPACE__ . '\\do_migrations' );
}

/**
Expand Down Expand Up @@ -368,3 +373,185 @@ function hide_yoast_premium_social_previews() {

echo "<style>$styles</style>"; // phpcs:ignore HM.Security.EscapeOutput.OutputNotEscaped
}

/**
* Run migration functions.
*
* @return void
*/
function do_migrations() : void {
migrate_wpseo_to_yoast();
}

/**
* Copy WPSEO settings to Yoast.
*
* Migration for Altis 7 or lower to 8+.
*
* @return void
*/
function migrate_wpseo_to_yoast() : void {
// WP SEO to Yoast data mappings.
$title_tag_mapping = [
'#site_name#' => '%%sitename%%',
'#site_description#' => '%%sitedesc%%',
'#date_published#' => '%%date%%',
'#date_modified#' => '%%modified%%',
'#author#' => '%%name%%',
'#categories#' => '%%category%%',
'#tags#' => '%%tag%%',
'#term_name#' => '%%term_title%%',
'#post_type_singular_name#' => '%%pt_single%%',
'#post_type_plural_name#' => '%%pt_plural%%',
'#archive_date#' => '%%archive_title%%',
'#search_term#' => '%%searchphrase%%',
'#thumbnail_url#' => '',
];

$options_mapping = [
'home_title' => 'title-home-wpseo',
'home_description' => 'metadesc-home-wpseo',
'archive_author_title' => 'title-author-wpseo',
'archive_author_description' => 'metadesc-author-wpseo',
'archive_date_title' => 'title-archive-wpseo',
'archive_date_description' => 'metadesc-archive-wpseo',
'search_title' => 'title-search-wpseo',
'404_title' => 'title-404-wpseo',
];

$meta_mapping = [
'_meta_title' => '_yoast_wpseo_title',
'_meta_description' => '_yoast_wpseo_metadesc',
'_meta_keywords' => '_yoast_wpseo_focuskw',
];

// Begin processing.
$sites_count = get_sites( [
'count' => true,
'number' => -1,
] );
$sites_processed = 0;
$sites_page = 0;

while ( $sites_processed < $sites_count ) {

// Get sites collection.
$sites = get_sites( [
'number' => 100,
'offset' => $sites_page * 100,
'fields' => 'ids',
] );

// Set next page.
$sites_page++;

foreach ( $sites as $site_id ) {

switch_to_blog( $site_id );

WP_CLI::log( sprintf( 'Migrating legacy SEO settings for site %d...', $site_id ) );

// Handle options.
$options = get_option( 'wp-seo' );
if ( ! empty( $options ) && is_array( $options ) ) {
$yoast_options = get_option( 'wpseo_titles' );
if ( empty( $yoast_options ) || ! is_array( $yoast_options ) ) {
$yoast_options = [];
}

foreach ( $options as $name => $value ) {
// Ignore if empty.
if ( empty( $value ) ) {
continue;
}

// Replace variables with Yoast equivalents.
$value = str_replace(
array_keys( $title_tag_mapping ),
array_values( $title_tag_mapping ),
$value
);

// Replace remaining hash delimited words with double percents (tag names are the same).
$value = preg_replace( '/(?:#([^#\s]+)#)/', '%%$1%%', $value );

// Check how to map this value.
if ( isset( $options_mapping[ $name ] ) ) {
$yoast_options[ $options_mapping[ $name ] ] = $value;
} elseif ( preg_match( '/^(single|archive)_([a-z_-]+)_(title|description)$/', $name, $matches ) ) {
// Dynamic item.
$prefix = $matches[3] === 'title' ? 'title' : 'metadesc';
if ( $matches[1] === 'single' ) {
$yoast_options[ $prefix . '-' . $matches[2] ] = $value;
} else {
if ( taxonomy_exists( $matches[2] ) ) {
$yoast_options[ $prefix . '-tax-' . $matches[2] ] = $value;
}
if ( post_type_exists( $matches[2] ) ) {
$yoast_options[ $prefix . '-ptarchive-' . $matches[2] ] = $value;
}
}
}
}

// Update Yoast options.
update_option( 'wpseo_titles', $yoast_options );
delete_option( 'wp-seo' );
}

// Handle post meta.
$posts_query_args = [
'post_type' => 'any',
'post_status' => 'any',
'posts_per_page' => 0,
'meta_key' => '_meta_title',
'meta_compare' => 'EXISTS',
'fields' => 'ids',
];
$posts = new WP_Query( $posts_query_args );

if ( $posts->found_posts > 0 ) {
$posts_query_args['posts_per_page'] = 100;
$posts_query_args['paged'] = 1;

$progress = WP_CLI\Utils\make_progress_bar( 'Copying post meta data', $posts->found_posts );

while ( $posts_query_args['paged'] <= $posts->max_num_pages ) {

$posts = new WP_Query( $posts_query_args );
$posts_query_args['paged']++;

foreach ( $posts->posts as $post_id ) {
foreach ( $meta_mapping as $old => $new ) {
// Copy post meta data over.
$value = get_post_meta( $post_id, $old, true );
// Handle keywords, Yoast only accepts 1 focus keyword by default so use the 1st.
if ( $old === '_meta_keywords' ) {
$value = explode( ',', $value );
$value = array_map( 'trim', $value );
$value = array_shift( $value );
}
if ( ! empty( $value ) ) {
update_post_meta( $post_id, $new, $value );
}
// Remove old meta data to prevent reprocessing.
delete_post_meta( $post_id, $old );
}

$progress->tick();
}

// Prevent object cache consuming too much memory.
WP_CLI\Utils\wp_clear_object_cache();
}

$progress->finish();
}

restore_current_blog();

// Site processed.
$sites_processed++;
}
}
}

0 comments on commit d41430d

Please sign in to comment.