icon-check icon-sns-facebook icon-sns-twitter icon-sns-instagram icon-sns-line icon-sns-pinterest arrow icon__mail

WEBサイト構築CMS

お問い合わせ・資料請求
  1. HOME
  2. ガイド
  3. Clipkit Liquidテンプレート言語リファレンス（オブジェクト・メソッド）
GUIDE

Clipkit Liquidテンプレート言語リファレンス（オブジェクト・メソッド）

Clipkitで構築するWEBサイトのフロントエンドをコーディングするためのLiquidテンプレート言語のリファレンスです。Clipkit独自のオブジェクトとメソッドを記載しています。

INDEX

Clipkitはテンプレート言語として Liquid を採用しています。
本リファレンスでは、Clipkit独自の拡張機能のみを掲載しており、Liquidの基本仕様については Liquid公式リファレンス をご参照ください。

オブジェクトとオブジェクトのリレーション

オブジェクト 説明
article 記事オブジェクト
article.category 記事に紐付くカテゴリーオブジェクト
article.comments 記事に紐付くコメントオブジェクトのリレーション
article.distributor 記事に紐付く配信元オブジェクト
article.ordered_tags 記事に紐付くタグオブジェクトの表示位置順でソートされたリレーション
article.relevance_articles 記事に紐付く関連する記事オブジェクトのリレーション
article.tags 記事に紐付くタグオブジェクトのリレーション
article.user 記事に紐付く記事作成者オブジェクト
category カテゴリーオブジェクト
category.articles カテゴリーに紐付く記事オブジェクトのリレーション
category.comments カテゴリーに紐付くコメントオブジェクトのリレーション
comment コメントオブジェクト
controller コントローラーオブジェクト
distributor 配信元オブジェクト
item 記事アイテムオブジェクト
paginate ページネートオブジェクト
request リクエストオブジェクト
site サイトオブジェクト
site.attributes サイトに紐付く拡張項目のリレーション
site.tags サイトに紐付くタグオブジェクトのリレーション
system システムオブジェクト
tag タグオブジェクト
tag.article タグに紐付く記事オブジェクトのリレーション
user 記事作成者オブジェクト
user.articles 記事作成者に紐付く記事オブジェクトのリレーション
widget ウィジェットオブジェクト

Articleオブジェクト

基本情報

メソッド 説明
article.permalink 英数字のユニークな記事のパーマリンクを取得する
article.title 記事のタイトルを取得する
article.description 記事の概要を取得する
article.url 記事のURLパスを取得する
article.id 数値型のユニークな記事IDを取得する
article.lang 記事の言語コードを取得する
article.type 記事定義の種類（ページまたは記事）を取得する
article.kind 記事種別を取得する（※古いバージョンのClipkitで実装された機能なので今後新たに利用する場合は下記 article.kinds を利用の事）
article.kinds 記事種別を取得する

日時関連

メソッド 説明
article.published_at 記事の公開日時を取得する
article.updated_at 記事の最終更新日時を取得する

画像関連

メソッド 説明
article.image_small_url 横幅320pxにリサイズされたアイキャッチ画像のURLを取得する
article.image_medium_url 横幅640pxにリサイズされたアイキャッチ画像のURLを取得する
article.image_large_url 横幅1280pxにリサイズされたアイキャッチ画像のURLを取得する
article.image_square_url 高さ・横幅150pxの正方形にリサイズされたアイキャッチ画像のURLを取得する
article.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされたアイキャッチ画像のURLを取得する
article.image_original_url オリジナルサイズのアイキャッチ画像のURLを取得する（使用時はresizeフィルタ必須）
article.image_is_empty アイキャッチ画像が登録されているか否かを返す

記事・コンテンツ関連

メソッド 説明
article.source_url 記事入稿（RSS受信）機能を使用した記事の時、外部配信元の参照元URLを取得する
article.items 記事を構成する記事アイテム（Itemオブジェクト）のRelation
article.subscribed_items ログイン中のユーザに購読する権利がある記事アイテム（Itemオブジェクト）のRelation
article.paginates 改ページ（Paginateオブジェクト）のRelation
article.relevance_articles 関連する記事（Articleオブジェクト）のRelation
article.locales 多言語翻訳機能を使用している時、有効な言語コードを配列で返す

関連オブジェクト

