BP_XProfile_Field_Type_Multiselectbox::edit_field_options_html( array $args = array() )
Output the edit field options HTML for this field type.
Description
BuddyPress considers a field’s "options" to be, for example, the items in a selectbox. These are stored separately in the database, and their templating is handled separately.
This templating is separate from BP_XProfile_Field_Type::edit_field_html() because it’s also used in the wp-admin screens when creating new fields, and for backwards compatibility.
Must be used inside the bp_profile_fields() template loop.
Parameters
- $args
-
(Optional) The arguments passed to bp_the_profile_field_options().
Default value: array()
Source
File: bp-xprofile/classes/class-bp-xprofile-field-type-multiselectbox.php
public function edit_field_options_html( array $args = array() ) {
$original_option_values = maybe_unserialize( BP_XProfile_ProfileData::get_value_byid( $this->field_obj->id, $args['user_id'] ) );
$options = $this->field_obj->get_children();
$html = '';
if ( empty( $original_option_values ) && ! empty( $_POST['field_' . $this->field_obj->id] ) ) {
$original_option_values = sanitize_text_field( $_POST['field_' . $this->field_obj->id] );
}
$option_values = ( $original_option_values ) ? (array) $original_option_values : array();
for ( $k = 0, $count = count( $options ); $k < $count; ++$k ) {
$selected = '';
// Check for updated posted values, but errors preventing them from
// being saved first time.
foreach( $option_values as $i => $option_value ) {
if ( isset( $_POST['field_' . $this->field_obj->id] ) && $_POST['field_' . $this->field_obj->id][$i] != $option_value ) {
if ( ! empty( $_POST['field_' . $this->field_obj->id][$i] ) ) {
$option_values[] = sanitize_text_field( $_POST['field_' . $this->field_obj->id][$i] );
}
}
}
// Run the allowed option name through the before_save filter, so
// we'll be sure to get a match.
$allowed_options = xprofile_sanitize_data_value_before_save( $options[$k]->name, false, false );
// First, check to see whether the user-entered value matches.
if ( in_array( $allowed_options, $option_values ) ) {
$selected = ' selected="selected"';
}
// Then, if the user has not provided a value, check for defaults.
if ( ! is_array( $original_option_values ) && empty( $option_values ) && ! empty( $options[$k]->is_default_option ) ) {
$selected = ' selected="selected"';
}
/**
* Filters the HTML output for options in a multiselect input.
*
* @since BuddyPress 1.5.0
*
* @param string $value Option tag for current value being rendered.
* @param object $value Current option being rendered for.
* @param int $id ID of the field object being rendered.
* @param string $selected Current selected value.
* @param string $k Current index in the foreach loop.
*/
$html .= apply_filters( 'bp_get_the_profile_field_options_multiselect', '<option' . $selected . ' value="' . esc_attr( stripslashes( $options[$k]->name ) ) . '">' . esc_html( stripslashes( $options[$k]->name ) ) . '</option>', $options[$k], $this->field_obj->id, $selected, $k );
}
echo $html;
}
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.