リファレンスとは|このカテゴリで分かること
リファレンスは、当サイトの中心にあたる関数辞典です。WordPress の関数一覧として、投稿の取得、テンプレートタグ、条件分岐、フック、エスケープ、オプション、タクソノミー、ユーザー、メディアなど、17の子カテゴリに分けて整理しています。テーマやプラグインを作る人が「やりたいことから関数を探し、引数と注意点を短時間で確認する」使い方を想定しています。このページは、どの子カテゴリから読めばよいかを決める地図です。
読む順番(おすすめの順路)
初めて読む人は、次の順で子カテゴリを巡ると、テーマ制作の流れに沿って学べます。
- テーマ・メニュー・ショートコード・ブロック … テーマの骨格となる読み込みやメニューから。例として wp_nav_menu() の使い方|説明・引数・注意点 や add_theme_support() の使い方|説明・引数・注意点 があります。
- テンプレートタグ … 画面に出力する基本のタグ。the_title() の使い方|説明・引数・注意点 と the_content() の使い方|説明・引数・注意点 が入口です。
- 条件分岐タグ … ページ種別で表示を変えます。is_front_page() の使い方|説明・引数・注意点 から読みます。
- 投稿の取得・操作 … ループとクエリ。get_posts() の使い方|説明・引数・注意点 が定番です。
- URL・パス取得 … URLやパスの取得。home_url() の使い方|説明・引数・注意点 が基本形です。
- スクリプト・スタイル読み込み … CSSやJSの読み込み。wp_enqueue_style() の使い方|説明・引数・注意点 と wp_enqueue_script() の使い方|説明・引数・注意点。
- フック(アクション・フィルター) … 拡張の仕組み。add_action() の使い方|説明・引数・注意点 と add_filter() の使い方|説明・引数・注意点。
- エスケープ・サニタイズ・セキュリティ … 出力・入力の安全対策。esc_html() の使い方|説明・引数・注意点 から。
- オプション・メタデータ … データ保存。get_option() の使い方|説明・引数・注意点 と get_post_meta() の使い方|説明・引数・注意点。
- タクソノミー・ターム … 分類の登録と取得。register_taxonomy() の使い方|説明・引数・注意点 を起点に。
- メディア・画像 … 画像サイズと添付。add_image_size() の使い方|説明・引数・注意点。
- ユーザー・権限 … 権限チェック。current_user_can() の使い方|説明・引数・注意点。
- データベース・キャッシュ … 直接クエリが必要なとき。$wpdb->prepare() の使い方|説明・引数・注意点。
- HTTP・REST・Ajax … 外部通信とAPI。register_rest_route() の使い方|説明・引数・注意点。
- 管理画面・設定 … 設定画面やメニュー追加。add_menu_page() の使い方|説明・引数・注意点。
- ユーティリティ(文字列・日時ほか) … 補助関数。
- クラス・オブジェクト … WP_Query クラスの使い方|説明・引数・注意点 など、クラス単位の解説です。
押さえておきたいポイント(リサーチ)
公式ドキュメントで確認できた内容です。最新は公式で確認してください。
- 公式のCode Referenceでは、関数、フック、クラスなどが一覧化されています。当サイトの解説も、引数、戻り値、導入バージョンは公式の記載をもとに確認しています。
- 例として、get_posts() は1.2.0、esc_html() は2.8.0で導入されました。関数ごとに導入バージョンや非推奨の有無が違うため、使う前に公式で確認する習慣が大切です。
- 公式のTheme Handbookは、ブロックテーマの構築を軸にした構成です。クラシックテーマの関数も既存サイトの保守では現役のため、当サイトでは両方の文脈を意識して整理しています。
| 目的 | 最初に見るカテゴリ |
|---|---|
| 画面に出す | テンプレートタグ |
| 条件で切り替える | 条件分岐タグ |
| データを保存する | オプション・メタデータ |
| 安全にする | エスケープ・サニタイズ・セキュリティ |
よくある疑問
Q. 関数の名前が分からないときはどうしますか。
A. やりたいことに近いカテゴリを開き、一覧から探します。投稿の取得なら 投稿の取得・操作 が入口です。
Q. 公式リファレンスとの違いは何ですか。
A. 当サイトは日本語で、使い方と注意点を短くまとめることを意識しています。細かな仕様は公式で確認してください。
Q. 初心者はどこから読めばよいですか。
A. the_title() の使い方|説明・引数・注意点、the_content() の使い方|説明・引数・注意点、get_posts() の使い方|説明・引数・注意点 の3本が出発点になると考えます。
編集部の見解
関数リファレンスは、通読するものではなく、必要なときに引く辞書だと考えます。ただし、全体の構成を一度つかんでおくと、探す時間がかなり短くなります。まずはテンプレートタグ、条件分岐、投稿の取得の3つで簡単なテーマを組み、次にセキュリティとデータ保存へ進む流れをおすすめします。関数は更新されることもあるため、実装前には公式の最新記載も確認してください。