| 1 | HTML.DefinitionID |
|---|
| 2 | TYPE: string/null |
|---|
| 3 | DEFAULT: NULL |
|---|
| 4 | VERSION: 2.0.0 |
|---|
| 5 | --DESCRIPTION-- |
|---|
| 6 | |
|---|
| 7 | <p> |
|---|
| 8 | Unique identifier for a custom-built HTML definition. If you edit |
|---|
| 9 | the raw version of the HTMLDefinition, introducing changes that the |
|---|
| 10 | configuration object does not reflect, you must specify this variable. |
|---|
| 11 | If you change your custom edits, you should change this directive, or |
|---|
| 12 | clear your cache. Example: |
|---|
| 13 | </p> |
|---|
| 14 | <pre> |
|---|
| 15 | $config = HTMLPurifier_Config::createDefault(); |
|---|
| 16 | $config->set('HTML', 'DefinitionID', '1'); |
|---|
| 17 | $def = $config->getHTMLDefinition(); |
|---|
| 18 | $def->addAttribute('a', 'tabindex', 'Number'); |
|---|
| 19 | </pre> |
|---|
| 20 | <p> |
|---|
| 21 | In the above example, the configuration is still at the defaults, but |
|---|
| 22 | using the advanced API, an extra attribute has been added. The |
|---|
| 23 | configuration object normally has no way of knowing that this change |
|---|
| 24 | has taken place, so it needs an extra directive: %HTML.DefinitionID. |
|---|
| 25 | If someone else attempts to use the default configuration, these two |
|---|
| 26 | pieces of code will not clobber each other in the cache, since one has |
|---|
| 27 | an extra directive attached to it. |
|---|
| 28 | </p> |
|---|
| 29 | <p> |
|---|
| 30 | You <em>must</em> specify a value to this directive to use the |
|---|
| 31 | advanced API features. |
|---|
| 32 | </p> |
|---|
| 33 | |
|---|