Skip to:
Content

BuddyPress.org

Changeset 10140


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

Standardizing our @since tags for the XProfile component.

See #6576.

Location:
trunk/src/bp-xprofile
Files:
17 edited

Legend:

Unmodified
Added
Removed

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

    r9944 r10140  
    11<?php
    2 
    32/**
    4  * BuddyPress XProfile Actions
     3 * BuddyPress XProfile Actions.
    54 *
    65 * Action functions are exactly the same as screen functions, however they do not
    … …  
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
    … …  
    5150 * Handles the saving of xprofile field visibilities
    5251 *
    53  * @since BuddyPress (1.9.0)
     52 * @since 1.9.0
    5453 */
    5554function bp_xprofile_action_settings() {
    … …  
    8281         * Fires before saving xprofile field visibilities.
    8382         *
    84          * @since BuddyPress (2.0.0)
     83         * @since 2.0.0
    8584         */
    8685        do_action( 'bp_xprofile_settings_before_save' );
    … …  
    123122         * Fires after saving xprofile field visibilities.
    124123         *
    125          * @since BuddyPress (2.0.0)
     124         * @since 2.0.0
    126125         */
    127126        do_action( 'bp_xprofile_settings_after_save' );

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

    r10135 r10140  
    11<?php
    2 
    3 /**
    4  * BuddyPress XProfile Activity & Notification Functions
     2/**
     3 * BuddyPress XProfile Activity & Notification Functions.
    54 *
    65 * These functions handle the recording, deleting and formatting of activity
    … …  
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
    … …  
    1716 * Register the activity actions for the Extended Profile component
    1817 *
    19  * @since BuddyPress (1.0.0)
     18 * @since 1.0.0
    2019 *
    2120 * @uses bp_activity_set_action() To setup the individual actions
    … …  
    4645         * Fires after the registration of default activity actions for Extended Profile component.
    4746         *
    48          * @since BuddyPress (1.1.0)
     47         * @since 1.1.0
    4948         */
    5049        do_action( 'xprofile_register_activity_actions' );
    … …  
    5554 * Format 'new_avatar' activity actions.
    5655 *
    57  * @since BuddyPress (2.0.0)
     56 * @since 2.0.0
    5857 *
    5958 * @param string $action Static activity action.
    … …  
    7372         * Filters the formatted 'new_avatar' activity stream action.
    7473         *
    75          * @since BuddyPress (2.0.0)
     74         * @since 2.0.0
    7675         *
    7776         * @param string $action   Formatted action for activity stream.
    … …  
    8483 * Format 'updated_profile' activity actions.
    8584 *
    86  * @since BuddyPress (2.0.0)
     85 * @since 2.0.0
    8786 *
    8887 * @param string $action Static activity action.
    … …  
    102101         * Filters the formatted 'updated_profile' activity stream action.
    103102         *
    104          * @since BuddyPress (2.0.0)
     103         * @since 2.0.0
    105104         *
    106105         * @param string $action   Formatted action for activity stream.
    … …  
    114113 * it will show in the users activity stream (if installed)
    115114 *
    116  * @since BuddyPress (1.0.0)
     115 * @since 1.0.0
    117116 *
    118117 * @package BuddyPress
    … …  
    149148 * removed from the users activity stream and sitewide stream (if installed)
    150149 *
    151  * @since BuddyPress (1.0.0)
     150 * @since 1.0.0
    152151 *
    153152 * @package BuddyPress XProfile
    … …  
    175174 * Register an activity action for the Extended Profiles component
    176175 *
    177  * @since BuddyPress (1.0.0)
     176 * @since 1.0.0
    178177 *
    179178 * @param string $key
    … …  
    191190         * Filters the return value of bp_activity_set_action.
    192191         *
    193          * @since BuddyPress (1.1.0)
     192         * @since 1.1.0
    194193         *
    195194         * @param bool   $value Whether or not an action was successfully registered.
    … …  
    244243 * Add an activity item when a user has updated his profile.
    245244 *
    246  * @since BuddyPress (2.0.0)
     245 * @since 2.0.0
    247246 *
    248247 * @param int $user_id ID of the user who has updated his profile.
    … …  
    310309                 * Filters the throttle time, in seconds, used to prevent excessive activity posting.
    311310                 *
    312                  * @since BuddyPress (2.0.0)
     311                 * @since 2.0.0
    313312                 *
    314313                 * @param int $value Throttle time, in seconds.
    … …  
    339338 * Add filters for xprofile activity types to Show dropdowns.
    340339 *
    341  * @since BuddyPress (2.0.0)
     340 * @since 2.0.0
    342341 * @todo Mark as deprecated
    343342 */

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

    r10071 r10140  
    11<?php
    2 
    3 /**
    4  * BuddyPress XProfile Admin
     2/**
     3 * BuddyPress XProfile Admin.
    54 *
    65 * @package BuddyPress
    … …  
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
    … …  
    6665 * Output the main XProfile management screen
    6766 *
    68  * @since BuddyPress (2.3.0)
     67 * @since 2.3.0
    6968 *
    7069 * @param string $message Feedback message
    … …  
    153152                                                                 * Fires at end of action buttons in xprofile management admin.
    154153                                                                 *
    155                                                                  * @since BuddyPress (2.2.0)
     154                                                                 * @since 2.2.0
    156155                                                                 *
    157156                                                                 * @param BP_XProfile_Group $group BP_XProfile_Group object
    … …  
    266265                                 * Fires at the end of the group adding/saving process, if successful.
    267266                                 *
    268                                  * @since BuddyPress (1.0.0)
     267                                 * @since 1.0.0
    269268                                 *
    270269                                 * @param BP_XProfile_Group $group Current BP_XProfile_Group object.
    … …  
    302301                 * Fires at the end of group deletion process, if successful.
    303302                 *
    304                  * @since BuddyPress (1.0.0)
     303                 * @since 1.0.0
    305304                 *
    306305                 * @param BP_XProfile_Group $group Current BP_XProfile_Group object.
    … …  
    392391                                 * Fires at the end of the process to save a field for a user, if successful.
    393392                                 *
    394                                  * @since BuddyPress (1.0.0)
     393                                 * @since 1.0.0
    395394                                 *
    396395                                 * @param BP_XProfile_Field $field Current BP_XProfile_Field object.
    … …  
    416415 * Handles the deletion of a profile field (or field option)
    417416 *
    418  * @since BuddyPress (1.0.0)
     417 * @since 1.0.0
    419418 * @global string $message The feedback message to show
    420419 * @global $type The type of feedback message to show
    … …  
    441440                 * Fires at the end of the field deletion process, if successful.
    442441                 *
    443                  * @since BuddyPress (1.0.0)
     442                 * @since 1.0.0
    444443                 *
    445444                 * @param BP_XProfile_Field $field Current BP_XProfile_Field object.
    … …  
    517516                                 * Fires at end of legend above the name field in base xprofile group.
    518517                                 *
    519                                  * @since BuddyPress (2.2.0)
     518                                 * @since 2.2.0
    520519                                 *
    521520                                 * @param BP_XProfile_Field $field Current BP_XProfile_Field
    … …  
    536535                                 * Fires after the input if the current field is not in default field types.
    537536                                 *
    538                                  * @since BuddyPress (1.5.0)
     537                                 * @since 1.5.0
    539538                                 *
    540539                                 * @param BP_XProfile_Field $field Current BP_XProfile_Field
    … …  
    568567                                 * Fires at end of field management links in xprofile management admin.
    569568                                 *
    570                                  * @since BuddyPress (2.2.0)
     569                                 * @since 2.2.0
    571570                                 *
    572571                                 * @param BP_XProfile_Group $group BP_XProfile_Group object
    … …  
    586585 *
    587586 * @param string $select_field_type The name of the field type that should be selected. Will defaults to "textbox" if NULL is passed.
    588  * @since BuddyPress (2.0.0)
     587 * @since 2.0.0
    589588 */
    590589function bp_xprofile_admin_form_field_types( $select_field_type ) {
    … …  
    640639 * @subpackage xProfileAdministration
    641640 *
    642  * @since BuddyPress (2.0.0)
     641 * @since 2.0.0
    643642 */
    644643class BP_XProfile_User_Admin {
    … …  
    648647         *
    649648         * @access public
    650          * @since BuddyPress (2.0.0)
     649         * @since 2.0.0
    651650         *
    652651         * @uses buddypress() to get BuddyPress main instance
    … …  
    672671         *
    673672         * @access public
    674          * @since BuddyPress (2.0.0)
     673         * @since 2.0.0
    675674         */
    676675        public function __construct() {
    … …  
    682681         *
    683682         * @access private
    684          * @since BuddyPress (2.0.0)
     683         * @since 2.0.0
    685684         */
    686685        private function setup_actions() {
    … …  
    699698         *
    700699         * @access public
    701          * @since BuddyPress (2.3.0)
     700         * @since 2.3.0
    702701         */
    703702        public function enqueue_scripts( $screen_id ) {
    … …  
    729728         *
    730729         * @access public
    731          * @since BuddyPress (2.0.0)
     730         * @since 2.0.0
    732731         *
    733732         * @param int $user_id ID of the user being edited.
    … …  
    804803         *
    805804         * @access public
    806          * @since BuddyPress (2.0.0)
     805         * @since 2.0.0
    807806         */
    808807        public function user_admin_load( $doaction = '', $user_id = 0, $request = array(), $redirect_to = '' ) {
    … …  
    889888                                         * Fires after the saving of each profile field, if successful.
    890889                                         *
    891                                          * @since BuddyPress (1.1.0)
     890                                         * @since 1.1.0
    892891                                         *
    893892                                         * @param int    $field_id ID of the field being updated.
    … …  
    905904                         * Fires after all of the profile fields have been saved.
    906905                         *
    907                          * @since BuddyPress (1.0.0)
     906                         * @since 1.0.0
    908907                         *
    909908                         * @param int   $user_id          ID of the user whose data is being saved.
    … …  
    928927         *
    929928         * @access public
    930          * @since BuddyPress (2.0.0)
     929         * @since 2.0.0
    931930         *
    932931         * @param WP_User $user The WP_User object for the user being edited.
    … …  
    983982                                         * Fires before display of visibility form elements for profile metaboxes.
    984983                                         *
    985                                          * @since BuddyPress (1.7.0)
     984                                         * @since 1.7.0
    986985                                         */
    987986                                        do_action( 'bp_custom_profile_edit_fields_pre_visibility' );
    … …  
    10191018                                         * Fires at end of custom profile field items on your xprofile screen tab.
    10201019                                         *
    1021                                          * @since BuddyPress (1.1.0)
     1020                                         * @since 1.1.0
    10221021                                         */
    10231022                                        do_action( 'bp_custom_profile_edit_fields' ); ?>
    … …  
    10341033         *
    10351034         * @access public
    1036          * @since BuddyPress (2.0.0)
     1035         * @since 2.0.0
    10371036         *
    10381037         * @param WP_User $user The WP_User object for the user being edited.
    … …  
    10481047         *
    10491048         * @access public
    1050          * @since BuddyPress (2.0.0)
     1049         * @since 2.0.0
    10511050         *
    10521051         * @param WP_User $user The WP_User object for the user being edited.

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

    r10022 r10140  
    11<?php
    2 
    3 /**
    4  * BuddyPress XProfile Caching Functions
     2/**
     3 * BuddyPress XProfile Caching Functions.
    54 *
    65 * Caching functions handle the clearing of cached objects and pages on specific
    … …  
    87 *
    98 * @package BuddyPress
    10  */
    11 
    12 // Exit if accessed directly
     9 * @subpackage XProfileCache
     10 */
     11
     12// Exit if accessed directly.
    1313defined( 'ABSPATH' ) || exit;
    1414
    … …  
    1616 * Determine which xprofile fields do not have cached values for a user.
    1717 *
    18  * @since BuddyPress (2.2.0)
     18 * @since 2.2.0
    1919 *
    2020 * @param int   $user_id   User ID to check
    … …  
    4848 * This function is called within a bp_has_profile() loop.
    4949 *
    50  * @since BuddyPress (2.0.0)
     50 * @since 2.0.0
    5151 *
    5252 * @param array $object_ids Multi-dimensional array of object_ids, keyed by
    … …  
    177177 * Clear cached XProfile field group data
    178178 *
    179  * @since BuddyPress (2.1.0)
     179 * @since 2.1.0
    180180 *
    181181 * @param object $group_obj
    … …  
    191191 * Clear cached XProfile fullname data for user
    192192 *
    193  * @since BuddyPress (2.1.0)
     193 * @since 2.1.0
    194194 *
    195195 * @param int $user_id ID of user whose fullname cache to delete
    … …  
    206206 * cases, except where the field is updated directly with xprofile_set_field_data()
    207207 *
    208  * @since BuddyPress (2.0.0)
     208 * @since 2.0.0
    209209 */
    210210function xprofile_clear_fullname_cache_on_profile_field_edit( $data ) {
    … …  
    218218 * Clear caches when a field object is modified.
    219219 *
    220  * @since BuddyPress (2.0.0)
     220 * @since 2.0.0
    221221 *
    222222 * @param BP_XProfile_Field
    … …  
    239239 * Clears member_type cache when a field's member types are updated.
    240240 *
    241  * @since BuddyPress (2.4.0)
     241 * @since 2.4.0
    242242 */
    243243function bp_xprofile_clear_member_type_cache() {
    … …  
    249249 * Clear caches when a user's updates a field data object.
    250250 *
    251  * @since BuddyPress (2.0.0)
     251 * @since 2.0.0
    252252 *
    253253 * @param BP_XProfile_ProfileData $data_obj
    … …  
    272272 * invalidation) is thus for backward compatibility only.
    273273 *
    274  * @since BuddyPress (2.0.0)
     274 * @since 2.0.0
    275275 */
    276276function xprofile_clear_fullname_field_id_cache() {

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

    r9819 r10140  
    11<?php
    2 
    32/**
    4  * Roles and capabilities logic for the XProfile component
     3 * Roles and capabilities logic for the XProfile component.
    54 *
    65 * @package BuddyPress
    7  * @since BuddyPress (1.6.0)
     6 * @subpackage XPRofileCaps
     7 * @since 1.6.0
    88 */
    99
    10 // Exit if accessed directly
     10// Exit if accessed directly.
    1111defined( 'ABSPATH' ) || exit;
    1212
    … …  
    1414 * Maps XProfile caps to built in WordPress caps
    1515 *
    16  * @since BuddyPress (1.6.0)
     16 * @since 1.6.0
    1717 *
    1818 * @param array $caps Capabilities for meta capability
    … …  
    5959         * Filters the XProfile caps to built in WordPress caps.
    6060         *
    61          * @since BuddyPress (1.6.0)
     61         * @since 1.6.0
    6262         *
    6363         * @param array  $caps    Capabilities for meta capability.

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

    r9819 r10140  
    11<?php
    22/**
    3  * BuddyPress XProfile Classes
     3 * BuddyPress XProfile Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111

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

    r9819 r10140  
    11<?php
    2 
    32/**
    4  * BuddyPress XProfile CSS and JS
     3 * BuddyPress XProfile CSS and JS.
    54 *
    65 * @package BuddyPress
    … …  
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
    … …  
    1413 * Enqueue the CSS for XProfile admin styling
    1514 *
    16  * @since BuddyPress (1.1.0)
     15 * @since 1.1.0
    1716 */
    1817function xprofile_add_admin_css() {
    … …  
    3332 * Enqueue the jQuery libraries for handling drag/drop/sort
    3433 *
    35  * @since BuddyPress (1.5.0)
     34 * @since 1.5.0
    3635 */
    3736function xprofile_add_admin_js() {

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

    r9819 r10140  
    11<?php
    2 
    3 /**
    4  * BuddyPress XProfile Filters
    5  *
    6  * Apply WordPress defined filters
     2/**
     3 * BuddyPress XProfile Filters.
     4 *
     5 * Apply WordPress defined filters.
    76 *
    87 * @package BuddyPress
    … …  
    109 */
    1110
    12 // Exit if accessed directly
     11// Exit if accessed directly.
    1312defined( 'ABSPATH' ) || exit;
    1413
    … …  
    7776 * Sanitize each field option name for saving to the database
    7877 *
    79  * @since BuddyPress (2.3.0)
     78 * @since 2.3.0
    8079 *
    8180 * @param  mixed $field_options
    … …  
    9392 * Sanitize each field option default for saving to the database
    9493 *
    95  * @since BuddyPress (2.3.0)
     94 * @since 2.3.0
    9695 *
    9796 * @param  mixed $field_default
    … …  
    124123         * Filters the allowed tags for use within xprofile_filter_kses().
    125124         *
    126          * @since BuddyPress (1.5.0)
     125         * @since 1.5.0
    127126         *
    128127         * @param array                   $xprofile_allowedtags Array of allowed tags for profile field values.
    … …  
    160159                 * Filters the kses-filtered data before saving to database.
    161160                 *
    162                  * @since BuddyPress (1.5.0)
     161                 * @since 1.5.0
    163162                 *
    164163                 * @param string                  $filtered_field_value The filtered value.
    … …  
    193192 * Runs stripslashes on XProfile fields.
    194193 *
    195  * @since BuddyPress (1.0.0)
     194 * @since 1.0.0
    196195 *
    197196 * @param string $field_value XProfile field_value to be filtered.
    … …  
    216215 * Apply display_filter() filters as defined by the BP_XProfile_Field_Type classes, when fetched inside a bp_has_profile() loop.
    217216 *
    218  * @since BuddyPress (2.1.0)
     217 * @since 2.1.0
    219218 *
    220219 * @param mixed $field_value Field value.
    … …  
    239238 * Apply display_filter() filters as defined by the BP_XProfile_Field_Type classes, when fetched by xprofile_get_field_data().
    240239 *
    241  * @since BuddyPress (2.1.0)
     240 * @since 2.1.0
    242241 *
    243242 * @param mixed $field_value Field value.
    … …  
    252251 * Apply pre_validate_filter() filters as defined by the BP_XProfile_Field_Type classes before validating.
    253252 *
    254  * @since BuddyPress (2.1.0)
     253 * @since 2.1.0
    255254 *
    256255 * @param mixed $value Value passed to the bp_xprofile_set_field_data_pre_validate
    … …  
    277276 * - To disable: remove_filter( 'bp_get_the_profile_field_value', 'xprofile_filter_link_profile_data', 9, 2 );
    278277 *
    279  * @since BuddyPress (1.1.0)
     278 * @since 1.1.0
    280279 *
    281280 * @param string $field_value
    … …  
    371370 * Filter BP_User_Query::populate_extras to override each queries users fullname
    372371 *
    373  * @since BuddyPress (1.7.0)
     372 * @since 1.7.0
    374373 *
    375374 * @param BP_User_Query $user_query
    … …  
    396395 * Parse 'xprofile_query' argument passed to BP_User_Query.
    397396 *
    398  * @since BuddyPress (2.2.0)
     397 * @since 2.2.0
    399398 *
    400399 * @param BP_User_Query User query object.
    … …  
    420419 * Filter meta queries to modify for the xprofile data schema.
    421420 *
    422  * @since BuddyPress (2.0.0)
     421 * @since 2.0.0
    423422 *
    424423 * @access private Do not use.

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

    r9819 r10140  
    11<?php
    2 
    3 /**
    4  * BuddyPress XProfile Filters
     2/**
     3 * BuddyPress XProfile Filters.
    54 *
    65 * Business functions are where all the magic happens in BuddyPress. They will
    … …  
    109 *
    1110 * @package BuddyPress
    12  * @subpackage XProfileFilters
    13  */
    14 
    15 // Exit if accessed directly
     11 * @subpackage XProfileFunctions
     12 */
     13
     14// Exit if accessed directly.
    1615defined( 'ABSPATH' ) || exit;
    1716
    … …  
    2322 * Procedural wrapper for BP_XProfile_Group::get() method.
    2423 *
    25  * @since BuddyPress (2.1.0)
     24 * @since 2.1.0
    2625 *
    2726 * @param array $args See {@link BP_XProfile_Group::get()} for description of
    … …  
    3635         * Filters a set of field groups, populated with fields and field data.
    3736         *
    38          * @since BuddyPress (2.1.0)
     37         * @since 2.1.0
    3938         *
    4039         * @param array $groups Array of field groups and field data.
    … …  
    4746 * Insert a new profile field group
    4847 *
    49  * @since BuddyPress (1.0.0)
     48 * @since 1.0.0
    5049 *
    5150 * @param type $args
    … …  
    7978 * Get a specific profile field group
    8079 *
    81  * @since BuddyPress (1.0.0)
     80 * @since 1.0.0
    8281 *
    8382 * @param int $field_group_id
    … …  
    101100 * Delete a specific profile field group
    102101 *
    103  * @since BuddyPress (1.0.0)
     102 * @since 1.0.0
    104103 *
    105104 * @param int $field_group_id
    … …  
    123122 * Update the position of a specific profile field group
    124123 *
    125  * @since BuddyPress (1.0.0)
     124 * @since 1.0.0
    126125 *
    127126 * @param int $field_group_id
    … …  
    140139 *
    141140 * @return array Key/value pairs (field type => class name).
    142  * @since BuddyPress (2.0.0)
     141 * @since 2.0.0
    143142 */
    144143function bp_xprofile_get_field_types() {
    … …  
    160159         * If you've added a custom field type in a plugin, register it with this filter.
    161160         *
    162          * @since BuddyPress (2.0.0)
     161         * @since 2.0.0
    163162         *
    164163         * @param array $fields Array of field type/class name pairings.
    … …  
    172171 * @param string $type Type of profile field to create. See {@link bp_xprofile_get_field_types()} for default core values.
    173172 * @return object If field type unknown, returns BP_XProfile_Field_Type_Textarea. Otherwise returns an instance of the relevant child class of BP_XProfile_Field_Type.
    174  * @since BuddyPress (2.0.0)
     173 * @since 2.0.0
    175174 */
    176175function bp_xprofile_create_field_type( $type ) {
    … …  
    324323                         * Filters the field data value for a specific field for the user.
    325324                         *
    326                          * @since BuddyPress (1.0.0)
     325                         * @since 1.0.0
    327326                         *
    328327                         * @param string $value    Value saved for the field.
    … …  
    377376         * doing field-type-specific validation.
    378377         *
    379          * @since BuddyPress (2.1.0)
     378         * @since 2.1.0
    380379         *
    381380         * @param mixed $value Value passed to xprofile_set_field_data()
    … …  
    458457 * Get the visibility level for a field.
    459458 *
    460  * @since BuddyPress (2.0.0)
     459 * @since 2.0.0
    461460 *
    462461 * @param int $field_id The ID of the xprofile field.
    … …  
    567566         * Filters a random piece of profile data for the user.
    568567         *
    569          * @since BuddyPress (1.0.0)
     568         * @since 1.0.0
    570569         *
    571570         * @param array $field_data Array holding random profile data.
    … …  
    613612 * globals before attempting any overrides.
    614613 *
    615  * @since BuddyPress (2.0.0)
     614 * @since 2.0.0
    616615 */
    617616function xprofile_override_user_fullnames() {
    … …  
    634633 * Setup the avatar upload directory for a user.
    635634 *
    636  * @since BuddyPress (1.0.0)
     635 * @since 1.0.0
    637636 *
    638637 * @package BuddyPress Core
    … …  
    664663         * Filters the avatar upload directory for a user.
    665664         *
    666          * @since BuddyPress (1.1.0)
     665         * @since 1.1.0
    667666         *
    668667         * @param array $value Array containing the path, URL, and other helpful settings.
    … …  
    681680 * When search_terms are passed to BP_User_Query, search against xprofile fields.
    682681 *
    683  * @since BuddyPress (2.0.0)
     682 * @since 2.0.0
    684683 *
    685684 * @param array $sql Clauses in the user_id SQL query.
    … …  
    771770 * Syncs the standard built in WordPress profile data to XProfile.
    772771 *
    773  * @since BuddyPress (1.2.4)
     772 * @since 1.2.4
    774773 * @package BuddyPress Core
    775774 */
    … …  
    909908 * Add a piece of xprofile metadata.
    910909 *
    911  * @since BuddyPress (2.0.0)
     910 * @since 2.0.0
    912911 *
    913912 * @param int $object_id ID of the object the metadata belongs to.
    … …  
    945944 * Return the field ID for the Full Name xprofile field.
    946945 *
    947  * @since BuddyPress (2.0.0)
     946 * @since 2.0.0
    948947 *
    949948 * @return int Field ID.
    … …  
    968967 *
    969968 * @package BuddyPress
    970  * @since BuddyPress (1.5.0)
     969 * @since 1.5.0
    971970 *
    972971 * @return string The field name
    … …  
    977976         * Filters the field name for the Full Name xprofile field.
    978977         *
    979          * @since BuddyPress (1.5.0)
     978         * @since 1.5.0
    980979         *
    981980         * @param string BP_XPROFILE_FULLNAME_FIELD_NAME Full name field constant.
    … …  
    994993         * Filters the visibility levels out of the $bp global.
    995994         *
    996          * @since BuddyPress (1.6.0)
     995         * @since 1.6.0
    997996         *
    998997         * @param array $visibility_levels Array of visibility levels.
    … …  
    10091008 * be excluded from the profile loop.
    10101009 *
    1011  * @since BuddyPress (1.6.0)
     1010 * @since 1.6.0
    10121011 * @see BP_XProfile_Group::get()
    10131012 * @uses apply_filters() Filter bp_xprofile_get_hidden_fields_for_user to modify visibility levels,
    … …  
    10381037         * Filters the ids of fields that are hidden for this displayed/loggedin user pair.
    10391038         *
    1040          * @since BuddyPress (1.6.0)
     1039         * @since 1.6.0
    10411040         *
    10421041         * @param array $hidden_fields     Array of hidden fields for the displayed/logged in user.
    … …  
    10561055 * that should be hidden for the current user pair.
    10571056 *
    1058  * @since BuddyPress (1.8.2)
     1057 * @since 1.8.2
    10591058 * @see bp_xprofile_get_hidden_fields_for_user()
    10601059 *
    … …  
    10901089         * Filters the visibility levels that should be hidden for this user pair.
    10911090         *
    1092          * @since BuddyPress (2.0.0)
     1091         * @since 2.0.0
    10931092         *
    10941093         * @param array $hidden_fields     Array of hidden fields for the displayed/logged in user.
    … …  
    11021101 * Fetch an array of the xprofile fields that a given user has marked with certain visibility levels
    11031102 *
    1104  * @since BuddyPress (1.6.0)
     1103 * @since 1.6.0
    11051104 * @see bp_xprofile_get_hidden_fields_for_user()
    11061105 *

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

    r9937 r10140  
    11<?php
    2 
    32/**
    4  * BuddyPress XProfile Loader
     3 * BuddyPress XProfile Loader.
    54 *
    65 * An extended profile component for users. This allows site admins to create
    … …  
    1110 */
    1211
    13 // Exit if accessed directly
     12// Exit if accessed directly.
    1413defined( 'ABSPATH' ) || exit;
    1514
    … …  
    1918         * Profile field types
    2019         *
    21          * @since BuddyPress (1.5.0)
     20         * @since 1.5.0
    2221         * @var array
    2322         */
    … …  
    2827         *
    2928         * @see bp_xprofile_get_visibility_levels()
    30          * @since BuddyPress (1.6.0)
     29         * @since 1.6.0
    3130         * @var array
    3231         */
    … …  
    3635         * Start the xprofile component creation process
    3736         *
    38          * @since BuddyPress (1.5.0)
     37         * @since 1.5.0
    3938         */
    4039        public function __construct() {
    … …  
    8281         * backwards compatibility.
    8382         *
    84          * @since BuddyPress (1.5.0)
     83         * @since 1.5.0
    8584         */
    8685        public function setup_globals( $args = array() ) {
    … …  
    106105                 * Filters the supported field type IDs.
    107106                 *
    108                  * @since BuddyPress (1.1.0)
     107                 * @since 1.1.0
    109108                 *
    110109                 * @param array $value Array of IDs for the supported field types.
    … …  
    242241         * be loaded in time for BP_XProfile_Component::setup_nav().
    243242         *
    244          * @since BuddyPress (2.1.0)
     243         * @since 2.1.0
    245244         */
    246245        public function setup_settings_nav() {
    … …  
    325324         * Add custom hooks.
    326325         *
    327          * @since BuddyPress (2.0.0)
     326         * @since 2.0.0
    328327         */
    329328        public function setup_hooks() {
    … …  
    357356         * Setup cache groups
    358357         *
    359          * @since BuddyPress (2.2.0)
     358         * @since 2.2.0
    360359         */
    361360        public function setup_cache_groups() {
    … …  
    375374         * Adds "Settings > Profile" subnav item under the "Settings" adminbar menu.
    376375         *
    377          * @since BuddyPress (2.0.0)
     376         * @since 2.0.0
    378377         *
    379378         * @param array $wp_admin_nav The settings adminbar nav array.

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

    r10135 r10140  
    11<?php
    2 
    3 /**
    4  * BuddyPress XProfile Screens
     2/**
     3 * BuddyPress XProfile Screens.
    54 *
    65 * Screen functions are the controllers of BuddyPress. They will execute when
    … …  
    1211 */
    1312
    14 // Exit if accessed directly
     13// Exit if accessed directly.
    1514defined( 'ABSPATH' ) || exit;
    1615
    … …  
    2726         * Fires right before the loading of the XProfile screen template file.
    2827         *
    29          * @since BuddyPress (1.0.0)
     28         * @since 1.0.0
    3029         *
    3130         * @param string $new $_GET parameter holding the "new" parameter.
    … …  
    3635         * Filters the template to load for the XProfile screen.
    3736         *
    38          * @since BuddyPress (1.0.0)
     37         * @since 1.0.0
    3938         *
    4039         * @param string $template Path to the XProfile template to load.
    … …  
    152151                                         * Fires on each iteration of an XProfile field being saved with no error.
    153152                                         *
    154                                          * @since BuddyPress (1.1.0)
     153                                         * @since 1.1.0
    155154                                         *
    156155                                         * @param int    $field_id ID of the field that was saved.
    … …  
    164163                         * Fires after all XProfile fields have been saved for the current profile.
    165164                         *
    166                          * @since BuddyPress (1.0.0)
     165                         * @since 1.0.0
    167166                         *
    168167                         * @param int   $value            Displayed user ID.
    … …  
    189188         * Fires right before the loading of the XProfile edit screen template file.
    190189         *
    191          * @since BuddyPress (1.0.0)
     190         * @since 1.0.0
    192191         */
    193192        do_action( 'xprofile_screen_edit_profile' );
    … …  
    196195         * Filters the template to load for the XProfile edit screen.
    197196         *
    198          * @since BuddyPress (1.0.0)
     197         * @since 1.0.0
    199198         *
    200199         * @param string $template Path to the XProfile edit template to load.
    … …  
    283282         * Fires right before the loading of the XProfile change avatar screen template file.
    284283         *
    285          * @since BuddyPress (1.0.0)
     284         * @since 1.0.0
    286285         */
    287286        do_action( 'xprofile_screen_change_avatar' );
    … …  
    290289         * Filters the template to load for the XProfile change avatar screen.
    291290         *
    292          * @since BuddyPress (1.0.0)
     291         * @since 1.0.0
    293292         *
    294293         * @param string $template Path to the XProfile change avatar template to load.
    … …  
    300299 * Show the xprofile settings template
    301300 *
    302  * @since BuddyPress (2.0.0)
     301 * @since 2.0.0
    303302 */
    304303function bp_xprofile_screen_settings() {
    … …  
    313312         * Filters the template to load for the XProfile settings screen.
    314313         *
    315          * @since BuddyPress (2.0.0)
     314         * @since 2.0.0
    316315         *
    317316         * @param string $template Path to the XProfile change avatar template to load.

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

    r9819 r10140  
    11<?php
     2/**
     3 * BuddyPress XProfile Settings.
     4 *
     5 * @package    BuddyPress
     6 * @subpackage XProfileSettings
     7 */
     8
     9// Exit if accessed directly.
     10defined( 'ABSPATH' ) || exit;
    211
    312/**
    413 * Query all profile fields and their visibility data for display in settings
    514 *
    6  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    716 *
    817 * @param array $args
    9  *
    1018 *
    1119 * @return array
    … …  
    3240 * Adds feedback messages when successfully saving profile field settings
    3341 *
    34  * @since BuddyPress (2.0.0)
     42 * @since 2.0.0
    3543 *
    3644 * @uses bp_core_add_message()

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

    r10082 r10140  
    11<?php
    2 
    32/**
    4  * BuddyPress XProfile Template Tags
     3 * BuddyPress XProfile Template Tags.
    54 *
    65 * @package BuddyPress
    … …  
    87 */
    98
    10 // Exit if accessed directly
     9// Exit if accessed directly.
    1110defined( 'ABSPATH' ) || exit;
    1211
    … …  
    1615 * This is responsible for loading profile field, group, and data and displaying it.
    1716 *
    18  * @since BuddyPress (1.0.0)
     17 * @since 1.0.0
    1918 */
    2019class BP_XProfile_Data_Template {
    … …  
    2322         * The loop iterator.
    2423         *
    25          * @since BuddyPress (1.5.0)
     24         * @since 1.5.0
    2625         * @access public
    2726         * @var int
    … …  
    3231         * The number of groups returned by the paged query.
    3332         *
    34          * @since BuddyPress (1.5.0)
     33         * @since 1.5.0
    3534         * @access public
    3635         * @var int
    … …  
    4140         * Array of groups located by the query.
    4241         *
    43          * @since BuddyPress (1.5.0)
     42         * @since 1.5.0
    4443         * @access public
    4544         * @var array
    … …  
    5049         * The group object currently being iterated on.
    5150         *
    52          * @since BuddyPress (1.5.0)
     51         * @since 1.5.0
    5352         * @access public
    5453         * @var object
    … …  
    5958         * The current field.
    6059         *
    61          * @since BuddyPress (1.5.0)
     60         * @since 1.5.0
    6261         * @access public
    6362         * @var int
    … …  
    6867         * The field count.
    6968         *
    70          * @since BuddyPress (1.5.0)
     69         * @since 1.5.0
    7170         * @access public
    7271         * @var int
    … …  
    7776         * Field has data.
    7877         *
    79          * @since BuddyPress (1.5.0)
     78         * @since 1.5.0
    8079         * @access public
    8180         * @var bool
    … …  
    8685         * The field.
    8786         *
    88          * @since BuddyPress (1.5.0)
     87         * @since 1.5.0
    8988         * @access public
    9089         * @var int
    … …  
    9594         * A flag for whether the loop is currently being iterated.
    9695         *
    97          * @since BuddyPress (1.5.0)
     96         * @since 1.5.0
    9897         * @access public
    9998         * @var bool
    … …  
    104103         * The user ID.
    105104         *
    106          * @since BuddyPress (1.5.0)
     105         * @since 1.5.0
    107106         * @access public
    108107         * @var int
    … …  
    115114         * @see BP_XProfile_Group::get() for more details about parameters.
    116115         *
    117          * @since BuddyPress (2.4.0) Introduced `$member_type` argument.
     116         * @since 2.4.0 Introduced `$member_type` argument.
    118117         *
    119118         * @param array $args {
    … …  
    194193                         * Filters the group fields for the next_group method.
    195194                         *
    196                          * @since BuddyPress (1.1.0)
     195                         * @since 1.1.0
    197196                         *
    198197                         * @param array $fields Array of fields for the group.
    … …  
    221220                         * Fires right before the rewinding of profile groups.
    222221                         *
    223                          * @since BuddyPress (1.1.0)
     222                         * @since 1.1.0
    224223                         */
    225224                        do_action( 'xprofile_template_loop_end' );
    … …  
    245244                         * Fires if the current group is the first in the loop.
    246245                         *
    247                          * @since BuddyPress (1.1.0)
     246                         * @since 1.1.0
    248247                         */
    249248                        do_action( 'xprofile_template_loop_start' );
    … …  
    316315 * Query for XProfile groups and fields
    317316 *
    318  * @since BuddyPress (1.0.0)
     317 * @since 1.0.0
    319318 *
    320319 * @global object $profile_template
    … …  
    371370         * Filters whether or not a group has a profile to display.
    372371         *
    373          * @since BuddyPress (1.1.0)
     372         * @since 1.1.0
    374373         *
    375374         * @param bool   $has_groups       Whether or not there are group profiles to display.
    … …  
    431430                 * Filters the field classes to be applied to a field.
    432431                 *
    433                  * @since BuddyPress (1.1.0)
     432                 * @since 1.1.0
    434433                 *
    435434                 * @param array $css_classes Array of classes to be applied to field. Passed by reference.
    … …  
    440439                 * Filters the class HTML attribute to be used on a field.
    441440                 *
    442                  * @since BuddyPress (1.1.0)
     441                 * @since 1.1.0
    443442                 *
    444443                 * @param string $value class HTML attribute with imploded classes.
    … …  
    471470                 * Filters the profile group ID.
    472471                 *
    473                  * @since BuddyPress (1.1.0)
     472                 * @since 1.1.0
    474473                 *
    475474                 * @param int $id ID for the profile group.
    … …  
    487486                 * Filters the profile group name.
    488487                 *
    489                  * @since BuddyPress (1.0.0)
     488                 * @since 1.0.0
    490489                 *
    491490                 * @param string $name Name for the profile group.
    … …  
    503502                 * Filters the profile group slug.
    504503                 *
    505                  * @since BuddyPress (1.1.0)
     504                 * @since 1.1.0
    506505                 *
    507506                 * @param string $value Slug for the profile group.
    … …  
    519518                 * Filters the profile group description.
    520519                 *
    521                  * @since BuddyPress (1.0.0)
     520                 * @since 1.0.0
    522521                 *
    523522                 * @param string $description Description for the profile group.
    … …  
    538537                 * Filters the action for the profile group edit form.
    539538                 *
    540                  * @since BuddyPress (1.1.0)
     539                 * @since 1.1.0
    541540                 *
    542541                 * @param string $value URL for the action attribute on the
    … …  
    566565 * Output a comma-separated list of field IDs that are to be submitted on profile edit.
    567566 *
    568  * @since BuddyPress (2.1.0)
     567 * @since 2.1.0
    569568 */
    570569function bp_the_profile_field_ids() {
    … …  
    574573         * Generate a comma-separated list of field IDs that are to be submitted on profile edit.
    575574         *
    576          * @since BuddyPress (2.1.0)
     575         * @since 2.1.0
    577576         *
    578577         * @return string
    … …  
    593592                 * Filters the comma-separated list of field IDs.
    594593                 *
    595                  * @since BuddyPress (2.1.0)
     594                 * @since 2.1.0
    596595                 *
    597596                 * @param string $field_ids Comma-separated field IDs.
    … …  
    619618                 * Filters the profile field ID.
    620619                 *
    621                  * @since BuddyPress (1.1.0)
     620                 * @since 1.1.0
    622621                 *
    623622                 * @param int $id ID for the profile field.
    … …  
    635634                 * Filters the profile field name.
    636635                 *
    637                  * @since BuddyPress (1.0.0)
     636                 * @since 1.0.0
    638637                 *
    639638                 * @param string $name Name for the profile field.
    … …  
    653652                 * Filters the profile field value.
    654653                 *
    655                  * @since BuddyPress (1.0.0)
     654                 * @since 1.0.0
    656655                 *
    657656                 * @param string $value Value for the profile field.
    … …  
    693692                 * Filters the profile field edit value.
    694693                 *
    695                  * @since BuddyPress (1.1.0)
     694                 * @since 1.1.0
    696695                 *
    697696                 * @param string $field_value Current field edit value.
    … …  
    711710                 * Filters the profile field type.
    712711                 *
    713                  * @since BuddyPress (1.1.0)
     712                 * @since 1.1.0
    714713                 *
    715714                 * @param string $type Type for the profile field.
    … …  
    727726                 * Filters the profile field description.
    728727                 *
    729                  * @since BuddyPress (1.1.0)
     728                 * @since 1.1.0
    730729                 *
    731730                 * @param string $description Description for the profile field.
    … …  
    743742                 * Filters the profile field input name.
    744743                 *
    745                  * @since BuddyPress (1.1.0)
     744                 * @since 1.1.0
    746745                 *
    747746                 * @param string $value Value used for the name attribute on an input.
    … …  
    759758 *   do_action( bp_get_the_profile_field_errors_action() );
    760759 *
    761  * @since BuddyPress (1.8.0)
     760 * @since 1.8.0
    762761 * @return string The _errors action name corresponding to this profile field
    763762 */
    … …  
    774773 *
    775774 * @package BuddyPress Xprofile
    776  * @since BuddyPress (1.1.0)
     775 * @since 1.1.0
    777776 *
    778777 * @uses bp_get_the_profile_field_options()
    … …  
    789788         *
    790789         * @package BuddyPress Xprofile
    791          * @since BuddyPress (1.1.0)
     790         * @since 1.1.0
    792791         *
    793792         * @uses BP_XProfile_Field::get_children()
    … …  
    855854                 * Filters whether or not a profile field is required.
    856855                 *
    857                  * @since BuddyPress (1.1.0)
     856                 * @since 1.1.0
    858857                 *
    859858                 * @param bool $retval Whether or not the field is required.
    … …  
    886885                 * Filters the profile field visibility level.
    887886                 *
    888                  * @since BuddyPress (1.6.0)
     887                 * @since 1.6.0
    889888                 *
    890889                 * @param string $retval Field visibility level.
    … …  
    919918                 * Filters the profile field visibility level label.
    920919                 *
    921                  * @since BuddyPress (1.6.0)
     920                 * @since 1.6.0
    922921                 *
    923922                 * @param string $retval Field visibility level label.
    … …  
    950949                 * Filters the profile field data.
    951950                 *
    952                  * @since BuddyPress (1.2.0)
     951                 * @since 1.2.0
    953952                 *
    954953                 * @param mixed $value Profile data for a specific field for the user.
    … …  
    960959 * Get all profile field groups.
    961960 *
    962  * @since  BuddyPress (2.1.0)
     961 * @since  2.1.0
    963962 *
    964963 * @return object $groups
    … …  
    975974         * Filters all profile field groups.
    976975         *
    977          * @since BuddyPress (2.1.0)
     976         * @since 2.1.0
    978977         *
    979978         * @param array $groups Array of available profile field groups.
    … …  
    985984 * Check if there is more than one group of fields for the profile being edited.
    986985 *
    987  * @since  BuddyPress (2.1.0)
     986 * @since  2.1.0
    988987 *
    989988 * @return bool True if there is more than one profile field group.
    … …  
    995994         * Filters if there is more than one group of fields for the profile being edited.
    996995         *
    997          * @since BuddyPress (2.1.0)
     996         * @since 2.1.0
    998997         *
    999998         * @param bool $has_multiple_groups Whether or not there are multiple groups.
    … …  
    10051004 * Output the tabs to switch between profile field groups.
    10061005 *
    1007  * @since BuddyPress (1.0.0)
     1006 * @since 1.0.0
    10081007 *
    10091008 * @return string Field group tabs markup.
    … …  
    10161015         * groups. This action is in a strange place for legacy reasons.
    10171016         *
    1018          * @since BuddyPress (1.0.0)
     1017         * @since 1.0.0
    10191018         */
    10201019        do_action( 'xprofile_profile_group_tabs' );
    … …  
    10241023 * Return the XProfile group tabs
    10251024 *
    1026  * @since BuddyPress (2.3.0)
     1025 * @since 2.3.0
    10271026 *
    10281027 * @return string
    … …  
    10641063         * Filters the tabs to display for profile field groups.
    10651064         *
    1066          * @since BuddyPress (1.5.0)
     1065         * @since 1.5.0
    10671066         *
    10681067         * @param array  $tabs       Array of tabs to display.
    … …  
    10961095                 * Filters the profile group name.
    10971096                 *
    1098                  * @since BuddyPress (1.0.0)
     1097                 * @since 1.0.0
    10991098                 *
    11001099                 * @param string $name Name of the profile group.
    … …  
    11221121                         * Filters the formatted string used to display when a profile was last updated.
    11231122                         *
    1124                          * @since BuddyPress (1.0.0)
     1123                         * @since 1.0.0
    11251124                         *
    11261125                         * @param string $value Formatted last updated indicator string.
    … …  
    11461145                 * Possible values are admin/profile/edit/[group-id]
    11471146                 *
    1148                  * @since BuddyPress (1.1.0)
     1147                 * @since 1.1.0
    11491148                 *
    11501149                 * @param string $profile_group_id Current profile group ID.
    … …  
    11611160                 * Filters the link used for deleting an avatar.
    11621161                 *
    1163                  * @since BuddyPress (1.1.0)
     1162                 * @since 1.1.0
    11641163                 *
    11651164                 * @param string $value Nonced URL used for deleting an avatar.
    … …  
    12431242                 * Filters the radio buttons for setting visibility.
    12441243                 *
    1245                  * @since BuddyPress (1.6.0)
     1244                 * @since 1.6.0
    12461245                 *
    12471246                 * @param string $retval HTML output for the visibility radio buttons.
    … …  
    12551254 * Output the XProfile field visibility select list for settings
    12561255 *
    1257  * @since BuddyPress (2.0.0)
     1256 * @since 2.0.0
    12581257 */
    12591258function bp_profile_settings_visibility_select( $args = '' ) {
    … …  
    12631262         * Return the XProfile field visibility select list for settings
    12641263         *
    1265          * @since BuddyPress (2.0.0)
     1264         * @since 2.0.0
    12661265         */
    12671266        function bp_profile_get_settings_visibility_select( $args = '' ) {
    … …  
    13161315                 * Filters the dropdown list for setting visibility.
    13171316                 *
    1318                  * @since BuddyPress (2.0.0)
     1317                 * @since 2.0.0
    13191318                 *
    13201319                 * @param string $retval HTML output for the visibility dropdown list.

  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-checkbox.php

    r9819 r10140  
    11<?php
    22/**
    3  * BuddyPress XProfile Classes
     3 * BuddyPress XProfile Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313 * Checkbox xprofile field type.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717class BP_XProfile_Field_Type_Checkbox extends BP_XProfile_Field_Type {
    … …  
    2020         * Constructor for the checkbox field type
    2121         *
    22          * @since BuddyPress (2.0.0)
     22         * @since 2.0.0
    2323         */
    2424        public function __construct() {
    … …  
    3737                 * Fires inside __construct() method for BP_XProfile_Field_Type_Checkbox class.
    3838                 *
    39                  * @since BuddyPress (2.0.0)
     39                 * @since 2.0.0
    4040                 *
    4141                 * @param BP_XProfile_Field_Type_Checkbox $this Current instance of
    … …  
    5151         *
    5252         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/input.checkbox.html permitted attributes} that you want to add.
    53          * @since BuddyPress (2.0.0)
     53         * @since 2.0.0
    5454         */
    5555        public function edit_field_html( array $raw_properties = array() ) {
    … …  
    9898         *
    9999         * @param array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}.
    100          * @since BuddyPress (2.0.0)
     100         * @since 2.0.0
    101101         */
    102102        public function edit_field_options_html( array $args = array() ) {
    … …  
    148148                         * Filters the HTML output for an individual field options checkbox.
    149149                         *
    150                          * @since BuddyPress (1.1.0)
     150                         * @since 1.1.0
    151151                         *
    152152                         * @param string $new_html Label and checkbox input field.
    … …  
    168168         *
    169169         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    170          * @since BuddyPress (2.0.0)
     170         * @since 2.0.0
    171171         */
    172172        public function admin_field_html( array $raw_properties = array() ) {
    … …  
    181181         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    182182         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    183          * @since BuddyPress (2.0.0)
     183         * @since 2.0.0
    184184         */
    185185        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {

  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-datebox.php

    r9819 r10140  
    11<?php
    22/**
    3  * BuddyPress XProfile Classes
     3 * BuddyPress XProfile Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313 * Datebox xprofile field type.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717class BP_XProfile_Field_Type_Datebox extends BP_XProfile_Field_Type {
    … …  
    2020         * Constructor for the datebox field type
    2121         *
    22          * @since BuddyPress (2.0.0)
     22         * @since 2.0.0
    2323         */
    2424        public function __construct() {
    … …  
    3333                 * Fires inside __construct() method for BP_XProfile_Field_Type_Datebox class.
    3434                 *
    35                  * @since BuddyPress (2.0.0)
     35                 * @since 2.0.0
    3636                 *
    3737                 * @param BP_XProfile_Field_Type_Datebox $this Current instance of
    … …  
    4747         *
    4848         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/input.html permitted attributes} that you want to add.
    49          * @since BuddyPress (2.0.0)
     49         * @since 2.0.0
    5050         */
    5151        public function edit_field_html( array $raw_properties = array() ) {
    … …  
    8888                         * your needed target ID.
    8989                         *
    90                          * @since BuddyPress (1.8.0)
     90                         * @since 1.8.0
    9191                         */
    9292                        do_action( bp_get_the_profile_field_errors_action() ); ?>
    … …  
    129129         *
    130130         * @param array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}.
    131          * @since BuddyPress (2.0.0)
     131         * @since 2.0.0
    132132         */
    133133        public function edit_field_options_html( array $args = array() ) {
    … …  
    224224                 * Filters the output for the profile field datebox.
    225225                 *
    226                  * @since BuddyPress (1.1.0)
     226                 * @since 1.1.0
    227227                 *
    228228                 * @param string $html  HTML output for the field.
    … …  
    243243         *
    244244         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    245          * @since BuddyPress (2.0.0)
     245         * @since 2.0.0
    246246         */
    247247        public function admin_field_html( array $raw_properties = array() ) {
    … …  
    283283         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    284284         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    285          * @since BuddyPress (2.0.0)
     285         * @since 2.0.0
    286286         */
    287287        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
    … …  
    290290         * Format Date values for display.
    291291         *
    292          * @since BuddyPress (2.1.0)
     292         * @since 2.1.0
    293293         *
    294294         * @param string $field_value The date value, as saved in the database.

  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-multiselectbox.php

    r9819 r10140  
    11<?php
    22/**
    3  * BuddyPress XProfile Classes
     3 * BuddyPress XProfile Classes.
    44 *
    55 * @package BuddyPress
    … …  
    77 */
    88
    9 // Exit if accessed directly
     9// Exit if accessed directly.
    1010defined( 'ABSPATH' ) || exit;
    1111
    … …  
    1313 * Multi-selectbox xprofile field type.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717class BP_XProfile_Field_Type_Multiselectbox extends BP_XProfile_Field_Type {
    … …  
    2020         * Constructor for the multi-selectbox field type
    2121         *
    22          * @since BuddyPress (2.0.0)
     22         * @since 2.0.0
    2323         */
    2424        public function __construct() {
    … …  
    3737                 * Fires inside __construct() method for BP_XProfile_Field_Type_Multiselectbox class.
    3838                 *
    39                  * @since BuddyPress (2.0.0)
     39                 * @since 2.0.0
    4040                 *
    4141                 * @param BP_XProfile_Field_Type_Multiselectbox $this Current instance of
    … …  
    5151         *
    5252         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/select.html permitted attributes} that you want to add.
    53          * @since BuddyPress (2.0.0)
     53         * @since 2.0.0
    5454         */
    5555        public function edit_field_html( array $raw_properties = array() ) {
    … …  
    105105         *
    106106         * @param array $args Optional. The arguments passed to {@link bp_the_profile_field_options()}.
    107          * @since BuddyPress (2.0.0)
     107         * @since 2.0.0
    108108         */
    109109        public function edit_field_options_html( array $args = array() ) {
    … …  
    148148                         * Filters the HTML output for options in a multiselect input.
    149149                         *
    150                          * @since BuddyPress (1.5.0)
     150                         * @since 1.5.0
    151151                         *
    152152                         * @param string $value    Option tag for current value being rendered.
    … …  
    168168         *
    169169         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    170          * @since BuddyPress (2.0.0)
     170         * @since 2.0.0
    171171         */
    172172        public function admin_field_html( array $raw_properties = array() ) {
    … …  
    189189         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    190190         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    191          * @since BuddyPress (2.0.0)
     191         * @since 2.0.0
    192192         */
    193193        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {

  • trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-number.php

    r9819 r10140  
    1313 * Number xprofile field type.
    1414 *
    15  * @since BuddyPress (2.0.0)
     15 * @since 2.0.0
    1616 */
    1717class BP_XProfile_Field_Type_Number extends BP_XProfile_Field_Type {
    … …  
    2020         * Constructor for the number field type
    2121         *
    22          * @since BuddyPress (2.0.0)
     22         * @since 2.0.0
    2323         */
    2424        public function __construct() {
    … …  
    3333                 * Fires inside __construct() method for BP_XProfile_Field_Type_Number class.
    3434                 *
    35                  * @since BuddyPress (2.0.0)
     35                 * @since 2.0.0
    3636                 *
    3737                 * @param BP_XProfile_Field_Type_Number $this Current instance of
    … …  
    4747         *
    4848         * @param array $raw_properties Optional key/value array of {@link http://dev.w3.org/html5/markup/input.number.html permitted attributes} that you want to add.
    49          * @since BuddyPress (2.0.0)
     49         * @since 2.0.0
    5050         */
    5151        public function edit_field_html( array $raw_properties = array() ) {
    … …  
    8585         *
    8686         * @param array $raw_properties Optional key/value array of permitted attributes that you want to add.
    87          * @since BuddyPress (2.0.0)
     87         * @since 2.0.0
    8888         */
    8989        public function admin_field_html( array $raw_properties = array() ) {
    … …  
    102102         * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    103103         * @param string $control_type Optional. HTML input type used to render the current field's child options.
    104          * @since BuddyPress (2.0.0)
     104         * @since 2.0.0
    105105         */
    106106        public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
Note: See TracChangeset for help on using the changeset viewer.