Changeset 12745

Timestamp:

10/09/2020 07:17:20 PM (4 years ago)

Author:

imath

Message:

Core: introduce the bp_is_running_wp() function

This helper function checks WordPress version and is used by BuddyPress to ensure backward-compatibility when a WordPress feature/function is not yet available on the WordPress site BuddyPress is running on.

We have standardized the way we were doing these checks so far by replacing these with the use of this new bp_is_running_wp() function. It will help us to identify backward-compatibility chunks when we bump our minimum WP version.

bp_is_running_wp() accepts two arguments:

• the WP version, in "PHP-standardized" format.
• the comparison operator. It defaults to >=.

Props boonebgorges, r-a-y, espellcaste

Fixes #7906

Location:

trunk/src

Files:

• bp-activity/bp-activity-filters.php (modified) (1 diff)
• bp-blogs/bp-blogs-functions.php (modified) (1 diff)
• bp-core/bp-core-blocks.php (modified) (1 diff)
• bp-core/bp-core-catchuri.php (modified) (1 diff)
• bp-core/bp-core-functions.php (modified) (3 diffs)
• bp-core/bp-core-rest-api.php (modified) (1 diff)
• bp-core/bp-core-theme-compatibility.php (modified) (1 diff)
• bp-core/classes/class-bp-admin.php (modified) (1 diff)
• bp-core/classes/class-bp-embed.php (modified) (1 diff)
• bp-groups/bp-groups-cssjs.php (modified) (1 diff)
• bp-groups/bp-groups-filters.php (modified) (1 diff)
• bp-members/bp-members-template.php (modified) (1 diff)
• bp-messages/bp-messages-filters.php (modified) (1 diff)
• bp-settings/bp-settings-functions.php (modified) (1 diff)
• bp-settings/classes/class-bp-settings-component.php (modified) (2 diffs)

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

@@ -32 +32 @@
 add_filter( 'bp_activity_action_before_save',        'force_balance_tags' );
 
-if ( function_exists( 'wp_encode_emoji' ) ) {
-    add_filter( 'bp_activity_content_before_save', 'wp_encode_emoji' );
-}
+add_filter( 'bp_activity_content_before_save', 'wp_encode_emoji' );
 
 add_filter( 'bp_get_activity_action',                'wptexturize' );

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

@@ -576 +576 @@
 }
 