メソッド 説明
article.user 記事所有者のユーザーオブジェクト
article.category 記事が属するカテゴリーのオブジェクト
article.distributor 記事入稿（RSS受信）機能を使用している時、入稿元オブジェクト
article.site 記事発信元サイトのオブジェクト
article.tag 記事に紐づけられたタグのオブジェクト
article.ordered_tag 任意の順に並べたタグのオブジェクト
article.attribute 記事に紐づく拡張項目オブジェクト

お気に入り関連

メソッド 説明
article.favorites 記事に紐づくお気に入りオブジェクト（Favorites）のRelation
article.num_favorites 記事のお気に入り登録数を取得する
article.is_favorite 記事がカレントユーザにお気に入りされているか否かを返す
article.add_favorite_path お気に入り追加パス
article.remove_favorite_path お気に入り削除パス
article.favorite_json_url 記事のお気に入りに関連する情報を取得するためのJSON APIのエンドポイントURLを取得する

統計・カウント関連

メソッド 説明
article.num_views 記事の閲覧数を取得する

コメント関連

メソッド 説明
article.comments 記事に紐づくコメント（Commentオブジェクト）のRelation
article.num_comments 記事に対して投稿された承認されているコメント数を取得する
article.new_comment_path コメント投稿フォームのURLパスを取得する

状態関連

メソッド 説明
article.is_published 記事は公開されているか否かを返す
article.has_subscription 記事には購読アイテムが使用されているかどうかを返す

ArticleAttributesオブジェクト

拡張項目関連

メソッド 説明
article.attributes.attr_str 拡張項目attr_strの値を取得する
article.attributes.attr_img_small 拡張項目attr_imgが画像の時、横幅320pxにリサイズされたURLパスを取得する
article.attributes.attr_img_medium 拡張項目attr_imgが画像の時、横幅640pxにリサイズされたURLパスを取得する
article.attributes.attr_img_large 拡張項目attr_imgが画像の時、横幅1280pxにリサイズされたURLパスを取得する
article.attributes.attr_img_square 拡張項目attr_imgが画像の時、高さ・横幅150pxの正方形にリサイズされたURLパスを取得する
article.attributes.attr_img_thumbnail 拡張項目attr_imgが画像の時、高さ・横幅75pxの正方形にリサイズされたURLパスを取得する
article.attributes.attr_img_original 拡張項目attr_imgが画像の時、オリジナルサイズのURLパスを取得する（使用時はresizeフィルタ必須）

ArticleFavoritesオブジェクト

お気に入り関連

メソッド 説明
article.favorites.num_foo お気に入り種類fooのお気に入り数を取得する

Categoryオブジェクト

基本情報

メソッド 説明
category.permalink カテゴリーのパーマリンクを取得する
category.name カテゴリー名称を取得する
category.description カテゴリーの概要を取得する
category.num_articles カテゴリーに分類されている記事数を取得する
category.url カテゴリーページのURLパスを取得する

画像関連

メソッド 説明
category.image_small_url 横幅320pxにリサイズされたカテゴリー画像のURLを取得する
category.image_medium_url 横幅640pxにリサイズされたカテゴリー画像のURLを取得するる
category.image_large_url 横幅1280pxにリサイズされたカテゴリー画像のURLを取得する
category.image_square_url 高さ・横幅150pxの正方形にリサイズされたカテゴリー画像のURLを取得する
category.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされたカテゴリー画像のURLを取得する
category.image_original_url オリジナルサイズのカテゴリー画像のURLパスを取得する（resizeフィルター使用必須）
category.icon_url カテゴリーに設定されたアイコンのURLパスを取得する

記事・コンテンツ関連

メソッド 説明
category.all_articles カテゴリーに属する全ての記事（Articleオブジェクト）のRelation
category.published_articles カテゴリーに属する全ての公開記事（Articleオブジェクト）を、公開日時の新しい順に並べたRelation
category.articles category.published_articlesに同じ（エイリアス）
category.recent_articles category.published_articlesに同じ（エイリアス）
category.updated_articles カテゴリーに属する全ての公開記事（Articleオブジェクト）を、更新日時の新しい順に並べたRelation
category.private_articles カテゴリーに属する全ての非公開記事（Articleオブジェクト）のRelation
category.reserved_articles カテゴリーに属する全ての公開予定記事（Articleオブジェクト）のRelation
category.all_pages カテゴリーに属する全てのページ（Articleオブジェクト）のRelation
category.pages カテゴリーに属する全ての公開済みのページ（Articleオブジェクト）のRelation
category.all_contents カテゴリーに属する全てのコンテンツ（Articleオブジェクト）のRelation
category.contents カテゴリーに属する全ての公開済みコンテンツ（Articleオブジェクト）のRelation

