Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
05/07/2016 07:38:27 PM (8 years ago)
Author:
tw2113
Message:

Continued XProfile docs cleanup.

See #6406.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-xprofile/bp-xprofile-functions.php

    r10434 r10740  
    2525 * @since 2.1.0
    2626 *
    27  * @param array $args See {@link BP_XProfile_Group::get()} for description of
    28  *                    arguments.
     27 * @param array $args See {@link BP_XProfile_Group::get()} for description of arguments.
    2928 * @return array $groups
    3029 */
    … …  
    4948 * @since 1.0.0
    5049 *
    51  * @param array|string $args Array of arguments for field group insertion.
     50 * @param array|string $args {
     51 *    Array of arguments for field group insertion.
     52 *
     53 *    @type int|bool    $field_group_id ID of the field group to insert into.
     54 *    @type string|bool $name           Name of the group.
     55 *    @type string      $description    Field group description.
     56 *    @type bool        $can_delete     Whether or not the field group can be deleted.
     57 * }
    5258 * @return boolean
    5359 */
    … …  
    193199/**
    194200 * Insert or update an xprofile field.
     201 *
     202 * @since 1.1.0
    195203 *
    196204 * @param array|string $args {
    … …  
    274282 * Get a profile field object.
    275283 *
     284 * @since 1.1.0
     285 *
    276286 * @param int|object $field ID of the field or object representing field data.
    277287 * @return BP_XProfile_Field|null Field object if found, otherwise null.
    … …  
    297307 * Delete a profile field object.
    298308 *
     309 * @since 1.1.0
     310 *
    299311 * @param int|object $field_id ID of the field or object representing field data.
    300312 * @return bool Whether or not the field was deleted.
    … …  
    313325 * When the field value is serialized, this function unserializes and filters
    314326 * each item in the array.
     327 *
     328 * @since 1.0.0
    315329 *
    316330 * @uses BP_XProfile_ProfileData::get_value_byid() Fetches the value based on the params passed.
    … …  
    374388 * A simple function to set profile data for a specific field for a specific user.
    375389 *
     390 * @since 1.0.0
     391 *
    376392 * @uses xprofile_get_field_id_from_name() Gets the ID from the field based on the name.
    377393 *
    … …  
    455471 * Set the visibility level for this field.
    456472 *
     473 * @since 1.6.0
     474 *
    457475 * @param int    $field_id         The ID of the xprofile field.
    458476 * @param int    $user_id          The ID of the user to whom the data belongs.
    … …  
    519537/**
    520538 * Delete XProfile field data.
     539 *
     540 * @since 1.1.0
    521541 *
    522542 * @param string $field   Field to delete.
    … …  
    548568 * Check if field is a required field.
    549569 *
     570 * @since 1.1.0
     571 *
    550572 * @param int $field_id ID of the field to check for.
    551573 * @return bool Whether or not field is required.
    … …  
    565587 * Returns the ID for the field based on the field name.
    566588 *
    567  * @package BuddyPress Core
     589 * @since 1.0.0
     590 *
    568591 * @param string $field_name The name of the field to get the ID for.
    569592 * @return int $field_id on success, false on failure.
    … …  
    575598/**
    576599 * Fetches a random piece of profile data for the user.
     600 *
     601 * @since 1.0.0
    577602 *
    578603 * @global BuddyPress $bp           The one true BuddyPress instance.
    … …  
    612637 * Formats a profile field according to its type. [ TODO: Should really be moved to filters ]
    613638 *
     639 * @since 1.0.0
     640 *
    614641 * @param string $field_type  The type of field: datebox, selectbox, textbox etc.
    615642 * @param string $field_value The actual value.
    … …  
    634661/**
    635662 * Update the field position for a provided field.
     663 *
     664 * @since 1.1.0
    636665 *
    637666 * @param int $field_id       ID of the field to update.
    … …  
    769798 * Syncs Xprofile data to the standard built in WordPress profile data.
    770799 *
     800 * @since 1.0.0
     801 *
    771802 * @param int $user_id ID of the user to sync.
    772803 * @return bool
    … …  
    836867 * usermeta table that this component uses.
    837868 *
     869 * @since 1.0.0
     870 *
    838871 * @param int $user_id The ID of the deleted user.
    839872 */
    … …  
    849882/**
    850883 * Delete a piece of xprofile metadata.
     884 *
     885 * @since 1.5.0
    851886 *
    852887 * @param int         $object_id   ID of the object the metadata belongs to.
    … …  
    902937 * underlying get_metadata() function. This is for backward compatibility.
    903938 *
     939 * @since 1.5.0
     940 *
    904941 * @param int    $object_id   ID of the object the metadata belongs to.
    905942 * @param string $object_type Type of object. 'group', 'field', or 'data'.
    … …  
    928965/**
    929966 * Update a piece of xprofile metadata.
     967 *
     968 * @since 1.5.0
    930969 *
    931970 * @param int    $object_id   ID of the object the metadata belongs to.
    … …  
    9781017 * Updates the fieldgroup metadata.
    9791018 *
     1019 * @since 1.5.0
     1020 *
    9801021 * @param int    $field_group_id Group ID for the group field belongs to.
    9811022 * @param string $meta_key       Meta key to update.
    … …  
    9901031 * Updates the field metadata.
    9911032 *
     1033 * @since 1.5.0
     1034 *
    9921035 * @param int    $field_id   Field ID to update.
    9931036 * @param string $meta_key   Meta key to update.
    … …  
    10021045 * Updates the fielddata metadata.
    10031046 *
     1047 * @since 1.5.0
     1048 *
    10041049 * @param int    $field_data_id Field ID to update.
    10051050 * @param string $meta_key      Meta key to update.
    … …  
    10881133 * Get visibility levels out of the $bp global.
    10891134 *
     1135 * @since 1.6.0
     1136 *
    10901137 * @return array
    10911138 */
    … …  
    11111158 *
    11121159 * @since 1.6.0
     1160 *
    11131161 * @see BP_XProfile_Group::get()
    11141162 * @uses apply_filters() Filter bp_xprofile_get_hidden_fields_for_user to modify visibility levels,
    … …  
    11581206 *
    11591207 * @since 1.8.2
     1208 *
    11601209 * @see bp_xprofile_get_hidden_fields_for_user()
    11611210 *
    … …  
    12041253 *
    12051254 * @since 1.6.0
     1255 *
    12061256 * @see bp_xprofile_get_hidden_fields_for_user()
    12071257 *
Note: See TracChangeset for help on using the changeset viewer.