BP_XProfile_Field_Type_Multiselectbox
Multi-selectbox xprofile field type.
Description Description
Source Source
File: bp-xprofile/classes/class-bp-xprofile-field-type-multiselectbox.php
class BP_XProfile_Field_Type_Multiselectbox extends BP_XProfile_Field_Type { /** * Constructor for the multi-selectbox field type. * * @since 2.0.0 */ public function __construct() { parent::__construct(); $this->category = _x( 'Multi Fields', 'xprofile field type category', 'buddypress' ); $this->name = _x( 'Multi Select Box', 'xprofile field type', 'buddypress' ); $this->supports_multiple_defaults = true; $this->accepts_null_value = true; $this->supports_options = true; $this->set_format( '/^.+$/', 'replace' ); /** * Fires inside __construct() method for BP_XProfile_Field_Type_Multiselectbox class. * * @since 2.0.0 * * @param BP_XProfile_Field_Type_Multiselectbox $this Current instance of * the field type multiple select box. */ do_action( 'bp_xprofile_field_type_multiselectbox', $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/select.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 we pass to // {@link bp_the_profile_field_options()}. if ( isset( $raw_properties['user_id'] ) ) { $user_id = (int) $raw_properties['user_id']; unset( $raw_properties['user_id'] ); } else { $user_id = bp_displayed_user_id(); } $r = bp_parse_args( $raw_properties, array( 'multiple' => 'multiple', 'id' => bp_get_the_profile_field_input_name() . '[]', 'name' => bp_get_the_profile_field_input_name() . '[]', ) ); ?> <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() ); ?> <select <?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_options( array( 'user_id' => $user_id ) ); ?> </select> <?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; ?> <?php if ( ! bp_get_the_profile_field_is_required() ) : ?> <a class="clear-value" href="javascript:clear( '<?php echo esc_js( bp_get_the_profile_field_input_name() ); ?>[]' );"> <?php esc_html_e( 'Clear', 'buddypress' ); ?> </a> <?php endif; ?> <?php } /** * Output the edit field options HTML for this field type. * * 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 {@link 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 {@link bp_profile_fields()} template loop. * * @since 2.0.0 * * @param array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}. */ 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 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; } /** * 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() ) { $r = bp_parse_args( $raw_properties, array( 'multiple' => 'multiple' ) ); ?> <label for="<?php bp_the_profile_field_input_name(); ?>" class="screen-reader-text"><?php /* translators: accessibility text */ esc_html_e( 'Select', 'buddypress' ); ?></label> <select <?php echo $this->get_edit_field_html_elements( $r ); ?>> <?php bp_the_profile_field_options(); ?> </select> <?php } /** * Output HTML for this field type's children options on the wp-admin Profile Fields, * "Add Field" and "Edit Field" screens. * * Must be used inside the {@link bp_profile_fields()} template loop. * * @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 = '' ) { parent::admin_new_field_html( $current_field, 'checkbox' ); } }
Changelog Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |
Methods Methods
- __construct — Constructor for the multi-selectbox field type.
- admin_field_html — Output HTML for this field type on the wp-admin Profile Fields screen.
- admin_new_field_html — Output HTML for this field type's children options on the wp-admin Profile Fields, "Add Field" and "Edit Field" screens.
- edit_field_html — Output the edit field HTML for this field type.
- edit_field_options_html — Output the edit field options HTML for this field type.