bp_xprofile_admin_get_signup_field( BP_XProfile_Field $signup_field, object $field_group = null, string $class = '', bool $echo = false )

Handles the WYSIWYG display of signup profile fields on the edit screen.

Parameters Parameters


(BP_XProfile_Field) (Required) The field to use into the signup form.


(object) (Optional) The real field group object.

Default value: null


(string) (Optional) Classes to append to output.

Default value: ''


(bool) (Optional) Whether to return or display the HTML output.

Default value: false

Top ↑

Return Return

(string) The HTML output.

Source Source

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

function bp_xprofile_admin_get_signup_field( $signup_field, $field_group = null, $class = '', $echo = false ) {
	add_filter( 'bp_get_the_profile_field_input_name', 'bp_get_the_profile_signup_field_input_name' );

	if ( ! $echo ) {
		// Set up an output buffer.
		xprofile_admin_field( $signup_field, $field_group, $class, true );
		$output = ob_get_contents();
	} else {
		xprofile_admin_field( $signup_field, $field_group, $class, true );

	remove_filter( 'bp_get_the_profile_field_input_name', 'bp_get_the_profile_signup_field_input_name' );

	if ( ! $echo ) {
		return $output;

Top ↑

Changelog Changelog

Version Description
8.0.0 Introduced.

Top ↑

User Contributed Notes User Contributed Notes

You must log in before being able to contribute a note or feedback.