WooCommerce Code Reference

BlockString
in package

Tags
see
BlockStringTest

Table of Contents

dedentBlockStringLines()  : string
Produces the value of a block string from its parsed raw value, similar to CoffeeScript's block string, Python's docstring trim or Ruby's strip_heredoc.
getIndentation()  : int
print()  : string
Print a block string in the indented block form by adding a leading and trailing blank line. However, if a block string starts with whitespace and is a single-line, adding a leading blank line would strip that whitespace.
isBlank()  : bool

Methods

dedentBlockStringLines()

Produces the value of a block string from its parsed raw value, similar to CoffeeScript's block string, Python's docstring trim or Ruby's strip_heredoc.

public static dedentBlockStringLines(string $rawString) : string

This implements the Automattic\WooCommerce\Vendor\GraphQL spec's BlockStringValue() static algorithm.

Parameters
$rawString : string
Return values
string

print()

Print a block string in the indented block form by adding a leading and trailing blank line. However, if a block string starts with whitespace and is a single-line, adding a leading blank line would strip that whitespace.

public static print(string $value) : string
Parameters
$value : string
Return values
string