ランキング関連

メソッド 説明
category.popular_tags カテゴリーに属する記事に紐づけられたタグ（Tagオブジェクト）のRelationをタグ付け回数の多い順に返す
category.custom_period_popular_articles カテゴリーに属する記事（Articleオブジェクト）のRelationを指定期間内の閲覧数の多い順に返す
category.daily_popular_articles カテゴリーに属する記事（Articleオブジェクト）のRelationを過去1日の閲覧数の多い順に返す
category.weekly_popular_articles カテゴリーに属する記事（Articleオブジェクト）のRelationを過去7日間の閲覧数の多い順に返す
category.monthly_popular_articles カテゴリーに属する記事（Articleオブジェクト）のRelationを過去1ヶ月の閲覧数の多い順に返す

階層関連

メソッド 説明
category.children カレントカテゴリーの子カテゴリーの配列を返す
category.descendants カレントカテゴリーの全子カテゴリーの配列を返す
category.ancestors カレントカテゴリーの祖先カテゴリーの配列を返す
category.parent カレントカテゴリーの親カテゴリを返す

コメント関連

メソッド 説明
category.comments カテゴリーに属する記事についたコメント（Commentオブジェクト）のRelation
category.num_comments カテゴリーに属する記事についたコメントの数値を取得する

Collectionオブジェクト

基本情報

メソッド 説明
site.collection.name コレクション名（和名）を取得する
site.collection.label コレクション名（英数字）を取得する
site.collection.items コレクションに登録されているアイテムオブジェクトのRelation

CollectionItemオブジェクト

基本情報

メソッド 説明
collectionitem.type コレクションアイテムの種類（CollectionItemWidget / CollectionItemArticle / CollectionItemImage / CollectionItemHtml）を取得する
collectionitem.label コレクションアイテムの名称（和名）を取得する
collectionitem.caption コレクションアイテムが記事の時はarticle.description、画像の時は「キャプション」、HTMLの時はHTMLソースを取得する
collectionitem.url コレクションアイテムが記事の時はarticle.url、画像の時は「URL」を取得する
collectionitem.path コレクションアイテムが記事の時、記事のパスを取得する

画像関連

メソッド 説明
collectionitem.image_url コレクションアイテムが画像の時は画像のURLパス、記事の時は記事のアイキャッチ画像のURLパス、ウィジェットの時かつウィジェットに画像が指定されている時は指定されている画像のURLパスを、画像が未指定の時および、コレクションアイテムがHTMLの時はmissing.pngを取得する
collectionitem.image_small_url 横幅320pxにリサイズされた画像のURLを取得する
collectionitem.image_medium_url 横幅640pxにリサイズされた画像のURLを取得する
collectionitem.image_large_url 横幅1280pxにリサイズされた画像のURLを取得する
collectionitem.image_square_url 高さ・横幅150pxの正方形にリサイズされた画像のURLを取得する
collectionitem.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされた画像のURLを取得する
collectionitem.image_original_url オリジナルサイズの画像のURLパスを取得する（resizeフィルター使用必須）

関連オブジェクト

メソッド 説明
collectionitem.article アイテムが記事の時
collectionitem.widget アイテムがウィジェットの時

Commentオブジェクト

基本情報

メソッド 説明
comment.id 数値型のユニークなコメントIDを取得する
comment.sender ゲストがコメント投稿する際に入力したニックネームを取得する
comment.body コメント本文を取得する
comment.created_at コメント投稿日時を取得する

関連オブジェクト

メソッド 説明
comment.user コメント投稿者のユーザー（Userオブジェクト）
comment.article コメント投稿元の記事（Articleオブジェクト）
comment.replies コメントに対する返信コメント（Commentオブジェクト）のRelation
comment.assets コメント投稿時に添付されたファイルのRelation

その他

メソッド 説明
comment.new_reply_path コメント返信用のURLパスを取得する

CommentAssetオブジェクト

画像関連

