in_save_post = false;
// Block editor specific actions.
if ( function_exists( 'register_block_type' ) ) {
add_action( 'admin_notices', array( $this, 'admin_notices' ) );
add_filter( 'gutenberg_can_edit_post_type', array( $this, 'show_classic_editor_for_panels' ), 10, 2 );
add_filter( 'use_block_editor_for_post_type', array( $this, 'show_classic_editor_for_panels' ), 10, 2 );
add_action( 'admin_print_scripts-edit.php', array( $this, 'add_panels_add_new_button' ) );
if ( siteorigin_panels_setting( 'admin-post-state' ) ) {
add_filter( 'display_post_states', array( $this, 'add_panels_post_state' ), 10, 2 );
}
}
// Inline Saving.
add_filter( 'heartbeat_received', array( $this, 'inline_saving_heartbeat_received' ), 10, 2 );
// Classic editor notice.
add_filter( 'so_panels_show_classic_admin_notice', array( $this, 'maybe_hide_admin_notice' ), 9 );
add_action( 'wp_ajax_so_panels_dismiss_post_notice', array( $this, 'dismiss_admin_post_notice' ) );
}
/**
* @return SiteOrigin_Panels_Admin
*/
public static function single() {
static $single;
return empty( $single ) ? $single = new self() : $single;
}
/**
* Do some general admin initialization
*/
public function admin_init_widget_count() {
if ( siteorigin_panels_setting( 'admin-widget-count' ) ) {
// Add the custom columns.
$post_types = siteorigin_panels_setting( 'post-types' );
if ( ! empty( $post_types ) ) {
foreach ( $post_types as $post_type ) {
add_filter( 'manage_' . $post_type . 's_columns', array( $this, 'add_custom_column' ) );
add_action( 'manage_' . $post_type . 's_custom_column', array( $this, 'display_custom_column' ), 10, 2 );
}
}
}
}
/**
* Check if this is an admin page.
*
* @return mixed|void
*/
public static function is_admin() {
$screen = get_current_screen();
$is_panels_page = ( $screen->base == 'post' && in_array( $screen->id, siteorigin_panels_setting( 'post-types' ) ) ) ||
in_array( $screen->base, array( 'appearance_page_so_panels_home_page', 'widgets', 'customize' ) ) ||
self::is_block_editor();
return apply_filters( 'siteorigin_panels_is_admin_page', $is_panels_page );
}
/**
* Check if the current page is Gutenberg or the Block Ediotr
*
* @return bool
*/
public static function is_block_editor() {
// This is for the Gutenberg plugin.
$is_gutenberg_page = function_exists( 'is_gutenberg_page' ) && is_gutenberg_page();
// This is for WP 5 with the integrated block editor.
$is_block_editor = false;
if ( function_exists( 'get_current_screen' ) ) {
$current_screen = get_current_screen();
if ( $current_screen && method_exists( $current_screen, 'is_block_editor' ) ) {
$is_block_editor = $current_screen->is_block_editor();
}
}
return $is_gutenberg_page || $is_block_editor;
}
/**
* Add action links to the plugin list for Page Builder.
*
* @return array
*/
public function plugin_action_links( $links ) {
if ( ! is_array( $links ) ) {
return $links;
}
unset( $links['edit'] );
$links[] = '' . __( 'Settings', 'siteorigin-panels' ) . '';
$links[] = '' . __( 'Support', 'siteorigin-panels' ) . '';
if ( SiteOrigin_Panels::display_premium_teaser() ) {
$links[] = '' . __( 'Addons', 'siteorigin-panels' ) . '';
}
return $links;
}
/**
* Callback to register the Page Builder Metaboxes
*/
public function add_meta_boxes() {
foreach ( siteorigin_panels_setting( 'post-types' ) as $type ) {
add_meta_box(
'so-panels-panels',
__( 'Page Builder', 'siteorigin-panels' ),
array( $this, 'render_meta_boxes' ),
(string) $type,
'advanced',
'high',
array(
// Ideally when we have panels data for a page we would set this to false and it would cause the
// editor to fall back to classic editor, but that's not the case so we just declare it as a `__back_compat_meta_box`.
'__back_compat_meta_box' => true,
'__block_editor_compatible_meta_box' => false,
)
);
}
}
/**
* Render a panel metabox.
*/
public function render_meta_boxes( $post ) {
$panels_data = $this->get_current_admin_panels_data();
$preview_url = SiteOrigin_Panels::preview_url();
if ( apply_filters( 'siteorigin_panels_add_preview_content', true ) ) {
$preview_content = apply_filters( 'siteorigin_panels_add_preview_content', true ) ? $this->generate_panels_preview( $post->ID, $panels_data ) : '';
}
$builder_id = uniqid();
$builder_type = apply_filters( 'siteorigin_panels_post_builder_type', 'editor_attached', $post, $panels_data );
$builder_supports = apply_filters( 'siteorigin_panels_builder_supports', array(), $post, $panels_data );
include plugin_dir_path( __FILE__ ) . '../tpl/metabox-panels.php';
}
/**
* Save the panels data
*
* @action save_post
*/
public function save_post( $post_id ) {
// Check that everything is valid with this save.
if (
$this->in_save_post ||
( defined( 'DOING_AUTOSAVE' ) && DOING_AUTOSAVE ) ||
empty( $_POST['_sopanels_nonce'] ) ||
! wp_verify_nonce( $_POST['_sopanels_nonce'], 'save' ) ||
! current_user_can( 'edit_post', $post_id ) ||
! isset( $_POST['panels_data'] )
) {
return;
}
$this->in_save_post = true;
// Get post from db as it might have been changed and saved by other plugins.
$post = get_post( $post_id );
$old_panels_data = get_post_meta( $post_id, 'panels_data', true );
$panels_data = json_decode( wp_unslash( $_POST['panels_data'] ), true );
$panels_data['widgets'] = $this->process_raw_widgets(
! empty( $panels_data['widgets'] ) ? $panels_data['widgets'] : array(),
! empty( $old_panels_data['widgets'] ) ? $old_panels_data['widgets'] : false,
false
);
if ( siteorigin_panels_setting( 'sidebars-emulator' ) ) {
$sidebars_emulator = SiteOrigin_Panels_Sidebars_Emulator::single();
$panels_data['widgets'] = $sidebars_emulator->generate_sidebar_widget_ids( $panels_data['widgets'], $post_id );
}
$panels_data = SiteOrigin_Panels_Styles_Admin::single()->sanitize_all( $panels_data );
$panels_data = apply_filters( 'siteorigin_panels_data_pre_save', $panels_data, $post, $post_id );
if ( ! empty( $panels_data['widgets'] ) || ! empty( $panels_data['grids'] ) ) {
// Use `update_metadata` instead of `update_post_meta` to prevent saving to parent post when it's a revision, e.g. preview.
update_metadata( 'post', $post_id, 'panels_data', map_deep( $panels_data, array( 'SiteOrigin_Panels_Admin', 'double_slash_string' ) ) );
if ( siteorigin_panels_setting( 'copy-content' ) ) {
// Store a version of the HTML in post_content
$post_parent_id = wp_is_post_revision( $post_id );
$layout_id = ( ! empty( $post_parent_id ) ) ? $post_parent_id : $post_id;
SiteOrigin_Panels_Post_Content_Filters::add_filters();
$GLOBALS[ 'SITEORIGIN_PANELS_POST_CONTENT_RENDER' ] = true;
$post_content = SiteOrigin_Panels::renderer()->render( $layout_id, false, $panels_data );
$post_css = SiteOrigin_Panels::renderer()->generate_css( $layout_id, $panels_data );
SiteOrigin_Panels_Post_Content_Filters::remove_filters();
unset( $GLOBALS[ 'SITEORIGIN_PANELS_POST_CONTENT_RENDER' ] );
// Update the post_content.
$post->post_content = $post_content;
if ( siteorigin_panels_setting( 'copy-styles' ) ) {
$post->post_content .= "\n\n";
$post->post_content .= '';
}
wp_update_post( $post );
}
} else {
// There are no widgets or rows, so delete the panels data.
delete_post_meta( $post_id, 'panels_data' );
}
// If this is a Live Editor Quick Edit, setup redirection.
if (
siteorigin_panels_setting( 'live-editor-quick-link-close-after' ) &&
! empty( $_POST['_wp_http_referer'] ) &&
strpos( $_POST['_wp_http_referer'], 'so_live_editor' ) !== false
) {
add_filter( 'redirect_post_location', array( $this, 'live_editor_redirect_after' ), 10, 2 );
}
$this->in_save_post = false;
}
/*
* Handles Live Editor Quick Link redirection after editing.
*/
public function live_editor_redirect_after( $location, $post_id ) {
return get_permalink( $post_id );
}
/**
* Enqueue the panels admin scripts
*
* @param string $prefix
* @param bool $force Should we force the enqueues
*
* @action admin_print_scripts-post-new.php
* @action admin_print_scripts-post.php
* @action admin_print_scripts-appearance_page_so_panels_home_page
*/
public function enqueue_admin_scripts( $prefix = '', $force = false ) {
$screen = get_current_screen();
if ( $force || self::is_admin() ) {
wp_register_script(
'wp-color-picker-alpha',
esc_url( siteorigin_panels_url( 'js/lib/wp-color-picker-alpha' . SITEORIGIN_PANELS_JS_SUFFIX . '.js' ) ),
array( 'wp-color-picker' ),
'3.0.2',
true
);
// Media is required for row styles.
wp_enqueue_media();
wp_enqueue_script(
'so-panels-admin',
esc_url( siteorigin_panels_url( 'js/siteorigin-panels' . SITEORIGIN_PANELS_JS_SUFFIX . '.js' ) ),
array(
'jquery',
'jquery-ui-resizable',
'jquery-ui-sortable',
'jquery-ui-draggable',
'jquery-ui-slider',
'wp-color-picker-alpha',
'underscore',
'backbone',
'plupload',
'plupload-all',
),
SITEORIGIN_PANELS_VERSION,
true
);
add_action( 'admin_footer', array( $this, 'js_templates' ) );
$widgets = $this->get_widgets();
$directory_enabled = get_user_meta( get_current_user_id(), 'so_panels_directory_enabled', true );
// This is the widget we'll use for default text.
if ( ! empty( $widgets[ 'SiteOrigin_Widget_Editor_Widget' ] ) ) {
$text_widget = 'SiteOrigin_Widget_Editor_Widget';
} elseif ( ! empty( $widgets[ 'WP_Widget_Text' ] ) ) {
$text_widget = 'WP_Widget_Text';
} else {
$text_widget = false;
}
$text_widget = apply_filters( 'siteorigin_panels_text_widget_class', $text_widget );
$user = wp_get_current_user();
$tabs = apply_filters( 'siteorigin_panels_widget_dialog_tabs', array() );
$tabs = array_map( function ( $tab ) {
$tab['title'] = esc_html( $tab['title'] );
$tab['filter']['groups'] = self::escape_text_recursive( $tab['filter']['groups'] );
return $tab;
}, $tabs );
$load_on_attach = siteorigin_panels_setting( 'load-on-attach' ) || isset( $_GET['siteorigin-page-builder'] );
wp_localize_script( 'so-panels-admin', 'panelsOptions', array(
'user' => ! empty( $user ) ? $user->ID : 0,
'ajaxurl' => esc_url( wp_nonce_url( admin_url( 'admin-ajax.php' ), 'panels_action', '_panelsnonce' ) ),
'widgets' => $widgets,
'text_widget' => $text_widget,
'widget_dialog_tabs' => $tabs,
'row_layouts' => apply_filters( 'siteorigin_panels_row_layouts', array() ),
'directory_enabled' => ! empty( $directory_enabled ),
'copy_content' => siteorigin_panels_setting( 'copy-content' ),
'cache' => array(),
'instant_open' => siteorigin_panels_setting( 'instant-open-widgets' ),
'add_media' => esc_html__( 'Choose Media', 'siteorigin-panels' ),
'add_media_done' => esc_html__( 'Done', 'siteorigin-panels' ),
'default_columns' => apply_filters( 'siteorigin_panels_default_row_columns', array(
array(
'weight' => 0.5,
),
array(
'weight' => 0.5,
),
) ),
// Settings for the contextual menu.
'contextual' => array(
// Developers can change which widgets are displayed by default using this filter.
'default_widgets' => apply_filters( 'siteorigin_panels_contextual_default_widgets', array(
'SiteOrigin_Widget_Editor_Widget',
'SiteOrigin_Widget_Button_Widget',
'SiteOrigin_Widget_Image_Widget',
'SiteOrigin_Panels_Widgets_Layout',
) ),
),
// General localization messages
'loc' => array(
'missing_widget' => array(
'title' => esc_html__( 'Missing Widget', 'siteorigin-panels' ),
'description' => esc_html__( "Page Builder doesn't know about this widget.", 'siteorigin-panels' ),
),
'time' => array(
// TRANSLATORS: Number of seconds since.
'seconds' => esc_html__( '%d seconds', 'siteorigin-panels' ),
// TRANSLATORS: Number of minutes since.
'minutes' => esc_html__( '%d minutes', 'siteorigin-panels' ),
// TRANSLATORS: Number of hours since.
'hours' => esc_html__( '%d hours', 'siteorigin-panels' ),
// TRANSLATORS: A single second since.
'second' => esc_html__( '%d second', 'siteorigin-panels' ),
// TRANSLATORS: A single minute since.
'minute' => esc_html__( '%d minute', 'siteorigin-panels' ),
// TRANSLATORS: A single hour since.
'hour' => esc_html__( '%d hour', 'siteorigin-panels' ),
// TRANSLATORS: Time ago - eg. "1 minute before".
'ago' => esc_html__( '%s before', 'siteorigin-panels' ),
'now' => esc_html__( 'Now', 'siteorigin-panels' ),
),
'history' => array(
// History messages.
'current' => esc_html__( 'Current', 'siteorigin-panels' ),
'revert' => esc_html__( 'Original', 'siteorigin-panels' ),
'restore' => esc_html__( 'Version restored', 'siteorigin-panels' ),
'back_to_editor' => esc_html__( 'Converted to editor', 'siteorigin-panels' ),
// Widgets.
// TRANSLATORS: Message displayed in the history when a widget is deleted.
'widget_deleted' => esc_html__( 'Widget deleted', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a widget is added.
'widget_added' => esc_html__( 'Widget added', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a widget is edited.
'widget_edited' => esc_html__( 'Widget edited', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a widget is duplicated.
'widget_duplicated' => esc_html__( 'Widget duplicated', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a widget position is changed.
'widget_moved' => esc_html__( 'Widget moved', 'siteorigin-panels' ),
// Rows
// TRANSLATORS: Message displayed in the history when a row is deleted.
'row_deleted' => esc_html__( 'Row deleted', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a row is added.
'row_added' => esc_html__( 'Row added', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a row is edited.
'row_edited' => esc_html__( 'Row edited', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a row position is changed.
'row_moved' => esc_html__( 'Row moved', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a row is duplicated.
'row_duplicated' => esc_html__( 'Row duplicated', 'siteorigin-panels' ),
// TRANSLATORS: Message displayed in the history when a row is pasted.
'row_pasted' => esc_html__( 'Row pasted', 'siteorigin-panels' ),
// Cells.
'cell_resized' => esc_html__( 'Column resized', 'siteorigin-panels' ),
// Prebuilt.
'prebuilt_loaded' => esc_html__( 'Prebuilt layout loaded', 'siteorigin-panels' ),
),
// General localization.
'prebuilt_loading' => esc_html__( 'Loading prebuilt layout', 'siteorigin-panels' ),
'confirm_use_builder' => esc_html__( "Would you like to copy this editor's existing content to Page Builder?", 'siteorigin-panels' ),
'confirm_stop_builder' => esc_html__( 'Would you like to clear your Page Builder content and revert to using the standard visual editor?', 'siteorigin-panels' ),
// TRANSLATORS: This is the title for a widget called "Layout Builder".
'layout_widget' => esc_html__( 'Layout Builder Widget', 'siteorigin-panels' ),
// TRANSLATORS: A standard confirmation message
'dropdown_confirm' => esc_html__( 'Are you sure?', 'siteorigin-panels' ),
// TRANSLATORS: When a layout file is ready to be inserted. %s is the filename.
'ready_to_insert' => esc_html__( '%s is ready to insert.', 'siteorigin-panels' ),
// Everything for the contextual menu.
'contextual' => array(
'add_widget_below' => esc_html__( 'Add Widget Below', 'siteorigin-panels' ),
'add_widget_cell' => esc_html__( 'Add Widget to Column', 'siteorigin-panels' ),
'search_widgets' => esc_html__( 'Search Widgets', 'siteorigin-panels' ),
'add_row' => esc_html__( 'Add Row', 'siteorigin-panels' ),
'column' => esc_html__( 'Column', 'siteorigin-panels' ),
'cell_actions' => esc_html__( 'Column Actions', 'siteorigin-panels' ),
'cell_paste_widget' => esc_html__( 'Paste Widget', 'siteorigin-panels' ),
'widget_actions' => esc_html__( 'Widget Actions', 'siteorigin-panels' ),
'widget_edit' => esc_html__( 'Edit Widget', 'siteorigin-panels' ),
'widget_duplicate' => esc_html__( 'Duplicate Widget', 'siteorigin-panels' ),
'widget_delete' => esc_html__( 'Delete Widget', 'siteorigin-panels' ),
'widget_copy' => esc_html__( 'Copy Widget', 'siteorigin-panels' ),
'widget_paste' => esc_html__( 'Paste Widget Below', 'siteorigin-panels' ),
'row_actions' => esc_html__( 'Row Actions', 'siteorigin-panels' ),
'row_edit' => esc_html__( 'Edit Row', 'siteorigin-panels' ),
'row_duplicate' => esc_html__( 'Duplicate Row', 'siteorigin-panels' ),
'row_delete' => esc_html__( 'Delete Row', 'siteorigin-panels' ),
'row_copy' => esc_html__( 'Copy Row', 'siteorigin-panels' ),
'row_paste' => esc_html__( 'Paste Row', 'siteorigin-panels' ),
),
'draft' => esc_html__( 'Draft', 'siteorigin-panels' ),
'untitled' => esc_html__( 'Untitled', 'siteorigin-panels' ),
'row' => array(
'add' => esc_html__( 'New Row', 'siteorigin-panels' ),
'edit' => esc_html__( 'Row', 'siteorigin-panels' ),
'cellInput' => esc_html__( 'Adjust column size of column %s.', 'siteorigin-panels' ),
'direction' => esc_html__( 'Change column direction to the %s', 'siteorigin-panels' ),
// TRANSLATORS: Used by the Column Preset Direction button aria-label.
'left' => esc_html__( 'left', 'siteorigin-panels' ),
// TRANSLATORS: Used by the Column Preset Direction button aria-label.
'right' => esc_html__( 'right', 'siteorigin-panels' ),
),
'welcomeMessage' => array(
'addingDisabled' => esc_html__( 'Hmmm... Adding layout elements is not enabled. Please check if Page Builder has been configured to allow adding elements.', 'siteorigin-panels' ),
'oneEnabled' => esc_html__( 'Add a {{%= items[0] %}} to get started.', 'siteorigin-panels' ),
'twoEnabled' => esc_html__( 'Add a {{%= items[0] %}} or {{%= items[1] %}} to get started.', 'siteorigin-panels' ),
'threeEnabled' => esc_html__( 'Add a {{%= items[0] %}}, {{%= items[1] %}} or {{%= items[2] %}} to get started.', 'siteorigin-panels' ),
'addWidgetButton' => "" . esc_html__( 'Widget', 'siteorigin-panels' ) . '',
'addRowButton' => "" . esc_html__( 'Row', 'siteorigin-panels' ) . '',
'addPrebuiltButton' => "" . esc_html__( 'Prebuilt Layout', 'siteorigin-panels' ) . '',
'docsMessage' => sprintf(
esc_html__( 'Read our %s if you need help.', 'siteorigin-panels' ),
"" . esc_html__( 'documentation', 'siteorigin-panels' ) . ''
),
),
),
'plupload' => array(
'max_file_size' => wp_max_upload_size() . 'b',
'url' => esc_url( wp_nonce_url(
admin_url( 'admin-ajax.php' ), 'panels_action', '_panelsnonce'
) ),
'flash_swf_url' => esc_url( includes_url( 'js/plupload/plupload.flash.swf' ) ),
'silverlight_xap_url' => esc_url( includes_url( 'js/plupload/plupload.silverlight.xap' ) ),
'filter_title' => esc_html__( 'Page Builder layouts', 'siteorigin-panels' ),
'error_message' => esc_html__( 'Error uploading or importing file.', 'siteorigin-panels' ),
),
'wpColorPickerOptions' => apply_filters( 'siteorigin_panels_wpcolorpicker_options', array() ),
'prebuiltDefaultScreenshot' => esc_url( siteorigin_panels_url( 'css/images/prebuilt-default.png' ) ),
'loadOnAttach' => $load_on_attach,
'siteoriginWidgetRegex' => str_replace( '*+', '*', get_shortcode_regex( array( 'siteorigin_widget' ) ) ),
'forms' => array(
'loadingFailed' => esc_html__( 'Unknown error. Failed to load the form. Please check your internet connection, contact your web site administrator, or try again later.', 'siteorigin-panels' ),
),
'row_color' => array(
'migrations' => apply_filters( 'siteorigin_panels_admin_row_colors_migration', array(
1 => esc_html__( 'soft-blue', 'siteorigin-panels' ),
2 => esc_html__( 'soft-red', 'siteorigin-panels' ),
3 => esc_html__( 'grayish-violet', 'siteorigin-panels' ),
4 => esc_html__( 'lime-green', 'siteorigin-panels' ),
5 => esc_html__( 'desaturated-yellow', 'siteorigin-panels' ),
) ),
'default' => apply_filters( 'siteorigin_panels_admin_row_colors_default', esc_html__( 'soft-blue', 'siteorigin-panels' ) ),
),
) );
$js_widgets = array();
if ( $screen->base != 'widgets' ) {
// Render all the widget forms. A lot of widgets use this as a chance to enqueue their scripts.
$original_post = isset( $GLOBALS['post'] ) ? $GLOBALS['post'] : null; // Make sure widgets don't change the global post.
global $wp_widget_factory;
foreach ( $wp_widget_factory->widgets as $widget_obj ) {
ob_start();
$return = $widget_obj->form( array() );
// These are the new widgets in WP 4.8 which are largely JS based. They only enqueue their own
// scripts on the 'widgets' screen.
if ( $this->is_core_js_widget( $widget_obj ) && method_exists( $widget_obj, 'enqueue_admin_scripts' ) ) {
$widget_obj->enqueue_admin_scripts();
}
do_action_ref_array( 'in_widget_form', array( &$widget_obj, &$return, array() ) );
ob_end_clean();
// Need to render templates for new WP 4.8 widgets when not on the 'widgets' screen or in the customizer.
if ( $this->is_core_js_widget( $widget_obj ) ) {
$js_widgets[] = $widget_obj;
}
}
$GLOBALS['post'] = $original_post;
}
// This gives panels a chance to enqueue scripts too, without having to check the screen ID.
if ( $screen->base != 'widgets' && $screen->base != 'customize' ) {
foreach ( $js_widgets as $js_widget ) {
$js_widget->render_control_template_scripts();
}
do_action( 'siteorigin_panel_enqueue_admin_scripts' );
do_action( 'sidebar_admin_setup' );
}
}
}
/**
* Enqueue the admin panel styles.
*
* @param string $prefix
* @param bool $force Should we force the enqueue.
*
* @action admin_print_styles-post-new.php
* @action admin_print_styles-post.php
*/
public function enqueue_admin_styles( $prefix = '', $force = false ) {
if ( $force || self::is_admin() ) {
wp_enqueue_style(
'so-panels-admin',
esc_url( siteorigin_panels_url( 'css/admin' . SITEORIGIN_PANELS_CSS_SUFFIX . '.css' ) ),
array( 'wp-color-picker' ),
SITEORIGIN_PANELS_VERSION
);
do_action( 'siteorigin_panel_enqueue_admin_styles' );
$row_colors = SiteOrigin_Panels_Admin::get_row_colors();
$row_colors_css = '';
foreach ( $row_colors as $id => $color ) {
$name = ! empty( $color['name'] ) ? sanitize_title( $color['name'] ) : $id;
$row_colors_css .= '
.siteorigin-panels-builder .so-rows-container .so-row-color-' . $name . '.so-row-color {
background-color: ' . $color['active'] . ';
border: 1px solid ' . $color['inactive'] . ';
}
.siteorigin-panels-builder .so-rows-container .so-row-color-' . $name . '.so-row-color.so-row-color-selected:before {
background: ' . $color['active'] . ';
}
.siteorigin-panels-builder .so-rows-container .so-row-container.so-row-color-' . $name . ' .so-cells .cell .cell-wrapper {
background-color: ' . $color['inactive'] . ';
}
.siteorigin-panels-builder .so-rows-container .so-row-container.so-row-color-' . $name . ' .so-cells .cell.cell-selected .cell-wrapper {
background-color: ' . $color['active'] . ';
}
.siteorigin-panels-builder .so-rows-container .so-row-container.so-row-color-' . $name . ' .so-cells .cell .resize-handle {
background-color: ' . $color['cell_divider'] . ';
}
.siteorigin-panels-builder .so-rows-container .so-row-container.so-row-color-' . $name . ' .so-cells .cell .resize-handle:hover {
background-color: ' . $color['cell_divider_hover'] . ';
}';
}
if ( ! empty( $row_colors_css ) ) {
wp_add_inline_style( 'so-panels-admin', $row_colors_css );
}
}
}
/**
* Add a help tab to pages that include a Page Builder interface.
*/
public function add_help_tab( $prefix ) {
$screen = get_current_screen();
if (
( $screen->base == 'post' && ( in_array( $screen->id, siteorigin_panels_setting( 'post-types' ) ) || $screen->id == '' ) )
|| ( $screen->id == 'appearance_page_so_panels_home_page' )
) {
$screen->add_help_tab( array(
'id' => 'panels-help-tab', // Unique id for the tab.
'title' => __( 'Page Builder', 'siteorigin-panels' ), // Unique visible title for the tab.
'callback' => array( $this, 'help_tab_content' ),
) );
}
}
/**
* Display the content for the help tab.
*/
public function help_tab_content() {
include plugin_dir_path( __FILE__ ) . '../tpl/help.php';
}
/**
* Get the Page Builder data for the current admin page.
*
* @return array
*/
public function get_current_admin_panels_data() {
$screen = get_current_screen();
// Localize the panels with the panels data.
if ( $screen->base == 'appearance_page_so_panels_home_page' ) {
$home_page_id = get_option( 'page_on_front' );
if ( empty( $home_page_id ) ) {
$home_page_id = get_option( 'siteorigin_panels_home_page_id' );
}
$panels_data = ! empty( $home_page_id ) ? get_post_meta( $home_page_id, 'panels_data', true ) : null;
if ( is_null( $panels_data ) ) {
// Load the default layout.
$layouts = apply_filters( 'siteorigin_panels_prebuilt_layouts', array() );
$home_name = siteorigin_panels_setting( 'home-page-default' ) ? siteorigin_panels_setting( 'home-page-default' ) : 'home';
$panels_data = ! empty( $layouts[ $home_name ] ) ? $layouts[ $home_name ] : current( $layouts );
} elseif ( empty( $panels_data ) ) {
// The current page_on_front isn't using Page Builder.
return false;
}
$panels_data = apply_filters( 'siteorigin_panels_data', $panels_data, 'home' );
} else {
global $post;
if ( ! empty( $post ) ) {
$panels_data = get_post_meta( $post->ID, 'panels_data', true );
$panels_data = apply_filters( 'siteorigin_panels_data', $panels_data, $post->ID );
}
}
if ( empty( $panels_data ) ) {
$panels_data = array();
}
return $panels_data;
}
/**
* Save home page.
*/
public function save_home_page() {
if ( ! isset( $_POST['_sopanels_home_nonce'] ) || ! wp_verify_nonce( $_POST['_sopanels_home_nonce'], 'save' ) ) {
return;
}
if ( ! current_user_can( 'edit_theme_options' ) ) {
return;
}
if ( ! isset( $_POST['panels_data'] ) ) {
return;
}
// Check that the home page ID is set and the home page exists.
$page_id = get_option( 'page_on_front' );
if ( empty( $page_id ) ) {
$page_id = get_option( 'siteorigin_panels_home_page_id' );
}
$post_content = wp_unslash( $_POST['post_content'] );
if ( ! $page_id || get_post_meta( $page_id, 'panels_data', true ) == '' ) {
// Lets create a new page.
$page_id = wp_insert_post( array(
// TRANSLATORS: This is the default name given to a user's home page.
'post_title' => __( 'Home Page', 'siteorigin-panels' ),
'post_status' => ! empty( $_POST['siteorigin_panels_home_enabled'] ) ? 'publish' : 'draft',
'post_type' => 'page',
'post_content' => $post_content,
'comment_status' => 'closed',
) );
update_option( 'page_on_front', $page_id );
update_option( 'siteorigin_panels_home_page_id', $page_id );
// Action triggered when creating a new home page through the custom home page interface.
do_action( 'siteorigin_panels_create_home_page', $page_id );
} else {
// `wp_insert_post` does it's own sanitization, but it seems `wp_update_post` doesn't.
$post_content = sanitize_post_field( 'post_content', $post_content, $page_id, 'db' );
// Update the post with changed content to save revision if necessary.
wp_update_post( array( 'ID' => $page_id, 'post_content' => $post_content ) );
}
$page = get_post( $page_id );
// Save the updated page data.
$old_panels_data = get_post_meta( $page_id, 'panels_data', true );
$panels_data = json_decode( wp_unslash( $_POST['panels_data'] ), true );
$panels_data['widgets'] = $this->process_raw_widgets(
$panels_data['widgets'],
! empty( $old_panels_data['widgets'] ) ? $old_panels_data['widgets'] : false,
false
);
if ( siteorigin_panels_setting( 'sidebars-emulator' ) ) {
$sidebars_emulator = SiteOrigin_Panels_Sidebars_Emulator::single();
$panels_data['widgets'] = $sidebars_emulator->generate_sidebar_widget_ids( $panels_data['widgets'], $page_id );
}
$panels_data = SiteOrigin_Panels_Styles_Admin::single()->sanitize_all( $panels_data );
$panels_data = apply_filters( 'siteorigin_panels_data_pre_save', $panels_data, $page, $page_id );
update_post_meta( $page_id, 'panels_data', map_deep( $panels_data, array( 'SiteOrigin_Panels_Admin', 'double_slash_string' ) ) );
$template = get_post_meta( $page_id, '_wp_page_template', true );
$home_template = siteorigin_panels_setting( 'home-template' );
if ( ( $template == '' || $template == 'default' ) && ! empty( $home_template ) ) {
// Set the home page template.
update_post_meta( $page_id, '_wp_page_template', $home_template );
}
if ( ! empty( $_POST['siteorigin_panels_home_enabled'] ) ) {
update_option( 'show_on_front', 'page' );
update_option( 'page_on_front', $page_id );
update_option( 'siteorigin_panels_home_page_id', $page_id );
wp_publish_post( $page_id );
} else {
// We're disabling this home page.
update_option( 'show_on_front', 'posts' );
// Change the post status to draft.
$post = get_post( $page_id );
if ( $post->post_status != 'draft' ) {
global $wpdb;
$wpdb->update( $wpdb->posts, array( 'post_status' => 'draft' ), array( 'ID' => $post->ID ) );
clean_post_cache( $post->ID );
$old_status = $post->post_status;
$post->post_status = 'draft';
wp_transition_post_status( 'draft', $old_status, $post );
do_action( 'edit_post', $post->ID, $post );
do_action( "save_post_{$post->post_type}", $post->ID, $post, true );
do_action( 'save_post', $post->ID, $post, true );
do_action( 'wp_insert_post', $post->ID, $post, true );
}
}
}
/**
* After the theme is switched, change the template on the home page if the theme supports home page functionality.
*/
public function update_home_on_theme_change() {
$page_id = get_option( 'page_on_front' );
if ( empty( $page_id ) ) {
$page_id = get_option( 'siteorigin_panels_home_page_id' );
}
if ( siteorigin_panels_setting( 'home-page' ) && siteorigin_panels_setting( 'home-template' ) && $page_id && get_post_meta( $page_id, 'panels_data', true ) !== '' ) {
// Lets update the home page to use the home template that this theme supports.
update_post_meta( $page_id, '_wp_page_template', siteorigin_panels_setting( 'home-template' ) );
}
}
/**
* @return array|mixed|void
*/
public function get_widgets() {
global $wp_widget_factory;
$widgets = get_transient( 'siteorigin_panels_widgets' );
if ( $widgets !== false ) {
return $widgets;
}
$widgets = array();
foreach ( $wp_widget_factory->widgets as $class => $widget_obj ) {
$class = preg_match( '/[0-9a-f]{32}/', $class ) ? get_class( $widget_obj ) : $class;
$widgets[ $class ] = array(
'class' => $class,
'title' => ! empty( $widget_obj->name ) ? $widget_obj->name : __( 'Untitled Widget', 'siteorigin-panels' ),
'description' => ! empty( $widget_obj->widget_options['description'] ) ? $widget_obj->widget_options['description'] : '',
'installed' => true,
'groups' => array(),
);
// Get Page Builder specific widget options.
if ( isset( $widget_obj->widget_options['panels_title'] ) ) {
$widgets[ $class ]['panels_title'] = $widget_obj->widget_options['panels_title'];
}
if ( isset( $widget_obj->widget_options['panels_title_check_sub_fields'] ) ) {
$widgets[ $class ]['panels_title_check_sub_fields'] = $widget_obj->widget_options['panels_title_check_sub_fields'];
}
if ( isset( $widget_obj->widget_options['panels_groups'] ) ) {
$widgets[ $class ]['groups'] = $widget_obj->widget_options['panels_groups'];
}
if ( isset( $widget_obj->widget_options['panels_icon'] ) ) {
$widgets[ $class ]['icon'] = $widget_obj->widget_options['panels_icon'];
}
}
// Other plugins can manipulate the list of widgets. Possibly to add recommended widgets.
$widgets = apply_filters( 'siteorigin_panels_widgets', $widgets );
// Exclude these temporarily, as they won't work until we have a reliable way to enqueue their admin form scripts.
$to_exclude = array(
'Jetpack_Gallery_Widget',
'WPCOM_Widget_GooglePlus_Badge',
'Jetpack_Widget_Social_Icons',
'Jetpack_Twitter_Timeline_Widget',
);
foreach ( $to_exclude as $widget_class ) {
if ( in_array( $widget_class, $widgets ) ) {
unset( $widgets[ $widget_class ] );
}
}
// Sort the widgets alphabetically.
uasort( $widgets, array( $this, 'widgets_sorter' ) );
set_transient( 'siteorigin_panels_widgets', $widgets, 10 * 60 );
return $widgets;
}
/**
* Sorts widgets for get_widgets function by title.
*
* @return int
*/
public function widgets_sorter( $a, $b ) {
if ( empty( $a['title'] ) ) {
return - 1;
}
if ( empty( $b['title'] ) ) {
return 1;
}
return $a['title'] > $b['title'] ? 1 : - 1;
}
/**
* Process raw widgets that have come from the Page Builder front end.
*
* @param array $widgets An array of widgets from panels_data.
* @param array $old_widgets
* @param bool $escape_classes Should the class names be escaped.
* @param bool $force
*
* @return array
*/
public function process_raw_widgets( $widgets, $old_widgets = array(), $escape_classes = false, $force = false ) {
if ( empty( $widgets ) || ! is_array( $widgets ) ) {
return array();
}
$old_widgets_by_id = array();
if ( ! empty( $old_widgets ) ) {
foreach ( $old_widgets as $widget ) {
if ( ! empty( $widget[ 'panels_info' ][ 'widget_id' ] ) ) {
$old_widgets_by_id[ $widget[ 'panels_info' ][ 'widget_id' ] ] = $widget;
unset( $old_widgets_by_id[ $widget[ 'panels_info' ][ 'widget_id' ] ][ 'panels_info' ] );
}
}
}
foreach ( $widgets as $i => & $widget ) {
if ( ! is_array( $widget ) ) {
continue;
}
if ( is_array( $widget ) ) {
$info = (array) ( is_array( $widget['panels_info'] ) ? $widget['panels_info'] : $widget['info'] );
} else {
$info = array();
}
unset( $widget['info'] );
$info[ 'class' ] = apply_filters( 'siteorigin_panels_widget_class', $info[ 'class' ] );
if ( ! empty( $info['raw'] ) || $force ) {
$the_widget = SiteOrigin_Panels::get_widget_instance( $info['class'] );
if ( ! empty( $the_widget ) &&
method_exists( $the_widget, 'update' ) ) {
if (
! empty( $old_widgets_by_id ) &&
! empty( $widget[ 'panels_info' ][ 'widget_id' ] ) &&
! empty( $old_widgets_by_id[ $widget[ 'panels_info' ][ 'widget_id' ] ] )
) {
$old_widget = $old_widgets_by_id[ $widget[ 'panels_info' ][ 'widget_id' ] ];
} else {
$old_widget = $widget;
}
/** @var WP_Widget $the_widget */
$the_widget = SiteOrigin_Panels::get_widget_instance( $info['class'] );
$instance = $the_widget->update( $widget, $old_widget );
$instance = apply_filters( 'widget_update_callback', $instance, $widget, $old_widget, $the_widget );
$widget = $instance;
unset( $info['raw'] );
}
}
if ( $escape_classes ) {
// Escaping for namespaced widgets.
$info[ 'class' ] = preg_replace( '/\\\\+/', '\\\\\\\\', $info['class'] );
}
$widget['panels_info'] = $info;
}
return $widgets;
}
private function column_sizes_round( $size ) {
if ( is_array( $size ) ) {
return array_map( array( $this, 'column_sizes_round' ), $size );
}
return round( $size , 2);
}
/**
* Add all the footer JS templates.
*/
public function js_templates() {
$column_sizes = apply_filters( 'siteorigin_panels_column_sizes', array(
2 => array(
array( 50, 50 ),
array( 25, 75 ),
array( 61.8, 38.2 ),
),
3 => array(
array( 33, 33, 33 ),
array( 25, 50, 25 ),
),
4 => array(
array( 25, 25, 25, 25 ),
array( 10, 40, 40, 10 ),
),
5 => array(
array( 20, 20, 20, 20, 20 ),
array( 10, 15, 30, 15, 30 ),
),
) );
// Prevent extra long column sizes.
if ( ! empty( $column_sizes ) ) {
$column_sizes = array_map( array( $this, 'column_sizes_round' ), $column_sizes );
}
include plugin_dir_path( __FILE__ ) . '../tpl/js-templates.php';
}
public static function get_row_colors() {
$row_colors = apply_filters( 'siteorigin_panels_admin_row_colors', array(
1 => array(
'name' => __( 'Soft Blue', 'siteorigin-panels' ),
'inactive' => '#cde2ec',
'active' => '#a4cadd',
'cell_divider' => '#e7f1f6',
'cell_divider_hover' => '#dcebf2',
),
2 => array(
'name' => __( 'Soft Red', 'siteorigin-panels' ),
'inactive' => '#f2c2be',
'active' => '#e9968f',
'cell_divider' => '#f8dedc',
'cell_divider_hover' => '#f5d2cf',
),
3 => array(
'name' => __( 'Grayish Violet', 'siteorigin-panels' ),
'inactive' => '#d5ccdf',
'active' => '#b9aac9',
'cell_divider' => '#e7e2ed',
'cell_divider_hover' => '#dfd9e7',
),
4 => array(
'name' => __( 'Lime Green', 'siteorigin-panels' ),
'inactive' => '#cae7cd',
'active' => '#a3d6a9',
'cell_divider' => '#e3f2e4',
'cell_divider_hover' => '#d8edda',
),
5 => array(
'name' => __( 'Desaturated Yellow', 'siteorigin-panels' ),
'inactive' => '#e2dcb1',
'active' => '#d3ca88',
'cell_divider' => '#ece8cb',
'cell_divider_hover' => '#e8e3c0',
),
) );
// Ensure all of the colors are valid.
foreach ( $row_colors as $id => $color ) {
unset( $name );
if (
! empty( $color['inactive'] ) &&
! empty( $color['active'] ) &&
! empty( $color['cell_divider'] ) &&
! empty( $color['cell_divider_hover'] )
) {
// If color has a name set, store it and re-apply later.
if ( ! empty( $color['name'] ) ) {
$name = $color['name'];
unset( $color['name'] );
}
$valid_row_colors[ $id ] = array_map( 'sanitize_hex_color', $color );
if ( ! empty( $name ) ) {
$valid_row_colors[ $id ]['name'] = $name;
}
}
}
return ! empty( $valid_row_colors ) ? $valid_row_colors : array();
}
/**
* Render a widget form with all the Page Builder specific fields.
*
* @param string $widget_class The class of the widget
* @param array $instance Widget values
* @param bool $raw
* @param string $widget_number
*
* @return mixed|string The form
*/
public function render_form( $widget_class, $instance = array(), $raw = false, $widget_number = '{$id}' ) {
$the_widget = SiteOrigin_Panels::get_widget_instance( $widget_class );
// This is a chance for plugins to replace missing widgets
$the_widget = apply_filters( 'siteorigin_panels_widget_object', $the_widget, $widget_class );
if ( empty( $the_widget ) || ! is_a( $the_widget, 'WP_Widget' ) ) {
$widgets = $this->get_widgets();
if ( ! empty( $widgets[ $widget_class ] ) && ! empty( $widgets[ $widget_class ]['plugin'] ) ) {
// We know about this widget, show a form about installing it.
$install_url = siteorigin_panels_plugin_activation_install_url( $widgets[ $widget_class ]['plugin']['slug'], $widgets[ $widget_class ]['plugin']['name'] );
$form =
'
' .
'
' .
preg_replace(
array(
'/1\{ *(.*?) *\}/',
'/2\{ *(.*?) *\}/',
),
array(
'$1',
'$1',
),
sprintf(
__( 'You need to install 1{%1$s} to use the widget 2{%2$s}.', 'siteorigin-panels' ),
$widgets[ $widget_class ]['plugin']['name'],
$widget_class
)
) .
'
' .
'
' . __( "Save and reload this page to start using the widget after you've installed it.", 'siteorigin-panels' ) . '
' .
'
';
} else {
// This widget is missing, so show a missing widgets form.
$form =
'
' .
preg_replace(
array(
'/1\{ *(.*?) *\}/',
'/2\{ *(.*?) *\}/',
),
array(
'$1',
'$1',
),
sprintf(
__( 'The widget 1{%1$s} is not available. Please try locate and install the missing plugin. Post on the 2{support forums} if you need help.', 'siteorigin-panels' ),
esc_html( $widget_class )
)
) .
'
';
}
// Allow other themes and plugins to change the missing widget form.
return apply_filters( 'siteorigin_panels_missing_widget_form', $form, $widget_class, $instance );
}
if ( $raw ) {
$instance = $the_widget->update( $instance, $instance );
}
$the_widget->id = 'temp';
$the_widget->number = $widget_number;
do_action( 'siteorigin_panels_before_widget_form', $the_widget, $instance );
ob_start();
if ( $this->is_core_js_widget( $the_widget ) ) {
?>