サイト内検索と分類ページを作る

検索欄とカテゴリ別の記事一覧を用意します。検索対象の設定、公開状態、URLとのつながりを順番に確認します。

目次

記事が増えたら、探す入口を作る

検索は「コーヒー」という言葉で探す入口、カテゴリは「暮らし」というまとまりから探す入口です。管理画面に記事やカテゴリがあっても、読者向けページはテーマに用意する必要があります。

ここでは一覧と詳細で作った/practice/posts/に記事を表示する練習サイトを使います。対象はEmDash 1.4.0です。

読者向けの検索APIを直接使うときは、検索条件と結果の読み方で件数やページ送りの指定を確認できます。

検索欄を表示する

src/pages/practice/search.astroを作り、次を保存します。

---
import LiveSearch from "emdash/ui/search";
import LearningLayout from "../../layouts/LearningLayout.astro";
---

<LearningLayout title="記事を探す">
  <h1>記事を探す</h1>
  <LiveSearch placeholder="気になる言葉を入力" collections={["posts"]} />
</LearningLayout>

LiveSearchは、入力された言葉で検索し、結果を表示する部品です。collectionsは検索する入れ物を指定します。上の例は記事のpostsだけを対象にします。

ローカルURLの/practice/search/を開き、公開記事に含まれる言葉を入力します。検索結果のリンク先は、サイト側のコレクションURL設定とも関係します。この練習で追加した/practice/posts/へ自動的に変更されるとは限らないので、結果をクリックして実際の詳細ページまで確認してください。

検索結果に出るための条件

検索結果に出すには、コレクションの検索機能を有効にし、検索したい入力欄も対象に指定する必要があります。文字を保存しただけでは、すべての欄が検索対象になるわけではありません。

管理画面やコンテンツ定義で、コレクションのsupports.search、対象欄のsearchableを確認します。設定を直す場合は、項目変更の手順に沿って、既存の記事を残したまま変更します。

多言語サイトでは、通常は現在の言語に沿って検索します。別の言語の記事を探しているために結果が0件になる場合もあります。

カテゴリごとのページを作る

ここでは分類の識別名がcategoryで、postsにその分類を付けられる前提です。管理画面でカテゴリを作り、公開記事に付けておきます。

src/pages/practice/category/[slug].astroを作ります。

---
import { decodeSlug, getTerm, getEmDashCollection } from "emdash";
import LearningLayout from "../../../layouts/LearningLayout.astro";

const slug = decodeSlug(Astro.params.slug);
if (!slug) return new Response("カテゴリが見つかりません。", { status: 404 });

const category = await getTerm("category", slug, { includeCounts: false });
if (!category) return new Response("カテゴリが見つかりません。", { status: 404 });

const { entries: posts, error } = await getEmDashCollection("posts", {
  where: { category: category.slug },
  orderBy: { published_at: "desc" },
});
if (error) return new Response("記事を読み込めませんでした。", { status: 500 });
---

<LearningLayout title={category.name}>
  <h1>{category.name}</h1>
  {posts.length === 0 && <p>このカテゴリの公開記事は、まだありません。</p>}
  <ul>
    {posts.map((post) => (
      <li><a href={`/practice/posts/${post.id}/`}>{post.data.title}</a></li>
    ))}
  </ul>
</LearningLayout>

whereは、取得する記事の条件です。ここでは「このカテゴリが付いた記事」に絞っています。カテゴリの表示名とスラッグは別なので、URLには管理画面で確認したスラッグを使います。スラッグがlifeなら、練習ページは/practice/category/life/です。

公開記事がないカテゴリを隠すには

公開記事が0件のカテゴリは、テーマ側の処理でリンク一覧から隠せます。カテゴリ一覧を取得するときに公開記事数も受け取り、1件以上あるものだけ表示します。カテゴリ自体は先に登録しておいてかまいません。

親子カテゴリがある場合は、親に直接付いた記事の数なのか、子カテゴリを含む見せ方なのかも決めます。数の意味を確認せず、親を一律で消すと、記事のある子カテゴリへ進めなくなる場合があります。

完了の目安

検索で日本語のタイトルを探せること、結果0件で意味のわかる表示になること、分類ページから記事を開けることを確認します。下書きが読者向け結果に混ざっていないことも確かめてください。

検索結果が古い場合は、公開状態、検索対象の欄、検索の索引、配信のキャッシュを順に確認します。索引は検索のために整理した情報、キャッシュは再利用のために保存した結果です。まずはどこに古い情報が残っているかを調べます。

下書きと削除済みデータが検索へ残らないか

架空の固有の言葉を入れた記事で、下書き→公開→非公開→ごみ箱の順に試します。各状態で、ログアウトした検索結果と、検索の通信で返るデータを確認します。

外部の検索サービスへコピーする構成では、公開取り消しや削除がいつ反映されるかも決めます。リンク先で拒否できても、検索結果のタイトルや要約が見えてしまう場合があります。旧サイトもまとめて探したい場合は、横断検索のガイドで対象を整理します。

公式の参照元

関連ガイド

メニュー
ホーム公式ドキュメント (別タブで開く)

キーワードを入力すると、ガイドの内容から探せます。