メソッド 説明
comment.asset.image_small_url 横幅320pxにリサイズされた、コメントに添付された画像のURLを取得する
comment.asset.image_medium_url 横幅640pxにリサイズされた、コメントに添付された画像のURLを取得する
comment.asset.image_large_url 横幅1280pxにリサイズされた、コメントに添付された画像のURLを取得する
comment.asset.image_square_url 高さ・横幅150pxの正方形にリサイズされた、コメントに添付された画像のURLを取得する
comment.asset.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされた、コメントに添付された画像のURLを取得する
comment.asset.image_original_url オリジナルサイズの添付された画像のURLパスを取得する（resizeフィルター使用必須）

Controllerオブジェクト

ナビゲーション関連

メソッド 説明
controller.render_breadcrumbs パンくずリストを表示する
controller.breadcrumbs パンくずの要素が定義された配列を返す
   

閲覧者関連

メソッド 説明
controller.current_user 閲覧者のユーザー（Userオブジェクト）
controller.signed_in 閲覧者がログインしているか否かを返す

その他

メソッド 説明
controller.response_status HTTPステータスコードを取得する

Distributorオブジェクト

基本情報

メソッド 説明
distributor.name 記事入稿（RSS受信）元のサイト名を取得する
distributor.label 記事入稿（RSS受信）元の識別用英数字を取得する
distributor.url 記事入稿（RSS受信）元のURLパスを取得する

画像関連

メソッド 説明
distributor.image_url 記事入稿（RSS受信）元に設定したアイコンのURLパスを取得する

Formオブジェクト

基本情報

メソッド 説明
form.title フォームのタイトルを取得する
form.description フォームの説明を取得する
form.url フォームの回答一覧ページのURLを取得する

ファイル関連

メソッド 説明
reply.form.is_downloadable ダウンロード可能なファイルが存在するか否かを返す
reply.form.files ダウンロード可能なファイルオブジェクトのRelation
reply.form.download_page_url ファイルダウンロードURLパスを取得する

Replyオブジェクト

基本情報

メソッド 説明
reply.values 回答されたフォームアイテム（reply.valueオブジェクト）のRelation
reply.download_page_url 回答した事によりダウンロード可能なファイルが存在する時、そのURLパスを取得する

関連オブジェクト

メソッド 説明
reply.user フォームに回答したユーザー（Userオブジェクト）
reply.form 回答されたフォーム（Formオブジェクト）

Reply.Valueオブジェクト

基本情報

メソッド 説明
reply.value.name フォームの回答項目名を取得する
reply.value.value 回答された値を取得する
reply.value.type 回答項目の種類を取得する

Galleryオブジェクト

基本情報

メソッド 説明
item.gallery.url ギャラリーアイテムに登録されている画像のURLパスを取得する
item.gallery.source ギャラリーアイテムに登録されている出典を取得する
item.gallery.source_url ギャラリーアイテムに登録されている出典URLを取得する
item.gallery.title ギャラリーアイテムに登録されている画像のタイトルを取得する
item.gallery.body ギャラリーアイテムに登録されている画像のタイトルを取得する（titleのalias）
item.gallery.comment ギャラリーアイテムに登録されている画像へのコメントを取得する
item.gallery.domain ギャラリーアイテムに登録されている出典URLから抽出されたドメインを取得する

画像関連

メソッド 説明
item.gallery.image_small_url 横幅320pxにリサイズされた画像のURLを取得する
item.gallery.image_medium_url 横幅640pxにリサイズされた画像のURLを取得する
item.gallery.image_large_url 横幅1280pxにリサイズされた画像のURLを取得する
item.gallery.image_square_url 高さ・横幅150pxの正方形にリサイズされた画像のURLを取得する
item.gallery.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされた画像のURLを取得する
item.gallery.image_original_url オリジナルサイズの画像のURLを取得する（使用時はresizeフィルタ必須）

画像サイズ関連

