669 lines
15 KiB
PHP
669 lines
15 KiB
PHP
<?php
|
|
namespace Elementor;
|
|
|
|
use Elementor\Core\Common\Modules\Ajax\Module as Ajax;
|
|
use Elementor\Core\Utils\Collection;
|
|
use Elementor\Core\Utils\Exceptions;
|
|
use Elementor\Core\Utils\Force_Locale;
|
|
use Elementor\Modules\NestedAccordion\Widgets\Nested_Accordion;
|
|
use Elementor\Modules\NestedTabs\Widgets\NestedTabs;
|
|
|
|
if ( ! defined( 'ABSPATH' ) ) {
|
|
exit; // Exit if accessed directly.
|
|
}
|
|
|
|
/**
|
|
* Elementor widgets manager.
|
|
*
|
|
* Elementor widgets manager handler class is responsible for registering and
|
|
* initializing all the supported Elementor widgets.
|
|
*
|
|
* @since 1.0.0
|
|
*/
|
|
class Widgets_Manager {
|
|
|
|
/**
|
|
* Widget types.
|
|
*
|
|
* Holds the list of all the widget types.
|
|
*
|
|
* @since 1.0.0
|
|
* @access private
|
|
*
|
|
* @var Widget_Base[]
|
|
*/
|
|
private $_widget_types = null;
|
|
|
|
/**
|
|
* Promoted widget types.
|
|
*
|
|
* Holds the list of all the Promoted widget types.
|
|
*
|
|
* @since 3.15.0
|
|
* @access private
|
|
*
|
|
* @var Widget_Base[]
|
|
*/
|
|
private $_promoted_widgets = [
|
|
'nested-elements' => NestedTabs::class,
|
|
'nested-accordion' => Nested_Accordion::class,
|
|
];
|
|
|
|
/**
|
|
* Init widgets.
|
|
*
|
|
* Initialize Elementor widgets manager. Include all the the widgets files
|
|
* and register each Elementor and WordPress widget.
|
|
*
|
|
* @since 2.0.0
|
|
* @access private
|
|
*/
|
|
private function init_widgets() {
|
|
$build_widgets_filename = [
|
|
'common',
|
|
'inner-section',
|
|
'heading',
|
|
'image',
|
|
'text-editor',
|
|
'video',
|
|
'button',
|
|
'divider',
|
|
'spacer',
|
|
'image-box',
|
|
'google-maps',
|
|
'icon',
|
|
'icon-box',
|
|
'star-rating',
|
|
'image-carousel',
|
|
'image-gallery',
|
|
'icon-list',
|
|
'counter',
|
|
'progress',
|
|
'testimonial',
|
|
'tabs',
|
|
'accordion',
|
|
'toggle',
|
|
'social-icons',
|
|
'alert',
|
|
'audio',
|
|
'shortcode',
|
|
'html',
|
|
'menu-anchor',
|
|
'sidebar',
|
|
'read-more',
|
|
'rating',
|
|
];
|
|
|
|
$this->_widget_types = [];
|
|
|
|
foreach ( $build_widgets_filename as $widget_filename ) {
|
|
include ELEMENTOR_PATH . 'includes/widgets/' . $widget_filename . '.php';
|
|
|
|
$class_name = str_replace( '-', '_', $widget_filename );
|
|
|
|
$class_name = __NAMESPACE__ . '\Widget_' . $class_name;
|
|
|
|
$this->register( new $class_name() );
|
|
}
|
|
|
|
$this->register_promoted_widgets();
|
|
|
|
$this->register_wp_widgets();
|
|
|
|
/**
|
|
* After widgets registered.
|
|
*
|
|
* Fires after Elementor widgets are registered.
|
|
*
|
|
* @since 1.0.0
|
|
* @deprecated 3.5.0 Use `elementor/widgets/register` hook instead.
|
|
*
|
|
* @param Widgets_Manager $this The widgets manager.
|
|
*/
|
|
Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->do_deprecated_action(
|
|
'elementor/widgets/widgets_registered',
|
|
[ $this ],
|
|
'3.5.0',
|
|
'elementor/widgets/register'
|
|
);
|
|
|
|
/**
|
|
* After widgets registered.
|
|
*
|
|
* Fires after Elementor widgets are registered.
|
|
*
|
|
* @since 3.5.0
|
|
*
|
|
* @param Widgets_Manager $this The widgets manager.
|
|
*/
|
|
do_action( 'elementor/widgets/register', $this );
|
|
}
|
|
|
|
/**
|
|
* Register WordPress widgets.
|
|
*
|
|
* Add native WordPress widget to the list of registered widget types.
|
|
*
|
|
* Exclude the widgets that are in Elementor widgets black list. Theme and
|
|
* plugin authors can filter the black list.
|
|
*
|
|
* @since 2.0.0
|
|
* @access private
|
|
*/
|
|
private function register_wp_widgets() {
|
|
global $wp_widget_factory;
|
|
|
|
// Allow themes/plugins to filter out their widgets.
|
|
$black_list = [];
|
|
|
|
/**
|
|
* Elementor widgets black list.
|
|
*
|
|
* Filters the widgets black list that won't be displayed in the panel.
|
|
*
|
|
* @since 1.0.0
|
|
*
|
|
* @param array $black_list A black list of widgets. Default is an empty array.
|
|
*/
|
|
$black_list = apply_filters( 'elementor/widgets/black_list', $black_list );
|
|
|
|
foreach ( $wp_widget_factory->widgets as $widget_class => $widget_obj ) {
|
|
|
|
if ( in_array( $widget_class, $black_list ) ) {
|
|
continue;
|
|
}
|
|
|
|
$elementor_widget_class = __NAMESPACE__ . '\Widget_WordPress';
|
|
|
|
$this->register(
|
|
new $elementor_widget_class( [], [
|
|
'widget_name' => $widget_class,
|
|
] )
|
|
);
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Require files.
|
|
*
|
|
* Require Elementor widget base class.
|
|
*
|
|
* @since 2.0.0
|
|
* @access private
|
|
*/
|
|
private function require_files() {
|
|
require ELEMENTOR_PATH . 'includes/base/widget-base.php';
|
|
}
|
|
|
|
private function pluck_default_controls( $controls ) {
|
|
return ( new Collection( $controls ) )
|
|
->reduce( function ( $controls_defaults, $control, $control_key ) {
|
|
if ( ! empty( $control['default'] ) ) {
|
|
$controls_defaults[ $control_key ]['default'] = $control['default'];
|
|
}
|
|
|
|
return $controls_defaults;
|
|
}, [] );
|
|
}
|
|
|
|
/**
|
|
* Register widget type.
|
|
*
|
|
* Add a new widget type to the list of registered widget types.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @deprecated 3.5.0 Use `register()` method instead.
|
|
*
|
|
* @param Widget_Base $widget Elementor widget.
|
|
*
|
|
* @return true True if the widget was registered.
|
|
*/
|
|
public function register_widget_type( Widget_Base $widget ) {
|
|
Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function(
|
|
__METHOD__,
|
|
'3.5.0',
|
|
'register()'
|
|
);
|
|
|
|
return $this->register( $widget );
|
|
}
|
|
|
|
/**
|
|
* Register a new widget type.
|
|
*
|
|
* @param \Elementor\Widget_Base $widget_instance Elementor Widget.
|
|
*
|
|
* @return bool True if the widget was registered.
|
|
* @since 3.5.0
|
|
* @access public
|
|
*/
|
|
public function register( Widget_Base $widget_instance ) {
|
|
if ( is_null( $this->_widget_types ) ) {
|
|
$this->init_widgets();
|
|
}
|
|
|
|
/**
|
|
* Should widget be registered.
|
|
*
|
|
* @since 3.18.0
|
|
*
|
|
* @param bool $should_register Should widget be registered. Default is `true`.
|
|
* @param \Elementor\Widget_Base $widget_instance Widget instance.
|
|
*/
|
|
$should_register = apply_filters( 'elementor/widgets/is_widget_enabled', true, $widget_instance );
|
|
|
|
if ( ! $should_register ) {
|
|
return false;
|
|
}
|
|
|
|
$this->_widget_types[ $widget_instance->get_name() ] = $widget_instance;
|
|
|
|
return true;
|
|
}
|
|
|
|
/** Register promoted widgets
|
|
*
|
|
* Since we cannot allow widgets to place themselves is a specific
|
|
* location on our widgets panel we need to use a hard coded solution for this.
|
|
*
|
|
* @return void
|
|
*/
|
|
private function register_promoted_widgets() {
|
|
|
|
foreach ( $this->_promoted_widgets as $module_name => $class_name ) {
|
|
|
|
if ( Plugin::$instance->experiments->is_feature_active( $module_name ) ) {
|
|
$instance = new $class_name();
|
|
$this->_widget_types[ $instance->get_name() ] = $instance;
|
|
}
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Unregister widget type.
|
|
*
|
|
* Removes widget type from the list of registered widget types.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
* @deprecated 3.5.0 Use `unregister()` method instead.
|
|
*
|
|
* @param string $name Widget name.
|
|
*
|
|
* @return true True if the widget was unregistered, False otherwise.
|
|
*/
|
|
public function unregister_widget_type( $name ) {
|
|
Plugin::$instance->modules_manager->get_modules( 'dev-tools' )->deprecation->deprecated_function(
|
|
__METHOD__,
|
|
'3.5.0',
|
|
'unregister()'
|
|
);
|
|
|
|
return $this->unregister( $name );
|
|
}
|
|
|
|
/**
|
|
* Unregister widget type.
|
|
*
|
|
* Removes widget type from the list of registered widget types.
|
|
*
|
|
* @since 3.5.0
|
|
* @access public
|
|
*
|
|
* @param string $name Widget name.
|
|
*
|
|
* @return boolean Whether the widget was unregistered.
|
|
*/
|
|
public function unregister( $name ) {
|
|
if ( ! isset( $this->_widget_types[ $name ] ) ) {
|
|
return false;
|
|
}
|
|
|
|
unset( $this->_widget_types[ $name ] );
|
|
|
|
return true;
|
|
}
|
|
|
|
/**
|
|
* Get widget types.
|
|
*
|
|
* Retrieve the registered widget types list.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param string $widget_name Optional. Widget name. Default is null.
|
|
*
|
|
* @return Widget_Base|Widget_Base[]|null Registered widget types.
|
|
*/
|
|
public function get_widget_types( $widget_name = null ) {
|
|
if ( is_null( $this->_widget_types ) ) {
|
|
$this->init_widgets();
|
|
}
|
|
|
|
if ( null !== $widget_name ) {
|
|
return isset( $this->_widget_types[ $widget_name ] ) ? $this->_widget_types[ $widget_name ] : null;
|
|
}
|
|
|
|
return $this->_widget_types;
|
|
}
|
|
|
|
/**
|
|
* Get widget types config.
|
|
*
|
|
* Retrieve all the registered widgets with config for each widgets.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @return array Registered widget types with each widget config.
|
|
*/
|
|
public function get_widget_types_config() {
|
|
$config = [];
|
|
|
|
foreach ( $this->get_widget_types() as $widget_key => $widget ) {
|
|
$config[ $widget_key ] = $widget->get_config();
|
|
}
|
|
|
|
return $config;
|
|
}
|
|
|
|
/**
|
|
* @throws \Exception
|
|
*/
|
|
public function ajax_get_widget_types_controls_config( array $data ) {
|
|
Plugin::$instance->documents->check_permissions( $data['editor_post_id'] );
|
|
|
|
wp_raise_memory_limit( 'admin' );
|
|
|
|
$config = [];
|
|
|
|
foreach ( $this->get_widget_types() as $widget_key => $widget ) {
|
|
if ( isset( $data['exclude'][ $widget_key ] ) ) {
|
|
continue;
|
|
}
|
|
|
|
$config[ $widget_key ] = [
|
|
'controls' => $widget->get_stack( false )['controls'],
|
|
'tabs_controls' => $widget->get_tabs_controls(),
|
|
];
|
|
}
|
|
|
|
return $config;
|
|
}
|
|
|
|
public function ajax_get_widgets_default_value_translations( array $data = [] ) {
|
|
$locale = empty( $data['locale'] )
|
|
? get_locale()
|
|
: $data['locale'];
|
|
|
|
$force_locale = new Force_Locale( $locale );
|
|
$force_locale->force();
|
|
|
|
$controls = ( new Collection( $this->get_widget_types() ) )
|
|
->map( function ( Widget_Base $widget ) {
|
|
$controls = $widget->get_stack( false )['controls'];
|
|
|
|
return [
|
|
'controls' => $this->pluck_default_controls( $controls ),
|
|
];
|
|
} )
|
|
->filter( function ( $widget ) {
|
|
return ! empty( $widget['controls'] );
|
|
} )
|
|
->all();
|
|
|
|
$force_locale->restore();
|
|
|
|
return $controls;
|
|
}
|
|
|
|
/**
|
|
* Ajax render widget.
|
|
*
|
|
* Ajax handler for Elementor render_widget.
|
|
*
|
|
* Fired by `wp_ajax_elementor_render_widget` action.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @throws \Exception If current user don't have permissions to edit the post.
|
|
*
|
|
* @param array $request Ajax request.
|
|
*
|
|
* @return array {
|
|
* Rendered widget.
|
|
*
|
|
* @type string $render The rendered HTML.
|
|
* }
|
|
*/
|
|
public function ajax_render_widget( $request ) {
|
|
$document = Plugin::$instance->documents->get_with_permissions( $request['editor_post_id'] );
|
|
|
|
// Override the global $post for the render.
|
|
query_posts(
|
|
[
|
|
'p' => $request['editor_post_id'],
|
|
'post_type' => 'any',
|
|
]
|
|
);
|
|
|
|
$editor = Plugin::$instance->editor;
|
|
$is_edit_mode = $editor->is_edit_mode();
|
|
$editor->set_edit_mode( true );
|
|
|
|
Plugin::$instance->documents->switch_to_document( $document );
|
|
|
|
$render_html = $document->render_element( $request['data'] );
|
|
|
|
$editor->set_edit_mode( $is_edit_mode );
|
|
|
|
return [
|
|
'render' => $render_html,
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Ajax get WordPress widget form.
|
|
*
|
|
* Ajax handler for Elementor editor get_wp_widget_form.
|
|
*
|
|
* Fired by `wp_ajax_elementor_editor_get_wp_widget_form` action.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*
|
|
* @param array $request Ajax request.
|
|
*
|
|
* @return bool|string Rendered widget form.
|
|
* @throws \Exception
|
|
*/
|
|
public function ajax_get_wp_widget_form( $request ) {
|
|
Plugin::$instance->documents->check_permissions( $request['editor_post_id'] );
|
|
|
|
if ( empty( $request['widget_type'] ) ) {
|
|
return false;
|
|
}
|
|
|
|
if ( empty( $request['data'] ) ) {
|
|
$request['data'] = [];
|
|
}
|
|
|
|
$element_data = [
|
|
'id' => $request['id'],
|
|
'elType' => 'widget',
|
|
'widgetType' => $request['widget_type'],
|
|
'settings' => $request['data'],
|
|
];
|
|
|
|
/**
|
|
* @var $widget_obj Widget_WordPress
|
|
*/
|
|
$widget_obj = Plugin::$instance->elements_manager->create_element_instance( $element_data );
|
|
|
|
if ( ! $widget_obj ) {
|
|
return false;
|
|
}
|
|
|
|
return $widget_obj->get_form();
|
|
}
|
|
|
|
/**
|
|
* Render widgets content.
|
|
*
|
|
* Used to generate the widget templates on the editor using Underscore JS
|
|
* template, for all the registered widget types.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*/
|
|
public function render_widgets_content() {
|
|
foreach ( $this->get_widget_types() as $widget ) {
|
|
$widget->print_template();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Get widgets frontend settings keys.
|
|
*
|
|
* Retrieve frontend controls settings keys for all the registered widget
|
|
* types.
|
|
*
|
|
* @since 1.3.0
|
|
* @access public
|
|
*
|
|
* @return array Registered widget types with settings keys for each widget.
|
|
*/
|
|
public function get_widgets_frontend_settings_keys() {
|
|
$keys = [];
|
|
|
|
foreach ( $this->get_widget_types() as $widget_type_name => $widget_type ) {
|
|
$widget_type_keys = $widget_type->get_frontend_settings_keys();
|
|
|
|
if ( $widget_type_keys ) {
|
|
$keys[ $widget_type_name ] = $widget_type_keys;
|
|
}
|
|
}
|
|
|
|
return $keys;
|
|
}
|
|
|
|
/**
|
|
* Enqueue widgets scripts.
|
|
*
|
|
* Enqueue all the scripts defined as a dependency for each widget.
|
|
*
|
|
* @since 1.3.0
|
|
* @access public
|
|
*/
|
|
public function enqueue_widgets_scripts() {
|
|
foreach ( $this->get_widget_types() as $widget ) {
|
|
$widget->enqueue_scripts();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Enqueue widgets styles
|
|
*
|
|
* Enqueue all the styles defined as a dependency for each widget
|
|
*
|
|
* @access public
|
|
*/
|
|
public function enqueue_widgets_styles() {
|
|
foreach ( $this->get_widget_types() as $widget ) {
|
|
$widget->enqueue_styles();
|
|
}
|
|
}
|
|
|
|
/**
|
|
* Retrieve inline editing configuration.
|
|
*
|
|
* Returns general inline editing configurations like toolbar types etc.
|
|
*
|
|
* @access public
|
|
* @since 1.8.0
|
|
*
|
|
* @return array {
|
|
* Inline editing configuration.
|
|
*
|
|
* @type array $toolbar {
|
|
* Toolbar types and the actions each toolbar includes.
|
|
* Note: Wysiwyg controls uses the advanced toolbar, textarea controls
|
|
* uses the basic toolbar and text controls has no toolbar.
|
|
*
|
|
* @type array $basic Basic actions included in the edit tool.
|
|
* @type array $advanced Advanced actions included in the edit tool.
|
|
* }
|
|
* }
|
|
*/
|
|
public function get_inline_editing_config() {
|
|
$basic_tools = [
|
|
'bold',
|
|
'underline',
|
|
'italic',
|
|
];
|
|
|
|
$advanced_tools = array_merge( $basic_tools, [
|
|
'createlink',
|
|
'unlink',
|
|
'h1' => [
|
|
'h1',
|
|
'h2',
|
|
'h3',
|
|
'h4',
|
|
'h5',
|
|
'h6',
|
|
'p',
|
|
'blockquote',
|
|
'pre',
|
|
],
|
|
'list' => [
|
|
'insertOrderedList',
|
|
'insertUnorderedList',
|
|
],
|
|
] );
|
|
|
|
return [
|
|
'toolbar' => [
|
|
'basic' => $basic_tools,
|
|
'advanced' => $advanced_tools,
|
|
],
|
|
];
|
|
}
|
|
|
|
/**
|
|
* Widgets manager constructor.
|
|
*
|
|
* Initializing Elementor widgets manager.
|
|
*
|
|
* @since 1.0.0
|
|
* @access public
|
|
*/
|
|
public function __construct() {
|
|
$this->require_files();
|
|
|
|
add_action( 'elementor/ajax/register_actions', [ $this, 'register_ajax_actions' ] );
|
|
}
|
|
|
|
/**
|
|
* Register ajax actions.
|
|
*
|
|
* Add new actions to handle data after an ajax requests returned.
|
|
*
|
|
* @since 2.0.0
|
|
* @access public
|
|
*
|
|
* @param Ajax $ajax_manager
|
|
*/
|
|
public function register_ajax_actions( Ajax $ajax_manager ) {
|
|
$ajax_manager->register_ajax_action( 'render_widget', [ $this, 'ajax_render_widget' ] );
|
|
$ajax_manager->register_ajax_action( 'editor_get_wp_widget_form', [ $this, 'ajax_get_wp_widget_form' ] );
|
|
$ajax_manager->register_ajax_action( 'get_widgets_config', [ $this, 'ajax_get_widget_types_controls_config' ] );
|
|
|
|
$ajax_manager->register_ajax_action( 'get_widgets_default_value_translations', function ( array $data ) {
|
|
return $this->ajax_get_widgets_default_value_translations( $data );
|
|
} );
|
|
}
|
|
}
|