BP_XProfile_Field_Type_Textarea::edit_field_html( array $raw_properties = array() )
Output the edit field HTML for this field type.
Description
Must be used inside the bp_profile_fields() template loop.
Parameters
- $raw_properties
-
(Optional) key/value array of permitted attributes that you want to add.
Default value: array()
Source
File: bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php
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 if ( bp_is_register_page() ) : ?>
<?php bp_the_profile_field_optional_label(); ?>
<?php else: ?>
<?php bp_the_profile_field_required_label(); ?>
<?php endif; ?>
</legend>
<?php 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;
/** 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 BuddyPress 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
);
}
}
Changelog
| Version | Description |
|---|---|
| BuddyPress 2.0.0 | Introduced. |
Questions?
We're always happy to help with code or other questions you might have! Search our developer docs, contact support, or connect with our sales team.