Add note to farm_log_entity_label_summary() emphasizing that it is the responsibility of downstream code to sanitize entity labels.

This commit is contained in:
Michael Stenta 2020-04-23 11:30:02 -04:00
parent 6bd7c0aa84
commit 8f01b05a58
1 changed files with 3 additions and 0 deletions

View File

@ -855,6 +855,9 @@ function farm_log_create($type, $name = '', $timestamp = REQUEST_TIME, $done = T
* Helper function for generating a summary of entity labels for use in a
* log name.
*
* Note that this function does NOT sanitize the entity labels. This is the
* responsibility of downstream code, if it is printing the text to the page.
*
* @param string $entity_type
* The entity type.
* @param Entity|array $entities