aboutsummaryrefslogtreecommitdiffstats
path: root/phpBB/phpbb/template/template.php
diff options
context:
space:
mode:
authorjaviexin <javiexin@gmail.com>2017-01-04 00:36:23 +0100
committerjaviexin <javiexin@gmail.com>2017-01-04 00:36:23 +0100
commit92708b290500d6b8e81b3b9bae2829958486f615 (patch)
treea3ba631858cbbd91d263831f03e5d6cacf89b7a6 /phpBB/phpbb/template/template.php
parent3322117c3863c443ca1b79d25541bde4c662c0ed (diff)
downloadforums-92708b290500d6b8e81b3b9bae2829958486f615.tar
forums-92708b290500d6b8e81b3b9bae2829958486f615.tar.gz
forums-92708b290500d6b8e81b3b9bae2829958486f615.tar.bz2
forums-92708b290500d6b8e81b3b9bae2829958486f615.tar.xz
forums-92708b290500d6b8e81b3b9bae2829958486f615.zip
[ticket/14950] Add possibility to delete a template block
Adds a new mode to alter_block_array to allow for the deletion of a certain block of template variables. The selection method is the same as for the other modes for alter_block_array. The passed in vararray is ignored, and an out of bounds index is considered an error. PHPBB3-14944
Diffstat (limited to 'phpBB/phpbb/template/template.php')
-rw-r--r--phpBB/phpbb/template/template.php3
1 files changed, 2 insertions, 1 deletions
diff --git a/phpBB/phpbb/template/template.php b/phpBB/phpbb/template/template.php
index 041ecb12e4..3d8505e204 100644
--- a/phpBB/phpbb/template/template.php
+++ b/phpBB/phpbb/template/template.php
@@ -160,10 +160,11 @@ interface template
* If key is false the position is set to 0
* If key is true the position is set to the last entry
*
- * @param string $mode Mode to execute (valid modes are 'insert' and 'change')
+ * @param string $mode Mode to execute (valid modes are 'insert', 'change' and 'delete')
*
* If insert, the vararray is inserted at the given position (position counting from zero).
* If change, the current block gets merged with the vararray (resulting in new \key/value pairs be added and existing keys be replaced by the new \value).
+ * If delete, the vararray is ignored, and the block at the given position (counting from zero) is removed.
*
* Since counting begins by zero, inserting at the last position will result in this array: array(vararray, last positioned array)
* and inserting at position 1 will result in this array: array(first positioned array, vararray, following vars)