Automattic\WooCommerce\EmailEditor\Integrations\Core\Renderer\Blocks

Quote{} │ WC 1.0└─ Abstract_Block_Renderer

Renders a quote block.

No Hooks.

Usage

$Quote = new Quote();
// use class methods

Methods

`Quote{} Quote{}` code ^{WC 10.9.1}

woocommerce/packages/email-editor/src/Integrations/Core/Renderer/Blocks/class-quote.php

class Quote extends Abstract_Block_Renderer {
	/**
	 * Renders the block content
	 *
	 * @param string            $block_content Block content.
	 * @param array             $parsed_block Parsed block.
	 * @param Rendering_Context $rendering_context Rendering context.
	 * @return string
	 */
	protected function render_content( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string {
		$dom_helper = new Dom_Document_Helper( $block_content );

		// Extract citation if present, then remove it from the DOM so it isn't
		// also rendered inline as part of the quote content below.
		$citation_content = '';
		$cite_element     = $dom_helper->find_element( 'cite' );
		if ( $cite_element ) {
			$citation_content = $this->get_citation_wrapper(
				$dom_helper->get_element_inner_html( $cite_element ),
				$parsed_block,
				$rendering_context
			);
			if ( $cite_element->parentNode ) { // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
				$cite_element->parentNode->removeChild( $cite_element ); // phpcs:ignore WordPress.NamingConventions.ValidVariableName.UsedPropertyNotSnakeCase
			}
		}

		// Strip the <blockquote> tag and keep its children. The visual quote indent
		// comes from the email-block-quote table built in get_block_wrapper(); keeping
		// the original blockquote would render a double-bordered quote-within-a-quote.
		// Children have already been re-wrapped in <table>…<div class="email-block-layout">…</div>…</table>
		// by the email editor's per-block render filter, so passing 'div' (the previous default)
		// would only return the first child's inner HTML and drop the rest.
		$blockquote_element = $dom_helper->find_element( 'blockquote' );
		$quote_content      = $blockquote_element
			? $dom_helper->get_element_inner_html( $blockquote_element )
			: $block_content;

		return str_replace(
			array( '{quote_content}', '{citation_content}' ),
			array( $quote_content, $citation_content ),
			$this->get_block_wrapper( $block_content, $parsed_block, $rendering_context )
		);
	}

	/**
	 * Returns the citation content with a wrapper.
	 *
	 * @param string            $citation_content The citation text.
	 * @param array             $parsed_block Parsed block.
	 * @param Rendering_Context $rendering_context Rendering context instance.
	 * @return string The wrapped citation HTML or empty string if no citation.
	 */
	private function get_citation_wrapper( string $citation_content, array $parsed_block, Rendering_Context $rendering_context ): string {
		if ( empty( $citation_content ) ) {
			return '';
		}

		// The HTML cite tag should use block gap as margin-top.
		$theme_styles    = $rendering_context->get_theme_styles();
		$margin_top      = $theme_styles['spacing']['blockGap'] ?? '0px';
		$citation_styles = Styles_Helper::get_block_styles( $parsed_block['attrs'], $rendering_context, array( 'text-align' ) );
		$citation_styles = Styles_Helper::extend_block_styles( $citation_styles, array( 'margin' => "{$margin_top} 0px 0px 0px" ) );

		return $this->add_spacer_with_context(
			sprintf(
				'<p style="%2$s"><cite class="email-block-quote-citation" style="display: block; margin: 0;">%1$s</cite></p>',
				$citation_content,
				$citation_styles['css'],
			),
			$parsed_block['email_attrs'] ?? array(),
			$rendering_context
		);
	}

	/**
	 * Returns the block wrapper.
	 *
	 * @param string            $block_content Block content.
	 * @param array             $parsed_block Parsed block.
	 * @param Rendering_Context $rendering_context Rendering context.
	 */
	private function get_block_wrapper( string $block_content, array $parsed_block, Rendering_Context $rendering_context ): string {
		$original_classname = ( new Dom_Document_Helper( $block_content ) )->get_attribute_value_by_tag_name( 'blockquote', 'class' ) ?? '';
		$block_attributes   = wp_parse_args(
			$parsed_block['attrs'] ?? array(),
			array(
				'style'           => array(),
				'backgroundColor' => '',
				'textColor'       => '',
				'borderColor'     => '',
			)
		);

		// Layout, background, borders need to be on the outer table element.
		$table_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'border', 'background', 'background-color', 'color', 'text-align' ) );
		if ( $rendering_context->is_rtl() && ! $this->has_authored_border( $block_attributes ) ) {
			$authored_alignment = $this->get_authored_alignment( $block_attributes, $original_classname );
			$border_width       = array(
				'left'   => '0 0 0 1px',
				'center' => '0',
				'right'  => '0 1px 0 0',
			)[ $authored_alignment ?? 'right' ];
			$table_styles       = Styles_Helper::extend_block_styles(
				$table_styles,
				array_filter(
					array(
						'border-color'  => 'currentColor',
						'border-style'  => 'solid',
						'border-width'  => $border_width,
						'border-inline' => 'center' === $authored_alignment ? '0' : null,
					),
					static function ( $value ) {
						return null !== $value;
					}
				)
			);
		}
		$table_styles = Styles_Helper::extend_block_styles(
			$table_styles,
			array(
				'border-collapse' => 'separate',
				'background-size' => $table_styles['declarations']['background-size'] ?? 'cover',
			)
		);

		// Padding properties need to be added to the table cell.
		$cell_styles = Styles_Helper::get_block_styles( $block_attributes, $rendering_context, array( 'padding' ) );

		$table_attrs = array(
			'class' => 'email-block-quote ' . $original_classname,
			'style' => $table_styles['css'],
			'width' => '100%',
		);

		$cell_attrs = array(
			'class' => 'email-block-quote-content',
			'style' => $cell_styles['css'],
			'width' => '100%',
		);

		return Table_Wrapper_Helper::render_table_wrapper( '{quote_content}{citation_content}', $table_attrs, $cell_attrs );
	}

	/**
	 * Get explicit quote alignment when authored.
	 *
	 * @param array  $block_attributes Block attributes.
	 * @param string $original_classname Original quote classes.
	 * @return string|null
	 */
	private function get_authored_alignment( array $block_attributes, string $original_classname ): ?string {
		foreach ( array( 'textAlign', 'align' ) as $attribute_name ) {
			$alignment = $block_attributes[ $attribute_name ] ?? null;
			if ( in_array( $alignment, array( 'left', 'center', 'right' ), true ) ) {
				return $alignment;
			}
		}

		foreach ( wp_parse_list( $original_classname ) as $class_name ) {
			if ( 0 !== strpos( $class_name, 'has-text-align-' ) ) {
				continue;
			}

			$alignment = substr( $class_name, strlen( 'has-text-align-' ) );
			if ( in_array( $alignment, array( 'left', 'center', 'right' ), true ) ) {
				return $alignment;
			}
		}

		return null;
	}

	/**
	 * Check whether quote border was explicitly authored.
	 *
	 * @param array $block_attributes Block attributes.
	 * @return bool
	 */
	private function has_authored_border( array $block_attributes ): bool {
		return ! empty( $block_attributes['style']['border'] ) || ! empty( $block_attributes['borderColor'] );
	}
}

Quote{} │ WC 1.0└─ Abstract_Block_Renderer

Usage

Methods

Quote{} Quote{} code WC 10.9.1

`Quote{} Quote{}` code ^{WC 10.9.1}