Skip to content

Commit 3d51693

Browse files
committed
Update Text helper documentation to replace 'has_textarea' with 'wpautop' parameter for improved clarity and functionality.
1 parent 841ae37 commit 3d51693

1 file changed

Lines changed: 9 additions & 9 deletions

File tree

inc/Helpers/Formatting/Text.php

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
/**
77
* @usage BEA\Theme\Framework\Helpers\Formatting\Text\the_text( $text, [ 'before' => '<p>', 'after' => '</p>' ] );
8-
* @usage BEA\Theme\Framework\Helpers\Formatting\Text\the_text( $text, [ 'has_textarea' => true, 'before' => '<div>', 'after' => '</div>' ] );
8+
* @usage BEA\Theme\Framework\Helpers\Formatting\Text\the_text( $text, [ 'wpautop' => true, 'before' => '<div>', 'after' => '</div>' ] );
99
*
1010
* @param string $value Text to display
1111
* @param array $settings {
@@ -14,7 +14,7 @@
1414
* @type string $before Optional. Markup to prepend to the text. Default empty.
1515
* @type string $after Optional. Markup to append after the text. Default empty.
1616
* @type string $escape Optional. Escape callback name (e.g. esc_html, wp_kses_post). Default esc_html.
17-
* @type bool $has_textarea Optional. When true, uses wp_kses_post if escape is still the default esc_html, then wpautop(). Default false.
17+
* @type bool $wpautop Optional. When true, uses wp_kses_post if escape is still the default esc_html, then wpautop(). Default false.
1818
*
1919
* }
2020
*
@@ -35,7 +35,7 @@ function the_text( string $value, array $settings = [] ): void {
3535
* @type string $before Optional. Markup to prepend to the text. Default empty.
3636
* @type string $after Optional. Markup to append after the text. Default empty.
3737
* @type string $escape Optional. Escape callback name (e.g. esc_html, wp_kses_post). Default esc_html.
38-
* @type bool $has_textarea Optional. When true, uses wp_kses_post if escape is still the default esc_html, then wpautop(). Default false.
38+
* @type bool $wpautop Optional. When true, uses wp_kses_post if escape is still the default esc_html, then wpautop(). Default false.
3939
*
4040
* }
4141
*
@@ -49,22 +49,22 @@ function get_the_text( string $value, array $settings = [] ): string {
4949
$settings = wp_parse_args(
5050
$settings,
5151
[
52-
'before' => '',
53-
'after' => '',
54-
'escape' => 'esc_html',
55-
'has_textarea' => false,
52+
'before' => '',
53+
'after' => '',
54+
'escape' => 'esc_html',
55+
'wpautop' => false,
5656
]
5757
);
5858

5959
$settings = apply_filters( 'bea_theme_framework_text_settings', $settings, $value );
6060

61-
if ( ! empty( $settings['has_textarea'] ) && 'esc_html' === $settings['escape'] ) {
61+
if ( ! empty( $settings['wpautop'] ) && 'esc_html' === $settings['escape'] ) {
6262
$settings['escape'] = 'wp_kses_post';
6363
}
6464

6565
$value = escape_content_value( $value, $settings['escape'] );
6666

67-
if ( ! empty( $settings['has_textarea'] ) ) {
67+
if ( ! empty( $settings['wpautop'] ) ) {
6868
$value = wpautop( $value );
6969
}
7070

0 commit comments

Comments
 (0)