xprofile_get_field_data

Fetches profile data for a specific field for the user.

Description

xprofile_get_field_data( (mixed) $field, (int) $user_id = 0, (string) $multi_format = 'array' ); 

When the field value is serialized, this function unserializes and filters each item in the array.

Parameters (3)

0. $field (mixed)
The ID of the field, or the $name of the field.
1. $user_id — Optional. (int)
The ID of the user.
2. $multi_format — Optional. (string) => 'array'
How should array data be returned? comma if you want a comma-separated string; array if you want an array.

Usage

  1. if ( !function_exists( 'xprofile_get_field_data' ) ) { 
  2.     require_once '/bp-xprofile/bp-xprofile-functions.php'; 
  3. } 
  4.   
  5. // The ID of the field, or the $name of the field. 
  6. $field = null; 
  7.   
  8. // The ID of the user. 
  9. $user_id = -1; 
  10.   
  11. // How should array data be returned? 'comma' if you want a 
  12. // comma-separated string; 'array' if you want an array. 
  13. $multi_format = 'array'; 
  14.   
  15. // NOTICE! Understand what this does before running. 
  16. $result = xprofile_get_field_data($field, $user_id, $multi_format); 
  17.     

Defined (1)

The function is defined in the following location(s).

/bp-xprofile/bp-xprofile-functions.php  
  1. function xprofile_get_field_data( $field, $user_id = 0, $multi_format = 'array' ) { 
  2.  
  3.     if ( empty( $user_id ) ) { 
  4.         $user_id = bp_displayed_user_id(); 
  5.     } 
  6.  
  7.     if ( empty( $user_id ) ) { 
  8.         return false; 
  9.     } 
  10.  
  11.     if ( is_numeric( $field ) ) { 
  12.         $field_id = $field; 
  13.     } else { 
  14.         $field_id = xprofile_get_field_id_from_name( $field ); 
  15.     } 
  16.  
  17.     if ( empty( $field_id ) ) { 
  18.         return false; 
  19.     } 
  20.  
  21.     $values = maybe_unserialize( BP_XProfile_ProfileData::get_value_byid( $field_id, $user_id ) ); 
  22.  
  23.     if ( is_array( $values ) ) { 
  24.         $data = array(); 
  25.         foreach( (array) $values as $value ) { 
  26.  
  27.             /** 
  28.              * Filters the field data value for a specific field for the user. 
  29.              * 
  30.              * @since 1.0.0 
  31.              * 
  32.              * @param string $value    Value saved for the field. 
  33.              * @param int    $field_id ID of the field being displayed. 
  34.              * @param int    $user_id  ID of the user being displayed. 
  35.              */ 
  36.             $data[] = apply_filters( 'xprofile_get_field_data', $value, $field_id, $user_id ); 
  37.         } 
  38.  
  39.         if ( 'comma' == $multi_format ) { 
  40.             $data = implode( ', ', $data ); 
  41.         } 
  42.     } else { 
  43.         /** This filter is documented in bp-xprofile/bp-xprofile-functions.php */ 
  44.         $data = apply_filters( 'xprofile_get_field_data', $values, $field_id, $user_id ); 
  45.     } 
  46.  
  47.     return $data; 
  48. }