WordPressのREST APIを利用して外部または内部サイトの情報を取得し、新着一覧を表示させるためのショートコードです。
本機能はバージョン4.1以降で利用できます
ショートコードの使用方法と表示サンプル
ショートコードは2種類あります。以下が使用するショートコードと表示サンプルです。
アイキャッチ画像付きの一覧 --小さい画像--
使用するショートコード
[ha-apipostlist-card home_url="" posttype="" num="" offset="" cache-second="0" orderby="modified" type=""]
表示サンプル
アイキャッチ画像付きの一覧 --大きい画像--
※ショートコードはカード表示と同じですが以下のようにして表示させています
- カラムブロックを使って左右に分けています
- 右のリストはoffsetパラメーターを使って繰り越し(ずらし)ています
- typeパラメーターで「large」を指定しています
表示サンプル
シンプルなリスト
使用するショートコード
[ha-apipostlist-simple home_url="" posttype="" num="" offset="" cache-second="0" orderby="modified"]
表示サンプル
ショートコード内で以下のパラメーターに値を指定することでカスタマイズできます。
パラメーター | 内容 | デフォルト |
---|---|---|
home_url | 取得するサイトのトップページURLを入力します | |
posttype | 特定の投稿タイプを指定します ※よく分からない場合は空欄にしておいてください | 投稿(posts) |
num | 表示数を指定します | 5(件) |
offset | 指定した分だけずらして取得します | 0(件) |
cache-second | 情報をキャッシュする時間を秒単位で指定します | 86400(秒)-1日 |
orderby | 取得する日付の基準を指定します 「date」または未入力の場合は公開日順(降順) 「modified」の場合は最終更新日順(降順) | 公開日(date) |
type | (カードのみ)カードの表示形式を選択できます 「small」または未入力の場合、小さいアイキャッチ画像のカード 「large」の場合、大きいアイキャッチ画像のカード | 小さい画像(small) |
ショートコードの仕様と注意事項
このショートコードはREST APIを使用した情報の取得を行います。参照先のサイト(情報を取得するサイト)でREST APIのエンドポイントへのアクセスが制限されている場合には表示できません。
サーバーへの負担軽減と、表示速度低下防止のため、取得したデータを一時的に保存(キャッシュ)するようにしています。
「cache-second」パラメーターを「0(ゼロ)」に設定することでキャッシュしないようにすることができ、ページ表示時に常に最新情報を取得することができます。
ショートコードパラメーターを変更してもキャッシュが効いている期間は変更が反映されないため、パラメーター変更時は、一度「cache-second」を「0(ゼロ)」にして保存し、再度設定を削除いただくことで反映されます
この機能は、あくまでも自身で所有または管理しているサイトの情報を取得して一覧表示させるために追加した機能ですので、他者が管理するサイトの情報を取得して表示する行為(いわゆるキュレーションやまとめ)は厳に慎んでいただけますようお願いします。
なお、REST API経由で情報を取得されることを制限したい場合には、本プラグインの「REST APIを無効にする」機能をご利用ください。
コメントを残す