WordPress リファレンス(関数・フック・クラス)

分類から探す

全関数一覧 »

Tips(制作のコツ)

一覧 »

WordPress関数とは|このサイトで分かること

WordPress関数は、投稿の取得、URLの生成、データの保存、画面への出力など、WordPressの機能をPHPから呼び出すための部品です。このサイトは、WordPress の関数・フック・テンプレートタグを目的別に整理した関数リファレンスで、テーマを自作したい人やプラグインを開発したい人が、引数、戻り値、注意点を日本語ですばやく調べられることを目指しています。

収録は、投稿の取得から条件分岐、フック、セキュリティ、データベース、REST APIまでの17カテゴリとTips、500本を超える記事です。入門者は最初の5本から、経験者は目的別のカテゴリから使ってください。なお、WordPressは更新が続くため、導入バージョンや非推奨の扱いは、実装の前に公式で最新を確認することをおすすめします。

はじめての人へ|最初に読む5本

テーマ制作の流れに沿って、画面に出す、取得する、安全にする、拡張する、の順で選びました。

  1. the_title() の使い方|説明・引数・注意点 … 最も基本のテンプレートタグ。出力する関数の感覚をつかみます。
  2. the_content() の使い方|説明・引数・注意点 … 本文の出力。ループの中で使い、フィルターを通る仕組みも学べます。
  3. get_posts() の使い方|説明・引数・注意点 … 投稿を条件つきで取得する定番。メインループ以外の一覧に使います。
  4. esc_html() の使い方|説明・引数・注意点 … 出力時のエスケープ。安全なコードの第一歩です。
  5. add_action() の使い方|説明・引数・注意点 … フックの入口。WordPressを拡張する仕組みを理解します。

テーマ別の入口

最初に押さえたい基礎知識(リサーチ)

公式ドキュメントで確認できた内容です。仕様は変わることがあるため、最新は公式で確認してください。

  • テンプレートタグには、the_ で始まる出力型と、get_the_ で始まる取得型の傾向があります。the_content() は内部で get_the_content() を呼び、the_content フィルターを適用します。
  • 出力のエスケープは、出力の直前にコンテキストに合った関数で行う「遅延エスケープ」が推奨されています。HTML内は esc_html()、属性は esc_attr()、URLは esc_url() が基本です。
  • nonce は主にCSRF対策で、既定の有効期間は24時間(実際は12〜24時間の幅)です。認証・認可の代わりにはならず、権限確認には current_user_can() を併用します。
  • デバッグには WP_DEBUG と WP_DEBUG_LOG が使えますが、公式はライブサイトでの使用を推奨していません。

よくある質問

Q. WordPressの関数はどこで調べればよいですか。 A. 一次情報は公式のCode Referenceです。当サイトでは日本語で使い方と注意点を整理しているので、まず リファレンス から探してください。

Q. WordPressでテーマを自作するには何から始めますか。 A. 出力、取得、判定の3種類から始めるのが近道です。the_title() の使い方|説明・引数・注意点、get_posts() の使い方|説明・引数・注意点、is_single() の使い方|説明・引数・注意点 が入口になります。

Q. フックとは何ですか。 A. WordPressの処理の途中に、自分のコードを差し込む仕組みです。アクションとフィルターがあり、add_action() の使い方|説明・引数・注意点 と add_filter() の使い方|説明・引数・注意点 が基本です。

Q. エラーで画面が真っ白になったらどうしますか。 A. 開発環境でログを確認しながら原因を切り分けます。手順は 「サイトに重大なエラーが発生しました」が出たときの切り分け手順 を参照してください。

編集部の見解|このサイトの使い方

関数リファレンスは、通読するより「困ったときに引く」道具だと考えます。ただ、最初の5本とカテゴリの地図だけは先に目を通しておくと、探す時間がぐっと減ると考えます。学び方としては、出力、取得、判定でテーマを組み、そのあとにセキュリティとデータ保存へ進む順番がおすすめです。

つまずきやすいのは、似た名前の関数の使い分けです。home_url と site_url、is_home と is_front_page、get_template_directory_uri と get_stylesheet_directory_uri のように、前提によって答えが変わる組み合わせがあります。当サイトでは、こうした違いが分かるように注意点を添えています。

また、当サイトは情報提供を目的とし、特定の環境での動作を保証するものではありません。本番サイトを変更する前には、バックアップを取り、テスト環境で確認することをおすすめします。

出典(一次情報)

タイトルとURLをコピーしました