WordPressのカスタマイズ方法やプラグインレビューを中心に、パソコン/動物/植物のことなどを紹介するホームページです

ショートコードで投稿リスト、RSSから取得したリストをシンプルに表示させるためのプラグイン「HA SIMPLE POST LIST」

公開日:2022(令和4)年2月14日/最終更新日:

WordPress Plugin



WordPressのブロックエディタに標準で備わっている投稿一覧やRSSから取得したリストを作成する機能。いろいろな切り口で一覧表示ができて便利だなぁと思うのですが、バージョン5.9の時点で、以下のことができないのが個人的に残念に感じていました。

  • 投稿一覧リストは「公開日順」のみで「更新日順」での抽出・並び替えができない
  • 投稿一覧リストで複数の投稿タイプを選択できない(いずれか1つになってしまう)
  • 投稿一覧リストで複数のカテゴリーを含む投稿の抽出ができない
  • 投稿一覧リスト・RSSリスト共、公開日(更新日)から一定期間内の記事に「NEW」や「Midified」などのマークを付けることができない
  • RSSリストで複数フィードURLからまとめて表示できない

そこで、独自ブロック...ではなく、レガシーを感じるショートコード?を使ってこれらを補完するプラグインを作成しました。文中のダウンロードページへのリンクより自由に使用いただけますので、よかったら使ってやってください。

あくまでも自身用に作成したプラグインであり、WordPress公式サイトで配布している訳でもなく、今後コア側の変更等に伴う対応等もいつまでできるか分かりませんので、それらを了承いただいた上で使用ください。

【HA SIMPLE POST LIST】プラグインの用途や機能

本プラグインは投稿や固定ページの編集画面へショートコードを挿入することで以下のリスト表示ができます。

  • 単独の同一サイト内の投稿リストをいろいろな切り口で表示
  • RSSフィードから取得した記事の一覧リストを表示

表示内容は「タイトル」「日付」のみのシンプルなものにしています

投稿リストで、投稿の公開日から現在までの日数が、パラメーターで指定した日数以内(デフォルトは7日)の場合、リスト先頭に「NEW」マークがつきます

RSSリストで、RSSフィード上の日付から現在までの日数が7日以内の場合は、リスト先頭に「NEW」マークがつきます

投稿の最終更新日からパラメーターで指定した日数以内(デフォルトは7日)の場合は、リスト先頭に「Modified」マークがつきます

本サイトの最新記事(最終更新日基準)一覧の表示サンプル

[ha_posts_list]

私が管理する別のサイトのRSS一覧の表示サンプル

