Skip to content

Commit 3eed8db

Browse files
committed
AOS-100: Update docs regarding the query class and the need for handling sanitisation of the string for including in the template
1 parent 793b622 commit 3eed8db

File tree

1 file changed

+3
-4
lines changed

1 file changed

+3
-4
lines changed

docs/detailed-result-handling.md

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -25,11 +25,10 @@ The `Results` class is also a `ViewableData` object, so these methods can be acc
2525
`$Records`, and `$Facets`.
2626

2727
## `Query` class
28-
The `Query` class provides the original query that was used for matching results. This is available should you wish
29-
to include `Showing results for "test"` or similar text on your results page.
28+
The `Query` class provides the original query that was used for matching results.
3029

31-
**Important:** When including `$Query` in the template it should be noted that this could contain raw user input
32-
and you may need to handle sanitisation of this value to mitigate against cross-site scripting (xss) attacks.
30+
**Important:** If you need to include the search term on the page (for example, `Showing results for "test"`) you will
31+
need to handle sanitisation of this value to mitigate against cross-site scripting (xss) attacks.
3332

3433
## `Record` class
3534

0 commit comments

Comments
 (0)