Changeset 14025

Timestamp:

09/23/2024 02:35:01 PM (22 months ago)

Author:

espellcaste

Message:

Fix: bp_get_object_terms returning a WP_Error object when used too early.

Added a _doing_it_wrong check to prevent errors when using the bp_get_object_terms function too early (before taxonomies are registered). Also, handle the case where wp_get_object_terms() returns an error.

Props raviousprime, paulgibbs, and imath.

Fixes #9227
Closes ​https://github.com/buddypress/buddypress/pull/370/

File:

• trunk/src/bp-core/bp-core-taxonomy.php (modified) (3 diffs)

trunk/src/bp-core/bp-core-taxonomy.php

@@ -142 +142 @@
  *
  * @since 2.2.0
- *
- * @see wp_get_object_terms() for a full description of function and parameters.
+ * @since 15.0.0 Added a `_doing_it_wrong` check to prevent errors when using the function too early.
+ *
+ * @see wp_get_object_terms() for a full description of function and parameters
  *
  * @param int|array    $object_ids ID or IDs of objects.
  * @param string|array $taxonomies Name or names of taxonomies to match.
  * @param array        $args       See {@see wp_get_object_terms()}.
- * @return array
+ *
+ * @return WP_Term[]|int[]|string[]
  */
 function bp_get_object_terms( $object_ids, $taxonomies, $args = array() ) {
+
+        // Check if the bp_register_taxonomies hook is set.
+        if ( ! did_action( 'bp_register_taxonomies' ) ) {
+                _doing_it_wrong(
+                        __FUNCTION__,
+                        sprintf(
+                                /* translators: 1: the name of the function. 2: the name of the hook. */
+                                esc_html__( 'The %1$s function requires the %2$s hook to be fired before is used.', 'buddypress' ),
+                                '<code>bp_get_object_terms</code>',
+                                '<code>bp_register_taxonomies</code>'
+                        ),
+                        '15.0.0'
+                );
+
+                // Return empty array since we don't have any taxonomies registered yet.
+                return array();
+        }
+
         // Different taxonomies must be stored on different sites.
         $taxonomy_site_map = array();
@@ -161 +181 @@
         foreach ( $taxonomy_site_map as $taxonomy_site_id => $site_taxonomies ) {
                 $switched = false;
+
                 if ( $taxonomy_site_id !== get_current_blog_id() ) {
                         switch_to_blog( $taxonomy_site_id );
@@ -168 +189 @@
 
                 $site_terms = wp_get_object_terms( $object_ids, $site_taxonomies, $args );
-                $retval     = array_merge( $retval, $site_terms );
+
+                // Handle the case where wp_get_object_terms() returns an error.
+                if ( is_wp_error( $site_terms ) || empty( $site_terms ) ) {
+                        $site_terms = array();
+                }
+
+                $retval = array_merge( $retval, $site_terms );
 
                 if ( $switched ) {