[ha_feeds_list url=”https://momosiri.nagoya/feed” num=”5″ ndays=”30″]

アイキャッチ画像や説明文(抜粋)があったりなかったり..などオプションを追加することも可能ではありますが、固定ページの中で背景色(カバー)などを使いながらということを考え、上のような単純なリストにしています、

本ページを最後に編集したときの環境・バージョンなど

プラグインは製作者によって日々更新されていくため、この紹介記事が最新バージョンのものであるとは限りません。参考までに本記事の最終更新日時点におけるテスト環境、プラグインバージョン、プラグイン導入時の留意点などを記載しておきます。

プラグインを使用(試用)したテスト環境・公式ページなど

この紹介記事作成にあたって、試用(テスト)を行った環境、本記事で紹介するプラグインバージョン、現在配布されている最新バージョン、公式ページのリンク等は以下の通りです。

テストしたサーバー カラフルボックス
WordPressバージョン5.9
PHPバージョン7.4.27(8.0でも動作確認済)
テストしたテーマHABONE(本サイトでも使用しているオリジナルテーマ)
プラグインバージョン本記事で紹介するために試用したバージョン :1.3.1
公式サイトで配布されている最新バージョン :公式サイト上での配布なし
※バージョンが違うと、仕様が大きく変更となっている可能性があります
テストした日
※本記事の最終更新日であり、実際の試用日とは異なることがあります
公式サイト公式サイト上では配布していません(ダウンロードはこちらから)
公式サイト

本記事を参考にWordPressサイトへプラグインの導入を検討される方へ

WordPressは古くから無料で配布されているサイト作成ツール(CMS)で、随時改良が加えられており、さまざまなバージョンが存在します。

さらにWordPressを動かすためのプログラムであるPHP、サイトのデータを保存しておくためのデータベースについても様々なバージョンがあります。

そしてWordPress本体同様にプラグインについてもさまざまなバージョンが存在します。

本記事を参考にプラグインの導入をお考えの方は、以下に留意の上でインストールするようにしてください。

  • テスト環境での動作に基づいた紹介記事ですので、すべての環境で正常に動作するかどうかは不明です
    ※本記事の内容についてはページ内に記載しているプラグインバージョンのものになります。現在のバージョンと異なる場合、機能や日本語対応の状況などが異なる場合があります。
    ※また、テスト環境、テストしたプラグインバージョン等の表示が本文内にない場合、ページタイトル下にある最終更新日当時の情報となりますので、現在のバージョンでは全く違う機能となっているかも知れません。
  • プラグインに無料版と有料版(Pro版)がある場合、特に記載がなければ無料版の情報のみを紹介しています
  • このページでプラグインを使用する際に必要なショートコードやコードなどは、コピーして使用することができますが、環境によっては記号などが文字化けすることがあります。コピーしたのに動作しない場合は特に「”」「’」などの記号を入力し直してみてください。
  • プラグイン本体の動作不具合や質問などは公式サイトのフォーラムなどで行ってください(ここでは質問にお答えすることはできません)

【HA SIMPLE POST LIST】プラグインの設定画面や表示画面の日本語化と翻訳

【HA SIMPLE POST LIST】プラグインは設定画面がありませんので、特に翻訳の必要な箇所はありません。

【HA SIMPLE POST LIST】プラグインのインストールと設定方法

冒頭でも紹介した通り、このプラグインは私ひまあーとが自身の管理するサイトで使用するために作成した簡易プラグインですので、WordPress公式サイトでの配布は行っておりません。

プラグインのダウンロードは「HA SIMPLE POST LIST」のダウンロードページから一旦パソコンへダウンロードいただく必要があります。

ダウンロード後、サイト管理画面のプラグインの新規追加から、プラグインのアップロードを選択して、パソコンへダウンロードしたファイルを選択してインストールと有効化を行ってください。

基本的な設定方法と使用方法

サイト内の投稿リストの作り方

以下のショートコードを投稿や固定ページへ挿入します

[ha_posts_list offset="" type="" num="" order="" cat="" ndays="" ccss="" nmark="" modmark=""]

ショートコード内のパラメーターを変更することでいろいろな切り口でのリスト化ができます。

パラメーター概要デフォルト
offset抽出したデータのうち、いくつかをスキップする際に数字指定します0
type抽出する投稿タイプを指定します(post/投稿 page/固定ページ)
(複数指定する場合は、「,」コンマで区切ります)
(公開しているすべての投稿タイプを指定する場合は「any」を入力します)
post
num一覧に表示する投稿数を数字で指定します5
order抽出したものの並び順を指定します(ASC/昇順 DESC/降順)DESC
orderby抽出条件を指定します
ID/投稿ID title/タイトル date/公開日 modified/更新日など
※詳しい条件はこちらを参照ください
modified
cat抽出するカテゴリーのIDを指定します
(複数指定する場合は、「,」コンマで区切ります)
★カテゴリーIDに「-(マイナス)」を付けると特定のカテゴリーを除外できます
※本プラグインを有効にすると、「投稿」→「カテゴリー」の一覧にIDが表示されるようになり、指定がしやすくなるようにしています。
ndays「NEW」「MODIFIED」マークを出力する日数を指定します7
ccss全体を囲むdiv要素に独自のCSSクラスを追加できます
★複数追加する場合は半角スペースで区切ってください
nmark「NEW」マークの文字列を入力したものへ変更しますNEW
modmark 「Modified」マークの文字列を入力したものへ変更します Modified

パラメーター同士はすべてand条件、パラメーター内に「,」で区切って複数入力したものはすべてor条件になります

RSSフィードから取得したリストの作り方

[ha_feeds_list url="" ndays="" num="" nmark="" ccss=""]

ショートコード内のパラメーターを変更することでいろいろな切り口でのリスト化ができます。

パラメーター概要デフォルト
urlフィードURLを指定します
★複数フィードをまとめる時は「,」で区切ります
num表示件数を指定します
★表示件数は取得するフィードに含まれる件数が最大値になります
★複数をまとめる際は、デフォルト値×フィードの数がデフォルトになりますから、このパラメーターで総数を指定してください
5
ndays「NEW」マークを表示させる日数を指定します7
nmark「NEW」マークの文字を任意のものへ変更しますNEW
ccss全体を囲むdiv要素に独自のCSSクラスを追加できます
★複数追加する場合は半角スペースで区切ってください

RSSフィードリストは、WordPress標準のSimplepieを使用しており、取得後12時間キャッシュされますので、即時反映はされません。

表示件数は取得するRSSフィードの出力件数の合計が最大値となります。例えば単独URL指定でフィードの出力件数が3件の場合には、ショートコードを5件に設定しても、3件しか表示されません。

おまけ プラグインとして追加したくないときは

冒頭でも説明した通り、本プラグインはWordPress公式リポジトリに登録していない、いわゆる野良プラグインで、私自身のサイトで使おうとしたものを一応配布させていただいているゆるいプラグインです。

私自身はこのプラグインを使って実際にリスト出力する際に「こんな風にできたらいいな」というのを追加する可能性があると判断してプラグインとして実装しているのですが、中には完全にテーマの中に入れてしまう(プラグインとして追加したくない)という方も見えるでしょう。

このプラグインは、プログラム部分のファイルとCSSファイルが1つずつしかない単純なものですので、プラグインのファイルを開いて以下のようにすれば、テーマに内包することができます。

  • 「ha-simple-post-list.php」のコメントアウトから下を起点に、「スタイルを追加」のコメントアウト行手前までを、有効化しているテーマのfunctions.phpへ追加する
  • 「postlist.css」の内容をテーマのCSSまたは、テーマカスタマイザーの「追加CSS」へコピーする

一応プログラム自体には、関数の重複エラーが起こらないよう措置をしていますので、テーマへ内包した上で、プラグインを有効にされても問題ないようにはしています(その場合はテーマ側が優先されます)

このページおよびプラグインの更新履歴

更新日更新内容
2022年 2月14日本記事を公開しました
2022年 2月15日バージョン1.1へ更新。複数のフィードURLをまとめてリスト化できるようにしました
2022年 2月17日バージョン1.2へ更新。新着マークを出力する日数を指定できるようにしました
2022年 2月22日バージョン1.3へ更新
・一部パラメーターで空の場合にデフォルトがセットされない問題を解消
・投稿一覧で「NEW」「Modified」が両方出力される問題を解消
・パラメーターで「NEW」「Modified」を別の文字列へ変更できるようにしました
・パラメーターでCSSクラスを任意追加できるようにしました
2022年 3月 6日バージョン1.3.1へ更新
・CSSの軽微な修正を行いました
著:清水 由規, 著:清水 久美子, 著:鈴木 力哉, 著:西岡 由美, 読み手:星野 邦敏, 読み手:吉田 裕介
¥2,889 (2024/02/08 17:07時点 | Amazon調べ)