Contents

Code Reference Functions bp_xprofile_is_richtext_enabled_for_field()

bp_xprofile_is_richtext_enabled_for_field( int|null $field_id = null )

Is rich text enabled for this profile field?

Description

By default, rich text is enabled for textarea fields and disabled for all other field types.

Parameters

$field_id

(Optional) Default current field ID.

Default value: null

Return

(bool)

Source

File: bp-xprofile/bp-xprofile-functions.php 

function bp_xprofile_is_richtext_enabled_for_field( $field_id = null ) {
	if ( ! $field_id ) {
		$field_id = bp_get_the_profile_field_id();
	}

	$field = xprofile_get_field( $field_id );

	$enabled = false;
	if ( $field instanceof BP_XProfile_Field ) {
		$enabled = (bool) $field->type_obj->supports_richtext;
	}

	/**
	 * Filters whether richtext is enabled for the given field.
	 *
	 * @since BuddyPress 2.4.0
	 *
	 * @param bool $enabled  True if richtext is enabled for the field, otherwise false.
	 * @param int  $field_id ID of the field.
	 */
	return apply_filters( 'bp_xprofile_is_richtext_enabled_for_field', $enabled, $field_id );
}

Expand full source code Collapse full source code

Changelog

Changelog
Version Description
BuddyPress 2.4.0 Introduced.
Used By
Used By Description
bp-xprofile/bp-xprofile-filters.php: xprofile_filter_kses()

Run profile field values through kses with filterable allowed tags.
bp-xprofile/bp-xprofile-filters.php: bp_xprofile_escape_field_data()

Escape field value for display.
bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php: BP_XProfile_Field_Type_Textarea::edit_field_html()

Output the edit field HTML for this field type.
bp-xprofile/classes/class-bp-xprofile-field-type-textarea.php: BP_XProfile_Field_Type_Textarea::admin_field_html()

Output HTML for this field type on the wp-admin Profile Fields screen.

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.