Changeset 14013

Timestamp:

08/31/2024 01:26:36 AM (6 weeks ago)

Author:

imath

Message:

Introduce a function to inform about whether BP was loaded from src

bp_is_running_from_src_subdirectory() informs whether BuddyPress was loaded from the src subdirectory (trunk version). This function exposes the 'bp_is_running_from_src_subdirectory' to let developers tests code that is only available when BuddyPress is built.

Props emaralive, espellcaste.

See #9210
Fixes #9224
Closes ​https://github.com/buddypress/buddypress/pull/358

Location:

trunk/src

Files:

• bp-core/bp-core-functions.php (modified) (3 diffs)
• bp-core/bp-core-rest-api.php (modified) (1 diff)
• bp-core/bp-core-template-loader.php (modified) (1 diff)
• bp-templates/bp-legacy/buddypress-functions.php (modified) (1 diff)

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

@@ -138 +138 @@
 function bp_is_running_wp( $version, $compare = '>=' ) {
     return version_compare( $GLOBALS['wp_version'], $version, $compare );
+}
+
+/**
+ * Informs whether BuddyPress was loaded from the `src` subdirectory (trunk version).
+ *
+ * @since 15.0.0
+ *
+ * @return boolean True if BuddyPress was loaded from the `src` subdirectory, false otherwise.
+ */
+function bp_is_running_from_src_subdirectory() {
+    $is_src = defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src';
+
+    /**
+     * Filter here to edit the way BuddyPress was loaded.
+     *
+     * @since 15.0.0
+     *
+     * @param boolean $is_src True if BuddyPress was loaded from the `src` subdirectory, false otherwise.
+     */
+    return apply_filters( 'bp_is_running_from_src_subdirectory', $is_src );
 }
 
@@ -2767 +2787 @@
 
     // Ensure the assets can be located when running from /src/.
-    if ( defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src' ) {
+    if ( bp_is_running_from_src_subdirectory() ) {
         $ext = str_replace( '.min', '', $ext );
     }
@@ -4981 +5001 @@
      * version of BuddyPress do not load deprecated functions.
      */
-    if ( defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src' ) {
+    if ( bp_is_running_from_src_subdirectory() ) {
         return array();
     }

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

@@ -34 +34 @@
  */
 function bp_rest_in_buddypress() {
-    $is_src = defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src';
-
-    return ! $is_src && ! bp_rest_is_plugin_active();
+    return ! bp_is_running_from_src_subdirectory() && ! bp_rest_is_plugin_active();
 }
 

trunk/src/bp-core/bp-core-template-loader.php

@@ -242 +242 @@
 function bp_locate_template_asset( $filename ) {
     // Ensure assets can be located when running from /src/.
-    if ( defined( 'BP_SOURCE_SUBDIRECTORY' ) && 'src' === BP_SOURCE_SUBDIRECTORY ) {
+    if ( bp_is_running_from_src_subdirectory() ) {
         $filename = str_replace( '.min', '', $filename );
     }

trunk/src/bp-templates/bp-legacy/buddypress-functions.php

@@ -407 +407 @@
 
         // Ensure the assets can be located when running from /src/.
-        if ( defined( 'BP_SOURCE_SUBDIRECTORY' ) && BP_SOURCE_SUBDIRECTORY === 'src' ) {
+        if ( bp_is_running_from_src_subdirectory() ) {
             $file = str_replace( '.min', '', $file );
         }