228 lines
6.8 KiB
PHP
228 lines
6.8 KiB
PHP
<?php
|
|
/**
|
|
* Class for the customizer importer.
|
|
*
|
|
* Code is mostly from the Customizer Export/Import plugin.
|
|
*
|
|
* @see https://wordpress.org/plugins/customizer-export-import/
|
|
*
|
|
* @package Merlin WP
|
|
*/
|
|
|
|
|
|
class Merlin_Customizer_Importer {
|
|
/**
|
|
* Import customizer from a DAT file, generated by the Customizer Export/Import plugin.
|
|
*
|
|
* @param string $customizer_import_file_path path to the customizer import file.
|
|
*/
|
|
public static function import( $customizer_import_file_path ) {
|
|
// Try to import the customizer settings.
|
|
$results = self::import_customizer_options( $customizer_import_file_path );
|
|
|
|
// Check for errors, else write the results to the log file.
|
|
if ( is_wp_error( $results ) ) {
|
|
Merlin_Logger::get_instance()->error( $results->get_error_message() );
|
|
|
|
return false;
|
|
}
|
|
|
|
Merlin_Logger::get_instance()->info( __( 'The customizer import has finished successfully', 'thinkai' ) );
|
|
return true;
|
|
}
|
|
|
|
|
|
/**
|
|
* Imports uploaded mods and calls WordPress core customize_save actions so
|
|
* themes that hook into them can act before mods are saved to the database.
|
|
*
|
|
* Update: WP core customize_save actions were removed, because of some errors.
|
|
*
|
|
* @since 1.1.1
|
|
* @param string $import_file_path Path to the import file.
|
|
* @return WP_Error
|
|
*/
|
|
public static function import_customizer_options( $import_file_path ) {
|
|
// Setup global vars.
|
|
global $wp_customize;
|
|
|
|
// Setup internal vars.
|
|
$template = get_template();
|
|
|
|
// Make sure we have an import file.
|
|
if ( ! file_exists( $import_file_path ) ) {
|
|
return new \WP_Error(
|
|
'missing_cutomizer_import_file',
|
|
sprintf(
|
|
esc_html__( 'Error: The customizer import file is missing! File path: %s', 'thinkai' ),
|
|
$import_file_path
|
|
)
|
|
);
|
|
}
|
|
|
|
// Get the upload data.
|
|
$raw = thinkai_filesystem()->get_contents( $import_file_path );
|
|
|
|
// Make sure we got the data.
|
|
if ( empty( $raw ) ) {
|
|
return new \WP_Error(
|
|
'customizer_import_data_missing_content',
|
|
esc_html__( 'Error: The customizer import file does not have any content in it. Please make sure to use the correct customizer import file.', 'thinkai' )
|
|
);
|
|
}
|
|
|
|
$data = unserialize( $raw );
|
|
|
|
// Data checks.
|
|
if ( ! is_array( $data ) && ( ! isset( $data['template'] ) || ! isset( $data['mods'] ) ) ) {
|
|
return new \WP_Error(
|
|
'customizer_import_data_error',
|
|
esc_html__( 'Error: The customizer import file is not in a correct format. Please make sure to use the correct customizer import file.', 'thinkai' )
|
|
);
|
|
}
|
|
if ( $data['template'] !== $template ) {
|
|
return new \WP_Error(
|
|
'customizer_import_wrong_theme',
|
|
esc_html__( 'Error: The customizer import file is not suitable for current theme. You can only import customizer settings for the same theme or a child theme.', 'thinkai' )
|
|
);
|
|
}
|
|
|
|
// Import images.
|
|
if ( apply_filters( 'merlin_customizer_import_images', true ) ) {
|
|
$data['mods'] = self::import_customizer_images( $data['mods'] );
|
|
}
|
|
|
|
// Import custom options.
|
|
if ( isset( $data['options'] ) ) {
|
|
// Require modified customizer options class.
|
|
if ( ! class_exists( '\WP_Customize_Setting' ) ) {
|
|
require_once ABSPATH . 'wp-includes/class-wp-customize-setting.php';
|
|
}
|
|
|
|
foreach ( $data['options'] as $option_key => $option_value ) {
|
|
$option = new Merlin_Customizer_Option( $wp_customize, $option_key, array(
|
|
'default' => '',
|
|
'type' => 'option',
|
|
'capability' => 'edit_theme_options',
|
|
) );
|
|
|
|
$option->import( $option_value );
|
|
}
|
|
}
|
|
|
|
// Should the customizer import use the WP customize_save* hooks?
|
|
$use_wp_customize_save_hooks = apply_filters( 'merlin_enable_wp_customize_save_hooks', false );
|
|
|
|
if ( $use_wp_customize_save_hooks ) {
|
|
do_action( 'customize_save', $wp_customize );
|
|
}
|
|
|
|
// Loop through the mods and save the mods.
|
|
foreach ( $data['mods'] as $key => $val ) {
|
|
if ( $use_wp_customize_save_hooks ) {
|
|
do_action( 'customize_save_' . $key, $wp_customize );
|
|
}
|
|
|
|
set_theme_mod( $key, $val );
|
|
}
|
|
|
|
if ( $use_wp_customize_save_hooks ) {
|
|
do_action( 'customize_save_after', $wp_customize );
|
|
}
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Helper function: Customizer import - imports images for settings saved as mods.
|
|
*
|
|
* @param array $mods An array of customizer mods.
|
|
* @return array The mods array with any new import data.
|
|
*/
|
|
private static function import_customizer_images( $mods ) {
|
|
foreach ( $mods as $key => $val ) {
|
|
if ( self::customizer_is_image_url( $val ) ) {
|
|
$data = self::customizer_sideload_image( $val );
|
|
if ( ! is_wp_error( $data ) ) {
|
|
$mods[ $key ] = $data->url;
|
|
|
|
// Handle header image controls.
|
|
if ( isset( $mods[ $key . '_data' ] ) ) {
|
|
$mods[ $key . '_data' ] = $data;
|
|
update_post_meta( $data->attachment_id, '_wp_attachment_is_custom_header', get_stylesheet() );
|
|
}
|
|
}
|
|
}
|
|
}
|
|
|
|
return $mods;
|
|
}
|
|
|
|
/**
|
|
* Helper function: Customizer import
|
|
* Taken from the core media_sideload_image function and
|
|
* modified to return an array of data instead of html.
|
|
*
|
|
* @param string $file The image file path.
|
|
* @return array An array of image data.
|
|
*/
|
|
private static function customizer_sideload_image( $file ) {
|
|
$data = new \stdClass();
|
|
|
|
if ( ! function_exists( 'media_handle_sideload' ) ) {
|
|
require_once( ABSPATH . 'wp-admin/includes/media.php' );
|
|
require_once( ABSPATH . 'wp-admin/includes/file.php' );
|
|
require_once( ABSPATH . 'wp-admin/includes/image.php' );
|
|
}
|
|
if ( ! empty( $file ) ) {
|
|
// Set variables for storage, fix file filename for query strings.
|
|
preg_match( '/[^\?]+\.(jpe?g|jpe|gif|png)\b/i', $file, $matches );
|
|
$file_array = array();
|
|
$file_array['name'] = basename( $matches[0] );
|
|
|
|
// Download file to temp location.
|
|
$file_array['tmp_name'] = download_url( $file );
|
|
|
|
// If error storing temporarily, return the error.
|
|
if ( is_wp_error( $file_array['tmp_name'] ) ) {
|
|
return $file_array['tmp_name'];
|
|
}
|
|
|
|
// Do the validation and storage stuff.
|
|
$id = media_handle_sideload( $file_array, 0 );
|
|
|
|
// If error storing permanently, unlink.
|
|
if ( is_wp_error( $id ) ) {
|
|
unlink( $file_array['tmp_name'] );
|
|
return $id;
|
|
}
|
|
|
|
// Build the object to return.
|
|
$meta = wp_get_attachment_metadata( $id );
|
|
$data->attachment_id = $id;
|
|
$data->url = wp_get_attachment_url( $id );
|
|
$data->thumbnail_url = wp_get_attachment_thumb_url( $id );
|
|
$data->height = $meta['height'];
|
|
$data->width = $meta['width'];
|
|
}
|
|
|
|
return $data;
|
|
}
|
|
|
|
/**
|
|
* Checks to see whether a string is an image url or not.
|
|
*
|
|
* @param string $string The string to check.
|
|
* @return bool Whether the string is an image url or not.
|
|
*/
|
|
private static function customizer_is_image_url( $string = '' ) {
|
|
if ( is_string( $string ) ) {
|
|
if ( preg_match( '/\.(jpg|jpeg|png|gif)/i', $string ) ) {
|
|
return true;
|
|
}
|
|
}
|
|
|
|
return false;
|
|
}
|
|
}
|