Skip to content

Commit 1a3f0f1

Browse files
authored
Merge pull request #5471 from kenjis/fix-docs-filters.rst
docs: improve filters.rst
2 parents 491ce1b + 67ce1b0 commit 1a3f0f1

2 files changed

Lines changed: 11 additions & 1 deletion

File tree

user_guide_src/source/incoming/filters.rst

Lines changed: 9 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -200,10 +200,18 @@ In this example, the array ``['dual', 'noreturn']`` will be passed in ``$argumen
200200
Provided Filters
201201
****************
202202

203-
The filters bundled with CodeIgniter4 are: ``Honeypot``, ``CSRF``, ``InvalidChars``, ``SecureHeaders``, and ``DebugToolbar``.
203+
The filters bundled with CodeIgniter4 are: :doc:`Honeypot <../libraries/honeypot>`, :ref:`CSRF <cross-site-request-forgery>`, ``InvalidChars``, ``SecureHeaders``, and :ref:`DebugToolbar <the-debug-toolbar>`.
204204

205205
.. note:: The filters are executed in the order defined in the config file. However, if enabled, ``DebugToolbar`` is always executed last because it should be able to capture everything that happens in the other filters.
206206

207+
InvalidChars
208+
=============
209+
210+
This filter prohibits user input data (``$_GET``, ``$_POST``, ``$_COOKIE``, ``php://input``) from containing the following characters:
211+
212+
- invalid UTF-8 characters
213+
- control characters except line break and tab code
214+
207215
SecureHeaders
208216
=============
209217

user_guide_src/source/libraries/security.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -19,6 +19,8 @@ If you find a case where you do need direct access though, you may load it throu
1919

2020
$security = \Config\Services::security();
2121

22+
.. _cross-site-request-forgery:
23+
2224
*********************************
2325
Cross-site request forgery (CSRF)
2426
*********************************

0 commit comments

Comments
 (0)