You are here

Home » API reference » Custom filter 6.2

README.txt in Custom filter 6.2

Same filename and directory in other branches
  1. 8 README.txt
  2. 5 README.txt
  3. 6 README.txt
  4. 7.2 README.txt
  5. 7 README.txt
  6. 2.0.x README.txt
Custom filter module provides an ability to create some filter without writing
any module.
When we create a new Input format, we will be asked to choose the filters we
want. Some modules hook into filter module and provide additional filters here,
e.g. Textile, GeshiFilter, MathFilter. This module does the same thing, except
that it allows the users with the right permission to define their own filters.

How do we define our own filters?
First, we need to create a filter; a filter is a container for filter rules.
When we create/configure a new input format, every defined filter will appear in
the filters list.

A filter is only a container. We need to define some filter rules if we want it
to work. So, an input format contains one or more filters, each of those has its
own filter rules.

=NOTES=

1. The PHP code used in the replacement rules must set the variable $result, which
   is then used from the module.
2. The module defines a new constant that allows PHP code used in the
   replacement rules to know the version of the API implemented from the module.

File

README.txt
View source 
  1. 

  2. Custom filter module provides an ability to create some filter without writing

  3. any module.

  4. When we create a new Input format, we will be asked to choose the filters we

  5. want. Some modules hook into filter module and provide additional filters here,

  6. e.g. Textile, GeshiFilter, MathFilter. This module does the same thing, except

  7. that it allows the users with the right permission to define their own filters.

  8. 

  9. How do we define our own filters?

  10. First, we need to create a filter; a filter is a container for filter rules.

  11. When we create/configure a new input format, every defined filter will appear in

  12. the filters list.

  13. 

  14. A filter is only a container. We need to define some filter rules if we want it

  15. to work. So, an input format contains one or more filters, each of those has its

  16. own filter rules.

  17. 

  18. =NOTES=

  19. 

  20. 1. The PHP code used in the replacement rules must set the variable $result, which

  21.    is then used from the module.

  22. 2. The module defines a new constant that allows PHP code used in the

  23.    replacement rules to know the version of the API implemented from the module.