[ Index ]

PHP Cross Reference of BuddyPress

title

Body

[close]

/src/bp-xprofile/ -> bp-xprofile-template.php (summary)

BuddyPress XProfile Template Tags.

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

Defines 69 functions

  bp_has_profile()
  bp_profile_groups()
  bp_the_profile_group()
  bp_profile_group_has_fields()
  bp_field_css_class()
  bp_get_field_css_class()
  bp_field_has_data()
  bp_field_has_public_data()
  bp_the_profile_group_id()
  bp_get_the_profile_group_id()
  bp_the_profile_group_name()
  bp_get_the_profile_group_name()
  bp_the_profile_group_slug()
  bp_get_the_profile_group_slug()
  bp_the_profile_group_description()
  bp_get_the_profile_group_description()
  bp_the_profile_group_edit_form_action()
  bp_get_the_profile_group_edit_form_action()
  bp_the_profile_group_field_ids()
  bp_get_the_profile_group_field_ids()
  bp_the_profile_field_ids()
  bp_get_the_profile_field_ids()
  bp_profile_fields()
  bp_the_profile_field()
  bp_the_profile_field_id()
  bp_get_the_profile_field_id()
  bp_the_profile_field_name()
  bp_get_the_profile_field_name()
  bp_the_profile_field_value()
  bp_get_the_profile_field_value()
  bp_the_profile_field_edit_value()
  bp_get_the_profile_field_edit_value()
  bp_the_profile_field_type()
  bp_get_the_profile_field_type()
  bp_the_profile_field_description()
  bp_get_the_profile_field_description()
  bp_the_profile_field_input_name()
  bp_get_the_profile_field_input_name()
  bp_get_the_profile_field_errors_action()
  bp_the_profile_field_options()
  bp_get_the_profile_field_options()
  bp_the_profile_field_is_required()
  bp_get_the_profile_field_is_required()
  bp_the_profile_field_visibility_level()
  bp_get_the_profile_field_visibility_level()
  bp_the_profile_field_visibility_level_label()
  bp_get_the_profile_field_visibility_level_label()
  bp_unserialize_profile_field()
  bp_profile_field_data()
  bp_get_profile_field_data()
  bp_profile_get_field_groups()
  bp_profile_has_multiple_groups()
  bp_profile_group_tabs()
  bp_get_profile_group_tabs()
  bp_profile_group_name()
  bp_get_profile_group_name()
  bp_profile_last_updated()
  bp_get_profile_last_updated()
  bp_current_profile_group_id()
  bp_get_current_profile_group_id()
  bp_avatar_delete_link()
  bp_get_avatar_delete_link()
  bp_edit_profile_button()
  bp_profile_visibility_radio_buttons()
  bp_profile_get_visibility_radio_buttons()
  bp_profile_settings_visibility_select()
  bp_profile_get_settings_visibility_select()
  bp_the_profile_field_required_label()
  bp_get_the_profile_field_required_label()

Functions
Functions that are not part of a class:

bp_has_profile( $args = '' )   X-Ref
Query for XProfile groups and fields.

