smarty-php/smarty
1
0
Fork 0
mirror of https://github.com/smarty-php/smarty.git synced 2025-10-08 10:20:16 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
cdf1ed2a506d9bc59f25e762fad371d5fd8ebd13
smarty/docs/programmers/plugins/plugins-naming-conventions.md
Simon Wisselink cdf1ed2a50 Simplified the (no)caching architecture by: 
- removing support for $cache_attrs for registered plugins,
- removing the undocumented {make_nocache} tag and the deprecated {insert} tag and associated code
- removing support for a compile_id property on include tags.

Fixes a bug in extends: resources by propagating the nocache-hashes between a master template and it's subtemplates in \Smarty\Template::_subTemplateRender. This might need further improvement.
2023-01-13 15:47:57 +01:00

1.1 KiB
Raw Blame History

Naming Conventions

Plugin files and functions must follow a very specific naming convention in order to be located by Smarty.

plugin files must be named as follows:

type.name.php

  • Where type is one of these plugin types:

    • function

    • modifier

    • block

    • compiler

    • prefilter

    • postfilter

    • outputfilter

    • resource

  • And name should be a valid identifier; letters, numbers, and underscores only, see php variables.

  • Some examples: function.html_select_date.php, resource.db.php, modifier.spacify.php.

plugin functions inside the PHP files must be named as follows:

smarty_type_name

  • The meanings of type and name are the same as above.

  • An example modifier name foo would be function smarty_modifier_foo().

Smarty will output appropriate error messages if the plugin file it needs is not found, or if the file or the plugin function are named improperly.