-if ( function_exists( 'wp_switch_roles_and_user' ) ) {
+if ( bp_is_running_wp( '4.9.0' ) ) {
     add_action( 'clean_site_cache', 'bp_blogs_delete_url_blogmeta' );
 } else {

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

@@ -20 +20 @@
  */
 function bp_support_blocks() {
-    return function_exists( 'register_block_type' ) && bp_rest_api_is_available();
+    return bp_is_running_wp( '5.0.0' ) && bp_rest_api_is_available();
 }
 

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

@@ -464 +464 @@
      * embed template, which is what we want.
      */
-    if ( function_exists( 'is_embed' ) && is_embed() ) {
+    if ( is_embed() ) {
         $located_template = '';
     }

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

@@ -70 +70 @@
         return !empty( $bp->db_version_raw ) ? $bp->db_version_raw : 0;
     }
+
+/**
+ * Check whether the current version of WP exceeds a given version.
+ *
+ * @since 7.0.0
+ *
+ * @param string $version WP version, in "PHP-standardized" format.
+ * @param string $compare Optional. Comparison operator. Default '>='.
+ * @return bool
+ */
+function bp_is_running_wp( $version, $compare = '>=' ) {
+    return version_compare( $GLOBALS['wp_version'], $version, $compare );
+}
 
 /** Functions *****************************************************************/
@@ -3135 +3148 @@
 
     // register_term_meta() was introduced in WP 4.9.8.
-    if ( ! function_exists( 'register_term_meta' ) ) {
+    if ( ! bp_is_running_wp( '4.9.8' ) ) {
         $args['object_subtype'] = $type_tax;
 
@@ -3539 +3552 @@
     );
 
-    if ( version_compare( $GLOBALS['wp_version'], '4.9.6', '>=' ) ) {
+    if ( bp_is_running_wp( '4.9.6' ) ) {
         $privacy_policy_url = get_privacy_policy_url();
         if ( $privacy_policy_url ) {

trunk/src/bp-core/bp-core-rest-api.php

@@ -57 +57 @@
      * @param boolean $value True if the BP REST API is available. False otherwise.
      */
-    return apply_filters( 'bp_rest_api_is_available', function_exists( 'create_initial_rest_routes' ) && bp_rest_in_buddypress() ) || bp_rest_is_plugin_active();
+    return apply_filters( 'bp_rest_api_is_available', bp_is_running_wp( '4.7.0' ) && bp_rest_in_buddypress() ) || bp_rest_is_plugin_active();
 }
 

trunk/src/bp-core/bp-core-theme-compatibility.php

@@ -666 +666 @@
 function bp_template_include_theme_compat( $template = '' ) {
     // If embed template, bail.
-    if ( true === function_exists( 'is_embed' ) && is_embed() ) {
+    if ( is_embed() ) {
         return $template;
     }

trunk/src/bp-core/classes/class-bp-admin.php

@@ -563 +563 @@
     public function add_privacy_policy_content() {
         // Nothing to do if we're running < WP 4.9.6.
-        if ( version_compare( $GLOBALS['wp_version'], '4.9.6', '<' ) ) {
+        if ( bp_is_running_wp( '4.9.6', '<' ) ) {
             return;
         }

trunk/src/bp-core/classes/class-bp-embed.php

@@ -118 +118 @@
         $id = apply_filters( 'embed_post_id', 0 );
 
-        $unfiltered_html   = current_user_can( 'unfiltered_html' );
-        $default_discovery = false;
-
         // Since 4.4, WordPress is now an oEmbed provider.
-        if ( function_exists( 'wp_oembed_register_route' ) ) {
-            $unfiltered_html   = true;
-            $default_discovery = true;
-        }
+        $unfiltered_html   = true;
+        $default_discovery = true;
 
         /**

trunk/src/bp-groups/bp-groups-cssjs.php

@@ -51 +51 @@
 
     $preloaded_members = array();
-    if ( function_exists( 'rest_preload_api_request' ) ) {
+    if ( bp_is_running_wp( '5.0.0' ) ) {
         $preloaded_members = rest_preload_api_request( '', $path );
     }

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

@@ -54 +54 @@
 
 // Support emoji.
-if ( function_exists( 'wp_encode_emoji' ) ) {
-    add_filter( 'groups_group_description_before_save', 'wp_encode_emoji' );
-}
+add_filter( 'groups_group_description_before_save', 'wp_encode_emoji' );
 
 // Escape output of new group creation details.

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

@@ -2417 +2417 @@
 function bp_signup_requires_privacy_policy_acceptance() {
     // Bail if we're running a version of WP that doesn't have the Privacy Policy feature.
-    if ( version_compare( $GLOBALS['wp_version'], '4.9.6', '<' ) ) {
+    if ( bp_is_running_wp( '4.9.6', '<' ) ) {
         return false;
     }

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

@@ -33 +33 @@
 add_filter( 'messages_notice_subject_before_save',  'force_balance_tags' );
 
-if ( function_exists( 'wp_encode_emoji' ) ) {
-    add_filter( 'messages_message_subject_before_save', 'wp_encode_emoji' );
-    add_filter( 'messages_message_content_before_save', 'wp_encode_emoji' );
-    add_filter( 'messages_notice_message_before_save',  'wp_encode_emoji' );
-    add_filter( 'messages_notice_subject_before_save',  'wp_encode_emoji' );
-}
+add_filter( 'messages_message_subject_before_save', 'wp_encode_emoji' );
+add_filter( 'messages_message_content_before_save', 'wp_encode_emoji' );
+add_filter( 'messages_notice_message_before_save',  'wp_encode_emoji' );
+add_filter( 'messages_notice_subject_before_save',  'wp_encode_emoji' );
 
 add_filter( 'bp_get_message_notice_subject',     'wptexturize' );

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

@@ -250 +250 @@
     if ( ! empty( $query->post ) ) {
         // WP 5.4 changed the user request function name to wp_get_user_request()
-        $user_request = function_exists( 'wp_get_user_request' ) ? 'wp_get_user_request' : 'wp_get_user_request_data';
+        $user_request = bp_is_running_wp( '4.9.6' ) ? 'wp_get_user_request' : 'wp_get_user_request_data';
         return $user_request( $query->post->ID );
     } else {

trunk/src/bp-settings/classes/class-bp-settings-component.php

@@ -194 +194 @@
 
         // Export Data - only available for WP 4.9.6+.
-        if ( true === $show_data_page && version_compare( $GLOBALS['wp_version'], '4.9.6', '>=' ) ) {
+        if ( true === $show_data_page && bp_is_running_wp( '4.9.6' ) ) {
             $sub_nav[] = array(
                 'name'            => __( 'Export Data', 'buddypress' ),
@@ -269 +269 @@
 
             // Export Data.
-            if ( true === $show_data_page && version_compare( $GLOBALS['wp_version'], '4.9.6', '>=' ) ) {
+            if ( true === $show_data_page && bp_is_running_wp( '4.9.6' ) ) {
                 $wp_admin_nav[] = array(
                     'parent'   => 'my-account-' . $this->id,