メソッド 説明
item.gallery.image_original_width オリジナルサイズの画像の横幅を取得する
item.gallery.image_original_height オリジナルサイズの画像の縦幅を取得する
item.gallery.image_large_width 横幅1280pxにリサイズされたの画像の横幅を取得する
item.gallery.image_large_height 横幅1280pxにリサイズされた画像の高さを取得する
item.gallery.image_medium_width 横幅640pxにリサイズされた画像の横幅を取得する
item.gallery.image_medium_height 横幅640pxにリサイズされた画像の高さを取得する
item.gallery.image_small_width 横幅320pxにリサイズされた画像の横幅を取得する
item.gallery.image_small_height 横幅320pxにリサイズされた画像の高さを取得する
item.gallery.image_square_width 高さ・横幅150pxの正方形にリサイズされた画像の横幅を取得する
item.gallery.image_square_height 高さ・横幅150pxの正方形にリサイズされた画像の高さを取得する
item.gallery.image_thumbnail_width 高さ・横幅75pxの正方形にリサイズされた画像の横幅を取得する
item.gallery.image_thumbnail_height 高さ・横幅75pxの正方形にリサイズされた画像の高さを取得する

Itemオブジェクト

基本情報

メソッド 説明
item.permalink 記事アイテムのパーマリンクIDを取得する
item.type 記事アイテムの種類を取得する
item.title 記事アイテムのタイトルを取得する
item.caption 記事アイテムの説明書きを取得する
item.alt 記事アイテムが画像の時、alt属性を取得する
item.url 記事アイテムのURLパスを取得する
item.source 記事アイテムに引用元がある時、引用元URLを取得する
item.body 記事アイテムに本文がある時、本文を取得する
item.comment 記事アイテムにコメントがある時、コメントを取得する
item.sortkey 記事アイテムの並び順を取得する

画像関連

メソッド 説明
item.image_small_url 横幅320pxにリサイズされた画像のURLを取得する
item.image_medium_url 横幅640pxにリサイズされた画像のURLを取得する
item.image_large_url 横幅1280pxにリサイズされた画像のURLを取得する
item.image_square_url 高さ・横幅150pxの正方形にリサイズされた画像のURLを取得する
item.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされた画像のURLを取得する
item.image_original_url オリジナルサイズの画像のURLを取得する（使用時はresizeフィルタ必須）
item.image_is_empty 画像は空か否かを返す
item.image_original_width オリジナルサイズの画像の横幅を取得する
item.image_original_height オリジナルサイズの画像の高さを取得する
item.image_large_width 横幅1280pxにリサイズされた画像の横幅を取得する
item.image_large_height 横幅1280pxにリサイズされた画像の高さを取得する
item.image_medium_width 横幅640pxにリサイズされた画像の横幅を取得する
item.image_medium_height 横幅640pxにリサイズされた画像の高さを取得する
item.image_small_width 横幅320pxにリサイズされた画像の横幅を取得する
item.image_small_height 横幅320pxにリサイズされた画像の高さを取得する
item.image_square_width 高さ・縦横150pxの正方形にリサイズされた画像の横幅を取得する
item.image_square_height 高さ・縦横150pxの正方形にリサイズされた画像の高さを取得する
item.image_thumbnail_width 高さ・縦横75pxの正方形にリサイズされた画像の横幅を取得する
item.image_thumbnail_height 高さ・縦横75pxの正方形にリサイズされた画像の高さを取得する

ファイル関連

メソッド 説明
item.file_name ファイル名を取得する
item.file_content_type ファイルの種類を取得する
item.file_size ファイルサイズを取得する
item.file_url ファイルのURLパスを取得する
item.file_download ファイルのダウンロードパスを取得する

動画・メディア関連

メソッド 説明
item.player_url 動画コンテンツのURLを取得する
item.domain 動画コンテンツのドメインを取得する
item.galleries ギャラリーアイテムに登録された画像のRelation

拡張項目

メソッド 説明
item.ext1 カスタムアイテムで定義された拡張項目1を取得する
item.ext2 カスタムアイテムで定義された拡張項目2を取得する
item.ext3 カスタムアイテムで定義された拡張項目3を取得する

その他

メソッド 説明
item.render レンダリングする
item.is_local_url アイテム内で定義されたURLはサイト内か否かを返す

ItemAssetオブジェクト

画像関連

メソッド 説明
itemasset.small_url 横幅320pxにリサイズされた画像のURLを取得する
itemasset.medium_url 横幅640pxにリサイズされた画像のURLを取得する
itemasset.large_url 横幅1280pxにリサイズされた画像のURLを取得する
itemasset.square_url 高さ・横幅150pxの正方形にリサイズされた画像のURLを取得する
itemasset.thumbnail_url 高さ・横幅75pxの正方形にリサイズされた画像のURLを取得する
itemasset.original_url オリジナルサイズの画像のURLを取得する（使用時はresizeフィルタ必須）

