From e1f39489ccc7ce2883882c3fe78bd54a388b92a8 Mon Sep 17 00:00:00 2001
From: marcus <marcus@36083f99-b078-4883-b0ff-0f9b5a30f544>
Date: Wed, 8 Apr 2009 16:10:31 +0000
Subject: 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
---
 actions/admin/plugins/reorder.php |  2 +-
 engine/lib/plugins.php            | 24 +++++++++++++++++++++---
 2 files changed, 22 insertions(+), 4 deletions(-)

diff --git a/actions/admin/plugins/reorder.php b/actions/admin/plugins/reorder.php
index c42f5fda1..c7a0f77bd 100644
--- a/actions/admin/plugins/reorder.php
+++ b/actions/admin/plugins/reorder.php
@@ -1,6 +1,6 @@
 <?php
 	/**
-	 * Reorder plugin action.
+	 * Reorder plugin action.
 	 * 
 	 * @package Elgg
 	 * @subpackage Core
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.
 		 */
-- 
cgit v1.2.3