Automattic\WooCommerce\Internal\Admin\Settings

SettingsUISchema::get_field_description │ private static │ WC 1.0

Get a field description.

Method of the class: SettingsUISchema{}

No Hooks.

Returns

String.

Usage

$result = SettingsUISchema::get_field_description( $setting, $type ): string;

$setting(array) (required)

Legacy field definition.

$type(string) (required)

Raw field type.

SettingsUISchema::get_field_description() SettingsUISchema::get field description code ^{WC 10.9.1}

private static function get_field_description( array $setting, string $type ): string {
	$description = 'checkbox' === $type || ! isset( $setting['desc'] ) || ! is_scalar( $setting['desc'] )
		? ''
		: wp_kses_post( (string) $setting['desc'] );

	$desc_tip = isset( $setting['desc_tip'] ) && is_string( $setting['desc_tip'] ) && '' !== $setting['desc_tip']
		? wp_kses_post( $setting['desc_tip'] )
		: '';

	if ( '' === $description ) {
		return $desc_tip;
	}

	if ( '' === $desc_tip ) {
		return $description;
	}

	return $description . '<br />' . $desc_tip;
}