aboutsummaryrefslogtreecommitdiffstats
path: root/vendor/smarty/smarty/docs/programmers/plugins/plugins-naming-conventions.md
blob: 28bbcfde8c789aaf2fd40f0789699a5efbbbbd10 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
Naming Conventions {#plugins.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

    -   insert

-   And `name` should be a valid identifier; letters, numbers, and
    underscores only, see [php
    variables](&url.php-manual;language.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.