Skip to:
Content

BuddyPress.org


Ignore:
Timestamp:
10/01/2015 04:18:13 AM (9 years ago)
Author:
tw2113
Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:
1 edited

Legend:

Unmodified
Added
Removed

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

    r10142 r10163  
    11<?php
    22/**
    3  * BuddyPress XProfile Classes
     3 * BuddyPress XProfile Classes.
    44 *
    55 * @package BuddyPress
    … …  
    4747     *
    4848     * @param array $raw_properties Optional key/value array of
    49      *        {@link http://dev.w3.org/html5/markup/input.number.html permitted attributes}
    50      *        that you want to add.
     49     *                              {@link http://dev.w3.org/html5/markup/input.number.html permitted attributes}
     50     *                              that you want to add.
     51     *
    5152     * @since 2.1.0
    5253     */
    … …  
    8889     *
    8990     * @param array $raw_properties Optional key/value array of permitted
    90      *        attributes that you want to add.
     91     *                              attributes that you want to add.
    9192     * @since 2.1.0
    9293     */
    … …  
    107108     * for this field type, we don't want it, so it's stubbed out.
    108109     *
     110     * @since 2.1.0
     111     *
    109112     * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
    110      * @param string $control_type Optional. HTML input type used to render the current field's child options.
    111      * @since 2.1.0
     113     * @param string            $control_type  Optional. HTML input type used to render the current
     114     *                                         field's child options.
    112115     */
    113116    public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
    … …  
    126129     *
    127130     * @param string $submitted_value Raw value submitted by the user.
     131     *
    128132     * @return string
    129133     */
    130134    public static function pre_validate_filter( $submitted_value = '' ) {
    131135
    132         // Allow empty URL values
     136        // Allow empty URL values.
    133137        if ( empty( $submitted_value ) ) {
    134138            return '';
    135139        }
    136140
    137         // Run some checks on the submitted value
     141        // Run some checks on the submitted value.
    138142        if ( false === strpos( $submitted_value, ':'  )
    139143             && substr( $submitted_value, 0, 1 ) !== '/'
    … …  
    153157     *
    154158     * @param string $field_value The URL value, as saved in the database.
     159     *
    155160     * @return string URL converted to a link.
    156161     */
Note: See TracChangeset for help on using the changeset viewer.