ファンクション

Twig に付随するテンプレートファンクションに加えて、Craft がいくつか独自のものを提供します。

actionInput( actionPath )

特定のコントローラーやアクションのための POST リクエストをルーティングするために使用される不可視項目を出力するためのショートカット。これは、テンプレート内に直接 <input type="hidden" name="action" value="controller/action-name"> を書き込むのと実質的に同じです。

<form method="POST">
    {{ actionInput('users/save-user') }}
    <!-- ... -->
</form>

alias( string )

その文字列がエイリアスではじまるかをチェックする Craft::getAlias() に、文字列を渡します。(詳細については、コンフィギュレーションを参照してください。)

<img src="{{ alias('@assetBaseUrl/images/logo.png') }}">

beginBody()

「begin body」に登録されたスクリプトやスタイルを出力します。<body> タグの直後に配置する必要があります。

<body>
    {{ beginBody() }}

    <h1>{{ page.name }}</h1>
    {{ page.body }}
</body>

ceil( num )

整数値に切り上げます。

{{ ceil(42.1) }} → 43

className( object )

指定されたオブジェクトの完全修飾クラス名を返します。

clone( object )

指定されたオブジェクトのクローンを作成します。

{% set query = craft.entries.section('news') %}
{% set articles = clone(query).type('articles') %}

create( type )

与えられたクラス名やオブジェクト設定に基づいて新しいオブジェクトインスタンスを作成します。サポートされる引数の詳細については、Yii::createObject() を参照してください。

