Changeset 10198 for trunk/src/bp-xprofile/bp-xprofile-functions.php

Timestamp:

10/07/2015 02:30:31 PM (9 years ago)

Author:

boonebgorges

Message:

Introduce cache support for xprofile fields.

xprofile_get_field() will now look in the cache before returning a
BP_XProfile_Field object (via the new BP_XProfile_Field::get_instance()),
and will populate the cache if necessary. It's strongly recommended to use
xprofile_get_field() when fetching individual existing fields, instead of
creating new BP_XProfile_Field objects directly.

BP_XProfile_Group::get() now leverages the field cache too. Instead of a
SELECT * query, it fetches a list of matching field IDs SELECT id, and
populates the full field objects from the cache, if available. The fields
property of BP_XProfile_Group objects is now an array of BP_XProfile_Field
objects, not stdClass. See #6358.

Props boonebgorges, r-a-y.
See #6638.

File:

• trunk/src/bp-xprofile/bp-xprofile-functions.php (modified) (1 diff)

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

@@ -276 +276 @@
 }
 
-function xprofile_get_field( $field_id ) {
-    return new BP_XProfile_Field( $field_id );
+/**
+ * Get a profile field object.
+ *
+ * @param int|object $field ID of the field or object representing field data.
+ * @return BP_XProfile_Field|null Field object if found, otherwise null.
+ */
+function xprofile_get_field( $field ) {
+    if ( $field instanceof BP_XProfile_Field ) {
+        $_field = $field;
+    } elseif ( is_object( $field ) ) {
+        $_field = new BP_XProfile_Field();
+        $_field->fill_data( $field );
+    } else {
+        $_field = BP_XProfile_Field::get_instance( $field );
+    }
+
+    if ( ! $_field ) {
+        return null;
+    }
+
+    return $_field;
 }