123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263 |
- <?php
- if ( ! class_exists( 'acf_field_textarea' ) ) :
- class acf_field_textarea extends acf_field {
- /*
- * initialize
- *
- * This function will setup the field type data
- *
- * @type function
- * @date 5/03/2014
- * @since 5.0.0
- *
- * @param n/a
- * @return n/a
- */
- function initialize() {
- // vars
- $this->name = 'textarea';
- $this->label = __( 'Text Area', 'acf' );
- $this->defaults = array(
- 'default_value' => '',
- 'new_lines' => '',
- 'maxlength' => '',
- 'placeholder' => '',
- 'rows' => '',
- );
- }
- /*
- * render_field()
- *
- * Create the HTML interface for your field
- *
- * @param $field - an array holding all the field's data
- *
- * @type action
- * @since 3.6
- * @date 23/01/13
- */
- function render_field( $field ) {
- // vars
- $atts = array();
- $keys = array( 'id', 'class', 'name', 'value', 'placeholder', 'rows', 'maxlength' );
- $keys2 = array( 'readonly', 'disabled', 'required' );
- // rows
- if ( ! $field['rows'] ) {
- $field['rows'] = 8;
- }
- // atts (value="123")
- foreach ( $keys as $k ) {
- if ( isset( $field[ $k ] ) ) {
- $atts[ $k ] = $field[ $k ];
- }
- }
- // atts2 (disabled="disabled")
- foreach ( $keys2 as $k ) {
- if ( ! empty( $field[ $k ] ) ) {
- $atts[ $k ] = $k;
- }
- }
- // remove empty atts
- $atts = acf_clean_atts( $atts );
- // return
- acf_textarea_input( $atts );
- }
- /*
- * render_field_settings()
- *
- * Create extra options for your field. This is rendered when editing a field.
- * The value of $field['name'] can be used (like bellow) to save extra data to the $field
- *
- * @param $field - an array holding all the field's data
- *
- * @type action
- * @since 3.6
- * @date 23/01/13
- */
- function render_field_settings( $field ) {
- acf_render_field_setting(
- $field,
- array(
- 'label' => __( 'Default Value', 'acf' ),
- 'instructions' => __( 'Appears when creating a new post', 'acf' ),
- 'type' => 'textarea',
- 'name' => 'default_value',
- )
- );
- }
- /**
- * Renders the field settings used in the "Validation" tab.
- *
- * @since 6.0
- *
- * @param array $field The field settings array.
- * @return void
- */
- function render_field_validation_settings( $field ) {
- acf_render_field_setting(
- $field,
- array(
- 'label' => __( 'Character Limit', 'acf' ),
- 'instructions' => __( 'Leave blank for no limit', 'acf' ),
- 'type' => 'number',
- 'name' => 'maxlength',
- )
- );
- }
- /**
- * Renders the field settings used in the "Presentation" tab.
- *
- * @since 6.0
- *
- * @param array $field The field settings array.
- * @return void
- */
- function render_field_presentation_settings( $field ) {
- acf_render_field_setting(
- $field,
- array(
- 'label' => __( 'Rows', 'acf' ),
- 'instructions' => __( 'Sets the textarea height', 'acf' ),
- 'type' => 'number',
- 'name' => 'rows',
- 'placeholder' => 8,
- )
- );
- acf_render_field_setting(
- $field,
- array(
- 'label' => __( 'Placeholder Text', 'acf' ),
- 'instructions' => __( 'Appears within the input', 'acf' ),
- 'type' => 'text',
- 'name' => 'placeholder',
- )
- );
- acf_render_field_setting(
- $field,
- array(
- 'label' => __( 'New Lines', 'acf' ),
- 'instructions' => __( 'Controls how new lines are rendered', 'acf' ),
- 'type' => 'select',
- 'name' => 'new_lines',
- 'choices' => array(
- 'wpautop' => __( 'Automatically add paragraphs', 'acf' ),
- 'br' => __( 'Automatically add <br>', 'acf' ),
- '' => __( 'No Formatting', 'acf' ),
- ),
- )
- );
- }
- /*
- * format_value()
- *
- * This filter is applied to the $value after it is loaded from the db and before it is returned to the template
- *
- * @type filter
- * @since 3.6
- * @date 23/01/13
- *
- * @param $value (mixed) the value which was loaded from the database
- * @param $post_id (mixed) the $post_id from which the value was loaded
- * @param $field (array) the field array holding all the field options
- *
- * @return $value (mixed) the modified value
- */
- function format_value( $value, $post_id, $field ) {
- // bail early if no value or not for template
- if ( empty( $value ) || ! is_string( $value ) ) {
- return $value;
- }
- // new lines
- if ( $field['new_lines'] == 'wpautop' ) {
- $value = wpautop( $value );
- } elseif ( $field['new_lines'] == 'br' ) {
- $value = nl2br( $value );
- }
- // return
- return $value;
- }
- /**
- * validate_value
- *
- * Validates a field's value.
- *
- * @date 29/1/19
- * @since 5.7.11
- *
- * @param (bool|string) Whether the value is vaid or not.
- * @param mixed $value The field value.
- * @param array $field The field array.
- * @param string $input The HTML input name.
- * @return (bool|string)
- */
- function validate_value( $valid, $value, $field, $input ) {
- // Check maxlength.
- if ( $field['maxlength'] && ( acf_strlen( $value ) > $field['maxlength'] ) ) {
- return sprintf( __( 'Value must not exceed %d characters', 'acf' ), $field['maxlength'] );
- }
- // Return.
- return $valid;
- }
- /**
- * Return the schema array for the REST API.
- *
- * @param array $field
- * @return array
- */
- function get_rest_schema( array $field ) {
- $schema = parent::get_rest_schema( $field );
- if ( ! empty( $field['maxlength'] ) ) {
- $schema['maxLength'] = (int) $field['maxlength'];
- }
- return $schema;
- }
- }
- // initialize
- acf_register_field_type( 'acf_field_textarea' );
- endif; // class_exists check
|