[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-xprofile/classes/ -> class-bp-xprofile-field-type-number.php (source)

   1  <?php
   2  /**
   3   * BuddyPress XProfile Classes.
   4   *
   5   * @package BuddyPress
   6   * @subpackage XProfileClasses
   7   * @since 2.0.0
   8   */
   9  
  10  // Exit if accessed directly.
  11  defined( 'ABSPATH' ) || exit;
  12  
  13  /**
  14   * Number xprofile field type.
  15   *
  16   * @since 2.0.0
  17   */
  18  class BP_XProfile_Field_Type_Number extends BP_XProfile_Field_Type {
  19  
  20      /**
  21       * Constructor for the number field type.
  22       *
  23       * @since 2.0.0
  24       */
  25  	public function __construct() {
  26          parent::__construct();
  27  
  28          $this->category = _x( 'Single Fields', 'xprofile field type category', 'buddypress' );
  29          $this->name     = _x( 'Number', 'xprofile field type', 'buddypress' );
  30  
  31          $this->set_format( '/^\d+|-\d+$/', 'replace' );
  32  
  33          /**
  34           * Fires inside __construct() method for BP_XProfile_Field_Type_Number class.
  35           *
  36           * @since 2.0.0
  37           *
  38           * @param BP_XProfile_Field_Type_Number $this Current instance of
  39           *                                            the field type number.
  40           */
  41          do_action( 'bp_xprofile_field_type_number', $this );
  42      }
  43  
  44      /**
  45       * Output the edit field HTML for this field type.
  46       *
  47       * Must be used inside the {@link bp_profile_fields()} template loop.
  48       *
  49       * @since 2.0.0
  50       *
  51       * @param array $raw_properties Optional key/value array of
  52       *                              {@link http://dev.w3.org/html5/markup/input.number.html permitted attributes}
  53       *                              that you want to add.
  54       */
  55  	public function edit_field_html( array $raw_properties = array() ) {
  56  
  57          // User_id is a special optional parameter that certain other fields
  58          // types pass to {@link bp_the_profile_field_options()}.
  59          if ( isset( $raw_properties['user_id'] ) ) {
  60              unset( $raw_properties['user_id'] );
  61          }
  62  
  63          $r = bp_parse_args(
  64              $raw_properties,
  65              array(
  66                  'type'  => 'number',
  67                  'value' => bp_get_the_profile_field_edit_value(),
  68              )
  69          );
  70          ?>
  71  
  72          <legend id="<?php bp_the_profile_field_input_name(); ?>-1">
  73              <?php bp_the_profile_field_name(); ?>
  74              <?php bp_the_profile_field_required_label(); ?>
  75          </legend>
  76  
  77          <?php
  78  
  79          /** This action is documented in bp-xprofile/bp-xprofile-classes */
  80          do_action( bp_get_the_profile_field_errors_action() ); ?>
  81  
  82          <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">
  83  
  84          <?php if ( bp_get_the_profile_field_description() ) : ?>
  85              <p class="description" id="<?php bp_the_profile_field_input_name(); ?>-3"><?php bp_the_profile_field_description(); ?></p>
  86          <?php endif; ?>
  87  
  88          <?php
  89      }
  90  
  91      /**
  92       * Output HTML for this field type on the wp-admin Profile Fields screen.
  93       *
  94       * Must be used inside the {@link bp_profile_fields()} template loop.
  95       *
  96       * @since 2.0.0
  97       *
  98       * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
  99       */
 100  	public function admin_field_html( array $raw_properties = array() ) {
 101          $r = bp_parse_args(
 102              $raw_properties,
 103              array(
 104                  'type' => 'number',
 105              )
 106          );
 107          ?>
 108  
 109          <label for="<?php bp_the_profile_field_input_name(); ?>" class="screen-reader-text"><?php
 110              /* translators: accessibility text */
 111              esc_html_e( 'Number field', 'buddypress' );
 112          ?></label>
 113          <input <?php echo $this->get_edit_field_html_elements( $r ); ?>>
 114      <?php
 115      }
 116  
 117      /**
 118       * This method usually outputs HTML for this field type's children options on the wp-admin Profile Fields
 119       * "Add Field" and "Edit Field" screens, but for this field type, we don't want it, so it's stubbed out.
 120       *
 121       * @since 2.0.0
 122       *
 123       * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
 124       * @param string            $control_type  Optional. HTML input type used to render the current
 125       *                                         field's child options.
 126       */
 127  	public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
 128  }


Generated: Fri Oct 15 01:00:55 2021 Cross-referenced by PHPXref 0.7.1