Automattic\WooCommerce\StoreApi\Formatters

HtmlFormatter{} │ WC 1.0└─ FormatterInterface

Html Formatter.

Formats HTML in API responses.

No Hooks.

Usage

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

Methods

1. public format( $value, array $options = [] )

HtmlFormatter{} HtmlFormatter{} code ^{WC 10.7.0}

class HtmlFormatter implements FormatterInterface {
	/**
	 * Format a given value and return the result.
	 *
	 * The wptexturize, convert_chars, and trim functions are also used in the `the_title` filter.
	 * The function wp_kses_post removes disallowed HTML tags.
	 *
	 * @param string|array $value Value to format.
	 * @param array        $options Options that influence the formatting.
	 * @return string
	 */
	public function format( $value, array $options = [] ) {
		if ( is_array( $value ) ) {
			return array_map( [ $this, 'format' ], $value );
		}
		return is_scalar( $value ) ? wp_kses_post( trim( convert_chars( wptexturize( $value ) ) ) ) : $value;
	}
}