Documentation/English (British)/developer-chapter1-kiriwritefilteradd.html

   1 <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN" "http://www.w3.org/TR/REC-html40/loose.dtd">\r
   2 <html>\r
   3         <head>\r
   4                 <link href="style.css" REL="stylesheet" TYPE="text/css" MEDIA="screen">\r
   5                 <meta http-equiv="Content-Type" content="text/html;charset=UTF-8">\r
   6                 <title>Kiriwrite Documentation - Developer Documentation - 1.19: kiriwrite_filter_add</title>\r
   7         </head>\r
   8         <body>\r
   9                 <div class="menubarback">\r
  10                         <div class="menubar">\r
  11                                 <span class="apptitle">Kiriwrite</span>\r
  12                                 <a href="index.html">Index</a> | <a href="user.html">User \r
  13 Documentation</a> | <a href="tutorial.html">Tutorial Documentation</a> | \r
  14 <a href="developer.html">Developer Documentation</a>\r
  15                         </div>\r
  16                 </div>\r
  17                 <div class="pageinformation">\r
  18                         <span class="pagetitle">1.19 kiriwrite_filter_add</span><br><br>\r
  19 \r
  20 kiriwrite_filter_add adds a filter to the filter database. If no confirm value is given then a form for adding a filter to the filter database is written.<br><br>\r
  21 \r
  22 kiriwrite_filter_add will return data that is intended for kiriwrite_output_page.<br><br>\r
  23 \r
  24 <span class="heading">Parameters:</span><br><br>\r
  25 \r
  26 <div class="code">\r
  27     kiriwrite_filter_add(filterfind, filterreplace, filterpriority, filternotes, confirm);\r
  28 </div>\r
  29 \r
  30 <br>\r
  31 \r
  32 <span class="heading">Usage:</span><br><br>\r
  33 \r
  34 <div class="code">\r
  35     $pagedata = kiriwrite_filter_add();<br>\r
  36     $pagedata = kiriwrite_filter_add(&quot;Find this&quot;, &quot;And replace it with this&quot;, 1, &quot;Some notes about the filter itself for checking up later.&quot;, 1);\r
  37 </div>\r
  38 \r
  39 <br>\r
  40 \r
  41 <i>filterfind</i><br>\r
  42 Specifies the text to find. This is required when adding a filter.<br><br>\r
  43 \r
  44 <i>filterreplace</i><br>\r
  45 Specifies what will replace the text that is found by the filterfind parameter. This is required when adding a filter.<br><br>\r
  46 \r
  47 <i>filterpriority</i><br>\r
  48 Specifies the filter priority. The bigger the priority number is then the filter will be processed earlier than filters with lower priority numbers. This is required when adding a filter.<br><br>\r
  49 \r
  50 <i>filternotes</i><br>\r
  51 Specifies the notes for the filter. This is required when adding a filter.<br><br>\r
  52 \r
  53 <i>confirm</i><br>\r
  54 Specifies if the action to add a filter should be confirmed by passing a '1'.<br><br>\r
  55                 </div>\r
  56         </body>\r
  57 </html>\r