feature(js): Allow canceling a previous elgg_require_js() call

Fixes #9074
Elgg · Oct 26, 2015 · 375be5f · 375be5f
1 parent 017b787
commit 375be5f
Show file tree

Hide file tree

Showing 2 changed files with 13 additions and 0 deletions.
diff --git a/engine/classes/Elgg/Amd/Config.php b/engine/classes/Elgg/Amd/Config.php
@@ -91,6 +91,7 @@ public function removePath($name, $path = null) {
 	 *                           deps:     array  Dependencies
 	 *                           exports:  string Name of the shimmed module to export
 	 * @return void
+	 * @throws \InvalidParameterException
 	 */
 	public function addShim($name, array $config) {
 		$deps = elgg_extract('deps', $config, array());

diff --git a/engine/lib/elgglib.php b/engine/lib/elgglib.php
@@ -219,6 +219,18 @@ function elgg_require_js($name) {
 	_elgg_services()->amdConfig->addDependency($name);
 }
 
+/**
+ * Cancel a request to load an AMD module onto the page.
+ *
+ * @note The elgg, jquery, and jquery-ui modules cannot be cancelled.
+ *
+ * @param string $name The AMD module name.
+ * @return void
+ * @since 2.1.0
+ */
+function elgg_unrequire_js($name) {
+	_elgg_services()->amdConfig->removeDependency($name);
+}
 
 /**
  * Get the JavaScript URLs that are loaded