[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-xprofile/classes/ -> class-bp-xprofile-field-type-checkbox-acceptance.php (summary)

BuddyPress XProfile Classes.

File Size: 387 lines (11 kb)
Included or required:0 times
Referenced: 0 times
Includes or requires: 0 files

Defines 1 class

BP_XProfile_Field_Type_Checkbox_Acceptance:: (9 methods):
  __construct()
  edit_field_html()
  admin_field_html()
  admin_new_field_html()
  admin_save_settings()
  edit_field_options_html()
  enforce_field_value()
  is_valid()
  display_filter()


Class: BP_XProfile_Field_Type_Checkbox_Acceptance  - X-Ref

Checkbox Acceptance xProfile field type.

__construct()   X-Ref
Constructor for the Checkbox Acceptance field type.

since: 8.0.0

edit_field_html( array $raw_properties = array()   X-Ref
Output the edit field HTML for this field type.

Must be used inside the {@link bp_profile_fields()} template loop.

param: array $raw_properties Optional key/value array of
since: 8.0.0

admin_field_html( array $raw_properties = array()   X-Ref
Field html for Admin-> User->Profile Fields screen.

param: array $raw_properties properties.
since: 8.0.0

admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' )   X-Ref
Admin new field screen.

param: BP_XProfile_Field $current_field Profile field object.
param: string            $control_type  Control type.
since: 8.0.0

admin_save_settings( $field_id, $settings )   X-Ref
Save settings from the field edit screen in the Dashboard.

return: bool True on success.
param: int   $field_id ID of the field.
param: array $settings Array of settings.
since: 8.0.0

edit_field_options_html( array $args = array()   X-Ref
Profile edit/register options html.

param: array $args args.
since: 8.0.0

enforce_field_value( $value, BP_XProfile_Field $field )   X-Ref
Enforces the field value if it has been already accepted.

As it's always possible to edit HTML source and remove the `readonly="readonly"` attribute
of the checkbox, we may need to enforce the field value.

return: mixed The field value.
param: mixed             $value Value passed to xprofile_set_field_data().
param: BP_XProfile_Field $field Field object.
since: 8.0.0

is_valid( $value )   X-Ref
Check if field is valid?

return: bool
param: string|int $values value.
since: 8.0.0

display_filter( $field_value, $field_id = 0 )   X-Ref
Modify the appearance of value.

return: string   Value formatted
param: string $field_value Original value of field.
param: int    $field_id field id.
since: 8.0.0



Generated: Thu Oct 28 01:00:59 2021 Cross-referenced by PHPXref 0.7.1