画像サイズ関連

メソッド 説明
itemasset.original_width オリジナルサイズの画像の横幅を取得する
itemasset.original_height オリジナルサイズの画像の高さを取得する
itemasset.large_width 横幅1280pxにリサイズされた画像の横幅を取得する
itemasset.large_height 横幅1280pxにリサイズされた画像の高さを取得する
itemasset.medium_width 横幅640pxにリサイズされた画像の横幅を取得する
itemasset.medium_height 横幅640pxにリサイズされた画像の高さを取得する
itemasset.small_width 横幅320pxにリサイズされた画像の横幅を取得する
itemasset.small_height 横幅320pxにリサイズされた画像の高さを取得する
itemasset.square_width 高さ・横幅150pxの正方形にリサイズされた画像の横幅を取得する
itemasset.square_height 高さ・横幅150pxの正方形にリサイズされた画像の高さを取得する
itemasset.thumbnail_width 高さ・横幅75pxの正方形にリサイズされた画像の横幅を取得する
itemasset.thumbnail_height 高さ・横幅75pxの正方形にリサイズされた画像の高さを取得する

ファイル関連

メソッド 説明
itemasset.file_name ファイル名を取得する
itemasset.file_content_type ファイルの種類を取得する
itemasset.file_size ファイルサイズを取得する
itemasset.file_url ファイルのURLパスを取得する
itemasset.file_download ファイルのダウンロードパスを取得する

Paginateオブジェクト

ページネーション関連

メソッド 説明
paginate.page ページ番号を取得する
paginate.limit 表示件数を取得する
paginate.offset 開始位置を取得する

Requestオブジェクト

リクエスト情報

メソッド 説明
request.url リクエストURLを取得する
request.path リクエストURLパスを取得する
reuqest.fullpath クエリー文字列を含むリクエストパスを取得する
request.params クエリー文字列を配列で返す
request.query_parameters クエリー文字列を取得する
request.current_page 現在のページ番号を取得する

Siteオブジェクト

基本情報

メソッド 説明
site.title サイトタイトルを取得する
site.top_title トップページのタイトルを取得する
site.name サイト名を取得する
site.description サイト説明を取得する
site.url トップページのURLを取得する

ロゴ・アイコン関連

メソッド 説明
site.logo_original_url サイトロゴ画像のURLを取得する
site.logo_small_url 小さなサイズのサイトロゴ画像のURLを取得する
site.logo_mobile_small_url モバイルサイト用の小サイズのサイトロゴ画像のURLを取得する
site.favicon_url ファビコン画像のURLを取得する
site.touch_icon_url タッチアイコン画像のURLを取得する

画像関連

メソッド 説明
site.image_small_url 横幅320pxにリサイズされたサイト画像のURLを取得する
site.image_medium_url 横幅640pxにリサイズされたサイト画像のURLを取得する
site.image_large_url 横幅1280pxにリサイズされたサイト画像のURLを取得する
site.image_square_url 高さ・横幅150pxの正方形にリサイズされたサイト画像のURLを取得する
site.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされたサイト画像のURLを取得する
site.image_original_url オリジナルサイズのサイト画像のURLパスを取得する（使用時はresizeフィルタ必須）

記事・コンテンツ関連

メソッド 説明
site.all_articles 全ての記事（Articleオブジェクト）のRelation
site.published_articles 全ての公開記事（Articleオブジェクト）を、公開日時の新しい順に並べたRelation
site.articles site.published_articlesに同じ（エイリアス）
site.recent_articles site.published_articlesに同じ（エイリアス）
site.updated_articles 全ての公開記事（Articleオブジェクト）を、更新日時の新しい順に並べたRelation
site.private_articles 全ての非公開記事（Articleオブジェクト）のRelation
site.reserved_articles 全ての公開予定記事（Articleオブジェクト）のRelation
site.all_pages 全てのページ（Articleオブジェクト）のRelation
site.pages 全ての公開済みのページ（Articleオブジェクト）のRelation
site.all_contents 全てのコンテンツ（Articleオブジェクト）のRelation
site.private_contents 全ての非公開コンテンツ（Articleオブジェクト）のRelation
site.private_pages 全ての非公開ページ（Articleオブジェクト）のRelation
site.contents 全ての公開済みコンテンツ（Articleオブジェクト）のRelation

ランキング関連

