Changeset 10740 for trunk/src/bp-xprofile/bp-xprofile-filters.php

Timestamp:

05/07/2016 07:38:27 PM (9 years ago)

Author:

tw2113

Message:

Continued XProfile docs cleanup.

See #6406.

File:

• trunk/src/bp-xprofile/bp-xprofile-filters.php (modified) (7 diffs)

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

@@ -83 +83 @@
  * @since 2.3.0
  *
- * @param  mixed $field_options Options to sanitize.
- *
+ * @param mixed $field_options Options to sanitize.
  * @return mixed
  */
@@ -100 +99 @@
  * @since 2.3.0
  *
- * @param  mixed $field_default Field defaults to sanitize.
- *
+ * @param mixed $field_default Field defaults to sanitize.
  * @return mixed
  */
@@ -115 +113 @@
  * Run profile field values through kses with filterable allowed tags.
  *
+ * @since 1.5.0
+ *
  * @param string      $content  Content to filter.
  * @param object|null $data_obj The BP_XProfile_ProfileData object.
- *
  * @return string $content
  */
@@ -155 +154 @@
  * Safely runs profile field data through kses and force_balance_tags.
  *
+ * @since 1.2.6
+ *
  * @param string      $field_value Field value being santized.
  * @param int         $field_id    Field ID being sanitized.
  * @param bool        $reserialize Whether to reserialize arrays before returning. Defaults to true.
  * @param object|null $data_obj    The BP_XProfile_ProfileData object.
- *
  * @return string
  */
@@ -217 +217 @@
  * @param string $field_value XProfile field_value to be filtered.
  * @param string $field_type  XProfile field_type to be filtered.
- *
  * @return string $field_value Filtered XProfile field_value. False on failure.
  */
@@ -243 +242 @@
  * @param string     $field_type  Field type.
  * @param string|int $field_id    Optional. ID of the field.
- *
  * @return mixed
  */
@@ -394 +392 @@
  * and swaps out user data with BP xprofile data, where available.
  *
+ * @since 1.2.0
+ *
  * @param array $comments Comments to filter in.
  * @param int   $post_id  Post ID the comments are for.
- *
  * @return array $comments
  */