BP_XProfile_Field_Type_Gender

Gender xprofile field type.
Description

Source

File: bp-xprofile/classes/class-bp-xprofile-field-type-gender.php
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
class BP_XProfile_Field_Type_Gender extends BP_XProfile_Field_Type {
 
    /**
     * Constructor for the gender field type.
     *
     * @since BuddyBoss 1.0.0
     */
    public function __construct() {
        parent::__construct();
 
        $this->category = __( 'Multi Fields', 'buddyboss' );
        $this->name     = __( 'Gender', 'buddyboss' );
 
        $this->supports_options = true;
 
        $this->set_format( '/^.+$/', 'replace' );
 
        /**
         * Fires inside __construct() method for BP_XProfile_Field_Type_Gender class.
         *
         * @since BuddyBoss 1.0.0
         *
         * @param BP_XProfile_Field_Type_Gender $this Current instance of
         *                                               the field type select box.
         */
        do_action( 'bp_xprofile_field_type_selectbox_gender', $this );
    }
 
    /**
     * Output the edit field HTML for this field type.
     *
     * Must be used inside the {@link bp_profile_fields()} template loop.
     *
     * @since BuddyBoss 1.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();
        } ?>
 
        <legend id="<?php bp_the_profile_field_input_name(); ?>-1">
            <?php bp_the_profile_field_name(); ?>
            <?php if ( bp_is_register_page() ) : ?>
                <?php bp_the_profile_field_optional_label(); ?>
            <?php else: ?>
                <?php bp_the_profile_field_required_label(); ?>
            <?php endif; ?>
        </legend>
 
        <?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
 
        /** 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( $raw_properties ); ?> 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
    }
 
    /**
     * 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 BuddyBoss 1.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    = '<option value="">' . /* translators: no option picked in select box */ esc_html__( '----', 'buddyboss' ) . '</option>';
 
        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] != $option_value ) {
                    if ( ! empty( $_POST['field_' . $this->field_obj->id] ) ) {
                        $option_values[$i] = sanitize_text_field( $_POST['field_' . $this->field_obj->id] );
                    }
                }
            }
 
            if ( '1' === $options[$k]->option_order ) {
                $option_value = 'his_'. $options[$k]->name;
            } elseif ( '2' === $options[$k]->option_order ) {
                $option_value = 'her_'. $options[$k]->name;
            } else {
                $option_value = 'their_'. $options[$k]->name;
            }
 
            // 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( $option_value, 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 ) && $options[$k]->is_default_option ) {
                $selected = ' selected="selected"';
            }
 
 
 
            /**
             * Filters the HTML output for options in a select input.
             *
             * @since BuddyBoss 1.0.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_select_gender', '<option' . $selected . ' value="' . esc_attr( stripslashes( $option_value ) ) . '">' . 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 BuddyBoss 1.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() ) {
        ?>
 
        <label for="<?php bp_the_profile_field_input_name(); ?>" class="screen-reader-text"><?php
            /* translators: accessibility text */
            esc_html_e( 'Select', 'buddyboss' );
            ?></label>
        <select <?php echo $this->get_edit_field_html_elements( $raw_properties ); ?>>
            <?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 BuddyBoss 1.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 = 'radio' ) {
        $type = array_search( get_class( $this ), bp_xprofile_get_field_types() );
        if ( false === $type ) {
            return;
        }
 
        $class            = $current_field->type != $type ? 'display: none;' : '';
        $current_type_obj = bp_xprofile_create_field_type( $type );
        ?>
 
        <div id="<?php echo esc_attr( $type ); ?>" class="postbox bp-options-box" style="<?php echo esc_attr( $class ); ?> margin-top: 15px;">
            <h3><?php esc_html_e( 'Male and Female use "his" and "her" pronouns in the activity feed. Other options use "their".', 'buddyboss' ); ?></h3>
            <div class="inside" aria-live="polite" aria-atomic="true" aria-relevant="all">
                <p style="display: none;">
                    <label for="sort_order_<?php echo esc_attr( $type ); ?>"><?php esc_html_e( 'Sort Order:', 'buddyboss' ); ?></label>
                    <select name="sort_order_<?php echo esc_attr( $type ); ?>" id="sort_order_<?php echo esc_attr( $type ); ?>" >
                        <option value="custom" <?php selected( 'custom', $current_field->order_by ); ?>><?php esc_html_e( 'Custom',     'buddyboss' ); ?></option>
                        <option value="asc"    <?php selected( 'asc',    $current_field->order_by ); ?>><?php esc_html_e( 'Ascending',  'buddyboss' ); ?></option>
                        <option value="desc"   <?php selected( 'desc',   $current_field->order_by ); ?>><?php esc_html_e( 'Descending', 'buddyboss' ); ?></option>
                    </select>
                </p>
 
                <?php
 
                // Does option have children?
                $options = $current_field->get_children( true );
 
                if ( empty( $options ) ) {
                    $options = array();
                    $options[] = (object) array(
                        'id'                => 1,
                        'is_default_option' => false,
                        'name'              => 'Male',
                    );
                    $options[] = (object) array(
                        'id'                => 2,
                        'is_default_option' => false,
                        'name'              => 'Female',
                    );
                    $options[] = (object) array(
                        'id'                => 3,
                        'is_default_option' => false,
                        'name'              => 'Prefer Not to Answer',
                    );
                }
 
                // If no children options exists for this field, check in $_POST
                // for a submitted form (e.g. on the "new field" screen).
                if ( empty( $options ) ) {
 
                    $options = array();
                    $i       = 1;
 
                    while ( isset( $_POST[$type . '_option'][$i] ) ) {
 
                        // Multiselectbox and checkboxes support MULTIPLE default options; all other core types support only ONE.
                        if ( $current_type_obj->supports_options && ! $current_type_obj->supports_multiple_defaults && isset( $_POST["isDefault_{$type}_option"][$i] ) && (int) $_POST["isDefault_{$type}_option"] === $i ) {
                            $is_default_option = true;
                        } elseif ( isset( $_POST["isDefault_{$type}_option"][$i] ) ) {
                            $is_default_option = (bool) $_POST["isDefault_{$type}_option"][$i];
                        } else {
                            $is_default_option = false;
                        }
 
                        // Grab the values from $_POST to use as the form's options.
                        $options[] = (object) array(
                            'id'                => -1,
                            'is_default_option' => $is_default_option,
                            'name'              => sanitize_text_field( stripslashes( $_POST[$type . '_option'][$i] ) ),
                        );
 
                        ++$i;
                    }
 
                    // If there are still no children options set, this must be the "new field" screen, so add one new/empty option.
                    if ( empty( $options ) ) {
                        $options[] = (object) array(
                            'id'                => -1,
                            'is_default_option' => false,
                            'name'              => '',
                        );
                    }
                }
 
                // Render the markup for the children options.
                if ( ! empty( $options ) ) {
                    $default_name = '';
 
                    for ( $i = 0, $count = count( $options ); $i < $count; ++$i ) :
                        $j = $i + 1;
 
                        // Multiselectbox and checkboxes support MULTIPLE default options; all other core types support only ONE.
                        if ( $current_type_obj->supports_options && $current_type_obj->supports_multiple_defaults ) {
                            $default_name = '[' . $j . ']';
                        }
 
                        if ( 1 === $j || 2 === $j ) {
                            $class = '';
                        } else {
                            $class = 'sortable';
                        }
                        ?>
 
                        <div id="<?php echo esc_attr( "{$type}_div{$j}" ); ?>" class="bp-option <?php echo esc_attr( $class ); ?>">
                            <span class="bp-option-icon grabber"></span>
                            <label for="<?php echo esc_attr( "{$type}_option{$j}" ); ?>" class="screen-reader-text"><?php
                                /* translators: accessibility text */
                                esc_html_e( 'Add an option', 'buddyboss' );
                                ?></label>
                            <?php
                            if ( 1 === $j ) {
                                $key = sanitize_key( 'male' );
                            } elseif ( 2 === $j ) {
                                $key = sanitize_key( 'female' );
                            } else {
                                $key = sanitize_key( 'other' );
                            }
                            ?>
                            <input type="text" name="<?php echo esc_attr( "{$type}_option[{$j}_{$key}]" ); ?>" id="<?php echo esc_attr( "{$type}_option{$j}" ); ?>" value="<?php echo esc_attr( stripslashes( $options[$i]->name ) ); ?>" />
                            <label for="<?php echo esc_attr( "{$type}_option{$default_name}" ); ?>">
                                <?php
                                if ( 1 === $j ) {
                                    _e( 'Male', 'buddyboss' );
                                } elseif ( 2 === $j ) {
                                    _e( 'Female', 'buddyboss' );
                                } else {
                                    _e( 'Other', 'buddyboss' );
                                }
                                ?>
                            </label>
 
                            <?php if ( 1 !== $j && 2 !== $j ) : ?>
                                <div class ="delete-button">
                                    <a href='javascript:hide("<?php echo esc_attr( "{$type}_div{$j}" ); ?>")' class="delete"><?php esc_html_e( 'Delete', 'buddyboss' ); ?></a>
                                </div>
                            <?php endif; ?>
 
                        </div>
 
                    <?php endfor; ?>
 
                    <input type="hidden" name="<?php echo esc_attr( "{$type}_option_number" ); ?>" id="<?php echo esc_attr( "{$type}_option_number" ); ?>" value="<?php echo esc_attr( $j + 1 ); ?>" />
                <?php } ?>
 
                <div id="<?php echo esc_attr( "{$type}_more" ); ?>"></div>
                <p><a href="javascript:add_option('<?php echo esc_js( $type ); ?>')"><?php esc_html_e( 'Add Another Option', 'buddyboss' ); ?></a></p>
 
                <?php
 
                /**
                 * Fires at the end of the new field additional settings area.
                 *
                 * @since BuddyBoss 1.0.0
                 *
                 * @param BP_XProfile_Field $current_field Current field being rendered.
                 */
                do_action( 'bp_xprofile_admin_new_field_additional_settings_gender', $current_field ) ?>
            </div>
        </div>
 
        <?php
    }
 
    /**
     * Check if valid.
     *
     * @param int $values post id.
     *
     * @return bool
     */
    public function is_valid( $values = '' ) {
 
        global $wpdb;
 
        if ( empty( $values ) ) {
            return true;
        }
 
        $split_value = explode('_', $values );
 
        if ( 2 === count( $split_value ) ) {
            if ( '' !== $split_value[1] && '' !== $split_value[0] ) {
                $count = $wpdb->get_var( $wpdb->prepare( "SELECT COUNT(id) FROM {$wpdb->prefix}bp_xprofile_fields WHERE type = %s AND name = %s AND parent_id != '' ", 'option', $split_value[1] ) );
                if ( '1' === $count ) {
                    return true;
                } else {
                    return false;
                }
            } else {
                return false;
            }
        } else {
            return false;
        }
    }
}
Expand full source code Collapse full source code
Changelog

Changelog
Version	Description
BuddyBoss 1.0.0	Introduced.
Uses

Uses
Uses	Description
bp-xprofile/classes/class-bp-xprofile-field-type.php: BP_XProfile_Field_Type	Represents a type of XProfile field and holds meta information about the type of value that it accepts.
Methods

__construct — Constructor for the gender 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.
is_valid — Check if valid.
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.
Contents
