/**
* Generate export data
*
* @since 0.1
* @return string Export file contents
*/
function wie_generate_export_data()
{
// Get all available widgets site supports
$available_widgets = wie_available_widgets();
// Get all widget instances for each widget
$widget_instances = array();
foreach ($available_widgets as $widget_data) {
// Get all instances for this ID base
$instances = get_option('widget_' . $widget_data['id_base']);
// Have instances
if (!empty($instances)) {
// Loop instances
foreach ($instances as $instance_id => $instance_data) {
// Key is ID (not _multiwidget)
if (is_numeric($instance_id)) {
$unique_instance_id = $widget_data['id_base'] . '-' . $instance_id;
$widget_instances[$unique_instance_id] = $instance_data;
}
}
}
}
// Gather sidebars with their widget instances
$sidebars_widgets = get_option('sidebars_widgets');
// get sidebars and their unique widgets IDs
$sidebars_widget_instances = array();
foreach ($sidebars_widgets as $sidebar_id => $widget_ids) {
// Skip inactive widgets
if ('wp_inactive_widgets' == $sidebar_id) {
continue;
}
// Skip if no data or not an array (array_version)
if (!is_array($widget_ids) || empty($widget_ids)) {
continue;
}
// Loop widget IDs for this sidebar
foreach ($widget_ids as $widget_id) {
// Is there an instance for this widget ID?
if (isset($widget_instances[$widget_id])) {
// Add to array
$sidebars_widget_instances[$sidebar_id][$widget_id] = $widget_instances[$widget_id];
}
}
}
// Filter pre-encoded data
$data = apply_filters('wie_unencoded_export_data', $sidebars_widget_instances);
// Encode the data for file contents
$encoded_data = json_encode($data);
// Return contents
return apply_filters('wie_generate_export_data', $encoded_data);
}
/**
* Import widget JSON data
*
* @since 0.4
* @global array $wp_registered_sidebars
* @param object $data JSON widget data from .wie file
* @return array Results array
*/
function wie_import_data($data)
{
global $wp_registered_sidebars;
// Have valid data?
// If no data or could not decode
if (empty($data) || !is_object($data)) {
wp_die(__('Import data could not be read. Please try a different file.', 'widget-importer-exporter'), '', array('back_link' => true));
}
// Hook before import
do_action('wie_before_import');
// Get all available widgets site supports
$available_widgets = wie_available_widgets();
// Get all existing widget instances
$widget_instances = array();
foreach ($available_widgets as $widget_data) {
$widget_instances[$widget_data['id_base']] = get_option('widget_' . $widget_data['id_base']);
}
// Begin results
$results = array();
// Loop import data's sidebars
foreach ($data as $sidebar_id => $widgets) {
// Skip inactive widgets
// (should not be in export file)
if ('wp_inactive_widgets' == $sidebar_id) {
continue;
}
// Check if sidebar is available on this site
// Otherwise add widgets to inactive, and say so
if (isset($wp_registered_sidebars[$sidebar_id])) {
$sidebar_available = true;
$use_sidebar_id = $sidebar_id;
$sidebar_message_type = 'success';
$sidebar_message = '';
} else {
$sidebar_available = false;
$use_sidebar_id = 'wp_inactive_widgets';
// add to inactive if sidebar does not exist in theme
$sidebar_message_type = 'error';
$sidebar_message = __('Sidebar does not exist in theme (using Inactive)', 'widget-importer-exporter');
}
// Result for sidebar
$results[$sidebar_id]['name'] = !empty($wp_registered_sidebars[$sidebar_id]['name']) ? $wp_registered_sidebars[$sidebar_id]['name'] : $sidebar_id;
// sidebar name if theme supports it; otherwise ID
$results[$sidebar_id]['message_type'] = $sidebar_message_type;
$results[$sidebar_id]['message'] = $sidebar_message;
$results[$sidebar_id]['widgets'] = array();
// Loop widgets
foreach ($widgets as $widget_instance_id => $widget) {
$fail = false;
// Get id_base (remove -# from end) and instance ID number
$id_base = preg_replace('/-[0-9]+$/', '', $widget_instance_id);
$instance_id_number = str_replace($id_base . '-', '', $widget_instance_id);
// Does site support this widget?
if (!$fail && !isset($available_widgets[$id_base])) {
$fail = true;
$widget_message_type = 'error';
$widget_message = __('Site does not support widget', 'widget-importer-exporter');
// explain why widget not imported
}
// Filter to modify settings before import
// Do before identical check because changes may make it identical to end result (such as URL replacements)
$widget = apply_filters('wie_widget_settings', $widget);
// Does widget with identical settings already exist in same sidebar?
if (!$fail && isset($widget_instances[$id_base])) {
// Get existing widgets in this sidebar
$sidebars_widgets = get_option('sidebars_widgets');
$sidebar_widgets = isset($sidebars_widgets[$use_sidebar_id]) ? $sidebars_widgets[$use_sidebar_id] : array();
// check Inactive if that's where will go
// Loop widgets with ID base
$single_widget_instances = !empty($widget_instances[$id_base]) ? $widget_instances[$id_base] : array();
foreach ($single_widget_instances as $check_id => $check_widget) {
// Is widget in same sidebar and has identical settings?
if (in_array("{$id_base}-{$check_id}", $sidebar_widgets) && (array) $widget == $check_widget) {
$fail = true;
$widget_message_type = 'warning';
$widget_message = __('Widget already exists', 'widget-importer-exporter');
// explain why widget not imported
break;
}
}
}
// No failure
if (!$fail) {
// Add widget instance
$single_widget_instances = get_option('widget_' . $id_base);
// all instances for that widget ID base, get fresh every time
$single_widget_instances = !empty($single_widget_instances) ? $single_widget_instances : array('_multiwidget' => 1);
// start fresh if have to
$single_widget_instances[] = (array) $widget;
// add it
// Get the key it was given
end($single_widget_instances);
$new_instance_id_number = key($single_widget_instances);
// If key is 0, make it 1
// When 0, an issue can occur where adding a widget causes data from other widget to load, and the widget doesn't stick (reload wipes it)
if ('0' === strval($new_instance_id_number)) {
$new_instance_id_number = 1;
$single_widget_instances[$new_instance_id_number] = $single_widget_instances[0];
unset($single_widget_instances[0]);
}
// Move _multiwidget to end of array for uniformity
if (isset($single_widget_instances['_multiwidget'])) {
$multiwidget = $single_widget_instances['_multiwidget'];
unset($single_widget_instances['_multiwidget']);
$single_widget_instances['_multiwidget'] = $multiwidget;
}
// Update option with new widget
update_option('widget_' . $id_base, $single_widget_instances);
// Assign widget instance to sidebar
$sidebars_widgets = get_option('sidebars_widgets');
// which sidebars have which widgets, get fresh every time
$new_instance_id = $id_base . '-' . $new_instance_id_number;
// use ID number from new widget instance
$sidebars_widgets[$use_sidebar_id][] = $new_instance_id;
// add new instance to sidebar
update_option('sidebars_widgets', $sidebars_widgets);
// save the amended data
// Success message
if ($sidebar_available) {
$widget_message_type = 'success';
$widget_message = __('Imported', 'widget-importer-exporter');
} else {
$widget_message_type = 'warning';
$widget_message = __('Imported to Inactive', 'widget-importer-exporter');
}
}
// Result for widget instance
$results[$sidebar_id]['widgets'][$widget_instance_id]['name'] = isset($available_widgets[$id_base]['name']) ? $available_widgets[$id_base]['name'] : $id_base;
// widget name or ID if name not available (not supported by site)
$results[$sidebar_id]['widgets'][$widget_instance_id]['title'] = $widget->title ? $widget->title : __('No Title', 'widget-importer-exporter');
// show "No Title" if widget instance is untitled
$results[$sidebar_id]['widgets'][$widget_instance_id]['message_type'] = $widget_message_type;
$results[$sidebar_id]['widgets'][$widget_instance_id]['message'] = $widget_message;
}
}
// Hook after import
do_action('wie_after_import');
// Return results
return apply_filters('wie_import_results', $results);
}
/**
* Import widget JSON data
*
* @since 0.4
* @global array $wp_registered_sidebars
* @param object $data JSON widget data from .wie file
* @return array Results array
*/
function wie_import_data($data)
{
global $wp_registered_sidebars;
// Have valid data?
// If no data or could not decode
if (empty($data) || !is_object($data)) {
wp_die(__('Import data could not be read. Please try a different file.', 'widget-importer-exporter'), '', array('back_link' => true));
}
// Hook before import
do_action('wie_before_import');
$data = apply_filters('wie_import_data', $data);
// Get all available widgets site supports
$available_widgets = wie_available_widgets();
// Get all existing widget instances
$widget_instances = array();
foreach ($available_widgets as $widget_data) {
$widget_instances[$widget_data['id_base']] = get_option('widget_' . $widget_data['id_base']);
}
// Begin results
$results = array();
// Loop import data's sidebars
foreach ($data as $sidebar_id => $widgets) {
// Skip inactive widgets
// (should not be in export file)
if ('wp_inactive_widgets' == $sidebar_id) {
continue;
}
// Check if sidebar is available on this site
// Otherwise add widgets to inactive, and say so
if (isset($wp_registered_sidebars[$sidebar_id])) {
$sidebar_available = true;
$use_sidebar_id = $sidebar_id;
$sidebar_message_type = 'success';
$sidebar_message = '';
} else {
$sidebar_available = false;
$use_sidebar_id = 'wp_inactive_widgets';
// add to inactive if sidebar does not exist in theme
$sidebar_message_type = 'error';
$sidebar_message = __('Sidebar does not exist in theme (using Inactive)', 'widget-importer-exporter');
}
// Result for sidebar
$results[$sidebar_id]['name'] = !empty($wp_registered_sidebars[$sidebar_id]['name']) ? $wp_registered_sidebars[$sidebar_id]['name'] : $sidebar_id;
// sidebar name if theme supports it; otherwise ID
$results[$sidebar_id]['message_type'] = $sidebar_message_type;
$results[$sidebar_id]['message'] = $sidebar_message;
$results[$sidebar_id]['widgets'] = array();
// Loop widgets
foreach ($widgets as $widget_instance_id => $widget) {
$fail = false;
// Get id_base (remove -# from end) and instance ID number
$id_base = preg_replace('/-[0-9]+$/', '', $widget_instance_id);
$instance_id_number = str_replace($id_base . '-', '', $widget_instance_id);
// Does site support this widget?
if (!$fail && !isset($available_widgets[$id_base])) {
$fail = true;
$widget_message_type = 'error';
$widget_message = __('Site does not support widget', 'widget-importer-exporter');
// explain why widget not imported
}
// Filter to modify settings object before conversion to array and import
// Leave this filter here for backwards compatibility with manipulating objects (before conversion to array below)
// Ideally the newer wie_widget_settings_array below will be used instead of this
$widget = apply_filters('wie_widget_settings', $widget);
// object
// Convert multidimensional objects to multidimensional arrays
// Some plugins like Jetpack Widget Visibility store settings as multidimensional arrays
// Without this, they are imported as objects and cause fatal error on Widgets page
// If this creates problems for plugins that do actually intend settings in objects then may need to consider other approach: https://wordpress.org/support/topic/problem-with-array-of-arrays
// It is probably much more likely that arrays are used than objects, however
$widget = json_decode(json_encode($widget), true);
// Filter to modify settings array
// This is preferred over the older wie_widget_settings filter above
// Do before identical check because changes may make it identical to end result (such as URL replacements)
$widget = apply_filters('wie_widget_settings_array', $widget);
// Does widget with identical settings already exist in same sidebar?
if (!$fail && isset($widget_instances[$id_base])) {
// Get existing widgets in this sidebar
$sidebars_widgets = get_option('sidebars_widgets');
$sidebar_widgets = isset($sidebars_widgets[$use_sidebar_id]) ? $sidebars_widgets[$use_sidebar_id] : array();
// check Inactive if that's where will go
// Loop widgets with ID base
$single_widget_instances = !empty($widget_instances[$id_base]) ? $widget_instances[$id_base] : array();
foreach ($single_widget_instances as $check_id => $check_widget) {
// Is widget in same sidebar and has identical settings?
if (in_array("{$id_base}-{$check_id}", $sidebar_widgets) && (array) $widget == $check_widget) {
$fail = true;
$widget_message_type = 'warning';
$widget_message = __('Widget already exists', 'widget-importer-exporter');
// explain why widget not imported
break;
}
}
}
// No failure
if (!$fail) {
// Add widget instance
$single_widget_instances = get_option('widget_' . $id_base);
// all instances for that widget ID base, get fresh every time
$single_widget_instances = !empty($single_widget_instances) ? $single_widget_instances : array('_multiwidget' => 1);
// start fresh if have to
$single_widget_instances[] = $widget;
// add it
// Get the key it was given
end($single_widget_instances);
$new_instance_id_number = key($single_widget_instances);
// If key is 0, make it 1
// When 0, an issue can occur where adding a widget causes data from other widget to load, and the widget doesn't stick (reload wipes it)
if ('0' === strval($new_instance_id_number)) {
$new_instance_id_number = 1;
$single_widget_instances[$new_instance_id_number] = $single_widget_instances[0];
unset($single_widget_instances[0]);
}
// Move _multiwidget to end of array for uniformity
if (isset($single_widget_instances['_multiwidget'])) {
$multiwidget = $single_widget_instances['_multiwidget'];
unset($single_widget_instances['_multiwidget']);
$single_widget_instances['_multiwidget'] = $multiwidget;
}
// Update option with new widget
update_option('widget_' . $id_base, $single_widget_instances);
// Assign widget instance to sidebar
$sidebars_widgets = get_option('sidebars_widgets');
// which sidebars have which widgets, get fresh every time
$new_instance_id = $id_base . '-' . $new_instance_id_number;
// use ID number from new widget instance
$sidebars_widgets[$use_sidebar_id][] = $new_instance_id;
// add new instance to sidebar
update_option('sidebars_widgets', $sidebars_widgets);
// save the amended data
// After widget import action
$after_widget_import = array('sidebar' => $use_sidebar_id, 'sidebar_old' => $sidebar_id, 'widget' => $widget, 'widget_type' => $id_base, 'widget_id' => $new_instance_id, 'widget_id_old' => $widget_instance_id, 'widget_id_num' => $new_instance_id_number, 'widget_id_num_old' => $instance_id_number);
do_action('wie_after_widget_import', $after_widget_import);
// Success message
if ($sidebar_available) {
$widget_message_type = 'success';
$widget_message = __('Imported', 'widget-importer-exporter');
} else {
$widget_message_type = 'warning';
$widget_message = __('Imported to Inactive', 'widget-importer-exporter');
}
}
// Result for widget instance
$results[$sidebar_id]['widgets'][$widget_instance_id]['name'] = isset($available_widgets[$id_base]['name']) ? $available_widgets[$id_base]['name'] : $id_base;
// widget name or ID if name not available (not supported by site)
$results[$sidebar_id]['widgets'][$widget_instance_id]['title'] = !empty($widget['title']) ? $widget['title'] : __('No Title', 'widget-importer-exporter');
// show "No Title" if widget instance is untitled
$results[$sidebar_id]['widgets'][$widget_instance_id]['message_type'] = $widget_message_type;
$results[$sidebar_id]['widgets'][$widget_instance_id]['message'] = $widget_message;
}
}
// Hook after import
do_action('wie_after_import');
// Return results
return apply_filters('wie_import_results', $results);
}
