Changeset 10163 for trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-url.php

Timestamp:

10/01/2015 04:18:13 AM (11 years ago)

Author:

tw2113

Message:

First pass of documentation cleanup for the XProfile Component.

See #6406.

File:

• trunk/src/bp-xprofile/classes/class-bp-xprofile-field-type-url.php (modified) (6 diffs)

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

@@ -1 +1 @@
 <?php
 /**
- * BuddyPress XProfile Classes
+ * BuddyPress XProfile Classes.
  *
  * @package BuddyPress
@@ -47 +47 @@
          *
          * @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.
+         *                              {@link http://dev.w3.org/html5/markup/input.number.html permitted attributes}
+         *                              that you want to add.
+         *
          * @since 2.1.0
          */
@@ -88 +89 @@
          *
          * @param array $raw_properties Optional key/value array of permitted
-         *        attributes that you want to add.
+         *                              attributes that you want to add.
          * @since 2.1.0
          */
@@ -107 +108 @@
          * for this field type, we don't want it, so it's stubbed out.
          *
+         * @since 2.1.0
+         *
          * @param BP_XProfile_Field $current_field The current profile field on the add/edit screen.
-         * @param string $control_type Optional. HTML input type used to render the current field's child options.
-         * @since 2.1.0
+         * @param string            $control_type  Optional. HTML input type used to render the current
+         *                                         field's child options.
          */
         public function admin_new_field_html( BP_XProfile_Field $current_field, $control_type = '' ) {}
@@ -126 +129 @@
          *
          * @param string $submitted_value Raw value submitted by the user.
+         *
          * @return string
          */
         public static function pre_validate_filter( $submitted_value = '' ) {
 
-                // Allow empty URL values
+                // Allow empty URL values.
                 if ( empty( $submitted_value ) ) {
                         return '';
                 }
 
-                // Run some checks on the submitted value
+                // Run some checks on the submitted value.
                 if ( false === strpos( $submitted_value, ':'  )
                      && substr( $submitted_value, 0, 1 ) !== '/'
@@ -153 +157 @@
          *
          * @param string $field_value The URL value, as saved in the database.
+         *
          * @return string URL converted to a link.
          */