Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
09/25/2015 02:19:11 AM (11 years ago)
Author:
tw2113
Message:

Finishing off the XProfile class files for @since changes.

See #6576.

File:
1 edited

Legend:

Unmodified
Added
Removed
  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field.php

    r10022 r10142  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313
    1414        /**
    15          * @since BuddyPress (1.0.0)
     15         * @since 1.0.0
    1616         *
    1717         * @var int ID of field
    … …  
    2020
    2121        /**
    22          * @since BuddyPress (1.0.0)
     22         * @since 1.0.0
    2323         *
    2424         * @var int Field group ID for field
    … …  
    2727
    2828        /**
    29          * @since BuddyPress (1.0.0)
     29         * @since 1.0.0
    3030         *
    3131         * @var int Parent ID of field
    … …  
    3434
    3535        /**
    36          * @since BuddyPress (1.0.0)
     36         * @since 1.0.0
    3737         *
    3838         * @var string Field type
    … …  
    4141
    4242        /**
    43          * @since BuddyPress (1.0.0)
     43         * @since 1.0.0
    4444         *
    4545         * @var string Field name
    … …  
    4848
    4949        /**
    50          * @since BuddyPress (1.0.0)
     50         * @since 1.0.0
    5151         *
    5252         * @var string Field description
    … …  
    5555
    5656        /**
    57          * @since BuddyPress (1.0.0)
     57         * @since 1.0.0
    5858         *
    5959         * @var bool Is field required to be filled out?
    … …  
    6262
    6363        /**
    64          * @since BuddyPress (1.0.0)
     64         * @since 1.0.0
    6565         *
    6666         * @var int Can field be deleted?
    … …  
    6969
    7070        /**
    71          * @since BuddyPress (1.0.0)
     71         * @since 1.0.0
    7272         *
    7373         * @var int Field position
    … …  
    7676
    7777        /**
    78          * @since BuddyPress (1.0.0)
     78         * @since 1.0.0
    7979         *
    8080         * @var int Option order
    … …  
    8383
    8484        /**
    85          * @since BuddyPress (1.0.0)
     85         * @since 1.0.0
    8686         *
    8787         * @var string Order child fields by
    … …  
    9090
    9191        /**
    92          * @since BuddyPress (1.0.0)
     92         * @since 1.0.0
    9393         *
    9494         * @var bool Is this the default option for this field?
    … …  
    9797
    9898        /**
    99          * @since BuddyPress (1.9.0)
     99         * @since 1.9.0
    100100         *
    101101         * @var string Default field data visibility
    … …  
    104104
    105105        /**
    106          * @since BuddyPress (2.3.0)
     106         * @since 2.3.0
    107107         *
    108108         * @var string Members are allowed/disallowed to modify data visibility
    … …  
    111111
    112112        /**
    113          * @since BuddyPress (2.0.0)
     113         * @since 2.0.0
    114114         *
    115115         * @var BP_XProfile_Field_Type Field type object used for validation
    … …  
    118118
    119119        /**
    120          * @since BuddyPress (2.0.0)
     120         * @since 2.0.0
    121121         *
    122122         * @var BP_XProfile_ProfileData Field data for user ID
    … …  
    127127         * Member types to which the profile field should be applied.
    128128         *
    129          * @since BuddyPress (2.4.0)
     129         * @since 2.4.0
    130130         * @access protected
    131131         * @var array Array of member types.
    … …  
    136136         * Initialize and/or populate profile field
    137137         *
    138          * @since BuddyPress (1.1.0)
     138         * @since 1.1.0
    139139         *
    140140         * @param int  $id
    … …  
    157157         * Populate a profile field object
    158158         *
    159          * @since BuddyPress (1.1.0)
     159         * @since 1.1.0
    160160         *
    161161         * @global object $wpdb
    … …  
    217217         * Delete a profile field
    218218         *
    219          * @since BuddyPress (1.1.0)
     219         * @since 1.1.0
    220220         *
    221221         * @global object  $wpdb
    … …  
    251251         * Save a profile field
    252252         *
    253          * @since BuddyPress (1.1.0)
     253         * @since 1.1.0
    254254         *
    255255         * @global object $wpdb
    … …  
    279279                 * Please use this hook to filter the properties above. Each part will be passed in.
    280280                 *
    281                  * @since BuddyPress (1.0.0)
     281                 * @since 1.0.0
    282282                 *
    283283                 * @param BP_XProfile_Field Current instance of the field being saved.
    … …  
    330330                                 * Filters the submitted field option value before saved.
    331331                                 *
    332                                  * @since BuddyPress (1.5.0)
     332                                 * @since 1.5.0
    333333                                 *
    334334                                 * @param string            $post_option Submitted option value.
    … …  
    340340                                 * Filters the default field option value before saved.
    341341                                 *
    342                                  * @since BuddyPress (1.5.0)
     342                                 * @since 1.5.0
    343343                                 *
    344344                                 * @param string            $post_default Default option value.
    … …  
    377377                         * Fires after the current field instance gets saved.
    378378                         *
    379                          * @since BuddyPress (1.0.0)
     379                         * @since 1.0.0
    380380                         *
    381381                         * @param BP_XProfile_Field Current instance of the field being saved.
    … …  
    396396         * Get field data for a user ID
    397397         *
    398          * @since BuddyPress (1.2.0)
     398         * @since 1.2.0
    399399         *
    400400         * @param  int $user_id
    … …  
    408408         * Get all child fields for this field ID
    409409         *
    410          * @since BuddyPress (1.2.0)
     410         * @since 1.2.0
    411411         *
    412412         * @global object $wpdb
    … …  
    443443                 * Filters the found children for a field.
    444444                 *
    445                  * @since BuddyPress (1.2.5)
     445                 * @since 1.2.5
    446446                 *
    447447                 * @param object $children    Found children for a field.
    … …  
    454454         * Delete all field children for this field
    455455         *
    456          * @since BuddyPress (1.2.0)
     456         * @since 1.2.0
    457457         *
    458458         * @global object $wpdb
    … …  
    474474         * 'null' is a special pseudo-type, which represents users that do not have a member type.
    475475         *
    476          * @since BuddyPress (2.4.0)
     476         * @since 2.4.0
    477477         *
    478478         * @return array Array of member type names.
    … …  
    515515                 * Filters the member types to which an XProfile object should be applied.
    516516                 *
    517                  * @since BuddyPress (2.4.0)
     517                 * @since 2.4.0
    518518                 *
    519519                 * @param array             $types Member types.
    … …  
    528528         * Sets the member types for this field.
    529529         *
    530          * @since BuddyPress (2.4.0)
     530         * @since 2.4.0
    531531         *
    532532         * @param array $member_types Array of member types. Can include 'null' (users with no type) in addition to any
    … …  
    586586                 * Fires after a field's member types have been updated.
    587587                 *
    588                  * @since BuddyPress (2.4.0)
     588                 * @since 2.4.0
    589589                 *
    590590                 * @param BP_XProfile_Field $field Field object.
    … …  
    601601         * This label is displayed alongside the field's name on the Profile Fields Dashboard panel.
    602602         *
    603          * @since BuddyPress (2.4.0)
     603         * @since 2.4.0
    604604         *
    605605         * @return string
    … …  
    681681         * Delete all fields in a field group
    682682         *
    683          * @since BuddyPress (1.2.0)
     683         * @since 1.2.0
    684684         *
    685685         * @global object $wpdb
    … …  
    712712         * Get field ID from field name
    713713         *
    714          * @since BuddyPress (1.5.0)
     714         * @since 1.5.0
    715715         *
    716716         * @global object $wpdb
    … …  
    736736         * Update field position and/or field group when relocating
    737737         *
    738          * @since BuddyPress (1.5.0)
     738         * @since 1.5.0
    739739         *
    740740         * @global object $wpdb
    … …  
    775775         * Gets the IDs of fields applicable for a given member type or array of member types.
    776776         *
    777          * @since BuddyPress (2.4.0)
     777         * @since 2.4.0
    778778         *
    779779         * @param string|array $member_types Member type or array of member types. Use 'any' to return unrestricted
    … …  
    849849         * Validate form field data on sumbission
    850850         *
    851          * @since BuddyPress (2.2.0)
     851         * @since 2.2.0
    852852         *
    853853         * @global type $message
    … …  
    931931         * Oupput the admin form for this field
    932932         *
    933          * @since BuddyPress (1.9.0)
     933         * @since 1.9.0
    934934         *
    935935         * @param type $message
    … …  
    10001000                                                         * Fires after XProfile Field sidebar metabox.
    10011001                                                         *
    1002                                                          * @since BuddyPress (2.2.0)
     1002                                                         * @since 2.2.0
    10031003                                                         *
    10041004                                                         * @param BP_XProfile_Field $this Current XProfile field.
    … …  
    10151015                                                         * Fires before XProfile Field content metabox.
    10161016                                                         *
    1017                                                          * @since BuddyPress (2.3.0)
     1017                                                         * @since 2.3.0
    10181018                                                         *
    10191019                                                         * @param BP_XProfile_Field $this Current XProfile field.
    … …  
    10301030                                                         * Fires after XProfile Field content metabox.
    10311031                                                         *
    1032                                                          * @since BuddyPress (2.2.0)
     1032                                                         * @since 2.2.0
    10331033                                                         *
    10341034                                                         * @param BP_XProfile_Field $this Current XProfile field.
    … …  
    10481048         * Private method used to display the submit metabox
    10491049         *
    1050          * @since BuddyPress (2.3.0)
     1050         * @since 2.3.0
    10511051         *
    10521052         * @param string $button_text
    … …  
    10571057                 * Fires before XProfile Field submit metabox.
    10581058                 *
    1059                  * @since BuddyPress (2.1.0)
     1059                 * @since 2.1.0
    10601060                 *
    10611061                 * @param BP_XProfile_Field $this Current XProfile field.
    … …  
    10741074                                                 * Fires at the beginning of the XProfile Field publishing actions section.
    10751075                                                 *
    1076                                                  * @since BuddyPress (2.1.0)
     1076                                                 * @since 2.1.0
    10771077                                                 *
    10781078                                                 * @param BP_XProfile_Field $this Current XProfile field.
    … …  
    11071107                 * Fires after XProfile Field submit metabox.
    11081108                 *
    1109                  * @since BuddyPress (2.1.0)
     1109                 * @since 2.1.0
    11101110                 *
    11111111                 * @param BP_XProfile_Field $this Current XProfile field.
    … …  
    11171117         * Private method used to output field name and description fields
    11181118         *
    1119          * @since BuddyPress (2.3.0)
     1119         * @since 2.3.0
    11201120         */
    11211121        private function name_and_description() {
    … …  
    11421142         * Private method used to output field Member Type metabox.
    11431143         *
    1144          * @since BuddyPress (2.4.0)
     1144         * @since 2.4.0
    11451145         */
    11461146        private function member_type_metabox() {
    … …  
    11951195         * Private method used to output field visibility metaboxes
    11961196         *
    1197          * @since BuddyPress (2.3.0)
     1197         * @since 2.3.0
    11981198         *
    11991199         * @return if default field id 1
    … …  
    12441244         * Output the metabox for setting if field is required or not
    12451245         *
    1246          * @since BuddyPress (2.3.0)
     1246         * @since 2.3.0
    12471247         *
    12481248         * @return if default field
    … …  
    12711271         * Output the metabox for setting what type of field this is
    12721272         *
    1273          * @since BuddyPress (2.3.0)
     1273         * @since 2.3.0
    12741274         *
    12751275         * @return if default field
    … …  
    13071307         * Output hidden fields used by default field
    13081308         *
    1309          * @since BuddyPress (2.3.0)
     1309         * @since 2.3.0
    13101310         *
    13111311         * @return if not default field
    … …  
    13271327         * Return if a field ID is the default field
    13281328         *
    1329          * @since BuddyPress (2.3.0)
     1329         * @since 2.3.0
    13301330         *
    13311331         * @param  int $field_id ID of field to check
Note: See TracChangeset for help on using the changeset viewer.