{"id":6022,"date":"2021-09-21T18:24:32","date_gmt":"2021-09-21T09:24:32","guid":{"rendered":"https:\/\/www.wexal.jp\/document-3-0-0\/pst-config-file\/pst-lua-directive\/"},"modified":"2022-12-28T20:14:41","modified_gmt":"2022-12-28T11:14:41","slug":"pst-lua-directive","status":"publish","type":"page","link":"https:\/\/www.wexal.jp\/en\/document-3-0-0\/pst-config-file\/pst-lua-directive\/","title":{"rendered":"\"lua\" Directive (3.1.5)"},"content":{"rendered":"\n

<\/span>Basic Coding<\/span><\/h2>\n\n\n\n

The following are the \"lua\" directive coding rules.<\/p>\n\n\n\n

<\/span>cmd<\/span><\/h3>\n\n\n\n

Specifies the name of the \"lua\" directive to be executed.<\/p>\n\n\n\n

<\/span>Type<\/span><\/h4>\n\n\n\n

Scalar (String)<\/p>\n\n\n\n

<\/span>Value<\/span><\/h4>\n\n\n\n
directive name<\/strong><\/strong><\/td>Specify the name of the directive.
This cannot be omitted.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n

<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  body_filter:\n  - cmd: wp shorten url<\/code><\/pre>\n\n\n\n
<\/span>args<\/span><\/h3>\n\n\n\n
Specifies options for the \"lua\" directive to be executed. <\/p>\n\n\n\n
<\/span>Type<\/span><\/h4>\n\n\n\n
Sequence (Mapping) or Mapping<\/p>\n\n\n\n
<\/span>Value<\/span><\/h4>\n\n\n\n
Options are different depending on the selected \"lua\" directive. Refer to each \"lua\" directive for more information.<\/p>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  body_filter:\n  - cmd: lazy load\n    args:\n    - element:img\n      skip: 5<\/code><\/pre>\n\n\n\n
<\/span>apply<\/span><\/h3>\n\n\n\n
Specifies the path or the conditions to be applied to the \"lua\" directive.
If more than one is specified, the OR condition will be used.<\/p>\n\n\n\n
<\/span>Type<\/span><\/h4>\n\n\n\n
Mapping<\/p>\n\n\n\n
<\/span>apply > path<\/span><\/h3>\n\n\n\n
Specifies the path to be applied to the \"lua\" directive.<\/p>\n\n\n\n
<\/span>Type<\/span><\/h4>\n\n\n\n
Sequence (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h4>\n\n\n\n
path<\/strong><\/td>Specify the path to be applied to the \"lua\" directive by regular expressions.
The \"worker\" directive will be applied by default to all resources except for paths specified in \"global_exclude\" in the PST configuration file.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  body_filter:\n  - cmd: wp shorten url\n    apply:\n      path: \n      - ^\/archives\/<\/code><\/pre>\n\n\n\n
<\/span>apply > if<\/span><\/h3>\n\n\n\n
Specifies the conditions to be applied to the \"lua\" directive.
If this is not set, this directive will be applied by default to all resources except for paths specified in \"global_exclude\" in the PST configuration file.<\/p>\n\n\n\n
<\/span>Type<\/span><\/h4>\n\n\n\n
Sequence (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h4>\n\n\n\n
is_kusanagi_pc<\/strong><\/td>Specify access from a PC browser as a condition.<\/td><\/tr>
is_kusanagi_mobile<\/strong><\/td>Specify access from a mobile browser as a condition.<\/td><\/tr>
is_kusanagi_tablet<\/strong><\/td>Specify access from a tablet browser as a condition.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  body_filter:\n  - cmd: wp shorten url\n    apply:\n      if:\n      - is_kusanagi_pc<\/code><\/pre>\n\n\n\n
<\/span>exclude<\/span><\/h3>\n\n\n\n
Specifies the path or conditions to be excluded from application to the \"lua\" directive.
If more than one is specified, the OR condition will be used.<\/p>\n\n\n\n
<\/span>Type<\/span><\/h4>\n\n\n\n
Mapping<\/p>\n\n\n\n
<\/span>exclude > path<\/span><\/h3>\n\n\n\n
Specifies the path to be excluded from application to the \"lua\" directive.<\/p>\n\n\n\n
<\/span>Type<\/span><\/h4>\n\n\n\n
Sequence (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h4>\n\n\n\n
path<\/strong><\/td>Specify the path to be excluded from application to the \"lua\" directive.
The \"worker\" directive will be applied by default to all resources except for paths specified in \"global_exclude\" in the PST configuration file.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  body_filter:\n  - cmd: wp shorten url\n    exclude:\n      path:\n      - \/wp-content\/plugins<\/code><\/pre>\n\n\n\n
<\/span>exclude > if<\/span><\/h3>\n\n\n\n
Specifies the conditions to be excluded from application to the \"lua\" directive.
If this is not set, this directive will be applied by default to all resources except for paths specified in \"global_exclude\" in the PST configuration file.<\/p>\n\n\n\n
<\/span>Type<\/span><\/h4>\n\n\n\n
Sequence (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h4>\n\n\n\n
is_kusanagi_pc<\/strong><\/td>Specify access from a PC browser as an exclusion condition.<\/td><\/tr>
is_kusanagi_mobile<\/strong><\/td>Specify access from a mobile browser as an exclusion condition.<\/td><\/tr>
is_kusanagi_tablet<\/strong><\/td>Specify access from a tablet browser as an exclusion condition.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  body_filter:\n  - cmd: wp shorten url\n    exclude:\n      if:\n      - is_kusanagi_pc<\/code><\/pre>\n\n\n\n
<\/span>lua > header_filter directive<\/span><\/h2>\n\n\n\n
<\/span>add<\/span><\/h3>\n\n\n\n
Adds HTTP header elements to be output in HTTP response headers.<\/p>\n\n\n\n
<\/span>args<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Sequence (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
key: value<\/strong><\/td>Specify the HTTP header key and value as a \":\" separated string. You can specify multiple HTTP header keys.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  header_filter:\n  - cmd: add\n    args:\n    - 'Page-Speed-Technology: on'<\/code><\/pre>\n\n\n\n
<\/span>remove<\/span><\/h3>\n\n\n\n
HTTP header keys that match exactly in value will be removed.<\/p>\n\n\n\n
<\/span>args<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Sequence (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
key:  value<\/strong><\/td>Specify the HTTP header key and value as a \":\" separated string. The HTTP header keys with an exact match in value will be removed. If the value is omitted, the specified HTTP header key will be removed regardless of value. You can specify multiple HTTP header keys.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  header_filter:\n  - cmd: remove\n    args:\n    - 'link: ; rel=\"https:\/\/api.w.org\/\"'\n    - 'x-pingback'<\/code><\/pre>\n\n\n\n
<\/span>replace<\/span><\/h3>\n\n\n\n
Replaces HTTP header elements in HTTP response headers.<\/p>\n\n\n\n
<\/span>args<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Sequence (Mapping)<\/p>\n\n\n\n
<\/span>args > search<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
key: value<\/strong><\/td>Specify the HTTP header key and value as a \":\" separated string. Specify the HTTP header key to be searched. Please enclose the value in single quotes ('). You can specify multiple HTTP header keys.
This cannot be omitted.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>args > replacement<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
key: value<\/strong><\/td>Specify the HTTP header key and value as a \":\" separated string. Specify the HTTP header key to be replaced. Please enclose the value in single quotes ('). You can specify multiple HTTP header keys.
This cannot be omitted.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  header_filter:\n  - cmd: replace\n    args:\n    - search: 'X-MyHeader: original'\n      replacement: 'X-MyHeader: replaced'\n    - search: 'X-old-header: original'\n      replacement: 'X-new-header: replaced'<\/code><\/pre>\n\n\n\n
<\/span>server push<\/span><\/h3>\n\n\n\n
Sends the specified resource via HTTP2 Push to reduce the time required to display content. Normally, the resources required to display content are not known until the HTTP response body is obtained and its contents are parsed. By specifying a resource for \"server push\", you can receive the resource at the same time as the HTTP response body.<\/p>\n\n\n\n
<\/span>args<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Sequence (Mapping)<\/p>\n\n\n\n
<\/span>args > href<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
URL<\/strong><\/td>Specify the URL for the \"href\" attribute of the \"link\" element as a string.
This cannot be omitted.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>args > media<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
media queries<\/strong><\/strong><\/td>Specify the media query for the \"media\" attribute of the \"link\" element as a string.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  header_filter:\n  - cmd: server push\n    args:\n    - href: \/wp-content\/mu-plugins\/pst\/font\/genericons-regular-webfont.ttf<\/code><\/pre>\n\n\n\n
<\/span>add link<\/span><\/h3>\n\n\n\n
Adds HTTP header elements to be output in the \"Link\" field of the HTTP response header.<\/p>\n\n\n\n
<\/span>args<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Sequence (Mapping)<\/p>\n\n\n\n
<\/span>args > rel<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
link type<\/strong><\/strong><\/td>Specify the link type for the \"rel\" attribute of the \"link\" element as a string.
This cannot be omitted.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>args > href<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
URL<\/strong><\/td>Specify the URL for the \"href\" attribute of the \"link\" element as a string.
This cannot be omitted.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>args > as<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
resource type<\/strong><\/strong><\/td>Specify the resource type for the \"as\" attribute of the \"link\" element as a string.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>args > type<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
content type<\/strong><\/td>Specify the content type for the \"type\" attribute of the \"link\" element as a string.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>args > media<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (String)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
media queries<\/strong><\/td>Specify the media query for the \"media\" attribute of the \"link\" element as a string.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>args > crossorigin<\/span><\/h4>\n\n\n\n
<\/span>Type<\/span><\/h5>\n\n\n\n
Scalar (Boolean)<\/p>\n\n\n\n
<\/span>Value<\/span><\/h5>\n\n\n\n
 Set Enable\/Disable CORS (Cross-Origin Resource Sharing). The default setting is disabled.<\/p>\n\n\n\n
true<\/strong><\/td>Enable CORS.<\/td><\/tr>
false<\/strong><\/td>Disable CORS.<\/td><\/tr><\/tbody><\/table><\/figure>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  header_filter:\n  - cmd: add link\n    args:\n    - rel: preload\n      href: \/wp-content\/themes\/twentytwenty\/assets\/fonts\/inter\/Inter-italic-var.woff2\n      as: font\n      type: font\/woff2\n      crossorigin: true<\/code><\/pre>\n\n\n\n
<\/span>server push external css<\/span><\/h3>\n\n\n\n
To be used in combination with \"engagement delay\". In \"engagement delay\", execute \"HTTP\/2 server push\" for style sheets set with \"type: css\/cssx\" and \"method: server push\".<\/p>\n\n\n\n
<\/span>args<\/span><\/h4>\n\n\n\n
None<\/p>\n\n\n\n
<\/span>Example<\/span><\/h4>\n\n\n\n
lua:\n  header_filter:\n  - cmd: server push external css<\/code><\/pre>\n\n\n\n