グローバル設定クエリ

グローバル設定クエリを使用して、テンプレートや PHP コード内でグローバル設定を取得できます。

{# Create a new global set query #}
{% set myGlobalSetQuery = craft.globalSets() %}

グローバル設定クエリを作成すると、結果を絞り込むためのパラメータをセットできます。 さらに、.all() を呼び出して実行できます。GlobalSet オブジェクトの配列が返されます。

TIP

エレメントクエリがどのように機能するかについては、エレメントクエリについてを参照してください。

実例

次の操作をすることで、プライマリサイトからグローバル設置をロードし、コンテンツを表示できます。

  1. craft.globalSets() でグローバル設定クエリを作成します。
  2. handle および siteId パラメータをセットします。
  3. .one() でグローバル設定を取得します。
  4. コンテンツを出力します。
{# Create a global set query with the 'handle' and 'siteId' parameters #}
{% set myGlobalSetQuery = craft.globalSets()
    .handle('footerCopy')
    .siteId(1) %}

{# Fetch the global set #}
{% set globalSet = myGlobalSetQuery.one() %}

{# Display the content #}
<p>{{ globalSet.copyrightInfo }}</p>

TIP

すべてのグローバル設定は、Twig テンプレートのグローバル変数としてすでに利用可能です。そのため、現在のサイトとは異なるサイトのコンテンツにアクセスする場合、craft.globalSets() を通して取得する必要があります。

パラメータ

グローバル設定クエリは、次のパラメータをサポートしています。

anyStatus

status() および enabledForSite() パラメータをクリアします。

{# Fetch all global sets, regardless of status #}
{% set globalSets = craft.globalSets()
    .anyStatus()
    .all() %}

asArray

GlobalSet オブジェクトではなく、データの配列として、マッチしたグローバル設定をクエリが返します。

{# Fetch global sets as arrays #}
{% set globalSets = craft.globalSets()
    .asArray()
    .all() %}

dateCreated

グローバル設定の作成日に基づいて、クエリの結果を絞り込みます。

利用可能な値には、次のものが含まれます。

取得するグローバル設定
'>= 2018-04-01'2018-04-01 以降に作成されたもの。
'< 2018-05-01'2018-05-01 より前に作成されたもの。
['and', '>= 2018-04-04', '< 2018-05-01']2018-04-01 から 2018-05-01 の間に作成されたもの。
{# Fetch global sets created last month #}
{% set start = date('first day of last month')|atom %}
{% set end = date('first day of this month')|atom %}

{% set globalSets = craft.globalSets()
    .dateCreated(['and', ">= #{start}", "< #{end}"])
    .all() %}

dateUpdated

グローバル設定の最終アップデート日に基づいて、クエリの結果を絞り込みます。

利用可能な値には、次のものが含まれます。

取得するグローバル設定
'>= 2018-04-01'2018-04-01 以降にアップデートされたもの。
'< 2018-05-01'2018-05-01 より前にアップデートされたもの。
['and', '>= 2018-04-04', '< 2018-05-01']2018-04-01 から 2018-05-01 の間にアップデートされたもの。
{# Fetch global sets updated in the last week #}
{% set lastWeek = date('1 week ago')|atom %}

{% set globalSets = craft.globalSets()
    .dateUpdated(">= #{lastWeek}")
    .all() %}

fixedOrder

クエリの結果を id で指定された順序で返します。

{# Fetch global sets in a specific order #}
{% set globalSets = craft.globalSets()
    .id([1, 2, 3, 4, 5])
    .fixedOrder()
    .all() %}

handle

グローバル設定のハンドルに基づいて、クエリの結果を絞り込みます。

利用可能な値には、次のものが含まれます。

取得するグローバル設定
'foo'ハンドルが foo
'not foo'ハンドルが foo ではない。
['foo', 'bar']ハンドルが foo または bar
['not', 'foo', 'bar']ハンドルが foo または bar ではない。
{# Fetch the global set with a handle of 'foo' #}
{% set globalSet = craft.globalSets()
    .handle('foo')
    .one() %}

id

グローバル設定の ID に基づいて、クエリの結果を絞り込みます。

利用可能な値には、次のものが含まれます。

取得するグローバル設定
1ID が 1。
'not 1'ID が 1ではない。
[1, 2]ID が 1 または 2。
['not', 1, 2]ID が 1 または 2 ではない。
{# Fetch the global set by its ID #}
{% set globalSet = craft.globalSets()
    .id(1)
    .one() %}

TIP

特定の順序で結果を返したい場合、fixedOrder と組み合わせることができます。

inReverse

クエリの結果を逆順で返します。

{# Fetch global sets in reverse #}
{% set globalSets = craft.globalSets()
    .inReverse()
    .all() %}

limit

返されるグローバル設定の数を決定します。

{# Fetch up to 10 global sets  #}
{% set globalSets = craft.globalSets()
    .limit(10)
    .all() %}

offset

結果からスキップされるグローバル設定の数を決定します。

{# Fetch all global sets except for the first 3 #}
{% set globalSets = craft.globalSets()
    .offset(3)
    .all() %}

orderBy

返されるグローバル設定の順序を決定します。

{# Fetch all global sets in order of date created #}
{% set globalSets = craft.globalSets()
    .orderBy('dateCreated asc')
    .all() %}

relatedTo

特定の他のエレメントと関連付けられたグローバル設定だけに、クエリの結果を絞り込みます。

このパラメーターがどのように機能するかの詳細については、リレーションを参照してください。

{# Fetch all global sets that are related to myCategory #}
{% set globalSets = craft.globalSets()
    .relatedTo(myCategory)
    .all() %}

検索クエリにマッチするグローバル設定だけに、クエリの結果を絞り込みます。

このパラメーターがどのように機能するかの詳細については、検索を参照してください。

{# Get the search query from the 'q' query string param #}
{% set searchQuery = craft.app.request.getQueryParam('q') %}

{# Fetch all global sets that match the search query #}
{% set globalSets = craft.globalSets()
    .search(searchQuery)
    .all() %}

site

グローバル設定を照会するサイトを決定します。

デフォルトでは、現在のサイトが使用されます。

利用可能な値には、次のものが含まれます。

取得するグローバル設定
'foo'ハンドルが foo のサイトから。
\craft\elements\db\Site オブジェクトオブジェクトで表されるサイトから。
{# Fetch global sets from the Foo site #}
{% set globalSets = craft.globalSets()
    .site('foo')
    .all() %}

siteId

サイトの ID ごとに、グローバル設定を照会するサイトを決定します。

デフォルトでは、現在のサイトが使用されます。

{# Fetch global sets from the site with an ID of 1 #}
{% set globalSets = craft.globalSets()
    .siteId(1)
    .all() %}

trashed

ソフトデリートされたグローバル設定だけに、クエリの結果を絞り込みます。

{# Fetch trashed global sets #}
{% set globalSets = {twig-function}
    .trashed()
    .all() %}

uid

グローバル設定の UID に基づいて、クエリの結果を絞り込みます。

{# Fetch the global set by its UID #}
{% set globalSet = craft.globalSets()
    .uid('xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx')
    .one() %}

with

関連付けられたエレメントを eager-loaded した状態で、マッチしたグローバル設定をクエリが返します。

このパラメーターがどのように機能するかの詳細については、エレメントのEager-Loadingを参照してください。

{# Fetch global sets eager-loaded with the "Related" field’s relations #}
{% set globalSets = craft.globalSets()
    .with(['related'])
    .all() %}