メソッド 説明
site.custom_period_popular_articles 記事（Articleオブジェクト）のRelationを指定期間内の閲覧数の多い順に返す
site.daily_popular_articles 記事（Articleオブジェクト）のRelationを過去1日の閲覧数の多い順に返す
site.weekly_popular_articles 記事（Articleオブジェクト）のRelationを過去7日間の閲覧数の多い順に返す
site.monthly_popular_articles 記事（Articleオブジェクト）のRelationを過去1ヶ月の閲覧数の多い順に返す
site.total_popular_articles 記事（Articleオブジェクト）のRelationを全期間の閲覧数の多い順に返す

タグ・カテゴリ関連

メソッド 説明
site.tags 記事で使用されているタグ（Tagオブジェクト）のRelation
site.all_tags サイトに登録されているタグ（Tagオブジェクト）のRelation
site.categories ルートカテゴリー（Categoryオブジェクト）のRelation
site.all_categories 全てのカテゴリー（Categoryオブジェクト）のRelation

ユーザー・コメント関連

メソッド 説明
site.curators ライター（Userオブジェクト）のRelation
site.accept_comment コメントを受け付けているか否かを返す
site.comments 全ての記事を対象とした全てのコメント（Commentオブジェクト）のRelation
site.num_comments 全ての記事を対象とした全てのコメント件数を取得する

その他

