y|false Child type or false if it's not a valid widget. */ protected function _get_default_child_type( array $element_data ) { return Plugin::$instance->elements_manager->get_element_types( 'section' ); } /** * Get repeater setting key. * * Retrieve the unique setting key for the current repeater item. Used to connect the current element in the * repeater to it's settings model and it's control in the panel. * * PHP usage (inside `Widget_Base::render()` method): * * $tabs = $this->get_settings( 'tabs' ); * foreach ( $tabs as $index => $item ) { * $tab_title_setting_key = $this->get_repeater_setting_key( 'tab_title', 'tabs', $index ); * $this->add_inline_editing_attributes( $tab_title_setting_key, 'none' ); * echo '
get_render_attribute_string( $tab_title_setting_key ) . '>' . $item['tab_title'] . '
'; * } * * @since 1.8.0 * @access protected * * @param string $setting_key The current setting key inside the repeater item (e.g. `tab_title`). * @param string $repeater_key The repeater key containing the array of all the items in the repeater (e.g. `tabs`). * @param int $repeater_item_index The current item index in the repeater array (e.g. `3`). * * @return string The repeater setting key (e.g. `tabs.3.tab_title`). */ protected function get_repeater_setting_key( $setting_key, $repeater_key, $repeater_item_index ) { return implode( '.', [ $repeater_key, $repeater_item_index, $setting_key ] ); } /** * Add inline editing attributes. * * Define specific area in the element to be editable inline. The element can have several areas, with this method * you can set the area inside the element that can be edited inline. You can also define the type of toolbar the * user will see, whether it will be a basic toolbar or an advanced one. * * Note: When you use wysiwyg control use the advanced toolbar, with textarea control use the basic toolbar. Text * control should not have toolbar. * * PHP usage (inside `Widget_Base::render()` method): * * $this->add_inline_editing_attributes( 'text', 'advanced' ); * echo '
get_render_attribute_string( 'text' ) . '>' . $this->get_settings( 'text' ) . '
'; * * @since 1.8.0 * @access protected * * @param string $key Element key. * @param string $toolbar Optional. Toolbar type. Accepted values are `advanced`, `basic` or `none`. Default is * `basic`. */ protected function add_inline_editing_attributes( $key, $toolbar = 'basic' ) { if ( ! Plugin::$instance->editor->is_edit_mode() ) { return; } $this->add_render_attribute( $key, [ 'class' => 'elementor-inline-editing', 'data-elementor-setting-key' => $key, ] ); if ( 'basic' !== $toolbar ) { $this->add_render_attribute( $key, [ 'data-elementor-inline-editing-toolbar' => $toolbar, ] ); } } /** * Add new skin. * * Register new widget skin to allow the user to set custom designs. Must be * called inside the `register_skins()` method. * * @since 1.0.0 * @access public * * @param Skin_Base $skin Skin instance. */ public function add_skin( Skin_Base $skin ) { Plugin::$instance->skins_manager->add_skin( $this, $skin ); } /** * Get single skin. * * Retrieve a single skin based on skin ID, from all the skin assigned to * the widget. If the skin does not exist or not assigned to the widget, * return false. * * @since 1.0.0 * @access public * * @param string $skin_id Skin ID. * * @return string|false Single skin, or false. */ public function get_skin( $skin_id ) { $skins = $this->get_skins(); if ( isset( $skins[ $skin_id ] ) ) { return $skins[ $skin_id ]; } return false; } /** * Get current skin ID. * * Retrieve the ID of the current skin. * * @since 1.0.0 * @access public * * @return string Current skin. */ public function get_current_skin_id() { return $this->get_settings( '_skin' ); } /** * Get current skin. * * Retrieve the current skin, or if non exist return false. * * @since 1.0.0 * @access public * * @return Skin_Base|false Current skin or false. */ public function get_current_skin() { return $this->get_skin( $this->get_current_skin_id() ); } /** * Remove widget skin. * * Unregister an existing skin and remove it from the widget. * * @since 1.0.0 * @access public * * @param string $skin_id Skin ID. * * @return \WP_Error|true Whether the skin was removed successfully from the widget. */ public function remove_skin( $skin_id ) { return Plugin::$instance->skins_manager->remove_skin( $this, $skin_id ); } /** * Get widget skins. * * Retrieve all the skin assigned to the widget. * * @since 1.0.0 * @access public * * @return Skin_Base[] */ public function get_skins() { return Plugin::$instance->skins_manager->get_skins( $this ); } /** * Get group name. * * Some widgets need to use group names, this method allows you to create them. * By default it retrieves the regular name. * * @since 3.3.0 * @access public * * @return string Unique name. */ public function get_group_name() { return $this->get_name(); } /** * Get Inline CSS dependencies. * * Retrieve a list of inline CSS dependencies that the element requires. * * @since 3.3.0 * @access public * * @return array. */ public function get_inline_css_depends() { return []; } /** * @param string $plugin_title Plugin's title * @param string $since Plugin version widget was deprecated * @param string $last Plugin version in which the widget will be removed * @param string $replacement Widget replacement */ protected function deprecated_notice( $plugin_title, $since, $last = '', $replacement = '' ) { $this->start_controls_section( 'Deprecated', [ 'label' => esc_html__( 'Deprecated', 'elementor' ), ] ); $this->add_control( 'deprecated_notice', [ 'type' => Controls_Manager::DEPRECATED_NOTICE, 'widget' => $this->get_title(), 'since' => $since, 'last' => $last, 'plugin' => $plugin_title, 'replacement' => $replacement, ] ); $this->end_controls_section(); } public function register_runtime_widget( $widget_name ) { self::$registered_runtime_widgets[] = $widget_name; } public function get_widget_css_config( $widget_name ) { $direction = is_rtl() ? '-rtl' : ''; $has_custom_breakpoints = $this->is_custom_breakpoints_widget(); $file_name = 'widget-' . $widget_name . $direction . '.min.css'; // The URL of the widget's external CSS file that is loaded in case that the CSS content is too large to be printed inline. $file_url = Plugin::$instance->frontend->get_frontend_file_url( $file_name, $has_custom_breakpoints ); // The local path of the widget's CSS file that is being read and saved in the DB when the CSS content should be printed inline. $file_path = Plugin::$instance->frontend->get_frontend_file_path( $file_name, $has_custom_breakpoints ); return [ 'key' => $widget_name, 'version' => ELEMENTOR_VERSION, 'file_path' => $file_path, 'data' => [ 'file_url' => $file_url, ], ]; } public function get_css_config() { return $this->get_widget_css_config( $this->get_group_name() ); } public function get_responsive_widgets_config() { $responsive_widgets_data_manager = $this->get_responsive_widgets_data_manager(); return [ 'key' => $responsive_widgets_data_manager::RESPONSIVE_WIDGETS_DATABASE_KEY, 'version' => ELEMENTOR_VERSION, 'file_path' => ELEMENTOR_ASSETS_PATH . $responsive_widgets_data_manager::RESPONSIVE_WIDGETS_FILE_PATH, ]; } public function get_responsive_widgets() { $responsive_widgets_data_manager = $this->get_responsive_widgets_data_manager(); $config = $this->get_responsive_widgets_config(); return $responsive_widgets_data_manager->get_asset_data_from_config( $config ); } /** * Get Responsive Widgets Data Manager. * * Retrieve the data manager that handles widgets that are using media queries for custom-breakpoints values. * * @since 3.5.0 * @access protected * * @return Responsive_Widgets_Data_Manager */ protected function get_responsive_widgets_data_manager() { if ( ! self::$responsive_widgets_data_manager ) { self::$responsive_widgets_data_manager = new Responsive_Widgets_Data_Manager(); } return self::$responsive_widgets_data_manager; } /** * Is Custom Breakpoints Widget. * * Checking if there are active custom-breakpoints and if the widget use them. * * @since 3.5.0 * @access protected * * @return boolean */ protected function is_custom_breakpoints_widget() { $has_custom_breakpoints = Plugin::$instance->breakpoints->has_custom_breakpoints(); if ( $has_custom_breakpoints ) { $responsive_widgets = $this->get_responsive_widgets(); // The $widget_name can also represents a widgets group name, therefore we need to use the current widget name to check if it's responsive widget. $current_widget_name = $this->get_name(); // If the widget is not implementing custom-breakpoints media queries then it has no custom- css file. if ( ! isset( $responsive_widgets[ $current_widget_name ] ) ) { $has_custom_breakpoints = false; } } return $has_custom_breakpoints; } private function get_widget_css() { $widgets_css_data_manager = $this->get_widgets_css_data_manager(); $widgets_list = $this->get_inline_css_depends(); $widgets_list[] = $this->get_group_name(); $widget_css = ''; foreach ( $widgets_list as $widget_data ) { $widget_name = isset( $widget_data['name'] ) ? $widget_data['name'] : $widget_data; if ( ! in_array( $widget_name, self::$registered_inline_css_widgets, true ) ) { if ( $this->get_group_name() === $widget_name ) { $config = $this->get_css_config(); } else { /** * The core-dependency allowing to create a dependency specifically with the core widgets. * Otherwise, the config will be taken from the class that inherits from Widget_Base. */ $is_core_dependency = isset( $widget_data['is_core_dependency'] ) ? true : false; $config = $is_core_dependency ? self::get_widget_css_config( $widget_name ) : $this->get_widget_css_config( $widget_name ); } $widget_css .= $widgets_css_data_manager->get_asset_data_from_config( $config ); self::$registered_inline_css_widgets[] = $widget_name; } } return $widget_css; } private function is_inline_css_mode() { static $is_active; if ( null === $is_active ) { $is_edit_mode = Plugin::$instance->editor->is_edit_mode(); $is_preview_mode = Plugin::$instance->preview->is_preview_mode(); $is_optimized_mode = Plugin::$instance->experiments->is_feature_active( 'e_optimized_css_loading' ); $is_active = ( Utils::is_script_debug() || $is_edit_mode || $is_preview_mode || ! $is_optimized_mode ) ? false : true; } return $is_active; } private function print_widget_css() { if ( ! $this->is_inline_css_mode() ) { return; } Utils::print_unescaped_internal_string( $this->get_widget_css() ); } private function get_widgets_css_data_manager() { if ( ! self::$widgets_css_data_manager ) { self::$widgets_css_data_manager = new Widgets_Css_Data_Manager(); } return self::$widgets_css_data_manager; } }