BP_XProfile_Field_Type_Textarea
Textarea xprofile field type.
Description Description
Source Source
File: bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php
18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 | class BP_XProfile_Field_Type_Textarea extends BP_XProfile_Field_Type { /** * Constructor for the textarea field type. * * @since 2.0.0 */ public function __construct() { parent::__construct(); $this->category = _x( 'Single Fields', 'xprofile field type category', 'buddypress' ); $this->name = _x( 'Multi-line Text Area', 'xprofile field type', 'buddypress' ); $this->supports_richtext = true; $this->set_format( '/^.*$/m', 'replace' ); /** * Fires inside __construct() method for BP_XProfile_Field_Type_Textarea class. * * @since 2.0.0 * * @param BP_XProfile_Field_Type_Textarea $this Current instance of * the field type textarea. */ do_action( 'bp_xprofile_field_type_textarea', $this ); } /** * Output the edit field HTML for this field type. * * Must be used inside the {@link bp_profile_fields()} template loop. * * @since 2.0.0 * * @param array $raw_properties Optional key/value array of * {@link http://dev.w3.org/html5/markup/textarea.html permitted attributes} * that you want to add. */ public function edit_field_html( array $raw_properties = array() ) { // User_id is a special optional parameter that certain other fields // types pass to {@link bp_the_profile_field_options()}. if ( isset( $raw_properties['user_id'] ) ) { unset( $raw_properties['user_id'] ); } $richtext_enabled = bp_xprofile_is_richtext_enabled_for_field(); ?> <legend id="<?php bp_the_profile_field_input_name(); ?>-1"> <?php bp_the_profile_field_name(); ?> <?php bp_the_profile_field_required_label(); ?> </legend> <?php /** This action is documented in bp-xprofile/bp-xprofile-classes */ do_action( bp_get_the_profile_field_errors_action() ); if ( ! $richtext_enabled ) { $r = wp_parse_args( $raw_properties, array( 'cols' => 40, 'rows' => 5, ) ); ?> <textarea <?php echo $this->get_edit_field_html_elements( $r ); ?> aria-labelledby="<?php bp_the_profile_field_input_name(); ?>-1" aria-describedby="<?php bp_the_profile_field_input_name(); ?>-3"><?php bp_the_profile_field_edit_value(); ?></textarea> <?php } else { /** * Filters the arguments passed to `wp_editor()` in richtext xprofile fields. * * @since 2.4.0 * * @param array $args { * Array of optional arguments. See `wp_editor()`. * @type bool $teeny Whether to use the teeny version of TinyMCE. Default true. * @type bool $media_buttons Whether to show media buttons. Default false. * @type bool $quicktags Whether to show the quicktags buttons. Default true. * @type int $textarea_rows Number of rows to display in the editor. Defaults to 1 in the * 'admin' context, and 10 in the 'edit' context. * } * @param string $context The display context. 'edit' when the markup is intended for the * profile edit screen, 'admin' when intended for the Profile Fields * Dashboard panel. */ $editor_args = apply_filters( 'bp_xprofile_field_type_textarea_editor_args', array( 'teeny' => true, 'media_buttons' => false, 'quicktags' => true, 'textarea_rows' => 10, ), 'edit' ); wp_editor( bp_get_the_profile_field_edit_value(), bp_get_the_profile_field_input_name(), $editor_args ); } if ( bp_get_the_profile_field_description() ) : ?> <p class="description" id="<?php bp_the_profile_field_input_name(); ?>-3"><?php bp_the_profile_field_description(); ?></p> <?php endif; } /** * Output HTML for this field type on the wp-admin Profile Fields screen. * * Must be used inside the {@link bp_profile_fields()} template loop. * * @since 2.0.0 * * @param array $raw_properties Optional key/value array of permitted attributes that you want to add. */ public function admin_field_html( array $raw_properties = array() ) { $richtext_enabled = bp_xprofile_is_richtext_enabled_for_field(); if ( ! $richtext_enabled ) { $r = bp_parse_args( $raw_properties, array( 'cols' => 40, 'rows' => 5, ) ); ?> <textarea <?php echo $this->get_edit_field_html_elements( $r ); ?>></textarea> <?php } else { /** This filter is documented in bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php */ $editor_args = apply_filters( 'bp_xprofile_field_type_textarea_editor_args', array( 'teeny' => true, 'media_buttons' => false, 'quicktags' => true, 'textarea_rows' => 1, ), 'admin' ); wp_editor( '', 'xprofile_textarea_' . bp_get_the_profile_field_id(), $editor_args ); } } /** * This method usually outputs HTML for this field type's children options on the wp-admin Profile Fields * "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out. * * @since 2.0.0 * * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen. * @param string $control_type Optional. HTML input type used to render the current * field's child options. */ public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}} |
Changelog Changelog
| Version | Description |
|---|---|
| 2.0.0 | Introduced. |
Methods Methods
- __construct — Constructor for the textarea field type.
- admin_field_html — Output HTML for this field type on the wp-admin Profile Fields screen.
- admin_new_field_html — This method usually outputs HTML for this field type's children options on the wp-admin Profile Fields "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out.
- edit_field_html — Output the edit field HTML for this field type.