This function takes the name of an array and renames all fields of this array.

array:rename() requires that the input array has continuous, sequential indexes with no gaps (empty indexes) and that the array starts at index [0], for example, incidents[0], incidents[1], incidents[2]. If there are gaps, for example, incidents[0], incidents[1], incidents[2], incidents[10] only the fields from index 0 up to the first empty index will be renamed.

If no array with the given name exists or the old and the new name are the same, the function does nothing.

Without this function, each element of an array would need to be renamed individually with the rename() function, or array:filter() should be used as a workaround as shown below:

array:filter(array="a[]", function={true}, var="", asArray="b[]")
| array:filter(array="a[]", function={false}, var="")

With the function, specify the name of the array to rename:

array:rename("a[]", asArray="b[]")

array:rename(array="mail[]", asArray="user.email[]")

'mail[0]'='user0@example.com'
'mail[1]'='user1@example.com'
'mail[2]'='user2@example.com'

user.email[0]->user0@example.com
user.email[1]->user1@example.com
user.email[2]->user2@example.com