ConfigSchema/schema/HTML.DefinitionID.txt

0001 HTML.DefinitionID
0002 TYPE: string/null
0003 DEFAULT: NULL
0004 VERSION: 2.0.0
0005 --DESCRIPTION--
0006
0007 <p>
0008     Unique identifier for a custom-built HTML definition. If you edit
0009     the raw version of the HTMLDefinition, introducing changes that the
0010     configuration object does not reflect, you must specify this variable.
0011     If you change your custom edits, you should change this directive, or
0012     clear your cache. Example:
0013 </p>
0014 <pre>
0015 $config = HTMLPurifier_Config::createDefault();
0016 $config->set('HTML', 'DefinitionID', '1');
0017 $def = $config->getHTMLDefinition();
0018 $def->addAttribute('a', 'tabindex', 'Number');
0019 </pre>
0020 <p>
0021     In the above example, the configuration is still at the defaults, but
0022     using the advanced API, an extra attribute has been added. The
0023     configuration object normally has no way of knowing that this change
0024     has taken place, so it needs an extra directive: %HTML.DefinitionID.
0025     If someone else attempts to use the default configuration, these two
0026     pieces of code will not clobber each other in the cache, since one has
0027     an extra directive attached to it.
0028 </p>
0029 <p>
0030     You <em>must</em> specify a value to this directive to use the
0031     advanced API features.
0032 </p>
0033 --# vim: et sw=4 sts=4