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

Timestamp:

03/04/2017 06:26:55 PM (8 years ago)

Author:

tw2113

Message:

Cleanup from recent Scrutinizer review around documentation and param/return types.

File:

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

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

@@ -100 +100 @@
  *
  * @param mixed $field_default Field defaults to sanitize.
- * @return mixed
+ * @return array|int
  */
 function bp_xprofile_sanitize_field_default( $field_default = '' ) {
@@ -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.
+ * @return false|string $field_value Filtered XProfile field_value. False on failure.
  */
 function xprofile_filter_format_field_value( $field_value, $field_type = '' ) {
@@ -337 +337 @@
  * @param string $field_value Profile field data value.
  * @param string $field_type  Profile field type.
- * @return string
+ * @return string|array
  */
 function xprofile_filter_link_profile_data( $field_value, $field_type = 'textbox' ) {