.*?<\/ul>/mis';
/**
* Constructor.
*
* ET_Builder_Block_Editor_Integration constructor.
*/
public function __construct() {
$this->init_hooks();
}
/**
* Return whether the post can be edited in the block editor.
*
* @param mixed $post Post ID or WP_Post object.
*
* @return bool
*/
protected function _can_edit_post( $post ) {
if ( function_exists( 'gutenberg_can_edit_post' ) ) {
return gutenberg_can_edit_post( $post );
}
// In case WordPress is lower than version 5.0.
if ( ! function_exists( 'use_block_editor_for_post' ) ) {
return false;
}
return use_block_editor_for_post( $post );
}
/**
* Return whether a post type is compatible with the block editor.
*
* @param string $type The post type.
*
* @return bool
*/
protected function _can_edit_post_type( $type ) {
if ( function_exists( 'gutenberg_can_edit_post_type' ) ) {
return gutenberg_can_edit_post_type( $type );
}
// In case WordPress is lower than version 5.0.
if ( ! function_exists( 'use_block_editor_for_post_type' ) ) {
return false;
}
return use_block_editor_for_post_type( $type );
}
/**
* Check if the current editor is set to load Gutenberg.
*
* @return bool
*/
protected function _is_block_editor_page() {
if ( function_exists( 'is_gutenberg_page' ) ) {
return is_gutenberg_page();
}
// In case WordPress is lower than version 5.0.
if ( ! function_exists( 'use_block_editor_for_post' ) ) {
return false;
}
return use_block_editor_for_post( get_the_ID() );
}
/**
* Filter on map_meta_cap.
*
* @param array $caps Capabilities.
* @param string $cap Capability to check.
* @param string $user_id User ID.
* @param array $args Additional args.
*
* @return array
*/
public function map_meta_cap( $caps, $cap, $user_id, $args ) {
// This only needs to run once,.
remove_filter( 'map_meta_cap', array( $this, 'map_meta_cap' ), 10 );
if (
// GB checks for 'edit_post' so do nothing in all other cases.
'edit_post' !== $cap ||
// Ignore the case where Divi wasn't used to edit the post.
! et_pb_is_pagebuilder_used( $args[0] )
) {
return $caps;
}
// We need to add `do_not_allow` for superadmins.
$caps = array( 'do_not_allow' );
return $caps;
}
/**
* Get user capabilities that is relevant to block editor integration
*
* @since 4.1.0
*
* @return array
*/
public function get_current_user_capabilities() {
/**
* Make relevant capabilities filterable should the need to check for more caps arises
*
* @since 4.1.0
*
* @param array user capabilities
*/
$relevant_capabilities = array(
'divi_library',
'use_visual_builder',
);
$relevant_capabilities = apply_filters( 'et_block_editor_relevant_capabilities', $relevant_capabilities );
$capabilities = array();
foreach ( $relevant_capabilities as $cap_name ) {
$capabilities[ $cap_name ] = et_pb_is_allowed( $cap_name );
}
return $capabilities;
}
/**
* Filter used to disable GB for certain post types.
*
* @param bool $can_edit Whether post type can be editable with gutenberg or not.
* @param string $post_type Post type name.
*
* @return bool
*/
public function gutenberg_can_edit_post_type( $can_edit, $post_type ) {
// The tricky part here is that GB doesn't pass the post ID to this filter but only its type
// but we need the ID to determine whether the post has been edited with Divi.
// Since GB uses `current_user_can( 'edit_post', $post->ID )` right after call this filter,
// We hook into `map_meta_cap` (which gets passed the ID) and do our checks there.
add_filter( 'map_meta_cap', array( $this, 'map_meta_cap' ), 10, 4 );
return $can_edit;
}
/**
* Enqueue our GB compatibility bundle.
*
* @return void
*/
public function enqueue_block_editor_assets() {
// Load script dependencies that is used by builder on top window. These dependencies
// happen to be the exact same scripts required by BFB top window's scripts.
et_bfb_enqueue_scripts_dependencies();
// Enqueue open sans.
et_builder_enqueue_open_sans();
// Enqueue integration & blocks scripts.
$deps = array(
'jquery',
'et_bfb_admin_date_addon_js',
'wp-hooks',
);
et_fb_enqueue_bundle( 'et-builder-gutenberg', 'gutenberg.js', $deps );
// Enqueue top window style.
wp_register_style(
'et-fb-top-window',
ET_BUILDER_URI . '/frontend-builder/assets/css/fb-top-window.css',
array(),
ET_BUILDER_VERSION
);
// Enqueue integration & blocks styles.
$deps = array(
'et-fb-top-window',
);
et_fb_enqueue_bundle( 'et-builder-gutenberg', 'gutenberg.css', $deps );
// this enqueue bundle.css.
et_builder_enqueue_assets_main();
$post_id = get_the_ID();
$post_type = get_post_type();
$enabled_for_post_type = et_builder_enabled_for_post_type( $post_type );
$updates_options = get_site_option( 'et_automatic_updates_options', array() );
$et_account = array(
'et_username' => et_()->array_get( $updates_options, 'username', '' ),
'et_api_key' => et_()->array_get( $updates_options, 'api_key', '' ),
'status' => get_site_option( 'et_account_status', 'not_active' ),
);
// Set helpers needed by our own Gutenberg bundle.
$gutenberg = array(
'helpers' => array(
'postID' => $post_id,
'postType' => $post_type,
'is3rdPartyPostType' => et_builder_is_post_type_custom( $post_type ) ? 'yes' : 'no',
'vbUrl' => et_fb_get_vb_url(),
'builderUsed' => et_pb_is_pagebuilder_used( $post_id ),
'scriptDebug' => defined( 'SCRIPT_DEBUG' ) && SCRIPT_DEBUG,
'canToggle' => et_pb_is_allowed( 'divi_builder_control' ) && $enabled_for_post_type,
'isEnabled' => $enabled_for_post_type,
'i18n' => array(
'placeholder' => array(
'block' => array(
'title' => esc_html__( 'Divi Builder', 'et_builder' ),
'description' => esc_html__( 'The Divi Builder is activated on this page. To edit your page using the builder, click the Edit With The Divi Builder button.', 'et_builder' ),
),
'render' => array(
'title' => array(
'new' => esc_html__( 'Build Your Layout Using Divi', 'et_builder' ),
'old' => esc_html__( 'This Layout Is Built With Divi', 'et_builder' ),
),
'divi' => array(
'new' => esc_html__( 'Use Divi Builder', 'et_builder' ),
'old' => esc_html__( 'Edit With The Divi Builder', 'et_builder' ),
),
'default' => esc_html__( 'Use Default Editor', 'et_builder' ),
),
),
),
),
// Loaded into ETBlockUserStore.
'capabilities' => $this->get_current_user_capabilities(),
// Loaded into ETBlockLibraryStore.
'etAccount' => $et_account,
// Loaded into ETBlockSettingsStore.
'conditions' => array(
'isRtl' => is_rtl(),
),
'constants' => array(
'emptyLayout' => '[et_pb_section admin_label="section"][et_pb_row admin_label="row"][/et_pb_row][/et_pb_section]',
),
'nonces' => array(
'et_builder_library_get_layouts_data' => wp_create_nonce( 'et_builder_library_get_layouts_data' ),
'et_builder_library_update_account' => wp_create_nonce( 'et_builder_library_update_account' ),
'et_block_layout_preview' => wp_create_nonce( 'et_block_layout_preview' ),
'et_rest_get_layout_content' => wp_create_nonce( 'et_rest_get_layout_content' ),
'et_rest_process_builder_edit_data' => wp_create_nonce( 'et_rest_process_builder_edit_data' ),
),
'urls' => array(
'adminAjax' => admin_url( 'admin-ajax.php' ),
'diviLibrary' => ET_BUILDER_DIVI_LIBRARY_URL,
'home' => home_url( '/' ),
),
/**
* Make DOM selectors list filterable so third party can modified it if needed
*
* @since 4.1.0
*
* @param array list of selectors
*/
'selectors' => apply_filters(
'et_gb_selectors',
array(
'pageLayoutSelect' => '#et_pb_page_layout',
)
),
/**
* Make Content Widhts settings filterable so third party can modified it if needed
*
* @since 4.1.0
*
* @param array content width configurations
*/
'contentWidths' => apply_filters(
'et_gb_content_widths',
array(
// Intentionally set null for default and undefined if no saved content width found
// unless `et_gb_content_widths` is being filtered to handle Divi Builder Plugin
// situation which might not have deifined content width.
'default' => null,
'current' => get_post_meta( $post_id, '_et_gb_content_width', true ),
'min' => 320, // Min content width (small smartphone width).
'max' => 2880, // Max content width (15" laptop * 2).
)
),
);
wp_localize_script( 'et-builder-gutenberg', 'et_builder_gutenberg', $gutenberg );
// Set translated strings for the scripts.
wp_set_script_translations( 'et-builder-gutenberg', 'et_builder', ET_BUILDER_DIR . 'languages' );
}
/**
* Add new Divi page
*
* @return void
*/
public function add_new_button() {
global $typenow;
if ( ! $this->_can_edit_post_type( $typenow ) ) {
return;
}
$edit = 'post-new.php';
$edit .= 'post' !== $typenow ? "?post_type=$typenow" : '';
// Create a nonce to auto activate VB on a new Auto Draft.
$url = add_query_arg( 'et_fb_new_vb_nonce', wp_create_nonce( 'et_fb_new_vb_nonce' ), admin_url( $edit ) );
$button = sprintf( '%s', esc_url( $url ), 'Divi' );
?>
$post->ID,
'post_status' => 'draft',
)
);
// Add VB activation nonce.
$url = add_query_arg(
'et_fb_activation_nonce',
wp_create_nonce( 'et_fb_activation_nonce_' . $post->ID ),
et_fb_prepare_ssl_link( get_permalink( $post ) )
);
// Set post meta to `off` or else `et_builder_set_content_activation` won't work...
update_post_meta( $post->ID, '_et_pb_use_builder', 'off' );
wp_safe_redirect( $url );
exit();
}
/**
* Add 'Edit With Divi Editor' links
*
* @param array $actions Currently defined actions for the row.
* @param object $post Current post object.
*
* @return array
*/
public function add_edit_link( $actions, $post ) {
// Maybe change this with et_fb_current_user_can_save or equivalent.
if ( ! $this->_can_edit_post( $post ) || ! et_builder_enabled_for_post_type( $post->post_type ) ) {
return $actions;
}
if ( (int) get_option( 'page_for_posts' ) === $post->ID ) {
// Post is assigned as the blog page so it does not have editable content.
return $actions;
}
$post_id = $post->ID;
$is_divi_library = 'et_pb_layout' === get_post_type( $post_id );
$edit_url = $is_divi_library ? get_edit_post_link( $post_id, 'raw' ) : get_permalink( $post_id );
if ( et_pb_is_pagebuilder_used( $post_id ) ) {
$edit_url = et_fb_get_vb_url( $edit_url );
} else {
if ( ! et_pb_is_allowed( 'divi_builder_control' ) ) {
// Do not add Divi activation link when user lacks `Toggle Divi Builder` capability.
return $actions;
}
$edit_url = add_query_arg(
array(
'et_fb_activation_nonce' => wp_create_nonce( 'et_fb_activation_nonce_' . $post_id ),
),
$edit_url
);
}
$edit_action = array(
'divi' => sprintf(
'%s',
esc_url( $edit_url ),
esc_attr(
sprintf(
__( 'Edit “%s” in Divi', 'et_builder' ),
_draft_or_post_title( $post->ID )
)
),
esc_html__( 'Edit With Divi', 'et_builder' )
),
);
$actions = array_merge( $actions, $edit_action );
// I'm leaving this here in case we wanna change item position.
// $edit_offset = array_search( 'edit', array_keys( $actions ), true );
// $actions = array_merge(
// array_slice( $actions, 0, $edit_offset + 1 ),
// $edit_action,
// array_slice( $actions, $edit_offset + 1 )
// );.
return $actions;
}
/**
* Add filters needed to show our extra row action.
*
* @return void
*/
public function add_edit_link_filters() {
// For hierarchical post types.
add_filter( 'page_row_actions', array( $this, 'add_edit_link' ), 10, 2 );
// For non-hierarchical post types.
add_filter( 'post_row_actions', array( $this, 'add_edit_link' ), 10, 2 );
}
/**
* Add 'Divi' to post states when builder is enabled for it.
*
* @param array $post_states Existing post states.
* @param object $post Current post object.
*
* @return array
*/
public function display_post_states( $post_states, $post ) {
// Make sure that $post_states is an array. Third party plugin might modify $post_states and makes it null
// which create various issue (i.e. Piklist + Having a page configured as a static page).
if ( ! is_array( $post_states ) ) {
$post_states = array();
}
if ( et_pb_is_pagebuilder_used( $post->ID ) ) {
// Remove Gutenberg if existing.
$key = array_search( 'Gutenberg', $post_states, true );
if ( false !== $key ) {
unset( $post_states[ $key ] );
}
// GB devs didn't allow this to be translated so why should we ?
$post_states[] = 'Divi';
}
return $post_states;
}
/**
* Ensures that Divi enabled CPTs support 'custom-fields'.
*
* @since 3.19.12
*/
public function ensure_post_type_supports() {
$post_types = et_builder_get_builder_post_types();
foreach ( $post_types as $post_type ) {
if ( ! post_type_supports( $post_type, 'custom-fields' ) ) {
add_post_type_support( $post_type, 'custom-fields' );
}
}
}
/**
* Alter update_post_metadata return value from during a REST API update
* when meta value isn't changed.
*
* @param mixed $result Previous result.
* @param int $object_id Post ID.
* @param string $meta_key Meta key.
* @param mixed $meta_value Meta value.
*
* @return mixed
*/
public function update_post_metadata( $result, $object_id, $meta_key, $meta_value ) {
if ( ! in_array( $meta_key, array( '_et_pb_use_builder', '_et_pb_old_content' ), true ) ) {
// Only act if it's one of our metas.
return $result;
}
if ( get_metadata( 'post', $object_id, $meta_key, true ) === $meta_value ) {
// Return true instead of false so silly WP REST API call won't die on us....
return true;
}
return $result;
}
/**
* Remove empty Divi GB placeholder when processing shortcode.
*
* @param string $post_content Raw post content (shortcode).
*
* @return string
*/
public function et_fb_load_raw_post_content( $post_content ) {
// Replace empty placeholder with no content so page creation will
// still work in this case.
return '' === $post_content ? '' : $post_content;
}
/**
* Convert a single GB gallery to shortcode.
*
* @param string $gallery Post content.
*
* @return string
*/
public function gb_gallery_to_shortcode( $gallery ) {
$gallery = is_array( $gallery ) ? $gallery[0] : $gallery;
$ids = preg_match_all( '/data-id="(\d+)"/i', $gallery, $matches ) ? $matches[1] : array();
$columns = preg_match( '//i', $gallery, $matches ) ? $matches[1] : 3;
$shortcode = sprintf(
'[gallery columns="%s" ids="%s"]',
intval( $columns ),
implode( ',', array_map( 'intval', $ids ) )
);
return $shortcode;
}
/**
* Convert all GB galleries to shortcodes.
*
* @param string $content Post content.
*
* @return string
*/
public function gb_galleries_to_shortcodes( $content ) {
return preg_replace_callback(
$this->_gb_gallery_regexp,
array( $this, 'gb_gallery_to_shortcode' ),
$content
);
}
/**
* Check a specified post's content for GB gallery and, if present, return the first
*
* @param string $gallery Gallery data and srcs parsed from the expanded shortcode.
* @param int|WP_Post $post Post ID or object.
*
* @return string|array Gallery data and srcs parsed from the expanded shortcode.
*/
public function get_post_gallery( $gallery, $post ) {
if ( $gallery ) {
return $gallery;
}
$content = get_post_field( 'post_content', $post );
if ( empty( $content ) ) {
return $gallery;
}
if ( preg_match( $this->_gb_gallery_regexp, $content, $matches ) ) {
// Found a GB gallery.
if ( apply_filters( 'et_gb_gallery_to_shortcode', true ) ) {
// Return as shortcode.
return do_shortcode( $this->gb_gallery_to_shortcode( $matches[0] ) );
}
// Return it as is.
return $matches[0];
}
return $gallery;
}
/**
* Delete first GB gallery in content
*
* @param string $content Content.
* @param bool $deleted Whether a gallery has been already deleted or not.
* @return string
*/
public function et_delete_post_gallery( $content, $deleted ) {
if ( $deleted ) {
// If a gallery was already removed, do nothing.
return $content;
}
return preg_replace( $this->_gb_gallery_regexp, '', $content, 1 );
}
/**
* Remove custom style from our metabox when GB is showing it.
*
* @param string $post_type Post type.
*
* @return void
*/
public function add_meta_boxes( $post_type ) {
$is_block_editor_page = $this->_is_block_editor_page();
$is_metabox_exist = function_exists( 'et_single_settings_meta_box' );
$is_builder_enabled = et_builder_enabled_for_post_type( $post_type );
$is_metabox_allowed = et_pb_is_allowed( 'page_options' );
if ( $is_block_editor_page && $is_metabox_exist && $is_builder_enabled && $is_metabox_allowed ) {
// Change our metabox id so that no custom style is applied.
remove_meta_box( 'et_settings_meta_box', $post_type, 'side' );
add_meta_box(
'et_settings_meta_box_gutenberg',
esc_html__( 'Divi Page Settings', 'Divi' ),
'et_single_settings_meta_box',
$post_type,
'side',
'high'
);
}
}
/**
* Hook into REST API page call.
*
* @return void
*/
public function rest_insert_page() {
add_filter( 'update_post_metadata', array( $this, 'update_post_metadata' ), 10, 4 );
}
/**
* Custom auth function for meta updates via REST API.
*
* @param boolean $allowed True if allowed to view the meta field by default, false if else.
* @param string $meta_key The meta key.
* @param int $id Post ID.
*
* @return bool
*/
public function meta_auth( $allowed, $meta_key, $id ) {
return current_user_can( 'edit_post', $id );
}
/**
* Hook methods to WordPress
* Latest plugin version: 1.5
*
* @return void
*/
public function init_hooks() {
if ( is_admin() ) {
add_action( 'enqueue_block_editor_assets', array( $this, 'enqueue_block_editor_assets' ), 4 );
add_action( 'admin_print_scripts-edit.php', array( $this, 'add_new_button' ), 10 );
add_action( 'admin_init', array( $this, 'add_edit_link_filters' ) );
// Only need to add this filter is the nonce is present in the url request
// nonce value will be checked in the filter itself.
// phpcs:ignore WordPress.Security.NonceVerification -- This is just check, therefore nonce verification not required.
if ( isset( $_GET['et_fb_new_vb_nonce'] ) ) {
add_action( 'new_to_auto-draft', array( $this, 'auto_draft' ), 1 );
}
add_filter( 'display_post_states', array( $this, 'display_post_states' ), 10, 2 );
} else {
// If "Enable Divi Gallery" option is enabled.
if ( apply_filters( 'et_gb_gallery_to_shortcode', false ) === true ) {
// Converts GB galleries to shortcodes.
add_filter( 'the_content', array( $this, 'gb_galleries_to_shortcodes' ), 1 );
}
if ( apply_filters( 'et_gb_gallery_include_in_get_post_gallery', false ) === true ) {
// Makes sure `get_post_gallery` returns a GB gallery if no shortcode is found.
add_filter( 'get_post_gallery', array( $this, 'get_post_gallery' ), 10, 2 );
}
// This filter gets called when Divi removes first gallery shortcode from
// a gallery post (as in post format). We hook into that to ensure that the first GB gallery
// is deleted if nothing else was.
add_filter( 'et_delete_post_gallery', array( $this, 'et_delete_post_gallery' ), 10, 2 );
// Provide other code a simple way to access the conversion function via this custom filter.
add_filter( 'et_gb_galleries_to_shortcodes', array( $this, 'gb_galleries_to_shortcodes' ) );
}
add_filter( 'et_fb_load_raw_post_content', array( $this, 'et_fb_load_raw_post_content' ) );
add_filter( 'init', array( $this, 'ensure_post_type_supports' ), 999999 );
// This is one of the most idiot things I had to do ever and its due to
// a 10 month old-yet not fixed WP bug: https://core.trac.wordpress.org/ticket/42069
// TLDR: when updating a post with meta via WP REST API, `update_metadata` should only
// be called for metas whose value changed.
// However, the equality check is fooled by values including characters that are
// slashed or converted to entities, like " or <.
// `update_metadata` is then called and returns `false` (because value didn't change) which results
// in REST API page update to abort with a 500 error code....
// To fix the issue, we hook into REST API page update and force `update_metadata` to return `true`
// when value didn't change (only applied to our own meta keys).
add_action( 'rest_insert_page', array( $this, 'rest_insert_page' ) );
// Need to deal with our metabox styling when inside GB.
add_action( 'add_meta_boxes', array( $this, 'add_meta_boxes' ), 10, 1 );
// To register the post metas is needed because we want to change their value within our custom GB blocks
// Editing a post meta via REST API is allowed by default unless its key is protected (starts with `_`)
// which is the case here so we also need to create a custom auth function.
$auth = array( $this, 'meta_auth' );
$args = array(
'auth_callback' => $auth,
'show_in_rest' => true,
'single' => true,
'type' => 'string',
);
register_meta( 'post', '_et_pb_use_builder', $args );
$args = array(
'auth_callback' => $auth,
'show_in_rest' => true,
'single' => true,
'type' => 'string',
);
register_meta( 'post', '_et_pb_old_content', $args );
$args = array(
'auth_callback' => $auth,
'show_in_rest' => true,
'single' => true,
'type' => 'string',
);
register_meta( 'post', '_et_gb_content_width', $args );
}
}
if ( et_core_is_gutenberg_active() ) {
new ET_Builder_Block_Editor_Integration();
}