WordPress 関数リファレンス|カテゴリ別の探し方

リファレンスとは|このカテゴリで分かること

リファレンスは、当サイトの中心にあたる関数辞典です。WordPress の関数一覧として、投稿の取得、テンプレートタグ、条件分岐、フック、エスケープ、オプション、タクソノミー、ユーザー、メディアなど、17の子カテゴリに分けて整理しています。テーマやプラグインを作る人が「やりたいことから関数を探し、引数と注意点を短時間で確認する」使い方を想定しています。このページは、どの子カテゴリから読めばよいかを決める地図です。

読む順番(おすすめの順路)

初めて読む人は、次の順で子カテゴリを巡ると、テーマ制作の流れに沿って学べます。

  1. テーマ・メニュー・ショートコード・ブロック … テーマの骨格となる読み込みやメニューから。例として wp_nav_menu() の使い方|説明・引数・注意点 や add_theme_support() の使い方|説明・引数・注意点 があります。
  2. テンプレートタグ … 画面に出力する基本のタグ。the_title() の使い方|説明・引数・注意点 と the_content() の使い方|説明・引数・注意点 が入口です。
  3. 条件分岐タグ … ページ種別で表示を変えます。is_front_page() の使い方|説明・引数・注意点 から読みます。
  4. 投稿の取得・操作 … ループとクエリ。get_posts() の使い方|説明・引数・注意点 が定番です。
  5. URL・パス取得 … URLやパスの取得。home_url() の使い方|説明・引数・注意点 が基本形です。
  6. スクリプト・スタイル読み込み … CSSやJSの読み込み。wp_enqueue_style() の使い方|説明・引数・注意点 と wp_enqueue_script() の使い方|説明・引数・注意点。
  7. フック(アクション・フィルター) … 拡張の仕組み。add_action() の使い方|説明・引数・注意点 と add_filter() の使い方|説明・引数・注意点。
  8. エスケープ・サニタイズ・セキュリティ … 出力・入力の安全対策。esc_html() の使い方|説明・引数・注意点 から。
  9. オプション・メタデータ … データ保存。get_option() の使い方|説明・引数・注意点 と get_post_meta() の使い方|説明・引数・注意点。
  10. タクソノミー・ターム … 分類の登録と取得。register_taxonomy() の使い方|説明・引数・注意点 を起点に。
  11. メディア・画像 … 画像サイズと添付。add_image_size() の使い方|説明・引数・注意点。
  12. ユーザー・権限 … 権限チェック。current_user_can() の使い方|説明・引数・注意点。
  13. データベース・キャッシュ … 直接クエリが必要なとき。$wpdb->prepare() の使い方|説明・引数・注意点。
  14. HTTP・REST・Ajax … 外部通信とAPI。register_rest_route() の使い方|説明・引数・注意点。
  15. 管理画面・設定 … 設定画面やメニュー追加。add_menu_page() の使い方|説明・引数・注意点。
  16. ユーティリティ(文字列・日時ほか) … 補助関数。
  17. クラス・オブジェクト … 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つで簡単なテーマを組み、次にセキュリティとデータ保存へ進む流れをおすすめします。関数は更新されることもあるため、実装前には公式の最新記載も確認してください。

出典(一次情報)

テーマ・メニュー・ショートコード・ブロック

テーマにナビゲーションメニューを追加する方法|register_nav_menus と表示手順

クラシックテーマにメニュー位置を追加し、wp_nav_menu で表示するまでの手順を解説。メニューが表示されない、固定ページ一覧が出てしまうときの原因(未割り当て・fallback_cb)も実行結果で確認します。
タクソノミー・ターム

カスタムタクソノミー アーカイブが404になる原因と対処

register_taxonomy で作ったタクソノミーのアーカイブURLが404になる原因を、リライトルールの更新漏れ・登録タイミング・rewrite 設定から整理。flush の正しい使い方も実行結果つきで解説します。
投稿の取得・操作

posts_per_page が効かない原因と pre_get_posts の正しい書き方

posts_per_page を指定しても件数が変わらない原因を、numberposts との違い、表示設定、pre_get_posts の書き換え、is_main_query の確認から整理。実測つきで直し方を示します。
メディア・画像

アイキャッチ画像をコードで設定する方法|取り込みと set_post_thumbnail

画像ファイルをメディアライブラリに取り込み、投稿のアイキャッチに設定するコードを解説。media_handle_sideload と media_handle_upload の違い、必要な require、失敗時の WP_Error を実行結果つきで整理します。
メディア・画像

add_image_size を追加しても反映されない原因と対処|サムネイル再生成の方法

add_image_size で画像サイズを追加したのに、既存の画像に反映されない原因は「生成はアップロード時だけ」だからです。再生成の方法、元画像より大きいサイズが作られない挙動を、実行結果で解説します。
エスケープ・サニタイズ・セキュリティ

wp_verify_nonce が false になる原因|nonce の作り方と検証

wp_verify_nonce が false を返す、「リンクの有効期限が切れました」と出る。そんなときの原因を、action名の不一致・ログイン状態・有効期限・キャッシュに分けて、実測結果つきで整理します。
HTTP・REST・Ajax

wp_remote_get が失敗する原因と対処|WP_Error の見方と安全な書き方

wp_remote_get が失敗したときの原因を、WP_Error・HTTPステータス・JSON不正の3層に分けて切り分けます。タイムアウトやSSL、wp_safe_remote_get のブロック挙動も、実行結果つきで解説します。
URL・パス取得

get_template_directory_uri と get_stylesheet_directory_uri の違い|子テーマでの使い分け

get_template_directory_uri は親テーマ、get_stylesheet_directory_uri は有効なテーマ(子テーマ)の URL を返します。get_theme_file_uri、home_url と site_url、plugins_url の違いも、実行結果で整理します。
エスケープ・サニタイズ・セキュリティ

esc_html と esc_attr の違い|使い分けと esc_url が必要な場面

esc_html と esc_attr は出力が同じに見えますが、使う場所が違います。HTMLの本文と属性値、URL、JavaScriptでの使い分けを、実際に実行した出力と一緒に整理します。
HTTP・REST・Ajax

admin-ajax.php が 0 や 400 を返す原因と対処|Ajax の書き方

admin-ajax.php が「0」や 400 を返す原因を、core の分岐に沿って整理します。action 名の不一致、wp_ajax_nopriv の登録漏れ、nonce の -1(403)の見分け方と、動く最小コードを検証付きで解説します。