フィルタ関数リファレンス¶
フィルタとは¶
フィルタは、フロントエンドが扱うデータを加工するための JavaScript プログラムです。
フィルタはサイト管理者が追加してください。
フィルタを使うことでフロントエンドの動作をある程度変更することができます。
フィルタは、フロントエンドからイベントに応じて呼び出されます。
引数として渡された文字列を加工して、戻り値としてフロントエンドへ返します。
フィルタの使い方¶
フィルタは、JavaScript の関数として実装します。
パラメータの値として関数オブジェクトを設定すると、イベントに応じて呼び出されます。
パラメータにフィルタを設定する例を示します。
itemLinkFilter: function(field, item, filter_options) {
return field + '?id=' + item.id;
},
...
引数の item 、filter_options の詳細は フックやフィルタの引数オブジェクトのプロパティ を参照してください。
フィルタの一覧¶
注意
用途やデータ登録方法によって、実際に利用可能なフィルタ関数は決定します。
登録されていないフィールドに対してのフィルタ関数は正しく動作しない可能性があります。
注意
フィルタの戻り値は必ず返す必要があります。
また、戻り値はフィルタ毎に決められたデータ型で返す必要があります。
戻り値を返さない場合や、指定されたデータ型以外の戻り値を返した場合の動作は保証されません。
itemFIELDNAMEFilter¶
説明: 検索結果コンポーネントで表示するフィールドの内容を編集します。
呼び出し: 検索結果コンポーネントの表示時
引数:
field: フィールドの内容。フィールドごとに型が異なる。
item: 表示する商品やコンテンツの情報
filter_options: フィルタの振る舞いを変える設定項目のハッシュ
戻り値: 編集後のフィールド内容。型は引数の field と合わせる。
利用可能なフィルタ関数名と、そこで編集可能なフィールドとデータ型は以下です。
| フィルタ関数名 | フィールド | データ型 | 備考 |
|---|---|---|---|
| itemSeqFilter | seq | Number | |
| itemTitleFilter | title | String | |
| itemIdFilter | id | String | |
| itemSummaryFilter | summary | String | |
| itemLinkFilter | link | String | |
| itemImageFilter | image | String | |
| itemTextFilter | text | String | |
| itemPriceFilter | price | Number | 1 |
| itemReviewScoreFilter | review_score | Number | |
| itemIconsFilter | icons | Array | |
| itemAttributesFilter | attributes | Array | |
| itemKeywordsFilter | keywords | Array | |
| itemKeywordsExactFilter | keywords_exact | Array | |
| itemKeywordsForwardFilter | keywords_forward | Array | |
| itemKeywordsAlphanumericFilter | keywords_alphanumeric | Array | |
| itemGroupTitleFilter | group_title | String | |
| itemGroupImageFIlter | group_image | String | |
| itemGroupLinkFilter | group_link | String | |
| itemSnippetFilter | snippet | String | 2 |
| itemFiletypeFilter | filetype | String | |
| itemFilesizeFilter | filesize | Number | 3 |
| itemLastModifiedFilter | last_modified | Number | 4 |
| itemDomainFilter | domain | String | |
| itemPathFilter | path | String | |
| itemThumbnailFilter | thumbnail | String | |
| itemAdditionalTextNFilter | additional_textN | String | N は 1 から 10 まで |
| itemAdditionalLinkNFilter | additional_linkN | String | N は 1 から 3 まで |
| itemAdditionalIconsNFilter | additional_iconsN | Array | N は 1 から 3 まで |
| itemNumericNFilter | numericN | Number | N は 1 から 5 まで |
| itemDisplayTextNFilter | display_textN | String | N は 1 から 50 まで |
| itemMultiNumericNFilter | multi_numericN | Array | N は 1 から 5 まで |
recommendLinkFIELDNAMEFilter¶
説明: おすすめリンクで表示するフィールドの内容を編集します。
呼び出し: おすすめリンクの表示時
引数:
field: フィールドの内容。フィールドごとに型が異なる。
item: 表示する商品やコンテンツの情報
filter_options: フィルタの振る舞いを変える設定項目のハッシュ
戻り値: 編集後のフィールド内容。型は引数の field と合わせる。
利用可能なフィルタ関数名と、そこで編集可能なフィールドとデータ型は以下です。
| フィルタ関数名 | フィールド | データ型 | 備考 |
|---|---|---|---|
| recommendLinkLinkFilter | link | String | |
| recommendLinkTitleFilter | title | String | |
| recommendLinkUrlFilter | url | String | |
| recommendLinkImageFilter | image | String | |
| recommendLinkSummaryFilter | summary | String |
gadgetItemFIELDNAMEFilter¶
説明: ガジェットコンポーネントで表示するフィールドの内容を編集します。
呼び出し: ガジェットコンポーネントの表示時
引数:
field: フィールドの内容。フィールドごとに型が異なる。
item: 表示する商品やコンテンツの情報
filter_options: フィルタの振る舞いを変える設定項目のハッシュ
戻り値: 編集後のフィールド内容。型は引数の field と合わせる。
利用可能なフィールドとデータ型は ItemFIELDNAMEFilter と同様です。
フィルタ関数名のみ変更して利用してください。
popwizFIELDNAMEFilter¶
説明: レコメンドコンポーネントで表示するフィールドの内容を編集します。
呼び出し: レコメンドコンポーネントの表示時
引数:
field: フィールドの内容。フィールドごとに型が異なる。
item: 表示する商品やコンテンツの情報
filter_options: フィルタの振る舞いを変える設定項目のハッシュ
戻り値: 編集後のフィールド内容。型は引数の field と合わせる。
利用可能なフィールドとデータ型は ItemFIELDNAMEFilter と同様です。
フィルタ関数名のみ変更して利用してください。
checkedItemFIELDNAMEFilter¶
説明: チェック履歴コンポーネントで表示するフィールドの内容を編集します。
呼び出し: チェック履歴コンポーネントの表示時
引数:
field: フィールドの内容。フィールドごとに型が異なる。itemFIELDNAMEFilterで編集された内容が渡されます。
item: 表示する商品やコンテンツの情報
filter_options: フィルタの振る舞いを変える設定項目のハッシュ
戻り値: 編集後のフィールド内容。型は引数の field と合わせる。
利用可能なフィールドとデータ型は ItemFIELDNAMEFilter と同様です。
フィルタ関数名のみ変更して利用してください。
relatedKeywordWordFilter¶
説明: 関連キーワードコンポーネントで表示する関連キーワードの内容を編集します。
呼び出し: 関連キーワードコンポーネントの表示時
引数:
word: 関連キーワードの文字列
戻り値: 編集後のフィールド内容。文字列型で返却する。
popwizInputFilter¶
説明: レコメンドコンポーネントで問い合わせに使用する内容を編集します。
呼び出し: レコメンドコンポーネントの問い合わせ時
引数:
input: 問い合わせ時に使用する予定の文字列
戻り値: 編集後のフィールド内容。文字列型で返却する。
changeStateUriFilter¶
説明: 検索結果の遷移先 URI を編集します。 絞り込み条件などを加えた URI に書き換えることが可能です。
呼び出し: 検索条件の変化時
引数:
uri: 検索結果の遷移先 URI
戻り値: 編集後のURI。文字列型で返却する
listItemFIELDNAMEFilter¶
説明: 比較用商品リストで表示するフィールドの内容を編集します。
呼び出し: 比較用商品リストの表示時
引数:
field: フィールドの内容。フィールドごとに型が異なる。
item: 表示する商品やコンテンツの情報
filter_options: フィルタの振る舞いを変える設定項目のハッシュ
戻り値: 編集後のフィールド内容。型は引数の field と合わせる。
利用可能なフィルタ関数名と、そこで編集可能なフィールドとデータ型は以下です。
| フィルタ関数名 | フィールド | データ型 | 備考 |
|---|---|---|---|
| listItemTitleFilter | title | String | |
| listItemIdFilter | id | String | |
| listItemLinkFilter | link | String | |
| listItemImageFilter | image | String |
compareItemFIELDNAMEFilter¶
説明: 商品比較結果で表示するフィールドの内容を編集します。
呼び出し: 商品比較結果の表示時
引数:
field: フィールドの内容。フィールドごとに型が異なる。
item: 表示する商品やコンテンツの情報
filter_options: フィルタの振る舞いを変える設定項目のハッシュ
戻り値: 編集後のフィールド内容。型は引数の field と合わせる。
利用可能なフィールドとデータ型は ItemFIELDNAMEFilter と同様です。
フィルタ関数名のみ変更して利用してください。
-
itemPriceFilter 関数をユーザ自身で作成・適用する場合、3 桁区切りでカンマを打つ標準の処理は適用されません。 ↩
-
itemSnippetFIlter 関数をユーザ自身で作成・適用する場合、ハイライトも有効にするには、フィルタ作成者が適切にエスケープ処理を行った上で、出力時にエスケープを行わず HTML として出力する filter_options.use_html を合わせて設定してください。 ↩
-
itemFilesizeFilter 関数をユーザ自身で作成・適用する場合、引数に渡されてくるのは byte となるので、まるめ処理などを必要に応じて検討してください。 ↩
-
itemLastModifiedFilter 関数をユーザ自身で作成・適用する場合、引数に渡されてくるのは sec (秒) となるので、日付変換処理などを必要に応じて検討してください。 ↩