return: bool
since: 1.0.0
param: array|string $args {

bp_profile_groups()   X-Ref
Start off the profile groups.

return: mixed
since: 1.0.0

bp_the_profile_group()   X-Ref
Set up the profile groups.

return: mixed
since: 1.0.0

bp_profile_group_has_fields()   X-Ref
Whether or not the group has fields to display.

return: mixed
since: 1.0.0

bp_field_css_class( $class = false )   X-Ref
Output the class attribute for a field.

since: 1.0.0
param: mixed $class Extra classes to append to class attribute.

bp_get_field_css_class( $class = false )   X-Ref
Return the class attribute for a field.

return: string
since: 1.1.0
param: string|bool $class Extra classes to append to class attribute.

bp_field_has_data()   X-Ref
Whether or not the XProfile field has data to display.

return: mixed
since: 1.0.0

bp_field_has_public_data()   X-Ref
Whether or not the XProfile field has public data to display.

return: bool
since: 1.0.0

bp_the_profile_group_id()   X-Ref
Output the XProfile group ID.

since: 1.0.0

bp_get_the_profile_group_id()   X-Ref
Return the XProfile group ID.

return: int
since: 1.1.0

bp_the_profile_group_name()   X-Ref
Output the XProfile group name.

since: 1.0.0

bp_get_the_profile_group_name()   X-Ref
Return the XProfile group name.

return: string
since: 1.0.0

bp_the_profile_group_slug()   X-Ref
Output the XProfile group slug.

since: 1.1.0

bp_get_the_profile_group_slug()   X-Ref
Return the XProfile group slug.

return: string
since: 1.1.0

bp_the_profile_group_description()   X-Ref
Output the XProfile group description.

since: 1.0.0

bp_get_the_profile_group_description()   X-Ref
Return the XProfile group description.

return: string
since: 1.0.0

bp_the_profile_group_edit_form_action()   X-Ref
Output the XProfile group edit form action.

since: 1.1.0

bp_get_the_profile_group_edit_form_action()   X-Ref
Return the XProfile group edit form action.

return: string
since: 1.1.0

bp_the_profile_group_field_ids()   X-Ref
Output the XProfile group field IDs.

since: 1.1.0

bp_get_the_profile_group_field_ids()   X-Ref
Return the XProfile group field IDs.

return: string
since: 1.1.0

bp_the_profile_field_ids()   X-Ref
Output a comma-separated list of field IDs that are to be submitted on profile edit.

since: 2.1.0

bp_get_the_profile_field_ids()   X-Ref
Generate a comma-separated list of field IDs that are to be submitted on profile edit.

return: string
since: 2.1.0

bp_profile_fields()   X-Ref
Return the XProfile fields.

return: mixed
since: 1.0.0

bp_the_profile_field()   X-Ref
Sets up the XProfile field.

return: mixed
since: 1.0.0

bp_the_profile_field_id()   X-Ref
Output the XProfile field ID.

since: 1.1.0

bp_get_the_profile_field_id()   X-Ref
Return the XProfile field ID.

return: int
since: 1.1.0

bp_the_profile_field_name()   X-Ref
Outputs the XProfile field name.

since: 1.0.0

bp_get_the_profile_field_name()   X-Ref
Returns the XProfile field name.

return: string
since: 1.0.0

bp_the_profile_field_value()   X-Ref
Outputs the XProfile field value.

since: 1.0.0

bp_get_the_profile_field_value()   X-Ref
Returns the XProfile field value.

return: string
since: 1.0.0

bp_the_profile_field_edit_value()   X-Ref
Outputs the XProfile field edit value.

since: 1.1.0

bp_get_the_profile_field_edit_value()   X-Ref
Returns the XProfile field edit value.

return: string
since: 1.1.0

bp_the_profile_field_type()   X-Ref
Outputs the XProfile field type.

since: 1.1.0

bp_get_the_profile_field_type()   X-Ref
Returns the XProfile field type.

return: string
since: 1.1.0

bp_the_profile_field_description()   X-Ref
Outputs the XProfile field description.

since: 1.1.0

bp_get_the_profile_field_description()   X-Ref
Returns the XProfile field description.

return: string
since: 1.1.0

bp_the_profile_field_input_name()   X-Ref
Outputs the XProfile field input name.

since: 1.1.0

bp_get_the_profile_field_input_name()   X-Ref
Retursn the XProfile field input name.

return: string
since: 1.1.0

bp_get_the_profile_field_errors_action()   X-Ref
Returns the action name for any signup errors related to this profile field.

In the registration templates, signup errors are pulled from the global
object and rendered at actions that look like 'bp_field_12_errors'. This
function allows the action name to be easily concatenated and called in the
following fashion:
do_action( bp_get_the_profile_field_errors_action() );

return: string The _errors action name corresponding to this profile field.
since: 1.8.0

bp_the_profile_field_options( $args = array()   X-Ref
Displays field options HTML for field types of 'selectbox', 'multiselectbox',
'radio', 'checkbox', and 'datebox'.

since: 1.1.0
param: array $args Specify type for datebox. Allowed 'day', 'month', 'year'.

bp_get_the_profile_field_options( $args = array()   X-Ref
Retrieves field options HTML for field types of 'selectbox', 'multiselectbox', 'radio', 'checkbox', and 'datebox'.

return: string $vaue Field options markup.
since: 1.1.0
param: array $args {

bp_the_profile_field_is_required()   X-Ref
Render whether or not a profile field is required.

since: 1.1.0

bp_get_the_profile_field_is_required()   X-Ref
Return whether or not a profile field is required.

return: bool
since: 1.1.0

bp_the_profile_field_visibility_level()   X-Ref
Output the visibility level of this field.

since: 1.6.0

bp_get_the_profile_field_visibility_level()   X-Ref
Return the visibility level of this field.

return: string
since: 1.6.0

bp_the_profile_field_visibility_level_label()   X-Ref
Echo the visibility level label of this field.

since: 1.6.0

bp_get_the_profile_field_visibility_level_label()   X-Ref
Return the visibility level label of this field.

return: string
since: 1.6.0

bp_unserialize_profile_field( $value )   X-Ref
Return unserialized profile field data, and combine any array items into a
comma-separated string.

return: string
since: 1.0.0
param: string $value Content to maybe unserialize.

bp_profile_field_data( $args = '' )   X-Ref
Output XProfile field data.

since: 1.2.0
param: string|array $args Array of arguments for field data. See {@link bp_get_profile_field_data}

bp_get_profile_field_data( $args = '' )   X-Ref
Return XProfile field data.

return: mixed
since: 1.2.0
param: string|array $args {

bp_profile_get_field_groups()   X-Ref
Get all profile field groups.

return: array $groups
since: 2.1.0

bp_profile_has_multiple_groups()   X-Ref
Check if there is more than one group of fields for the profile being edited.

return: bool True if there is more than one profile field group.
since: 2.1.0

bp_profile_group_tabs()   X-Ref
Output the tabs to switch between profile field groups.

since: 1.0.0

bp_get_profile_group_tabs()   X-Ref
Return the XProfile group tabs.

return: string
since: 2.3.0

bp_profile_group_name( $deprecated = true )   X-Ref
Output the XProfile group name.

return: string|null
since: 1.0.0
param: bool $deprecated Deprecated boolean parameter.

bp_get_profile_group_name()   X-Ref
Return the XProfile group name.

return: string
since: 1.0.0

bp_profile_last_updated()   X-Ref
Render a formatted string displaying when a profile was last updated.

since: 1.0.0

bp_get_profile_last_updated()   X-Ref
Return a formatted string displaying when a profile was last updated.

return: bool|string
since: 1.0.0

bp_current_profile_group_id()   X-Ref
Display the current profile group ID.

since: 1.1.0

bp_get_current_profile_group_id()   X-Ref
Return the current profile group ID.

return: int
since: 1.1.0

bp_avatar_delete_link()   X-Ref
Render an avatar delete link.

since: 1.1.0

bp_get_avatar_delete_link()   X-Ref
Return an avatar delete link.

return: string
since: 1.1.0

bp_edit_profile_button()   X-Ref
Render an edit profile button.

since: 1.0.0

bp_profile_visibility_radio_buttons( $args = '' )   X-Ref
Echo the field visibility radio buttons.

since: 1.6.0
param: array|string $args Args for the radio buttons. See {@link bp_profile_get_visibility_radio_buttons}

bp_profile_get_visibility_radio_buttons( $args = '' )   X-Ref
Return the field visibility radio buttons.

return: string $retval
since: 1.6.0
param: array|string $args {

bp_profile_settings_visibility_select( $args = '' )   X-Ref
Output the XProfile field visibility select list for settings.

since: 2.0.0
param: array|string $args Args for the select list. See {@link bp_profile_get_settings_visibility_select}

bp_profile_get_settings_visibility_select( $args = '' )   X-Ref
Return the XProfile field visibility select list for settings.

return: string $retval
since: 2.0.0
param: array|string $args {

bp_the_profile_field_required_label()   X-Ref
Output the 'required' markup in extended profile field labels.

since: 2.4.0

bp_get_the_profile_field_required_label()   X-Ref
Return the 'required' markup in extended profile field labels.

return: string HTML for the required label.
since: 2.4.0



Generated: Tue Oct 22 01:01:36 2019 Cross-referenced by PHPXref 0.7.1