From 4e549771b24d39ddb017c4992285244429387e25 Mon Sep 17 00:00:00 2001
From: =?UTF-8?q?G=C3=A1bor=20Hojtsy?= <gabor@hojtsy.hu>
Date: Fri, 6 Aug 2010 11:30:14 +0000
Subject: [PATCH] #276876 by mr.baileys, rdrh555: document that we suggest to
use lowercase names with the variable_*() API due to database backend
behaviors
---
includes/bootstrap.inc | 18 +++++++++++++++---
1 file changed, 15 insertions(+), 3 deletions(-)
diff --git a/includes/bootstrap.inc b/includes/bootstrap.inc
index 3b3f8334277e..ed0679254cce 100644
--- a/includes/bootstrap.inc
+++ b/includes/bootstrap.inc
@@ -566,7 +566,11 @@ function variable_init($conf = array()) {
}
/**
- * Return a persistent variable.
+ * Returns a persistent variable.
+ *
+ * Case-sensitivity of the variable_* functions depends on the database
+ * collation used. To avoid problems, always use lower case for persistent
+ * variable names.
*
* @param $name
* The name of the variable to return.
@@ -584,7 +588,11 @@ function variable_get($name, $default) {
}
/**
- * Set a persistent variable.
+ * Sets a persistent variable.
+ *
+ * Case-sensitivity of the variable_* functions depends on the database
+ * collation used. To avoid problems, always use lower case for persistent
+ * variable names.
*
* @param $name
* The name of the variable to set.
@@ -609,7 +617,11 @@ function variable_set($name, $value) {
}
/**
- * Unset a persistent variable.
+ * Unsets a persistent variable.
+ *
+ * Case-sensitivity of the variable_* functions depends on the database
+ * collation used. To avoid problems, always use lower case for persistent
+ * variable names.
*
* @param $name
* The name of the variable to undefine.
--
GitLab