Skip to:
Content

BuddyPress.org


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

Continued XProfile docs cleanup.

See #6406.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/bp-xprofile/classes/class-bp-xprofile-profiledata.php

    r10434 r10740  
    2121     * XProfile ID.
    2222     *
     23     * @since 1.6.0
    2324     * @var int $id
    2425     */
    … …  
    2829     * User ID.
    2930     *
     31     * @since 1.6.0
    3032     * @var int $user_id
    3133     */
    … …  
    3537     * XProfile field ID.
    3638     *
     39     * @since 1.6.0
    3740     * @var int $field_id
    3841     */
    … …  
    4245     * XProfile field value.
    4346     *
     47     * @since 1.6.0
    4448     * @var string $value
    4549     */
    … …  
    4953     * XProfile field last updated time.
    5054     *
     55     * @since 1.6.0
    5156     * @var string $last_updated
    5257     */
    … …  
    5661     * BP_XProfile_ProfileData constructor.
    5762     *
    58      * @param null $field_id Field ID to instantiate.
    59      * @param null $user_id  User ID to instantiate for.
     63     * @since 1.5.0
     64     *
     65     * @param int|null $field_id Field ID to instantiate.
     66     * @param int|null $user_id  User ID to instantiate for.
    6067     */
    6168    public function __construct( $field_id = null, $user_id = null ) {
    … …  
    6774    /**
    6875     * Populates the XProfile profile data.
     76     *
     77     * @since 1.0.0
    6978     *
    7079     * @param int $field_id Field ID to populate.
    … …  
    105114     * Check if there is data already for the user.
    106115     *
     116     * @since 1.0.0
     117     *
    107118     * @global object $wpdb
    108119     * @global array $bp
     120     *
    109121     * @return bool
    110122     */
    … …  
    137149     * Check if this data is for a valid field.
    138150     *
     151     * @since 1.0.0
     152     *
    139153     * @global object $wpdb
     154     *
    140155     * @return bool
    141156     */
    … …  
    160175    /**
    161176     * Save the data for the XProfile field.
     177     *
     178     * @since 1.0.0
    162179     *
    163180     * @return bool
    … …  
    219236     * Delete specific XProfile field data.
    220237     *
     238     * @since 1.0.0
     239     *
    221240     * @global object $wpdb
     241     *
    222242     * @return boolean
    223243     */
    … …  
    257277    /**
    258278     * Get a user's profile data for a set of fields.
     279     *
     280     * @since 2.0.0
    259281     *
    260282     * @param int   $user_id   ID of user whose data is being queried.
    … …  
    324346     * Get all of the profile information for a specific user.
    325347     *
     348     * @since 1.2.0
     349     *
    326350     * @param int $user_id ID of the user.
    327351     * @return array
    … …  
    369393     * Get the user's field data id by the id of the xprofile field.
    370394     *
     395     * @since 1.6.0
     396     *
    371397     * @param int $field_id Field ID being queried for.
    372398     * @param int $user_id  User ID associated with field.
    … …  
    398424     *
    399425     * Supports multiple user IDs.
     426     *
     427     * @since 1.0.0
    400428     *
    401429     * @param int            $field_id ID of the field.
    … …  
    479507     * Get profile field values by field name and user ID.
    480508     *
     509     * @since 1.0.0
     510     *
    481511     * @param array|string $fields  Field(s) to get.
    482512     * @param int|null     $user_id User ID to get field data for.
    … …  
    541571     * Delete field.
    542572     *
     573     * @since 1.0.0
     574     *
    543575     * @param int $field_id ID of the field to delete.
    544576     * @return bool
    … …  
    559591     * Get time for last XProfile field data update by user.
    560592     *
     593     * @since 1.0.0
     594     *
    561595     * @param int $user_id User ID to get time for.
    562596     * @return null|string
    … …  
    575609     * Delete all data for provided user ID.
    576610     *
     611     * @since 1.0.0
     612     *
    577613     * @param int $user_id User ID to remove data for.
    578614     * @return false|int
    … …  
    588624    /**
    589625     * Get random field type by user ID.
     626     *
     627     * @since 1.0.0
    590628     *
    591629     * @param int    $user_id          User ID to query for.
    … …  
    606644     * Get fullname for provided user ID.
    607645     *
     646     * @since 1.0.0
     647     *
    608648     * @param int $user_id ID of the user to query.
    609649     * @return mixed
Note: See TracChangeset for help on using the changeset viewer.