便利なショートコードの作成 #2/2

はじめに

概要

WordPressは、ホームページのURLを取得するなどの便利な機能を提供しています。しかし、これらの関数はデフォルトの設定では、エディタ内で直接使用することはできません。その問題を解決するためには、ショートコードを作成することで、これらの関数を利用可能にすることができます。ここでは、良く使う関数をショートコードに組み込むことや、ACFプラグインの便利なショートコードを紹介します。

※本記事の情報は執筆時点のものであり、閲覧時点では変更されている可能性があります。また、ご利用の環境によっては、本記事の内容が正常に動作しないことがあります。最新の情報については、公式サイトなどでご確認ください。

読者

便利なショートコードの作成は、最初にどこを理解するとよいですか？

木村

WordPress標準機能、プラグインの機能、テーマ側の処理を分けて考えると、どこを変更すべきか判断しやすくなります。

読者

実際に試すときは、手順だけでなく確認方法も知っておいた方がよいでしょうか？

木村

はい。この記事では、作業の目的から実装後の確認までを順番に整理します。自分の環境と照らし合わせながら読み進めてください。

ショートコードの作成

ショートコードの作成では、便利なショートコードの作成 #2/2を理解・実装するために必要な考え方と、作業時に確認したい点を整理します。最初に役割を把握してから、記事内の手順へ進みましょう。

よく使う関数

以下の関数をショートコードに組み込みます。 – the_title() – the_permalink() – the_excerpt() functionos.php

// タイトルを取得 [title]
function shortcode_ttl()
{
    return get_the_title();
}
add_shortcode('title', 'shortcode_ttl');

// パーマリンクの関数
function shortcode_permalink()
{
    return get_permalink();
}
add_shortcode('permalink', 'shortcode_permalink');

// 抜粋の関数
function shortcode_excerpt()
{
    return get_the_excerpt();
}
add_shortcode('excerpt', 'shortcode_excerpt');

ショートコードは設計上、値を返す（return）動作を行います。そのため、値を取得する際にはget関数を使用します。ショートコードの実装

これで、the_title()、the_excerpt()、the_permalink()といった関数が利用可能になったことが確認できます。もちろん、カスタムHTML内でも同様に使用することが可能です。

ショートコードの作成で押さえたいポイント

ショートコードの作成は、コードや設定だけを切り離して覚えるより、何を変えるための処理なのかを確認してから試すと理解しやすくなります。変更前の状態を控え、作業を一つずつ反映すると、問題が起きた場所も特定しやすくなります。

ACFプラグイン

ACFプラグインでは、便利なショートコードの作成 #2/2を理解・実装するために必要な考え方と、作業時に確認したい点を整理します。最初に役割を把握してから、記事内の手順へ進みましょう。

このACFプラグインは、カスタムフィールドの設置において頻繁に使用されるツールです。こちらのプラグインには事前にショートコードが準備されており、上記と同様にエディタ内で使用することが可能です。

[acf field=]

ACFで予め準備されているショートコードです。この中に設定したフィールド名を組み込むことで、カスタムフィールドと紐付けることができます。以下はその一例です。

functions.phpに記述する必要はなく、そのまま使えますので非常に便利です。

ACFプラグインで押さえたいポイント

ACFプラグインは、コードや設定だけを切り離して覚えるより、何を変えるための処理なのかを確認してから試すと理解しやすくなります。変更前の状態を控え、作業を一つずつ反映すると、問題が起きた場所も特定しやすくなります。

実装前に確認しておきたいこと

ここでは、便利なショートコードの作成を実際の制作へ取り入れる前に、準備しておきたい内容を整理します。先に作業範囲と確認方法を決めておくと、既存ページへの影響を抑えながら進められます。

作業の目的と変更範囲を決める

WordPress標準機能、プラグインの機能、テーマ側の処理を分けて考えると、どこを変更すべきか判断しやすくなります。サンプルをそのまま貼り付ける前に、どのページ、どの要素、どの利用者へ影響するのかを書き出してください。目的が明確であれば、必要以上にコードや設定を増やさずに済みます。

元の状態へ戻せるようにする

テーマや設定を変更するときは、対象ファイルや設定値のコピーを残します。複数の変更を一度に行わず、一つ反映するたびに表示と動作を確認すると、問題が起きても原因を切り分けやすくなります。

よくあるつまずきと確認方法

便利なショートコードの作成が期待どおりに動かない場合は、コードを追加し続ける前に、読み込み順、対象要素、設定値、キャッシュの順で確認します。小さな入力ミスや確認条件の違いが原因になることも少なくありません。

変更が反映されない場合

保存したファイルと表示中のページが対応しているかを確認し、キャッシュを消して再読み込みします。ブラウザーの開発者ツールやWordPressのエラーログを確認すると、読み込み失敗や記述ミスを見つけやすくなります。

公開前の最終確認

ローカル環境で変更し、未ログイン状態と管理者状態の両方で表示を確認します。PHPを変更した場合は、エラーログ、権限、エスケープ処理も合わせて確認してください。

実務で使うための進め方

便利なショートコードの作成を実務で使うときは、完成形を一度に作ろうとせず、最小のサンプルで動作を確かめてから既存ページへ組み込みます。確認できた処理を少しずつ広げると、記事の例と自分の環境に差があっても調整しやすくなります。

小さなサンプルから試す

新しいコードや設定は、関係する要素だけを置いた小さなページで試します。期待する結果、実際の結果、変更した箇所を短く記録すると、途中で別の方法を試した場合にも比較できます。動作を確認できた後で、既存の命名規則やファイル構成へ合わせて移してください。

既存の実装と重複していないか確認する

同じ目的のCSS、JavaScript、プラグイン設定がすでに存在すると、指定の上書きや処理の二重実行が起きることがあります。検索機能や開発者ツールを使い、同じクラス名、関数名、フック、設定項目がないかを先に確認しましょう。

保守しやすい状態を保つ

実装時に動くだけでなく、数か月後に見直せる状態にしておくことも大切です。採用した理由と確認方法を短く残しておけば、仕様変更や担当者の交代があっても安全に更新できます。

変更理由を短く記録する

コメントや作業メモには、コードの内容をそのまま説明するのではなく、なぜその処理が必要なのかを書きます。参照した公式情報や動作確認日も残すと、仕様が変わったときに見直す判断材料になります。秘密情報や個人の環境だけで使えるパスは記録へ含めません。

定期的に動作を見直す

ローカル環境で変更し、未ログイン状態と管理者状態の両方で表示を確認します。PHPを変更した場合は、エラーログ、権限、エスケープ処理も合わせて確認してください。ブラウザー、WordPress、プラグイン、外部サービスを更新した後にも同じ項目を確認すると、変更による影響を早めに見つけられます。

まとめ

ショートコードを活用すれば、開発の幅がアップする
固定ページやエディタ内でもWordpressの関数が使用できる
デフォルトの設定では、関数は使用できない
ACFプラグインには予め便利なショートコードが準備されている
ACFのショートコードはそのまま活用できる

便利なショートコードの作成 #2/2

目次