WordPress リファレンス
関数・フック・クラスを、説明・引数・使い方・注意点つきで日本語にまとめました。
分類から探す
全関数一覧 »アクション・フィルターの登録と実行、よく使うフック
すべて見る »タイトル・本文・日付などをテンプレートに出力
- get_the_content()
- get_the_excerpt()
- the_post_thumbnail()
- get_the_post_thumbnail()
- get_the_post_thumbnail_url()
- has_post_thumbnail()
サイトURL・テーマ・プラグインのパスやURL
- get_permalink()
- home_url()
- site_url()
- admin_url()
- get_template_directory_uri()
- get_stylesheet_directory_uri()
CSS・JavaScriptの読み込みと出力ポイント
- wp_enqueue_style()
- wp_register_style()
- wp_deregister_style()
- wp_dequeue_style()
- wp_enqueue_script()
- wp_register_script()
オプション・カスタムフィールド・トランジェント
すべて見る »カテゴリー・タグ・カスタム分類と投稿タイプ
- register_taxonomy()
- register_post_type()
- get_terms()
- get_the_terms()
- wp_get_post_terms()
- wp_set_post_terms()
画像・添付ファイル・アイキャッチ
- wp_get_attachment_url()
- wp_get_attachment_image_src()
- wp_get_attachment_image()
- wp_get_attachment_metadata()
- wp_generate_attachment_metadata()
- wp_update_attachment_metadata()
エスケープ・サニタイズ・nonce
すべて見る »外部API通信・Ajax・REST API・メール
- wp_remote_get()
- wp_remote_post()
- wp_remote_request()
- wp_remote_head()
- wp_remote_retrieve_body()
- wp_remote_retrieve_response_code()
データベース操作・キャッシュ・WP-Cron
すべて見る »管理画面のメニュー・設定画面・メタボックス
- add_menu_page()
- add_submenu_page()
- add_options_page()
- remove_menu_page()
- remove_submenu_page()
- register_setting()
テーマ設定・メニュー・ウィジェット・ブロック
- add_theme_support()
- remove_theme_support()
- current_theme_supports()
- register_nav_menus()
- wp_nav_menu()
- has_nav_menu()
WP_Query・WP_Post・WP_Error など主要クラス
すべて見る »Tips(制作のコツ)
一覧 »- パーマリンク変更後に404になる原因と対処|.htaccess と mod_rewriteパーマリンクを変更したら投稿ページが404になる原因を整理。リライトルールの再生成、.htaccess の標準記述、mod_rewrite と AllowOverride の確認、flush_rewrite_rules の注意点を解説します。
- WordPress 画面が真っ白になる原因とWP_DEBUGでの調べ方WordPress の画面が真っ白になったときの原因の切り分け手順を整理。WP_DEBUG と WP_DEBUG_LOG の設定、debug.log の読み方、メモリ不足やプラグイン・テーマの無効化、リカバリーモードまでを解説します。
- 「サイトに重大なエラーが発生しました」が出たときの切り分け手順WordPressで「このサイトで重大なエラーが発生しました」と表示されたときの原因調査を、デバッグログの出力、プラグイン全停止、テーマ切替、PHPバージョン確認の順で進める実践フローを解説します。
- AmazonJSが表示されない原因と解決方法WordPressでアフィリエイトをやっている人の中にはAmazonJSというプラグインを… 続きを読む: AmazonJSが表示されない原因と解決方法
- 商用サイトにマイナーなプラグインを導入すること起こり得る3つの深刻な被害Webデザインを仕事にしている人で使わない人は今や存在しないというぐらいに普及した『Wor… 続きを読む: 商用サイトにマイナーなプラグインを導入すること起こり得る3つの深刻な被害
- エクスポート・インポートの致命的バグ!サイトの安全なサーバー移転手順&おすすめレンタルサーバー紹介ありがたいことにここ1ヶ月くらい急激に当ブログのアクセス数が増加したので、転送量を確認した… 続きを読む: エクスポート・インポートの致命的バグ!サイトの安全なサーバー移転手順&おすすめレンタルサーバー紹介
- 独自テーマ・テンプレートを作成する場合はwp_headを忘れずに!今回は独自テーマやテンプレートを作成する際のとある注意点をご紹介します。 目次 オリジナル… 続きを読む: 独自テーマ・テンプレートを作成する場合はwp_headを忘れずに!
- アーカイブページで現在のカテゴリ・タグの情報を簡単に取得する方法目次 アーカイブページでカテゴリ・タグの情報を取得するのに毎回混乱してしまう…そんな問題を… 続きを読む: アーカイブページで現在のカテゴリ・タグの情報を簡単に取得する方法
- カテゴリ・タグを作成する際に気をつけるべきことWordPressを利用するにあたり、カテゴリやタグは欠かせないものですが気をつけておくべ… 続きを読む: カテゴリ・タグを作成する際に気をつけるべきこと
- プラグインを使わずカスタム投稿・分類の追加を超簡単に行う!WordPressには「投稿」や「固定ページ」の他にも投稿する方法があるのをご存知でしょう… 続きを読む: プラグインを使わずカスタム投稿・分類の追加を超簡単に行う!
- カスタムパーマリンクに日付を入れるとis_single()が正常に動作しないことがある原因と対策目次 まず始めに事前知識として条件分岐タグをついて説明MovableTypeからWordP… 続きを読む: カスタムパーマリンクに日付を入れるとis_single()が正常に動作しないことがある原因と対策
- カテゴリ「未分類」を削除する方法WordPressが世間に普及してからもう何年か経ち、私のブログも1、2年ほど前にMova… 続きを読む: カテゴリ「未分類」を削除する方法
WordPress関数とは|このサイトで分かること
WordPress関数は、投稿の取得、URLの生成、データの保存、画面への出力など、WordPressの機能をPHPから呼び出すための部品です。このサイトは、WordPress の関数・フック・テンプレートタグを目的別に整理した関数リファレンスで、テーマを自作したい人やプラグインを開発したい人が、引数、戻り値、注意点を日本語ですばやく調べられることを目指しています。
収録は、投稿の取得から条件分岐、フック、セキュリティ、データベース、REST APIまでの17カテゴリとTips、500本を超える記事です。入門者は最初の5本から、経験者は目的別のカテゴリから使ってください。なお、WordPressは更新が続くため、導入バージョンや非推奨の扱いは、実装の前に公式で最新を確認することをおすすめします。
はじめての人へ|最初に読む5本
テーマ制作の流れに沿って、画面に出す、取得する、安全にする、拡張する、の順で選びました。
- the_title() の使い方|説明・引数・注意点 … 最も基本のテンプレートタグ。出力する関数の感覚をつかみます。
- the_content() の使い方|説明・引数・注意点 … 本文の出力。ループの中で使い、フィルターを通る仕組みも学べます。
- get_posts() の使い方|説明・引数・注意点 … 投稿を条件つきで取得する定番。メインループ以外の一覧に使います。
- esc_html() の使い方|説明・引数・注意点 … 出力時のエスケープ。安全なコードの第一歩です。
- add_action() の使い方|説明・引数・注意点 … フックの入口。WordPressを拡張する仕組みを理解します。
テーマ別の入口
- リファレンス … 全17カテゴリの地図。迷ったらここから。
- テンプレートタグ … 画面に出力するタグ。the_post_thumbnail() の使い方|説明・引数・注意点 や the_category() の使い方|説明・引数・注意点 など。
- 条件分岐タグ … ページ種別で表示を変える。is_single() の使い方|説明・引数・注意点 と is_front_page() の使い方|説明・引数・注意点。
- 投稿の取得・操作 … ループとクエリ。get_post() の使い方|説明・引数・注意点 と wp_insert_post() の使い方|説明・引数・注意点。
- フック(アクション・フィルター) … 拡張の仕組み。add_filter() の使い方|説明・引数・注意点 と pre_get_posts フックの使い方|説明・引数・注意点。
- テーマ・メニュー・ショートコード・ブロック … テーマの機能。add_theme_support() の使い方|説明・引数・注意点 と add_shortcode() の使い方|説明・引数・注意点。
- スクリプト・スタイル読み込み … CSS・JSの読み込み。wp_enqueue_style() の使い方|説明・引数・注意点 と wp_enqueue_script() の使い方|説明・引数・注意点。
- URL・パス取得 … home_url() の使い方|説明・引数・注意点 と get_template_directory_uri() の使い方|説明・引数・注意点。
- エスケープ・サニタイズ・セキュリティ … sanitize_text_field() の使い方|説明・引数・注意点 と wp_verify_nonce() の使い方|説明・引数・注意点。
- オプション・メタデータ … get_option() の使い方|説明・引数・注意点 と get_post_meta() の使い方|説明・引数・注意点。
- タクソノミー・ターム … register_taxonomy() の使い方|説明・引数・注意点 と get_terms() の使い方|説明・引数・注意点。
- メディア・画像 … add_image_size() の使い方|説明・引数・注意点 と wp_get_attachment_image() の使い方|説明・引数・注意点。
- ユーザー・権限 … current_user_can() の使い方|説明・引数・注意点 と get_users() の使い方|説明・引数・注意点。
- データベース・キャッシュ … $wpdb->prepare() の使い方|説明・引数・注意点 と wp_schedule_event() の使い方|説明・引数・注意点。
- HTTP・REST・Ajax … register_rest_route() の使い方|説明・引数・注意点 と wp_remote_get() の使い方|説明・引数・注意点。
- 管理画面・設定 … add_menu_page() の使い方|説明・引数・注意点 と register_setting() の使い方|説明・引数・注意点。
- ユーティリティ(文字列・日時ほか) … wp_trim_words() の使い方|説明・引数・注意点 と absint() の使い方|説明・引数・注意点。
- クラス・オブジェクト … WP_Query クラスの使い方|説明・引数・注意点 と WP_Error クラスの使い方|説明・引数・注意点。
- Tips … つまずきやすい点の対処。「サイトに重大なエラーが発生しました」が出たときの切り分け手順。
最初に押さえたい基礎知識(リサーチ)
公式ドキュメントで確認できた内容です。仕様は変わることがあるため、最新は公式で確認してください。
- テンプレートタグには、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 のように、前提によって答えが変わる組み合わせがあります。当サイトでは、こうした違いが分かるように注意点を添えています。
また、当サイトは情報提供を目的とし、特定の環境での動作を保証するものではありません。本番サイトを変更する前には、バックアップを取り、テスト環境で確認することをおすすめします。