メソッド 説明
site.files メソッド単体では何も返さないが、filename フィルターで指定したファイル名のURLを取得する
site.manageable 現在ログインしているユーザはサイトを管理可能か否かを返す
site.attribute_fields サイトに登録されている拡張項目(Attributefieldオブジェクト）のRelation
site.collections サイトに登録されているコレクション(Collectionオブジェクト）のRelation
site.widgets サイトに登録されているウィジェット(Widgetsオブジェクト）のRelation
site.recaptcha_site_key サイトに登録されているreCAPTCHAのキーを取得する
site.link_option 外部リンクを出力する際に付与すべきHTML属性を文字列として取得する

Systemオブジェクト

基本情報

メソッド 説明
system.domain ドメイン名（ホスト名）を取得する
system.root_path システムのトップページのURLパスを取得する
system.url システムのトップページのURLを取得する

Tagオブジェクト

基本情報

メソッド 説明
tag.permalink タグのパーマリンクを取得する
tag.name タグ名を取得する
tag.description タグの説明を取得する
tag.url タグのURLパスを取得する
tag.num_articles タグが付いた記事数を取得する

画像関連

メソッド 説明
tag.image_small_url 横幅320pxにリサイズされたタグ画像のURLを取得する
tag.image_medium_url 横幅640pxにリサイズされたタグ画像のURLを取得する
tag.image_large_url 横幅1280pxにリサイズされたタグ画像のURLを取得する
tag.image_square_url 高さ・横幅150pxの正方形にリサイズされたタグ画像のURLを取得する
tag.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされたタグ画像のURLを取得する
tag.image_original_url オリジナルサイズのタグ画像のURLを取得する（使用時はresizeフィルタ必須）
tag.has_image タグに画像が設定されているか否かを返す

記事・コンテンツ関連

メソッド 説明
tag.articles 下記tag.recent_articlesに同じ（エイリアス）
tag.recent_articles タグ付けされた公開記事（Articleオブジェクト）のRelation
tag.all_articles タグ付けされた全ての記事（Articleオブジェクト）のRelation
tag.private_articles タグ付けされた全ての非公開記事（Articleオブジェクト）のRelation
tag.reserved_articles タグ付けされた全ての公開予定記事（Articleオブジェクト）のRelation
tag.all_pages タグ付けされた全てのページ（Articleオブジェクト）のRelation
tag.all_contents タグ付けされた全てのコンテンツ（Articleオブジェクト）のRelation

ランキング関連

メソッド 説明
tag.custom_period_popular_articles 指定期間内における記事の閲覧数をもとに、人気順で抽出された記事に紐づくタグ（Tagオブジェクト）のRelation
tag.daily_popular_articles 過去24時間における記事の閲覧数をもとに、人気順で抽出された記事に紐づくタグ（Tagオブジェクト）のRelation
tag.weekly_popular_articles 過去1週間における記事の閲覧数をもとに、人気順で抽出された記事に紐づくタグ（Tagオブジェクト）のRelation
tag.monthly_popular_articles 過去1ヶ月における記事の閲覧数をもとに、人気順で抽出された記事に紐づくタグ（Tagオブジェクト）のRelation

階層関連

メソッド 説明
tag.children カレントタグのひとつ下の階層に定義されているタグ（Tagオブジェクト）のRelation
tag.descendants カレントタグの下の全階層に定義されているタグ（Tagオブジェクト）のRelation
tag.ancestors カレントタグから見た全ての祖先タグのタグ（Tagオブジェクト）のRelation
tag.parent カレントタグの親タグのタグ（Tagオブジェクト）
tag.related_tags 関連するタグ（Tagオブジェクト）のRelation

Userオブジェクト

基本情報

メソッド 説明
user.name user.nicknameが空で無ければnickname、空であればemailの@マークより前をユーザー名として取得する
user.nickname ユーザーのニックネームを取得する
user.email ユーザーのメールアドレスを取得する
user.bio ユーザーの自己紹介文を取得する
user.url ユーザーページのURLを取得する
user.url1 ユーザーが登録した任意のサイトのURL1を取得する
user.url2 ユーザーが登録した任意のサイトのURL2を取得する
user.url3 ユーザーが登録した任意のサイトのURL3を取得する

画像関連

メソッド 説明
user.image_small_url 高さ・横幅48pxの正方形にリサイズされたユーザー画像のURLを取得する
user.image_medium_url 高さ・横幅256pxの正方形にリサイズされたユーザー画像のURLを取得する
user.image_original_url オリジナルサイズのユーザー画像のURLパスを取得する（使用時はresizeフィルタ必須）

記事・コンテンツ関連

メソッド 説明
user.articles ユーザーが作成した公開記事（Articleオブジェクト）のRelation
user.private_articles ユーザーが作成した非公開記事（Articleオブジェクト）のRelation
user.all_articles ユーザーが作成した全ての記事（Articleオブジェクト）のRelation
user.reserved_articles ユーザーが作成した公開予定記事（Articleオブジェクト）のRelation
user.all_pages ユーザーが作成した全てのページ（Articleオブジェクト）のRelation
user.all_contents ユーザーが作成した全てのコンテンツ（Articleオブジェクト）のRelation
user.favorite_articles ユーザーがお気に入りに入れている記事（Articleオブジェクト）のRelation

ユーザー関連

メソッド 説明
user.followers ユーザーがフォローしているユーザー（Userオブジェクト）のRelation
user.followees ユーザーをフォローしているユーザー（Userオブジェクト）のRelation
user.is_follower ユーザーをフォローしているか否かを返す
user.add_follower_path ユーザーをフォローするためのURLパスを取得する
user.remove_follower_path ユーザーをフォローから外すためのURLパスを取得する
user.followers_json_url ユーザーのフォロワー情報を持つJSONのURLパスを取得する

統計・カウント関連

メソッド 説明
user.num_views ユーザーの記事の閲覧数を取得する

権限・属性関連

メソッド 説明
user.kinds ユーザーに付けられたユーザー種別の配列を返す
user.curator_kinds user.kindsに同じ（エイリアス）

Widgetオブジェクト

基本情報

メソッド 説明
widget.type ウィジェットの種類を取得する
widget.status ウィジェットの公開ステータスを取得する
widget.is_published ウィジェットが公開されているか否かを返す
widget.code ウィジェットのテキストエリアに定義されたコードを取得する
widget.name ウィジェット名を取得する
widget.url ウィジェットの種類が画像の時、URLパスを取得する
widget.caption ウィジェットの注釈を取得する
widget.label ウィジェットの種類が画像の時、画像のタイトルを取得する

画像関連

メソッド 説明
widget.image_is_empty 画像が登録されているか否かを返す
widget.image_url 画像のURLを取得する
widget.image_small_url 横幅320pxにリサイズされた画像のURLを取得する
widget.image_medium_url 横幅640pxにリサイズされた画像のURLを取得する
widget.image_large_url 横幅1280pxにリサイズされた画像のURLを取得する
widget.image_square_url 高さ・横幅150pxの正方形にリサイズされた画像のURLを取得する
widget.image_thumbnail_url 高さ・横幅75pxの正方形にリサイズされた画像のURLを取得する
widget.image_original_url オリジナルサイズの画像のURLを取得する使用時はresizeフィルタ必須）
169 件