BP_XProfile_Field_Type_Textbox
Textbox xprofile field type.
Description Description
Source Source
File: bp-xprofile/classes/class-bp-xprofile-field-type-textbox.php
class BP_XProfile_Field_Type_Textbox extends BP_XProfile_Field_Type { /** * Constructor for the textbox field type. * * @since 2.0.0 */ public function __construct() { parent::__construct(); $this->category = _x( 'Single Fields', 'xprofile field type category', 'buddypress' ); $this->name = _x( 'Text Box', 'xprofile field type', 'buddypress' ); $this->set_format( '/^.*$/', 'replace' ); /** * Fires inside __construct() method for BP_XProfile_Field_Type_Textbox class. * * @since 2.0.0 * * @param BP_XProfile_Field_Type_Textbox $this Current instance of * the field type text box. */ do_action( 'bp_xprofile_field_type_textbox', $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/input.text.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 certain other fields // types pass to {@link bp_the_profile_field_options()}. if ( isset( $raw_properties['user_id'] ) ) { unset( $raw_properties['user_id'] ); } $r = bp_parse_args( $raw_properties, array( 'type' => 'text', 'value' => bp_get_the_profile_field_edit_value(), ) ); ?> <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() ); ?> <input <?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 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 } /** * 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( 'type' => 'text' ) ); ?> <label for="<?php bp_the_profile_field_input_name(); ?>" class="screen-reader-text"><?php /* translators: accessibility text */ esc_html_e( 'Textbox', 'buddypress' ); ?></label> <input <?php echo $this->get_edit_field_html_elements( $r ); ?>> <?php } /** * This method usually outputs HTML for this field type's children options on the wp-admin Profile Fields * "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out. * * @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 = '' ) {} }
Changelog Changelog
Version | Description |
---|---|
2.0.0 | Introduced. |
Methods Methods
- __construct — Constructor for the textbox field type.
- admin_field_html — Output HTML for this field type on the wp-admin Profile Fields screen.
- admin_new_field_html — This method usually outputs HTML for this field type's children options on the wp-admin Profile Fields "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out.
- edit_field_html — Output the edit field HTML for this field type.