Edit File by line

<?php

[0] Fix | Delete

/**

[1] Fix | Delete

* WooCommerce Modules: ET_Builder_Module_Woocommerce_Rating class

[2] Fix | Delete

[3] Fix | Delete

* The ET_Builder_Module_Woocommerce_Rating Class is responsible for rendering the

[4] Fix | Delete

* Rating markup using the WooCommerce template.

[5] Fix | Delete

[6] Fix | Delete

* @package Divi\Builder

[7] Fix | Delete

[8] Fix | Delete

* @since 3.29

[9] Fix | Delete

[10] Fix | Delete

[11] Fix | Delete

/**

[12] Fix | Delete

* Class representing WooCommerce Rating component.

[13] Fix | Delete

[14] Fix | Delete

class ET_Builder_Module_Woocommerce_Rating extends ET_Builder_Module {

[15] Fix | Delete

/**

[16] Fix | Delete

* Initialize.

[17] Fix | Delete

[18] Fix | Delete

* @since 3.29.2 Added custom margin default.

[19] Fix | Delete

[20] Fix | Delete

public function init() {

[21] Fix | Delete

$this->name = esc_html__( 'Woo Rating', 'et_builder' );

[22] Fix | Delete

$this->plural = esc_html__( 'Woo Ratings', 'et_builder' );

[23] Fix | Delete

$this->slug = 'et_pb_wc_rating';

[24] Fix | Delete

$this->vb_support = 'on';

[25] Fix | Delete

[26] Fix | Delete

$this->settings_modal_toggles = array(

[27] Fix | Delete

'general' => array(

[28] Fix | Delete

'toggles' => array(

[29] Fix | Delete

'main_content' => et_builder_i18n( 'Content' ),

[30] Fix | Delete

'elements' => et_builder_i18n( 'Elements' ),

[31] Fix | Delete

[32] Fix | Delete

[33] Fix | Delete

'advanced' => array(

[34] Fix | Delete

'toggles' => array(

[35] Fix | Delete

'layout' => et_builder_i18n( 'Layout' ),

[36] Fix | Delete

// Avoid Text suffix by manually defining the `text` toggle slug.

[37] Fix | Delete

'text' => array(

[38] Fix | Delete

'title' => et_builder_i18n( 'Text' ),

[39] Fix | Delete

'priority' => 45,

[40] Fix | Delete

[41] Fix | Delete

// Avoid Text suffix by manually defining the `star` toggle slug.

[42] Fix | Delete

'star' => esc_html__( 'Star Rating', 'et_builder' ),

[43] Fix | Delete

[44] Fix | Delete

[45] Fix | Delete

);

[46] Fix | Delete

[47] Fix | Delete

$this->advanced_fields = array(

[48] Fix | Delete

'fonts' => array(

[49] Fix | Delete

'rating' => array(

[50] Fix | Delete

'label' => esc_html__( 'Star Rating', 'et_builder' ),

[51] Fix | Delete

'css' => array(

[52] Fix | Delete

'main' => '%%order_class%% .woocommerce-product-rating .star-rating',

[53] Fix | Delete

'color' => '%%order_class%% .woocommerce-product-rating .star-rating > span:before',

[54] Fix | Delete

'text_align' => '%%order_class%% .woocommerce-product-rating',

[55] Fix | Delete

[56] Fix | Delete

'font_size' => array(

[57] Fix | Delete

'default' => '14px',

[58] Fix | Delete

[59] Fix | Delete

'hide_font' => true,

[60] Fix | Delete

'hide_line_height' => true,

[61] Fix | Delete

'hide_text_shadow' => true,

[62] Fix | Delete

'text_align' => array(

[63] Fix | Delete

'label' => esc_html__( 'Star Rating Alignment', 'et_builder' ),

[64] Fix | Delete

[65] Fix | Delete

'font_size' => array(

[66] Fix | Delete

'label' => esc_html__( 'Star Rating Size', 'et_builder' ),

[67] Fix | Delete

[68] Fix | Delete

'text_color' => array(

[69] Fix | Delete

'label' => esc_html__( 'Star Rating Color', 'et_builder' ),

[70] Fix | Delete

[71] Fix | Delete

'toggle_slug' => 'star',

[72] Fix | Delete

[73] Fix | Delete

'body' => array(

[74] Fix | Delete

'label' => et_builder_i18n( 'Text' ),

[75] Fix | Delete

'css' => array(

[76] Fix | Delete

'main' => '%%order_class%% a.woocommerce-review-link',

[77] Fix | Delete

[78] Fix | Delete

'font_size' => array(

[79] Fix | Delete

'default' => '14px',

[80] Fix | Delete

[81] Fix | Delete

'line_height' => array(

[82] Fix | Delete

'default' => '1.7em',

[83] Fix | Delete

[84] Fix | Delete

'hide_text_align' => true,

[85] Fix | Delete

[86] Fix | Delete

[87] Fix | Delete

* Manually assign `text` toggle to avoid `Text Text` toggle defined by advanced

[88] Fix | Delete

* field font which automatically append ` Text` by default.

[89] Fix | Delete

[90] Fix | Delete

'toggle_slug' => 'text',

[91] Fix | Delete

[92] Fix | Delete

[93] Fix | Delete

'background' => array(

[94] Fix | Delete

'settings' => array(

[95] Fix | Delete

'color' => 'alpha',

[96] Fix | Delete

[97] Fix | Delete

[98] Fix | Delete

'margin_padding' => array(

[99] Fix | Delete

'css' => array(

[100] Fix | Delete

'important' => 'all',

[101] Fix | Delete

[102] Fix | Delete

'custom_margin' => array(

[103] Fix | Delete

'default' => '0em|0em|1.618em|0em|false|false',

[104] Fix | Delete

[105] Fix | Delete

[106] Fix | Delete

'text' => array(),

[107] Fix | Delete

'text_shadow' => array(

[108] Fix | Delete

// Don't add text-shadow fields since they already are via font-options.

[109] Fix | Delete

'default' => false,

[110] Fix | Delete

[111] Fix | Delete

'button' => false,

[112] Fix | Delete

);

[113] Fix | Delete

[114] Fix | Delete

$this->custom_css_fields = array(

[115] Fix | Delete

'text' => array(

[116] Fix | Delete

'label' => et_builder_i18n( 'Text' ),

[117] Fix | Delete

'selector' => 'a.woocommerce-review-link',

[118] Fix | Delete

[119] Fix | Delete

'star_rating_text' => array(

[120] Fix | Delete

'label' => esc_html__( 'Star Rating', 'et_builder' ),

[121] Fix | Delete

'selector' => '.woocommerce-product-rating .star-rating',

[122] Fix | Delete

[123] Fix | Delete

);

[124] Fix | Delete

[125] Fix | Delete

$this->help_videos = array(

[126] Fix | Delete

array(

[127] Fix | Delete

'id' => '7X03vBPYJ1o',

[128] Fix | Delete

'name' => esc_html__( 'Divi WooCommerce Modules', 'et_builder' ),

[129] Fix | Delete

[130] Fix | Delete

);

[131] Fix | Delete

}

[132] Fix | Delete

[133] Fix | Delete

/**

[134] Fix | Delete

* {@inheritdoc}

[135] Fix | Delete

[136] Fix | Delete

public function get_fields() {

[137] Fix | Delete

$fields = array(

[138] Fix | Delete

'product' => ET_Builder_Module_Helper_Woocommerce_Modules::get_field(

[139] Fix | Delete

'product',

[140] Fix | Delete

array(

[141] Fix | Delete

'default' => ET_Builder_Module_Helper_Woocommerce_Modules::get_product_default(),

[142] Fix | Delete

'computed_affects' => array(

[143] Fix | Delete

'__rating',

[144] Fix | Delete

[145] Fix | Delete

)

[146] Fix | Delete

[147] Fix | Delete

'product_filter' => ET_Builder_Module_Helper_Woocommerce_Modules::get_field(

[148] Fix | Delete

'product_filter',

[149] Fix | Delete

array(

[150] Fix | Delete

'computed_affects' => array(

[151] Fix | Delete

'__rating',

[152] Fix | Delete

[153] Fix | Delete

)

[154] Fix | Delete

[155] Fix | Delete

'show_rating' => array(

[156] Fix | Delete

'label' => esc_html__( 'Show Star Rating', 'et_builder' ),

[157] Fix | Delete

'type' => 'yes_no_button',

[158] Fix | Delete

'option_category' => 'configuration',

[159] Fix | Delete

'options' => array(

[160] Fix | Delete

'on' => et_builder_i18n( 'On' ),

[161] Fix | Delete

'off' => et_builder_i18n( 'Off' ),

[162] Fix | Delete

[163] Fix | Delete

'default_on_front' => 'on',

[164] Fix | Delete

'toggle_slug' => 'elements',

[165] Fix | Delete

'description' => esc_html__( 'Here you can choose whether the star rating should be added.', 'et_builder' ),

[166] Fix | Delete

'mobile_options' => true,

[167] Fix | Delete

'hover' => 'tabs',

[168] Fix | Delete

[169] Fix | Delete

'show_reviews_link' => array(

[170] Fix | Delete

'label' => esc_html__( 'Show Customer Reviews Count', 'et_builder' ),

[171] Fix | Delete

'type' => 'yes_no_button',

[172] Fix | Delete

'option_category' => 'configuration',

[173] Fix | Delete

'options' => array(

[174] Fix | Delete

'on' => et_builder_i18n( 'On' ),

[175] Fix | Delete

'off' => et_builder_i18n( 'Off' ),

[176] Fix | Delete

[177] Fix | Delete

'default_on_front' => 'on',

[178] Fix | Delete

'toggle_slug' => 'elements',

[179] Fix | Delete

'description' => esc_html__( 'Here you can choose whether the custom reviews link should be added.', 'et_builder' ),

[180] Fix | Delete

'mobile_options' => true,

[181] Fix | Delete

'hover' => 'tabs',

[182] Fix | Delete

[183] Fix | Delete

'layout' => array(

[184] Fix | Delete

'label' => esc_html__( 'Rating Layout', 'et_builder' ),

[185] Fix | Delete

'type' => 'select',

[186] Fix | Delete

'option_category' => 'layout',

[187] Fix | Delete

'options' => array(

[188] Fix | Delete

'inline' => esc_html__( 'Inline', 'et_builder' ),

[189] Fix | Delete

'stacked' => esc_html__( 'Stacked', 'et_builder' ),

[190] Fix | Delete

[191] Fix | Delete

'tab_slug' => 'advanced',

[192] Fix | Delete

'toggle_slug' => 'layout',

[193] Fix | Delete

'description' => esc_html__( 'Here you can choose where to place the reviews link.', 'et_builder' ),

[194] Fix | Delete

'default_on_front' => 'inline',

[195] Fix | Delete

[196] Fix | Delete

'__rating' => array(

[197] Fix | Delete

'type' => 'computed',

[198] Fix | Delete

'computed_callback' => array(

[199] Fix | Delete

'ET_Builder_Module_Woocommerce_Rating',

[200] Fix | Delete

'get_rating',

[201] Fix | Delete

[202] Fix | Delete

'computed_depends_on' => array(

[203] Fix | Delete

'product',

[204] Fix | Delete

'product_filter',

[205] Fix | Delete

[206] Fix | Delete

'computed_minimum' => array(

[207] Fix | Delete

'product',

[208] Fix | Delete

[209] Fix | Delete

[210] Fix | Delete

);

[211] Fix | Delete

[212] Fix | Delete

return $fields;

[213] Fix | Delete

}

[214] Fix | Delete

[215] Fix | Delete

/**

[216] Fix | Delete

* {@inheritdoc}

[217] Fix | Delete

[218] Fix | Delete

public function get_transition_fields_css_props() {

[219] Fix | Delete

$fields = parent::get_transition_fields_css_props();

[220] Fix | Delete

[221] Fix | Delete

$fields['rating_letter_spacing'] = array(

[222] Fix | Delete

'width' => '%%order_class%% .star-rating',

[223] Fix | Delete

'letter-spacing' => '%%order_class%% .star-rating',

[224] Fix | Delete

);

[225] Fix | Delete

[226] Fix | Delete

return $fields;

[227] Fix | Delete

}

[228] Fix | Delete

[229] Fix | Delete

/**

[230] Fix | Delete

* Get rating output

[231] Fix | Delete

[232] Fix | Delete

* @param array $args Additional arguments.

[233] Fix | Delete

[234] Fix | Delete

* @return string

[235] Fix | Delete

[236] Fix | Delete

public static function get_rating( $args = array() ) {

[237] Fix | Delete

$defaults = array(

[238] Fix | Delete

'product' => 'current',

[239] Fix | Delete

);

[240] Fix | Delete

$args = wp_parse_args( $args, $defaults );

[241] Fix | Delete

[242] Fix | Delete

if ( 'current' !== $args['product'] ) {

[243] Fix | Delete

// Enable comments via filter to render the reviews link.

[244] Fix | Delete

add_filter( 'comments_open', '__return_true' );

[245] Fix | Delete

}

[246] Fix | Delete

[247] Fix | Delete

$rating = et_builder_wc_render_module_template(

[248] Fix | Delete

'woocommerce_template_single_rating',

[249] Fix | Delete

$args,

[250] Fix | Delete

array( 'product', 'wp_query' )

[251] Fix | Delete

);

[252] Fix | Delete

[253] Fix | Delete

if ( 'current' !== $args['product'] ) {

[254] Fix | Delete

// Remove filter after module is rendered.

[255] Fix | Delete

remove_filter( 'comments_open', '__return_true' );

[256] Fix | Delete

}

[257] Fix | Delete

[258] Fix | Delete

return $rating;

[259] Fix | Delete

}

[260] Fix | Delete

[261] Fix | Delete

/**

[262] Fix | Delete

* Adds Multi view attributes to the Outer wrapper.

[263] Fix | Delete

[264] Fix | Delete

* Since we do not have control over the WooCommerce Rating markup, we inject Multi view

[265] Fix | Delete

* attributes on to the Outer wrapper.

[266] Fix | Delete

[267] Fix | Delete

* @param array $outer_wrapper_attrs

[268] Fix | Delete

[269] Fix | Delete

* @return array

[270] Fix | Delete

[271] Fix | Delete

public function add_multi_view_attrs( $outer_wrapper_attrs ) {

[272] Fix | Delete

$multi_view = et_pb_multi_view_options( $this );

[273] Fix | Delete

[274] Fix | Delete

$multi_view_attrs = $multi_view->render_attrs( array(

[275] Fix | Delete

'classes' => array(

[276] Fix | Delete

'et_pb_wc_rating_no_rating' => array(

[277] Fix | Delete

'show_rating' => 'off',

[278] Fix | Delete

[279] Fix | Delete

'et_pb_wc_rating_no_reviews' => array(

[280] Fix | Delete

'show_reviews_link' => 'off',

[281] Fix | Delete

[282] Fix | Delete

[283] Fix | Delete

), false, null, true );

[284] Fix | Delete

[285] Fix | Delete

if ( $multi_view_attrs && is_array( $multi_view_attrs ) ) {

[286] Fix | Delete

$outer_wrapper_attrs = array_merge( $outer_wrapper_attrs, $multi_view_attrs );

[287] Fix | Delete

}

[288] Fix | Delete

[289] Fix | Delete

return $outer_wrapper_attrs;

[290] Fix | Delete

}

[291] Fix | Delete

[292] Fix | Delete

/**

[293] Fix | Delete

* Renders the module output.

[294] Fix | Delete

[295] Fix | Delete

* @param array $attrs List of attributes.

[296] Fix | Delete

* @param string $content Content being processed.

[297] Fix | Delete

* @param string $render_slug Slug of module that is used for rendering output.

[298] Fix | Delete

[299] Fix | Delete

* @return string

[300] Fix | Delete

[301] Fix | Delete

public function render( $attrs, $content = null, $render_slug ) {

[302] Fix | Delete

ET_Builder_Module_Helper_Woocommerce_Modules::process_background_layout_data( $render_slug, $this );

[303] Fix | Delete

ET_Builder_Module_Helper_Woocommerce_Modules::add_star_rating_style(

[304] Fix | Delete

$render_slug,

[305] Fix | Delete

$this->props,

[306] Fix | Delete

'%%order_class%% .star-rating',

[307] Fix | Delete

'%%order_class%%:hover .star-rating',

[308] Fix | Delete

array( 'rating_letter_spacing' )

[309] Fix | Delete

);

[310] Fix | Delete

[311] Fix | Delete

$this->add_classname( $this->get_text_orientation_classname() );

[312] Fix | Delete

[313] Fix | Delete

// Add classes to hide disabled elements.

[314] Fix | Delete

if ( 'on' !== $this->props['show_rating'] ) {

[315] Fix | Delete

$this->add_classname( 'et_pb_wc_rating_no_rating' );

[316] Fix | Delete

}

[317] Fix | Delete

[318] Fix | Delete

if ( 'on' !== $this->props['show_reviews_link'] ) {

[319] Fix | Delete

$this->add_classname( 'et_pb_wc_rating_no_reviews' );

[320] Fix | Delete

}

[321] Fix | Delete

[322] Fix | Delete

if ( ! empty( $this->props['layout'] ) ) {

[323] Fix | Delete

$this->add_classname( "et_pb_wc_rating_layout_{$this->props['layout']}" );

[324] Fix | Delete

}

[325] Fix | Delete

[326] Fix | Delete

add_filter( "et_builder_module_{$render_slug}_outer_wrapper_attrs", array(

[327] Fix | Delete

$this,

[328] Fix | Delete

'add_multi_view_attrs',

[329] Fix | Delete

) );

[330] Fix | Delete

[331] Fix | Delete

$output = self::get_rating( $this->props );

[332] Fix | Delete

[333] Fix | Delete

// Render empty string if no output is generated to avoid unwanted vertical space.

[334] Fix | Delete

if ( '' === $output ) {

[335] Fix | Delete

return '';

[336] Fix | Delete

}

[337] Fix | Delete

[338] Fix | Delete

return $this->_render_module_wrapper( $output, $render_slug );

[339] Fix | Delete

}

[340] Fix | Delete

}

[341] Fix | Delete

[342] Fix | Delete

new ET_Builder_Module_Woocommerce_Rating();

[343] Fix | Delete

[344] Fix | Delete