フィルタリファレンス¶

フィルタとは¶

フィルタは、フロントエンドが扱うデータを加工するための JavaScript プログラムです。
フィルタはサイト管理者が追加してください。

フィルタを使うことでフロントエンドの動作をある程度変更することができます。

フィルタは、フロントエンドからイベントに応じて呼び出されます。
引数として渡された文字列を加工して、戻り値としてフロントエンドへ返します。
戻り値は必ず返す必要があります。

フィルタの使い方¶

フィルタは、JavaScript の関数として実装します。
パラメータの値として関数オブジェクトを設定すると、イベントに応じて呼び出されます。
パラメータにフィルタを設定する例を示します。

searchAnchorFilter: function(url, item) { return url + '?foo=' + item.id; }

フィルタ一覧¶

searchAnchorFilter¶


説明	商品ページの URL を編集します。遷移先にパラメータを渡したり、遷移先を変更したりするのに使用します。
呼び出し	商品検索結果の表示時
引数	url: 商品ページの URL (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後の商品ページの URL (String)

searchAny1Filter¶


説明	ユーザー定義データ1を編集します。
呼び出し	商品検索結果の表示時
引数	any1: ユーザー定義データ1 (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後のユーザー定義データ1 (String)

searchAny1HTMLFilter¶


説明	ユーザー定義データ1を編集します。戻り値を、ユーザー定義データ1を表示する要素の innerHTML に設定します。不正な HTML を返すと表示が崩れる場合があります。
呼び出し	商品検索結果の表示時
引数	any1:ユーザー定義データ1 (String) item:表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後のユーザー定義データ1の HTML (String)。 undefined または null を返した場合には、ユーザー定義データ1は変更されません。(表示されなくなるのではなく、変更されない点に注意してください)

searchAny2Filter¶


説明	ユーザー定義データ2を編集します。
呼び出し	商品検索結果の表示時
引数	any2: ユーザー定義データ2 (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後のユーザー定義データ2 (String)

searchAny2HTMLFilter¶


説明	innerHTML に設定します。不正な HTML を返すと表示が崩れる場合があります。
呼び出し	商品検索結果の表示時
引数	any2: ユーザー定義データ2 (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後のユーザー定義データ2の HTML (String) undefined または null を返した場合には、ユーザー定義データ2は変更されません。(表示されなくなるのではなく、変更されない点に注意してください)

searchAny3Filter¶


説明	ユーザー定義データ3を編集します。
呼び出し	商品検索結果の表示時
引数	any3: ユーザー定義データ3 (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後のユーザー定義データ3 (String)

searchAny3HTMLFilter¶


説明	ユーザー定義データ3を編集します。戻り値を、ユーザー定義データ3を表示する要素の innerHTML に設定します。不正な HTML を返すと表示が崩れる場合があります。
呼び出し	商品検索結果の表示時
引数	any3: ユーザー定義データ3 (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後のユーザー定義データ3の HTML (String) undefined または null を返した場合には、ユーザー定義データ3は変更されません。(表示されなくなるのではなく、変更されない点に注意してください)

searchImageFilter¶


説明	商品画像の URL を編集します。異なる URL を生成や、スキームを変更・補完するのに使用します。
呼び出し	商品検索結果の表示時
引数	image_url: 商品画像の URL (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後の商品画像の URL (String)

searchSummaryFilter¶


説明	商品説明を編集します。
呼び出し	商品検索結果の表示時
引数	summary: 商品説明 (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後の商品説明 (String)

searchSummaryHTMLFilter¶


説明	商品説明を編集します。戻り値を、商品説明を表示する要素の innerHTML に設定します。不正な HTML を返すと表示が崩れる場合があります。
呼び出し	商品検索結果の表示時
引数	summary: 商品説明 (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後の商品説明の HTML (String)。 undefined または null を返した場合には、商品説明は変更されません。(表示されなくなるのではなく、変更されない点に注意してください。)

searchTitleFilter¶


説明	商品名の文字列を編集します。
呼び出し	商品検索結果の表示時
引数	title: 商品名 (String) item: 表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後の商品名 (String)

searchTitleHTMLFilter¶


説明	商品名の文字列を編集します。戻り値を、商品名を表示する要素の innerHTML に設定します。不正な HTML を返すと表示が崩れる場合があります。
呼び出し	商品検索結果の表示時
引数	title: 商品名 (String) item:表示する商品の情報、このパラメータの詳細は、「引数の詳細」を参照してください。
戻り値	編集後の商品名の HTML (String)。 undefined または null を返した場合には、商品名は変更されません。(表示されなくなるのではなく、変更されない点に注意してください。)

引数の詳細¶

item¶

フックやフィルタで利用可能な第 2 引数の item (商品情報) は次のプロパティを持ちます。(全て String)
ただし、データが含まれていない項目については、そのプロパティは存在しません。(取り出した場合、undefined が返されます。)

id (商品 ID)
title (商品名)
url (商品ページの URL)
image (商品画像 URL)
item_code (商品 ID)
summary (商品説明)
any1 (ユーザー定義データ 1)
any2 (ユーザー定義データ 2)
any3 (ユーザー定義データ 3)

フィルタの利用例¶

下記の例では、商品検索結果がクリックされたときに遷移する先のページの URL を編集しています。
URL 文字列中の「https://geniee.co.jp/」を「https://search.jp」に置換しています。
これにより、クリックしたときの遷移先を任意のものに変えることができます。

// サジェスト設定タグ
var poplink3 = {
  uid: "[UID]",
  target: "#q",
  deviceType: "pcia",
  searchAnchorFilter: function(url) {
    return url.replace(/^https:\/\/geniee.co.jp/, "https://search.jp")
  }
};

customSuggestNNameFilter¶


説明	カスタムサジェスト候補の表示名を編集します。
呼び出し	カスタムサジェスト候補の表示時
引数	name: カスタムサジェスト候補の表示名 (String)

customSuggestNLinkFilter¶


説明	カスタムサジェスト候補のリンクを編集します。
呼び出し	カスタムサジェスト候補の表示時
引数	link: カスタムサジェスト候補のリンク (String)

customSuggestNIconUriFilter¶


説明	カスタムサジェスト候補のアイコン画像の URL を編集します。
呼び出し	カスタムサジェスト候補の表示時
引数	icon: カスタムサジェスト候補のアイコン画像の URL (String)