Changeset 11884

Timestamp:

03/04/2018 11:17:29 PM (7 years ago)

Author:

r-a-y

Message:

Core: Introduce hook, 'bp_late_include'.

This hook is meant to be used to load conditional files on certain pages
so we are not always loading code unnecessarily.

This fires on the 'bp_setup_canonical_stack' at priority 20 when we
have ensured that the canonical stack is set up and before we register
navigation items that do checks for screen functions.

We'll be using this hook across all components to offshore code until it
is required.

See #7218.

Location:

trunk/src/bp-core

Files:

• bp-core-actions.php (modified) (1 diff)
• bp-core-dependency.php (modified) (1 diff)
• classes/class-bp-component.php (modified) (2 diffs)

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

@@ -87 +87 @@
 
 /**
+ * Late includes.
+ *
+ * Run after the canonical stack is setup to allow for conditional includes
+ * on certain pages.
+ */
+add_action( 'bp_setup_canonical_stack', 'bp_late_include', 20 );
+
+/**
  * The bp_template_redirect hook - Attached to 'template_redirect' above.
  *

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

@@ -32 +32 @@
      */
     do_action( 'bp_include' );
+}
+
+/**
+ * Fire the 'bp_late_include' action for loading conditional files.
+ *
+ * @since 3.0.0
+ */
+function bp_late_include() {
+
+    /**
+     * Fires the 'bp_late_include' action.
+     *
+     * Allow for conditional includes on certain pages.
+     *
+     * @since 3.0.0
+     */
+    do_action( 'bp_late_include' );
 }
 

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

@@ -395 +395 @@
 
     /**
+     * Late includes method.
+     *
+     * Components should include files here only on specific pages using
+     * conditionals such as {@link bp_is_current_component()}. Intentionally left
+     * empty.
+     *
+     * @since 3.0.0
+     */
+    public function late_includes() {}
+
+    /**
      * Set up the actions.
      *
@@ -414 +425 @@
         // extending this base class.
         add_action( 'bp_include',                array( $this, 'includes'               ), 8 );
+
+        // Load files conditionally, based on certain pages.
+        add_action( 'bp_late_include',           array( $this, 'late_includes'          ) );
 
         // Setup navigation.