balanceTags( string $text, bool $force = false )

Balances tags if forced to, or if the ‘use_balanceTags’ option is set to true.

Description

Parameters

$text

(string) (Required) Text to be balanced

$force

(bool) (Optional) If true, forces balancing, ignoring the value of the option.

Default value: false

Top ↑

Return

(string) Balanced text

Top ↑

Source

File: wp-includes/formatting.php 

function balanceTags( $text, $force = false ) {  // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
	if ( $force || (int) get_option( 'use_balanceTags' ) === 1 ) {
		return force_balance_tags( $text );
	} else {
		return $text;
	}
}

View on Trac

Top ↑

Changelog

Version Description
0.71 Introduced.

Top ↑

Top ↑

Uses

Uses Description
wp-includes/formatting.php: force_balance_tags()

Balances tags of string using a modified stack.
wp-includes/option.php: get_option()

Retrieves an option value based on an option name.