Refs #946: Improved documentation on enable/disable/reorder plugin commands

git-svn-id: https://code.elgg.org/elgg/trunk@3195 36083f99-b078-4883-b0ff-0f9b5a30f544

1 files changed, 21 insertions, 3 deletions

diff --git a/engine/lib/plugins.php b/engine/lib/plugins.php
index 771fe7306..399ef13b6 100644
--- a/engine/lib/plugins.php
+++ b/engine/lib/plugins.php
@@ -132,7 +132,13 @@
 		}

 		

 		/**

-		 * Regenerates the list of known plugins and saves it to the current site

+		 * Regenerates the list of known plugins and saves it to the current site
+		 * 
+		 * Important: You should regenerate simplecache and the viewpath cache after executing this function
+		 * otherwise you may experience view display artifacts. Do this with the following code:
+		 * 
+		 * 		elgg_view_regenerate_simplecache();
+		 *		elgg_filepath_cache_reset();

 		 *

 		 * @param array $pluginorder Optionally, a list of existing plugins and their orders

 		 * @return array The new list of plugins and their orders

@@ -585,7 +591,13 @@
 		}

 		

 		/**

-		 * Enable a plugin for a site (default current site)

+		 * Enable a plugin for a site (default current site)
+		 * 
+		 * Important: You should regenerate simplecache and the viewpath cache after executing this function
+		 * otherwise you may experience view display artifacts. Do this with the following code:
+		 * 
+		 * 		elgg_view_regenerate_simplecache();
+		 *		elgg_filepath_cache_reset();

 		 *

 		 * @param string $plugin The plugin name.

 		 * @param int $site_guid The site id, if not specified then this is detected.

@@ -623,7 +635,13 @@
 		

 		/**

 		 * Disable a plugin for a site (default current site)

-		 *

+		 * 
+		 * Important: You should regenerate simplecache and the viewpath cache after executing this function
+		 * otherwise you may experience view display artifacts. Do this with the following code:
+		 * 
+		 * 		elgg_view_regenerate_simplecache();
+		 *		elgg_filepath_cache_reset();
+		 * 

 		 * @param string $plugin The plugin name.

 		 * @param int $site_guid The site id, if not specified then this is detected.

 		 */