| [ Index ] |
PHP Cross Reference of BuddyPress |
[Source view] [Print] [Project Stats]
BuddyPress XProfile Classes.
| File Size: | 667 lines (24 kb) |
| Included or required: | 0 times |
| Referenced: | 0 times |
| Includes or requires: | 0 files |
BP_XProfile_Field_Type_Datebox:: (10 methods):
__construct()
edit_field_html()
edit_field_options_html()
admin_field_html()
get_field_settings()
validate_settings()
admin_save_settings()
admin_new_field_html()
display_filter()
get_date_formats()
Class: BP_XProfile_Field_Type_Datebox - X-Ref
Datebox xprofile field type.| __construct() X-Ref |
| Constructor for the datebox field type. since: 2.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: 2.0.0 |
| edit_field_options_html( array $args = array() X-Ref |
| 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. param: array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}. since: 2.0.0 |
| admin_field_html( array $raw_properties = array() X-Ref |
| Output HTML for this field type on the wp-admin Profile Fields screen. Must be used inside the {@link bp_profile_fields()} template loop. param: array $raw_properties Optional key/value array of permitted attributes that you want to add. since: 2.0.0 |
| get_field_settings( $field_id ) X-Ref |
| Get settings for a given date field. return: array param: int $field_id ID of the field. since: 2.7.0 |
| validate_settings( $settings ) X-Ref |
| Validate date field settings. return: array Validated settings. param: array $settings Raw settings. since: 2.7.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. |
| admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) X-Ref |
| Generate the settings markup for Date fields. 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 since: 2.7.0 |
| display_filter( $field_value, $field_id = '' ) X-Ref |
| Format Date values for display. return: string Date formatted by bp_format_time(). param: string $field_value The date value, as saved in the database. Typically, this is a MySQL-formatted param: string|int $field_id Optional. ID of the field. since: 2.1.0 since: 2.4.0 Added the `$field_id` parameter. |
| get_date_formats() X-Ref |
| Gets the default date formats available when configuring a Date field. return: array since: 2.7.0 |
| Generated: Thu Nov 21 01:00:57 2024 | Cross-referenced by PHPXref 0.7.1 |