{# Pass in a class name #}
{% set cookie = create('yii\\web\\Cookie') %}

{# Or a full object configuration array #}
{% set cookie = create({
    class: 'yii\\web\\cookie',
    name: 'foo',
    value: 'bar'
}) %}

csrfInput()

不可視の CSRF トークン入力欄を返します。CSRF 保護が有効になっているすべてのサイトでは、POST 経由で送信するそれぞれのフォームにこれを含めなければなりません。

<form method="post">
    {{ csrfInput() }}
    <!-- ... -->
</form>

endBody()

「end body」に登録されたスクリプトやスタイルを出力します。</body> タグの直前に配置する必要があります。

<body>
    <h1>{{ page.name }}</h1>
    {{ page.body }}

    {{ endBody() }}
</body>

expression( expression, params, config )

データベースクエリで使用するための新しい yii\db\Expression オブジェクトを作成して返します。

floor( num )

整数値に切り捨てます。

{{ floor(42.9) }} → 42

getenv( name )

環境変数の値を返します。

{{ getenv('MAPS_API_KEY') }}

parseEnv( str )

文字列が環境変数($VARIABLE_NAME)、および / または、エイリアス(@aliasName)を参照しているかどうかを確認し、参照されている値を返します。

「head」に登録されたスクリプトやスタイルを出力します。</head> タグの直前に配置する必要があります。

<head>
    <title>{{ siteName }}</title>
    {{ head() }}
</head>

plugin( handle )

ハンドルに従ってプラグインインスタンスを返します。そのハンドルでインストールされ有効化されているプラグインがない場合、null を返します。

{{ plugin('commerce').version }}

redirectInput( url )

<input type="hidden" name="redirect" value="{{ url|hash }}"> を入力するためのショートカットです。

seq( name, length, next )

name で定義されたシーケンスの次または現在の番号を出力します。

<p>This entry has been read {{ seq('hits:' ~ entry.id) }} times.</p>

ファンクションが呼び出されるたびに、与えられたシーケンスは自動的にインクリメントされます。

オプションで特定の長さにゼロ詰めした数値にすることができます。

{{ now|date('Y') ~ '-' ~ seq('orderNumber:' ~ now|date('Y'), 5) }}
{# outputs: 2018-00001 #}

インクリメントせずにシーケンスの現在の数字を表示するには、next 引数に false をセットします。

<h5><a href="{{ entry.url }}">{{ entry.title }}</a></h5>
<p>{{ seq('hits:' ~ entry.id, next=false) }} views</p>

shuffle( array )

配列内のエレメントの順序をランダム化します。

{% set promos = shuffle(homepage.promos) %}

{% for promo in promos %}
    <div class="promo {{ promo.slug }}">
        <h3>{{ promo.title }}</h3>
        <p>{{ promo.description }}</p>
        <a class="cta" href="{{ promo.ctaUrl }}">{{ promo.ctaLabel }}</a>
    </div>
{% endfor %}

siteUrl( path, params, scheme, siteId )

サイト上のページへの URL を作成するため だけ という点を除けば、url() と似ています。

<a href="{{ siteUrl('company/contact') }}">Contact Us</a>

引数

siteUrl() ファンクションは、次の引数を持っています。

  • path – 結果となる URL がサイトで指すべきパス。それは、ベースサイト URL に追加されます。
  • params – URL に追加するクエリ文字列パラメータ。これは文字列(例:'foo=1&bar=2')またはオブジェクト(例:{foo:'1', bar:'2'})が利用可能です。
  • scheme – URL が使用するスキーム('http' または 'https')。デフォルト値は、現在のリクエストが SSL 経由で配信されているかどうかに依存します。そうでなければ、サイト URL のスキームが使用され、SSL 経由なら https が使用されます。
  • siteId – URL が指すべきサイト ID。デフォルトでは、現在のサイトが使用されます。

svg( svg, sanitize, namespace, class )

SVG 文書を出力します。

次のものを渡すことができます。

  • SVG ファイルのパス。

    {{ svg('@webroot/icons/lemon.svg') }}
    
  • アセットフィールドから引っ張られたような、craft\elements\Asset オブジェクト。

     {% set image = entry.myAssetsField.one() %}
     {% if image and image.extension == 'svg' %}
       {{ svg(image) }}
     {% endif %}
    
  • 生の SVG マークアップ。

     {% set image = include('_includes/icons/lemon.svg') %}
     {{ svg(image) }}
    

ファンクションにアセットまたは生のマークアップを渡した場合、デフォルトでは SVG は svg-sanitizer を使用して潜在的に悪意のあるスクリプトをサニタイズし、ドキュメント内の ID や class 名が DOM の他の ID や class 名と衝突しないよう名前空間を付加します。引数 sanitize、および、namespace を使用して、これらの動作を無効にできます。

{{ svg(image, sanitize=false, namespace=false) }}

引数 class を使用して、ルートの <svg> ノードに追加する独自の class 名を指定することもできます。

{{ svg('@webroot/icons/lemon.svg', class='lemon-icon') }}

url( path, params, scheme, mustShowScriptName )

URL を返します。

<a href="{{ url('company/contact') }}">Contact Us</a>

引数

url() ファンクションは、次の引数を持っています。

  • path – 結果となる URL がサイトで指すべきパス。それは、ベースサイト URL に追加されます。
  • params – URL に追加するクエリ文字列パラメータ。これは文字列(例:'foo=1&bar=2')またはオブジェクト(例:{foo:'1', bar:'2'})が利用可能です。
  • scheme – URL が使用するスキーム('http' または 'https')。デフォルト値は、現在のリクエストが SSL 経由で配信されているかどうかに依存します。そうでなければ、サイト URL のスキームが使用され、SSL 経由なら https が使用されます。
  • mustShowScriptName – ここに true がセットされている場合、「index.php」を含めた URL が返され、コンフィグ設定の omitScriptNameInUrls は無視されます。(ブラウザのアドレスバーに表示されない URL と .htaccess ファイルのリダイレクトとの衝突を避けたいような、Ajax 経由の POST リクエストで使用される URL の場合に有用です。)

TIP

クエリ文字列パラメータを追加、および / または、絶対 URL にスキームを適用するために、url() ファンクションを使用することができます。

{{ url('http://my-project.com', 'foo=1', 'https') }}
{# Outputs: "https://my-project.com?foo=1" #}