Changeset 12729 for trunk/src/bp-members/bp-members-functions.php

Timestamp:

09/21/2020 01:21:21 AM (4 years ago)

Author:

imath

Message:

BP Types: merge BP Types saved in DB with the ones registered by code

• Introduces the bp_get_taxonomy_types() to merge types saved into the database with the types registered by code. It's now possible to edit all properties of the registered by code types except for the type's slug which needs to be unique.
• Caches these merged types.
• Introduces the bp_get_member_types_registered_by_code() to only get member types registered by code.
• Updates the test_bp_get_member_type_should_not_return_unregistered_types() unit test to test_bp_get_registered_by_code_member_type_should_not_return_unregistered_types() to check the previous point new function.
• Introduces the bp_update_type_metadata() function to update a type's metadata.

Props mercime, DJPaul, dcavins, boonebgorges, tw2113, sbrajesh

See #7179
See #7181

File:

• trunk/src/bp-members/bp-members-functions.php (modified) (5 diffs)

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

@@ -2764 +2764 @@
         'labels'        => array(),
         'has_directory' => true,
+        'code'          => true,
+        'db_id'         => 0,
     ), 'register_member_type' );
 
@@ -2863 +2865 @@
     $types = buddypress()->members->types;
 
+    // Merge with types available into the database.
+    if ( ! isset( $args['code'] ) || true !== $args['code'] ) {
+        $types = bp_get_taxonomy_types( bp_get_member_type_tax_name(), $types );
+    }
+
     $types = wp_filter_object_list( $types, $args, $operator );
 
@@ -2885 +2892 @@
     return $types;
 }
+
+/**
+ * Only gets the member types registered by code.
+ *
+ * @since 7.0.0
+ *
+ * @return array The member types registered by code.
+ */
+function bp_get_member_types_registered_by_code() {
+    return bp_get_member_types(
+        array(
+            'code' => true,
+        ),
+        'objects'
+    );
+}
+add_filter( bp_get_member_type_tax_name() . '_registered_by_code', 'bp_get_member_types_registered_by_code' );
+
+/**
+ * Generates missing metadata for a type registered by code.
+ *
+ * @since 7.0.0
+ *
+ * @return array The member type metadata.
+ */
+function bp_set_registered_by_code_member_type_metadata( $metadata = array(), $type = '' ) {
+    $member_type = bp_get_member_type_object( $type );
+
+    foreach ( get_object_vars( $member_type ) as $object_key => $object_value ) {
+        if ( 'labels' === $object_key ) {
+            foreach ( $object_value as $label_key => $label_value ) {
+                $metadata[ 'bp_type_' . $label_key ] = $label_value;
+            }
+        } elseif ( ! in_array( $object_key, array( 'name', 'code', 'db_id' ), true ) ) {
+            $metadata[ 'bp_type_' . $object_key ] = $object_value;
+        }
+    }
+
+    /**
+     * Save metadata into database to avoid generating metadata
+     * each time a type is listed into the Types Admin screen.
+     */
+    if ( isset( $member_type->db_id ) && $member_type->db_id ) {
+        bp_update_type_metadata( $member_type->db_id, bp_get_member_type_tax_name(), $metadata );
+    }
+
+    return $metadata;
+}
+add_filter( bp_get_member_type_tax_name() . '_set_registered_by_code_metada', 'bp_set_registered_by_code_member_type_metadata', 10, 2 );
+
+/**
+ * Insert member types registered by code not yet saved into the database as WP Terms.
+ *
+ * @since 7.0.0
+ */
+function bp_insert_member_types_registered_by_code() {
+    $all_types     = bp_get_member_types( array(), 'objects' );
+    $unsaved_types = wp_filter_object_list( $all_types, array( 'db_id' => 0 ), 'and', 'name' );
+
+    if ( $unsaved_types ) {
+        foreach ( $unsaved_types as $type_name ) {
+            bp_insert_term(
+                $type_name,
+                bp_get_member_type_tax_name(),
+                array(
+                    'slug' => $type_name,
+                )
+            );
+        }
+    }
+}
+add_action( bp_get_member_type_tax_name() . '_add_form', 'bp_insert_member_types_registered_by_code', 1 );
 
 /**
@@ -2969 +3048 @@
  *
  * @since 2.2.0
+ * @since 7.0.0 Adds the `$use_db` parameter.
  *
  * @param int  $user_id ID of the user.
  * @param bool $single  Optional. Whether to return a single type string. If multiple types are found
  *                      for the user, the oldest one will be returned. Default: true.
+ * @param bool $use_db  Optional. Whether to request all member types or only the ones registered by code.
+ *                      Default: true.
  * @return string|array|bool On success, returns a single member type (if $single is true) or an array of member
  *                           types (if $single is false). Returns false on failure.
  */
-function bp_get_member_type( $user_id, $single = true ) {
+function bp_get_member_type( $user_id, $single = true, $use_db = true ) {
     $types = wp_cache_get( $user_id, 'bp_member_member_type' );
 
@@ -2994 +3076 @@
             wp_cache_set( $user_id, $types, 'bp_member_member_type' );
         }
+    }
+
+    if ( false === $use_db && $types ) {
+        $registred_by_code = bp_get_member_types_registered_by_code();
+        $ctype_names       = wp_list_pluck( $registred_by_code, 'name' );
+        $types             = array_intersect( $types, $ctype_names );
     }