WordPress関数一覧
- 1.テンプレートタグ
- 2.データベース
- 3.投稿タイプ
- 4.分類
- 5.ユーザー
- 6.メディア
- 7.ナビゲーション
- 8.カスタマイズ
- 9.プラグインAPI
- 10.管理画面
- 11.セキュリティ
- 12.トランスレーション
- 13.REST API
1.テンプレートタグ
テンプレートタグは、WordPressテーマ内で使用される関数群で、投稿やページのタイトル、コンテンツ、メタ情報などを表示するために使用されます。これらの関数は、テーマファイル内で呼び出され、動的なコンテンツを生成するための基本的なビルディングブロックを提供します。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| get_header() | header.php ファイルを読み込む | get_header(); | $name - 読み込むファイル名 (任意) | なし | $nameを指定すると、header-$name.phpを読み込みます。 | こちらをクリック | |
| get_footer() | footer.php ファイルを読み込む | get_footer(); | $name - 読み込むファイル名 (任意) | なし | $nameを指定すると、footer-$name.phpを読み込みます。 | こちらをクリック | |
| get_sidebar() | sidebar.php ファイルを読み込む | get_sidebar(); | $name - 読み込むファイル名 (任意) | なし | $nameを指定すると、sidebar-$name.phpを読み込みます。 | こちらをクリック | |
| get_template_part() | テンプレートファイルの一部を読み込む | get_template_part('content', 'single'); | $slug, $name - 読み込むファイルの部分 (任意) | なし | 特定のテンプレートの一部を再利用する際に便利です。 | こちらをクリック | |
| the_title() | 投稿やページのタイトルを表示する | the_title(); | なし | なし | エスケープ処理はされません。必要に応じて手動で行ってください。 | こちらをクリック | |
| get_the_title() | 投稿やページのタイトルを取得する | echo get_the_title($post_id); | $post - 投稿ID (任意) | タイトル (文字列) | タイトルのHTMLやカスタム表示に使用できます。 | こちらをクリック | |
| the_content() | 投稿やページの内容を表示する | the_content(); | なし | なし | 投稿の全文を表示します。moreタグがある場合、それを考慮します。 | こちらをクリック | |
| get_the_content() | 投稿やページの内容を取得する | echo get_the_content(); | なし | 投稿の内容 (文字列) | 投稿の内容を変数に格納したり、カスタム表示に使用します。 | こちらをクリック | |
| the_excerpt() | 投稿の抜粋を表示する | the_excerpt(); | なし | なし | デフォルトでは、投稿の最初の55語が表示されます。 | こちらをクリック | |
| get_the_excerpt() | 投稿の抜粋を取得する | echo get_the_excerpt(); | なし | 抜粋 (文字列) | 抜粋のHTMLやカスタム表示に使用できます。 | こちらをクリック | |
| the_permalink() | 投稿やページのパーマリンクを表示する | the_permalink(); | なし | なし | タグを使ってリンクを生成する際に使われます。 | こちらをクリック | |
| get_permalink() | 投稿やページのパーマリンクを取得する | echo get_permalink($post_id); | $post, $leavename - 投稿ID、名前を含めるか (任意) | URL (文字列) | カスタムリンクや他の用途に使用できます。 | こちらをクリック | |
| the_post_thumbnail() | 投稿やページのサムネイル画像を表示する | the_post_thumbnail(); | $size - 画像サイズ (任意) | なし | サムネイルが設定されていない場合、何も表示されません。 | こちらをクリック | |
| get_the_post_thumbnail() | 投稿やページのサムネイル画像のHTMLを取得する | echo get_the_post_thumbnail($post_id, 'thumbnail'); | $post, $size, $attr - 投稿ID、画像サイズ、HTML属性 (任意) | サムネイル画像のHTML (文字列) | サムネイルのHTMLを取得し、カスタム表示に使用できます。 | こちらをクリック | |
| wp_nav_menu() | 登録されたナビゲーションメニューを表示する | wp_nav_menu(array('theme_location' => 'primary')); | $args - メニューの設定 (任意) | なし | カスタムメニューをテーマで表示するために使用されます。 | こちらをクリック | |
| the_category() | 現在の投稿のカテゴリーを表示する | the_category(); | なし | なし | カテゴリーのリンクが含まれます。 | こちらをクリック | |
| get_the_category() | 現在の投稿のカテゴリーを取得する | get_the_category($post_id); | $id - 投稿ID (任意) | カテゴリーオブジェクトの配列 | 投稿に関連するすべてのカテゴリーを配列で取得します。 | こちらをクリック | |
| the_tags() | 現在の投稿に関連付けられているタグを表示する | the_tags(); | なし | なし | タグのリンクが含まれます。 | こちらをクリック | |
| get_the_tag_list() | 現在の投稿に関連付けられているタグのリストを取得する | get_the_tag_list('', ', ', ''); | $before, $sep, $after - 前後のテキスト、区切り文字 (任意) | タグリスト (文字列) | タグリストのHTMLを取得します。 | こちらをクリック | |
| the_author() | 投稿の著者名を表示する | the_author(); | なし | なし | 著者リンクが必要な場合は、the_author_posts_link()を使用してください。 | こちらをクリック | |
| get_the_author() | 投稿の著者名を取得する | echo get_the_author(); | なし | 著者名 (文字列) | 著者名のカスタム表示に使用できます。 | こちらをクリック | |
| the_time() | 投稿の公開時間を表示する | the_time(); | なし | なし | 投稿の時間を表示します。フォーマットはWordPressの設定に依存します。 | こちらをクリック | |
| get_the_time() | 投稿の公開時間を取得する | echo get_the_time('H:i:s'); | $d, $post - フォーマット、投稿オブジェクト (任意) | 時間 (文字列) | 投稿の時間を変数に格納したり、カスタム表示に使用します。 | こちらをクリック | |
| the_date() | 投稿の公開日を表示する | the_date(); | なし | なし | 投稿の日付を表示します。 | こちらをクリック | |
| get_the_date() | 投稿の公開日を取得する | echo get_the_date('Y-m-d'); | $d, $post - フォーマット、投稿オブジェクト (任意) | 日付 (文字列) | 投稿の日付を変数に格納したり、カスタム表示に使用します。 | こちらをクリック | |
| comments_template() | コメントテンプレートを読み込んで表示する | comments_template(); | なし | なし | なし | こちらをクリック | |
| edit_post_link() | 投稿の編集リンクを表示する | edit_post_link('編集'); | $link, $before, $after - リンクの表示方法 (任意) | なし | ログイン中のユーザーにのみ表示されます。 | こちらをクリック | |
| get_edit_post_link() | 投稿の編集リンクを取得する | echo get_edit_post_link($post_id); | $id, $context, $object_id - 投稿ID、コンテキスト、オブジェクトID (任意) | リンク (文字列) | カスタムリンクに使用できます。 | こちらをクリック | |
| next_post_link() | 次の投稿へのリンクを表示する | next_post_link('%link'); | $format, $link, $in_same_term - リンクの表示方法 (任意) | なし | 次の投稿がない場合、リンクは表示されません。 | こちらをクリック | |
| get_next_post_link() | 次の投稿へのリンクを取得する | echo get_next_post_link('%link'); | $format, $link, $in_same_term - リンクの表示方法 (任意) | リンク (文字列) | カスタムリンクに使用できます。 | こちらをクリック | |
| previous_post_link() | 前の投稿へのリンクを表示する | previous_post_link('%link'); | $format, $link, $in_same_term - リンクの表示方法 (任意) | なし | 前の投稿がない場合、リンクは表示されません。 | こちらをクリック | |
| get_previous_post_link() | 前の投稿へのリンクを取得する | echo get_previous_post_link('%link'); | $format, $link, $in_same_term - リンクの表示方法 (任意) | リンク (文字列) | カスタムリンクに使用できます。 | こちらをクリック | |
| wp_list_pages() | 固定ページのリストを表示する | wp_list_pages(); | $args - リストの設定 (任意) | なし | デフォルトではリスト形式で表示されます。 | こちらをクリック | |
| wp_get_pages() | 固定ページのリストを取得する | wp_get_pages(array('sort_column' => 'menu_order')); | $args - リストの設定 (任意) | 固定ページオブジェクトの配列 | カスタムリストを生成する際に使用できます。 | こちらをクリック | |
| wp_list_categories() | カテゴリーのリストを表示する | wp_list_categories(); | $args - リストの設定 (任意) | なし | デフォルトではリスト形式で表示されます。 | こちらをクリック | |
| get_categories() | カテゴリーのリストを取得する | get_categories(array('orderby' => 'name')); | $args - リストの設定 (任意) | カテゴリーオブジェクトの配列 | カスタムリストを生成する際に使用できます。 | こちらをクリック | |
| wp_loginout() | ログインまたはログアウトリンクを表示する | wp_loginout(); | $redirect - リダイレクトURL (任意) | なし | ログイン状態に応じてリンクが変わります。 | こちらをクリック | |
| wp_register() | 登録リンクを表示する | wp_register(); | なし | なし | 非推奨: 登録リンクを表示しますが、ほとんどのサイトでは不要です。 | こちらをクリック | |
| bloginfo() | サイトに関する情報を表示する | bloginfo('name'); | $show - 表示する情報の種類 | なし | 情報はエスケープされないため、出力前にエスケープが推奨されます。 | こちらをクリック | |
| get_bloginfo() | サイトに関する情報を取得する | echo get_bloginfo('name'); | $show, $filter - 表示する情報、フィルタ (任意) | サイト情報 (文字列) | カスタムテンプレートで使用する場合に便利です。 | こちらをクリック | |
| body_class() | タグにクラスを追加する | body_class(); | $class - クラス名 (任意) | なし | 条件に応じた複数のクラスを自動的に追加します。 | こちらをクリック | |
| get_body_class() | タグに適用されるクラスを取得する | echo implode(' ', get_body_class()); | $class - クラス名 (任意) | クラスの配列 | クラスをカスタマイズする場合に使用します。 | こちらをクリック | |
| post_class() | やタグにクラスを追加する | post_class(); | $class - クラス名 (任意) | なし | 投稿タイプや状態に応じたクラスが追加されます。 | こちらをクリック | |
| get_post_class() | やタグに適用されるクラスを取得する | echo implode(' ', get_post_class()); | $class - クラス名 (任意) | クラスの配列 | クラスをカスタマイズする場合に使用します。 | こちらをクリック | |
| get_search_form() | 検索フォームを読み込んで表示する | get_search_form(); | $args - フォームの設定 (任意) | なし | カスタム検索フォームを使用する場合は、searchform.phpを作成します。 | こちらをクリック | |
| the_meta() | カスタムフィールドのメタデータを表示する | the_meta(); | なし | なし | 非推奨: 新しいプロジェクトでは、get_post_meta()とカスタムテンプレートタグの使用が推奨されます。 | こちらをクリック |
2.データベース
データベースカテゴリーの関数は、WordPressデータベースとの直接的な操作を行うために使用されます。投稿の取得、オプションの保存、メタデータの管理などが含まれ、データベースへのアクセスや操作をプログラム的に制御するための重要な機能を提供します。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| wpdb | WordPressのデータベースインターフェース | $wpdb->get_results($query); | なし | オブジェクト | $wpdbオブジェクトを通じてカスタムクエリを実行します。 | こちらをクリック | |
| get_posts() | 投稿のリストを取得する | get_posts(array('numberposts' => 10)); | $args - クエリの引数 (任意) | 配列 | 取得した投稿の配列を返します。 | こちらをクリック | |
| get_post() | 投稿オブジェクトを取得する | get_post(1); | $post, $output, $filter - 投稿のID、形式、フィルタ (任意) | 投稿オブジェクト | 投稿IDを指定して単一の投稿を取得します。 | こちらをクリック | |
| get_page() | 固定ページオブジェクトを取得する | get_page(2); | $page, $output, $filter - ページのID、形式、フィルタ (任意) | ページオブジェクト | 固定ページに特化した取得関数です。 | こちらをクリック | |
| get_term() | タームオブジェクトを取得する | get_term(3, 'category'); | $term, $taxonomy, $output, $filter - タームID、タクソノミー、形式、フィルタ (任意) | タームオブジェクト | タームIDを指定して取得します。 | こちらをクリック | |
| get_option() | オプションの値を取得する | get_option('blogname'); | $option, $default - オプション名、デフォルト値 (任意) | オプション値 (様々な形式) | データベースから直接オプションを取得します。 | こちらをクリック | |
| get_post_meta() | 投稿のメタデータを取得する | get_post_meta(1, 'key', true); | $post_id, $key, $single - 投稿ID、キー、単一値 (任意) | メタデータ (単一値または配列) | 単一のメタデータや配列を取得します。 | こちらをクリック | |
| update_post_meta() | 投稿のメタデータを更新する | update_post_meta(1, 'key', 'value'); | $post_id, $meta_key, $meta_value, $prev_value - 投稿ID、キー、値、前の値 (任意) | メタデータID (またはtrue) | 存在しない場合は新しいメタデータを追加します。 | こちらをクリック | |
| delete_post_meta() | 投稿のメタデータを削除する | delete_post_meta(1, 'key', 'value'); | $post_id, $meta_key, $meta_value - 投稿ID、キー、値 (任意) | true または false | 指定されたキーのメタデータを削除します。 | こちらをクリック | |
| add_post_meta() | 投稿のメタデータを追加する | add_post_meta(1, 'key', 'value', true); | $post_id, $meta_key, $meta_value, $unique - 投稿ID、キー、値、一意かどうか (任意) | true または false | 同じキーのメタデータが既に存在する場合は追加されません。 | こちらをクリック | |
| get_comments() | コメントのリストを取得する | get_comments(array('post_id' => 1)); | $args - クエリの引数 (任意) | コメントオブジェクトの配列 | 取得したコメントオブジェクトの配列を返します。 | こちらをクリック | |
| get_comment_meta() | コメントのメタデータを取得する | get_comment_meta(1, 'key', true); | $comment_id, $key, $single - コメントID、キー、単一値 (任意) | メタデータ (単一値または配列) | コメントのメタデータを取得します。 | こちらをクリック |
3.投稿タイプ
投稿タイプカテゴリーの関数は、カスタム投稿タイプの登録や管理、既存の投稿タイプの操作を行います。WordPressの柔軟なコンテンツ管理システムを活用して、特定のコンテンツタイプを作成し、それに関連するデータを管理するために使用されます。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| register_post_type() | カスタム投稿タイプを登録する | register_post_type('book', $args); | $post_type, $args - 投稿タイプ名、引数 (必須) | 投稿タイプオブジェクト | カスタム投稿タイプを作成し、テーマやプラグインで使用可能にします。 | こちらをクリック | |
| get_post_type() | 現在の投稿タイプを取得する | get_post_type(1); | $post - 投稿オブジェクトまたはID (任意) | 投稿タイプ (文字列) | 投稿の種類を識別するために使用します。 | こちらをクリック | |
| wp_insert_post() | 新しい投稿をデータベースに追加する | wp_insert_post($post); | $post, $wp_error - 投稿データ、エラー発生時にWP_Errorを返すか (任意) | 投稿ID (整数) | 投稿を追加し、成功するとその投稿のIDを返します。 | こちらをクリック | |
| wp_update_post() | 既存の投稿を更新する | wp_update_post($post); | $post, $wp_error - 投稿データ、エラー発生時にWP_Errorを返すか (任意) | 投稿ID (整数) | 投稿を更新し、成功するとその投稿のIDを返します。 | こちらをクリック | |
| wp_delete_post() | 投稿を削除する | wp_delete_post(1, true); | $postid, $force_delete - 投稿ID、完全削除するか (任意) | 投稿ID または false | 完全削除またはゴミ箱へ移動します。 | こちらをクリック | |
| get_post_type_object() | 投稿タイプオブジェクトを取得する | get_post_type_object('book'); | $post_type - 投稿タイプ名 (必須) | 投稿タイプオブジェクト | 特定の投稿タイプに関連する詳細情報を取得します。 | こちらをクリック | |
| get_post_type_archive_link() | 投稿タイプアーカイブのリンクを取得する | get_post_type_archive_link('book'); | $post_type - 投稿タイプ名 (必須) | URL (文字列) | 特定の投稿タイプのアーカイブページへのリンクを取得します。 | こちらをクリック |
4.分類
分類カテゴリーの関数は、カテゴリーやタグなどのタクソノミーを管理するために使用されます。カスタム分類の登録や、特定の投稿に関連付けられたタームの取得、タームリンクの生成など、コンテンツの分類と整理を助ける機能を提供します。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| register_taxonomy() | カスタム分類を登録する | register_taxonomy('genre', 'book', $args); | $taxonomy, $object_type, $args - 分類名、投稿タイプ、引数 (必須) | タクソノミーオブジェクト | カスタム分類を作成し、テーマやプラグインで使用可能にします。 | こちらをクリック | |
| get_terms() | タームのリストを取得する | get_terms('category'); | $taxonomy, $args - 分類名、引数 (任意) | タームオブジェクトの配列 | 指定された分類に属するタームの配列を返します。 | こちらをクリック | |
| wp_set_post_terms() | 投稿にタームを設定する | wp_set_post_terms(1, array(1, 2), 'category'); | $post_id, $terms, $taxonomy, $append - 投稿ID、タームIDまたは名前、分類名、追加するか (任意) | true または false | 投稿にタームを設定します。 | こちらをクリック | |
| get_term_link() | タームのリンクを取得する | get_term_link(1, 'category'); | $term, $taxonomy - タームIDまたはオブジェクト、分類名 (任意) | URL (文字列) | タームのアーカイブページへのリンクを取得します。 | こちらをクリック | |
| get_the_terms() | 投稿に関連付けられたタームを取得する | get_the_terms(1, 'category'); | $post, $taxonomy - 投稿オブジェクトまたはID、分類名 (任意) | タームオブジェクトの配列 | 投稿に関連付けられたタームを配列で返します。 | こちらをクリック | |
| the_terms() | 投稿に関連付けられたタームを表示する | the_terms(1, 'category', 'Categories: ', ', ', '.'); | $post_id, $taxonomy, $before, $sep, $after - 投稿ID、分類名、前後に追加する文字列 (任意) | なし | タームのリンクリストを表示します。 | こちらをクリック | |
| get_taxonomy() | タクソノミーオブジェクトを取得する | get_taxonomy('category'); | $taxonomy - タクソノミー名 (必須) | タクソノミーオブジェクト | 特定のタクソノミーに関連する詳細情報を取得します。 | こちらをクリック | |
| wp_get_post_terms() | 投稿に関連するタームを取得する | wp_get_post_terms(1, 'category'); | $post_id, $taxonomy, $args - 投稿ID、分類名、引数 (任意) | タームオブジェクトの配列 | 投稿に関連するタームの配列を返します。 | こちらをクリック | |
| wp_get_object_terms() | オブジェクトに関連するタームを取得する | wp_get_object_terms(array(1), array('category')); | $object_ids, $taxonomies, $args - オブジェクトID、分類名、引数 (任意) | タームオブジェクトの配列 | 複数のオブジェクトに関連するタームを配列で返します。 | こちらをクリック |
5.ユーザー
ユーザーカテゴリーの関数は、WordPressサイトのユーザー管理を行うための機能を提供します。ユーザーの登録、ログイン状況の確認、ユーザーメタデータの管理など、サイトのユーザーに関連する操作をプログラム的に制御するために使用されます。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| wp_create_user() | 新しいユーザーを作成する | wp_create_user('user', 'password', 'email@example.com'); | $username, $password, $email - ユーザー名、パスワード、メール (必須) | ユーザーID (整数) | 成功すると新しいユーザーのIDを返します。 | こちらをクリック | |
| get_user_by() | ユーザー情報を取得する | get_user_by('email', 'email@example.com'); | $field, $value - 検索フィールド、値 (必須) | ユーザーオブジェクト | 特定のフィールドに基づいてユーザーを取得します。 | こちらをクリック | |
| wp_insert_user() | ユーザー情報を追加または更新する | wp_insert_user($userdata); | $userdata - ユーザーデータ (必須) | ユーザーID (整数) または WP_Error | 成功するとユーザーのIDを返します。 | こちらをクリック | |
| wp_update_user() | 既存のユーザー情報を更新する | wp_update_user($userdata); | $userdata - ユーザーデータ (必須) | ユーザーID (整数) または WP_Error | 成功するとユーザーのIDを返します。 | こちらをクリック | |
| wp_delete_user() | ユーザーを削除する | wp_delete_user(1); | $id, $reassign - ユーザーID、再割り当て先 (任意) | true または false | 投稿の再割り当てを行わない場合、すべての投稿も削除されます。 | こちらをクリック | |
| get_current_user_id() | 現在のユーザーIDを取得する | get_current_user_id(); | なし | ユーザーID (整数) | ログインしていない場合、0を返します。 | こちらをクリック | |
| is_user_logged_in() | ユーザーがログインしているか確認する | is_user_logged_in(); | なし | true または false | ユーザーがログインしているかどうかを確認します。 | こちらをクリック | |
| wp_get_current_user() | 現在のユーザーオブジェクトを取得する | wp_get_current_user(); | なし | ユーザーオブジェクト | ユーザーがログインしていない場合、WP_Userオブジェクトが返されます。 | こちらをクリック | |
| get_user_meta() | ユーザーのメタデータを取得する | get_user_meta(1, 'key', true); | $user_id, $key, $single - ユーザーID、キー、単一値 (任意) | メタデータ (単一値または配列) | 特定のユーザーに関連するメタデータを取得します。 | こちらをクリック | |
| update_user_meta() | ユーザーのメタデータを更新する | update_user_meta(1, 'key', 'value'); | $user_id, $meta_key, $meta_value, $prev_value - ユーザーID、キー、値、前の値 (任意) | メタデータID (またはtrue) | 存在しない場合は新しいメタデータを追加します。 | こちらをクリック |
6.メディア
ディアカテゴリーの関数は、WordPressのメディアライブラリに関する操作を行います。画像やファイルのアップロード、添付ファイルのメタデータ管理、サムネイルの設定など、メディアファイルの管理と表示に関連する機能を提供します。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| wp_get_attachment_url() | 添付ファイルのURLを取得する | wp_get_attachment_url(1); | $post_id - 添付ファイルの投稿ID (必須) | URL (文字列) | メディアライブラリ内のファイルURLを取得します。 | こちらをクリック | |
| add_image_size() | カスタム画像サイズを追加する | add_image_size('custom-size', 800, 600, true); | $name, $width, $height, $crop - 名前、幅、高さ、クロップ (任意) | なし | テーマやプラグインで使用するカスタムサイズを追加します。 | こちらをクリック | |
| wp_handle_upload() | ファイルのアップロード処理を行う | wp_handle_upload($_FILES['upload'], array('test_form' => false)); | $file, $overrides - ファイル情報、オプション (任意) | 配列 (ファイル情報) | アップロードされたファイルの情報を処理します。 | こちらをクリック | |
| wp_insert_attachment() | 添付ファイルをデータベースに追加する | wp_insert_attachment($args, $file); | $args, $file - 添付ファイルのデータ、ファイルパス (必須) | 投稿ID (整数) | 添付ファイルを新しい投稿として追加します。 | こちらをクリック | |
| wp_generate_attachment_metadata() | 添付ファイルのメタデータを生成する | wp_generate_attachment_metadata(1, $file); | $post_id, $file - 添付ファイルの投稿ID、ファイルパス (必須) | 配列 (メタデータ) | メディアライブラリの画像サイズ情報を生成します。 | こちらをクリック | |
| wp_get_attachment_metadata() | 添付ファイルのメタデータを取得する | wp_get_attachment_metadata(1); | $post_id - 添付ファイルの投稿ID (必須) | 配列 (メタデータ) | 添付ファイルのメタデータを配列形式で取得します。 | こちらをクリック | |
| get_attached_file() | 添付ファイルのパスを取得する | get_attached_file(1); | $post_id - 添付ファイルの投稿ID (必須) | ファイルパス (文字列) | 添付ファイルのローカルパスを取得します。 | こちらをクリック | |
| wp_delete_attachment() | 添付ファイルを削除する | wp_delete_attachment(1, true); | $post_id, $force_delete - 添付ファイルの投稿ID、完全削除するか (任意) | true または false | 添付ファイルとその関連メタデータを削除します。 | こちらをクリック | |
| set_post_thumbnail() | 投稿にサムネイル画像を設定する | set_post_thumbnail(1, 1); | $post_id, $attachment_id - 投稿ID、添付ファイルID (必須) | true または false | 投稿に設定されたサムネイル画像を指定します。 | こちらをクリック | |
| get_post_thumbnail_id() | 投稿に設定されたサムネイル画像のIDを取得する | get_post_thumbnail_id(1); | $post_id - 投稿ID (任意) | 添付ファイルID (整数) | サムネイル画像が設定されていない場合はfalseを返します。 | こちらをクリック | |
| get_the_post_thumbnail_url() | 投稿サムネイルのURLを取得する | echo get_the_post_thumbnail_url( $post->ID, 'full' ); | $post (int | WP_Post, オプション): 取得したい投稿のIDまたは投稿オブジェクト。 $size (string | array, オプション): 取得する画像サイズ。デフォルトは thumbnail。 | 文字列 (string) | false: 投稿サムネイルのURL。サムネイルが設定されていない場合は false。 | サムネイルが設定されていない場合は false を返します。 | こちらをクリック |
7.ナビゲーション
ナビゲーションカテゴリーの関数は、WordPressサイトのメニューやナビゲーションを管理するための機能を提供します。カスタムメニューの登録、ナビゲーションメニューの表示、メニューアイテムの取得など、サイトのユーザーインターフェースを構築するために使用されます。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| wp_nav_menu() | 登録されたナビゲーションメニューを表示する | wp_nav_menu(array('theme_location' => 'primary')); | $args - メニューの設定 (任意) | なし | カスタムメニューをテーマで表示するために使用されます。 | こちらをクリック | |
| register_nav_menus() | カスタムメニューをテーマに登録する | register_nav_menus(array('primary' => 'Primary Menu')); | $locations, $description - メニューの場所、説明 (必須) | なし | テーマで使用するカスタムメニューの位置を定義します。 | こちらをクリック | |
| wp_get_nav_menu_items() | 指定されたナビゲーションメニューのアイテムを取得する | wp_get_nav_menu_items('primary'); | $menu, $args - メニュー名またはID、引数 (任意) | メニューアイテムの配列 | 特定のメニューの全アイテムを取得します。 | こちらをクリック | |
| wp_page_menu() | 固定ページのリストとしてメニューを表示する | wp_page_menu(); | $args - メニューの設定 (任意) | なし | 固定ページから生成されたメニューを表示します。 | こちらをクリック | |
| get_menu() | 指定されたメニューのオブジェクトを取得する | get_menu(2); | $menu_id - メニューID (必須) | メニューオブジェクト | メニューのオブジェクトデータを取得します。 | こちらをクリック | |
| get_nav_menu_locations() | カスタムメニューの位置を取得する | get_nav_menu_locations(); | なし | 位置とメニューIDの配列 | テーマで登録されたメニュー位置を取得します。 | こちらをクリック |
8.カスタマイズ
カスタマイズカテゴリーの関数は、テーマやプラグインのカスタマイズオプションを追加・管理するために使用されます。カスタム背景やヘッダーのサポート、ショートコードの追加、画像サイズの設定など、サイトの外観と機能を調整するための柔軟なツールを提供します。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| add_theme_support() | テーマに特定の機能を追加する | add_theme_support('post-thumbnails'); | $feature, $args - 機能名、引数 (任意) | なし | テーマにカスタム機能やサポートを追加します。 | こちらをクリック | |
| add_custom_background() | カスタム背景サポートをテーマに追加する | add_custom_background($args); | $args - 背景画像設定の引数 (任意) | なし | 非推奨: add_theme_support('custom-background') を使用してください。 | こちらをクリック | |
| add_custom_header() | カスタムヘッダーサポートをテーマに追加する | add_custom_header($args); | $args - ヘッダー画像設定の引数 (任意) | なし | 非推奨: add_theme_support('custom-header') を使用してください。 | こちらをクリック | |
| add_image_size() | カスタム画像サイズを追加する | add_image_size('custom-size', 800, 600, true); | $name, $width, $height, $crop - 名前、幅、高さ、クロップ (任意) | なし | テーマやプラグインで使用するカスタムサイズを追加します。 | こちらをクリック | |
| add_editor_style() | テーマエディタ用のスタイルシートを追加する | add_editor_style('editor-style.css'); | $stylesheet - スタイルシート名 (任意) | なし | テーマエディタにカスタムスタイルを適用します。 | こちらをクリック | |
| add_shortcode() | ショートコードを追加する | add_shortcode('my_shortcode', 'my_function'); | $tag, $func - ショートコード名、コールバック関数 (必須) | なし | ショートコードを追加し、コンテンツ内で使用可能にします。 | こちらをクリック | |
| do_shortcode() | コンテンツ内のショートコードを実行する | do_shortcode('[my_shortcode]'); | $content - コンテンツ (必須) | 実行結果 (文字列) | コンテンツ内に含まれるショートコードを実行します。 | こちらをクリック | |
| remove_shortcode() | ショートコードを削除する | remove_shortcode('my_shortcode'); | $tag - ショートコード名 (必須) | なし | 特定のショートコードを無効化します。 | こちらをクリック | |
| set_post_thumbnail_size() | 投稿サムネイルのサイズを設定する | set_post_thumbnail_size(150, 150, true); | $width, $height, $crop - 幅、高さ、クロップ (任意) | なし | デフォルトのサムネイルサイズを設定します。 | こちらをクリック |
9.プラグインAPI
プラグインAPIカテゴリーの関数は、WordPressのフックシステムを利用して、カスタムアクションやフィルターを追加・管理するために使用されます。テーマやプラグイン開発者が、WordPressの動作を拡張し、特定の機能を実行するための手段を提供します
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| add_action() | 指定したフックにアクションを追加する | add_action('init', 'my_function'); | $hook, $function_to_add, $priority, $accepted_args - フック名、関数名、優先度、引数数 (任意) | true または false | フックにカスタムアクションを追加します。 | こちらをクリック | |
| add_filter() | 指定したフックにフィルターを追加する | add_filter('the_content', 'my_filter'); | $hook, $function_to_add, $priority, $accepted_args - フック名、関数名、優先度、引数数 (任意) | true または false | フックにカスタムフィルターを追加します。 | こちらをクリック | |
| do_action() | 指定したフックを実行する | do_action('init'); | $hook, $arg - フック名、引数 (任意) | なし | フックに追加されたすべてのアクションを実行します。 | こちらをクリック | |
| apply_filters() | 指定したフィルターを実行する | apply_filters('the_content', $content); | $hook, $value, $var - フック名、値、引数 (任意) | フィルターを適用した値 | フックに追加されたすべてのフィルターを実行します。 | こちらをクリック | |
| remove_action() | 指定したフックからアクションを削除する | remove_action('init', 'my_function'); | $hook, $function_to_remove, $priority - フック名、関数名、優先度 (任意) | true または false | 特定のアクションをフックから削除します。 | こちらをクリック | |
| remove_filter() | 指定したフックからフィルターを削除する | remove_filter('the_content', 'my_filter'); | $hook, $function_to_remove, $priority - フック名、関数名、優先度 (任意) | true または false | 特定のフィルターをフックから削除します。 | こちらをクリック | |
| has_action() | 指定したフックにアクションが存在するか確認する | has_action('init', 'my_function'); | $hook, $function_to_check - フック名、関数名 (任意) | true または false | フックに指定したアクションが存在するか確認します。 | こちらをクリック | |
| has_filter() | 指定したフックにフィルターが存在するか確認する | has_filter('the_content', 'my_filter'); | $hook, $function_to_check - フック名、関数名 (任意) | true または false | フックに指定したフィルターが存在するか確認します。 | こちらをクリック | |
| do_action_ref_array() | 配列を渡して指定したフックを実行する | do_action_ref_array('init', array($arg1, $arg2)); | $hook, $args - フック名、引数の配列 (必須) | なし | フックに追加されたすべてのアクションを配列で実行します。 | こちらをクリック | |
| apply_filters_ref_array() | 配列を渡して指定したフィルターを実行する | apply_filters_ref_array('the_content', array($content)); | $hook, $args - フック名、引数の配列 (必須) | フィルターを適用した値 | フックに追加されたすべてのフィルターを配列で実行します。 | こちらをクリック |
10.管理画面
管理画面カテゴリーの関数は、WordPressの管理画面に新しいメニューやサブメニューを追加し、スクリプトやスタイルシートを管理画面にエンキューするために使用されます。管理画面のカスタマイズと拡張に関連するツールを提供します。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| add_menu_page() | 管理画面に新しいメニューを追加する | add_menu_page('Custom Page', 'Custom', 'manage_options', 'custom-page', 'my_custom_page'); | $page_title, $menu_title, $capability, $menu_slug, $function, $icon_url, $position - ページタイトル、メニュータイトル、権限、スラッグ、コールバック、アイコン、位置 (必須) | メニューのフック名 | カスタム管理メニューを追加します。 | こちらをクリック | |
| add_submenu_page() | 既存のメニューにサブメニューを追加する | add_submenu_page('tools.php', 'Sub Page', 'Sub', 'manage_options', 'sub-page', 'my_sub_page'); | $parent_slug, $page_title, $menu_title, $capability, $menu_slug, $function - 親スラッグ、ページタイトル、メニュータイトル、権限、スラッグ、コールバック (必須) | メニューのフック名 | カスタムサブメニューを追加します。 | こちらをクリック | |
| wp_enqueue_script() | スクリプトをキューに追加する | wp_enqueue_script('my_script', '/js/script.js', array('jquery'), '1.0', true); | $handle, $src, $deps, $ver, $in_footer - ハンドル、パス、依存関係、バージョン、フッターで読み込むか (任意) | なし | スクリプトを管理画面やフロントエンドで読み込みます。 | こちらをクリック | |
| wp_enqueue_style() | スタイルシートをキューに追加する | wp_enqueue_style('my_style', '/css/style.css', array(), '1.0', 'all'); | $handle, $src, $deps, $ver, $media - ハンドル、パス、依存関係、バージョン、メディア (任意) | なし | スタイルシートを管理画面やフロントエンドで読み込みます。 | こちらをクリック | |
| wp_register_script() | スクリプトを登録する | wp_register_script('my_script', '/js/script.js', array('jquery'), '1.0', true); | $handle, $src, $deps, $ver, $in_footer - ハンドル、パス、依存関係、バージョン、フッターで読み込むか (任意) | なし | スクリプトを後でキューに追加するために登録します。 | こちらをクリック | |
| wp_register_style() | スタイルシートを登録する | wp_register_style('my_style', '/css/style.css', array(), '1.0', 'all'); | $handle, $src, $deps, $ver, $media - ハンドル、パス、依存関係、バージョン、メディア (任意) | なし | スタイルシートを後でキューに追加するために登録します。 | こちらをクリック | |
| wp_redirect() | 指定されたURLにリダイレクトする | wp_redirect(home_url()); | $location, $status - リダイレクト先のURL、ステータスコード (必須) | なし | リダイレクト後は exit を実行する必要があります。 | こちらをクリック | |
| wp_die() | スクリプトの実行を停止し、メッセージを表示する | wp_die('An error occurred.', 'Error'); | $message, $title, $args - メッセージ、タイトル、オプション (任意) | なし | 実行を停止し、エラーメッセージを表示します。 | こちらをクリック | |
| get_admin_page_title() | 現在の管理ページのタイトルを取得する | get_admin_page_title(); | なし | タイトル (文字列) | 現在の管理ページのタイトルを返します。 | こちらをクリック | |
| remove_menu_page() | 指定したメニューを管理画面から削除する | remove_menu_page('tools.php'); | $menu_slug - メニュースラッグ (必須) | なし | メニューを完全に削除します。 | こちらをクリック | |
| remove_submenu_page() | 指定したサブメニューを管理画面から削除する | remove_submenu_page('tools.php', 'sub-page'); | $parent_slug, $menu_slug - 親スラッグ、メニュースラッグ (必須) | なし | サブメニューを完全に削除します。 | こちらをクリック |
11.セキュリティ
セキュリティカテゴリーの関数は、WordPressサイトの安全性を確保するための機能を提供します。nonceの生成と検証、ユーザー権限の確認、パスワードのハッシュ化と検証など、サイトのセキュリティを強化するために使用されます。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| wp_nonce_field() | フォームにnonceフィールドを追加する | wp_nonce_field('my_action'); | $action, $name, $referer, $echo - アクション名、フィールド名、リファラー、表示するか (任意) | フィールドHTML (文字列) | フォームのセキュリティチェックに使用します。 | こちらをクリック | |
| wp_verify_nonce() | nonceが有効かどうかを確認する | wp_verify_nonce($_POST['_wpnonce'], 'my_action'); | $nonce, $action - nonce値、アクション名 (必須) | true または false | nonceの有効期限はデフォルトで24時間です。 | こちらをクリック | |
| wp_create_nonce() | nonceを生成する | wp_create_nonce('my_action'); | $action - アクション名 (任意) | nonce (文字列) | セキュリティ目的で一意のnonceを生成します。 | こちらをクリック | |
| current_user_can() | 現在のユーザーが特定の権限を持っているか確認する | current_user_can('manage_options'); | $capability - 権限名 (必須) | true または false | 権限チェックを行い、操作の許可を判断します。 | こちらをクリック | |
| check_admin_referer() | nonceの有効性とリファラーを確認する | check_admin_referer('my_action'); | $action, $query_arg - アクション名、クエリ引数 (任意) | true または WP_Error | リクエストが管理画面からのものであるか確認します。 | こちらをクリック | |
| wp_hash_password() | パスワードをハッシュ化する | wp_hash_password('mypassword'); | $password - パスワード (必須) | ハッシュ化されたパスワード (文字列) | ハッシュ化には PASSWORD_BCRYPT を使用します。 | こちらをクリック | |
| wp_check_password() | パスワードがハッシュと一致するか確認する | wp_check_password('mypassword', $hash); | $password, $hash, $user_id - パスワード、ハッシュ、ユーザーID (必須) | true または false | ハッシュ化されたパスワードとの照合を行います。 | こちらをクリック | |
| wp_set_password() | ユーザーのパスワードを設定する | wp_set_password('newpassword', 1); | $password, $user_id - 新しいパスワード、ユーザーID (必須) | なし | パスワードを変更し、ユーザーのセッションをリセット。 | こちらをクリック | |
| wp_salt() | パスワードやセッションのハッシュ化に使用するソルト文字列を生成する | wp_salt('auth'); | $scheme - スキーム (任意) | ソルト文字列 | WordPressのセキュリティ強化のための追加ソルト。 | こちらをクリック | |
| is_user_logged_in() | ユーザーがログインしているか確認する | is_user_logged_in(); | なし | true または false | ログインしているかを簡単に確認します。 | こちらをクリック |
12.トランスレーション
トランスレーションカテゴリーの関数は、WordPressサイトの多言語対応を行うために使用されます。テキストの翻訳、複数形の管理、翻訳ファイルの読み込みなど、サイトの国際化とローカリゼーションをサポートするための機能を提供します。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| __() | テキストを翻訳して返す | __('Hello', 'my_domain'); | $text, $domain - テキスト、テキストドメイン (必須) | 翻訳されたテキスト (文字列) | 翻訳された文字列を返すだけで、出力はしません。 | こちらをクリック | |
| _e() | テキストを翻訳して出力する | _e('Hello', 'my_domain'); | $text, $domain - テキスト、テキストドメイン (必須) | なし | 翻訳された文字列を直接出力します。 | こちらをクリック | |
| _n() | 単数形と複数形のテキストを翻訳して返す | _n('One apple', '%s apples', $count, 'my_domain'); | $single, $plural, $number, $domain - 単数形、複数形、数、テキストドメイン (必須) | 翻訳されたテキスト (文字列) | 数に応じて単数形または複数形のテキストを返します。 | こちらをクリック | |
| _x() | コンテキストを指定してテキストを翻訳して返す | _x('Post', 'noun', 'my_domain'); | $text, $context, $domain - テキスト、コンテキスト、テキストドメイン (必須) | 翻訳されたテキスト (文字列) | 同じテキストに異なる翻訳が必要な場合に使用します。 | こちらをクリック | |
| esc_html__() | HTMLエスケープして翻訳されたテキストを返す | esc_html__('Hello', 'my_domain'); | $text, $domain - テキスト、テキストドメイン (必須) | エスケープされたテキスト (文字列) | HTMLコンテンツ向けにエスケープします。 | こちらをクリック | |
| esc_html_e() | HTMLエスケープして翻訳されたテキストを出力する | esc_html_e('Hello', 'my_domain'); | $text, $domain - テキスト、テキストドメイン (必須) | なし | HTMLコンテンツ向けにエスケープして直接出力します。 | こちらをクリック | |
| esc_attr__() | 属性値として安全な形式にエスケープして翻訳されたテキストを返す | esc_attr__('Hello', 'my_domain'); | $text, $domain - テキスト、テキストドメイン (必須) | エスケープされたテキスト (文字列) | HTML属性向けにエスケープします。 | こちらをクリック | |
| esc_attr_e() | 属性値として安全な形式にエスケープして翻訳されたテキストを出力する | esc_attr_e('Hello', 'my_domain'); | $text, $domain - テキスト、テキストドメイン (必須) | なし | HTML属性向けにエスケープして直接出力します。 | こちらをクリック | |
| load_textdomain() | テキストドメインの翻訳ファイルを読み込む | load_textdomain('my_domain', '/path/to/languages/my_domain-en_US.mo'); | $domain, $mofile - テキストドメイン、翻訳ファイルパス (必須) | true または false | 指定した翻訳ファイルを読み込みます。 | こちらをクリック | |
| get_locale() | 現在のロケールを取得する | get_locale(); | なし | ロケール (文字列) | サイトの言語設定に応じたロケールを返します。 | こちらをクリック |
13.REST API
REST APIカテゴリーの関数は、WordPressのRESTful APIを利用して、外部からデータを取得・操作するために使用されます。新しいAPIルートの登録、リクエストの実行、APIレスポンスの管理など、外部サービスとの連携を行うための強力なツールを提供します。
| 解説ページ | 関数名 | 説明 | 例 | 引数 | 返り値 | return_value | リファレンス |
|---|---|---|---|---|---|---|---|
| register_rest_route() | 新しいREST APIルートを登録する | register_rest_route('my_namespace/v1', '/my-route/', array('methods' => 'GET', 'callback' => 'my_function')); | $namespace, $route, $args - 名前空間、ルート、引数 (必須) | なし | REST APIルートを追加し、APIで利用可能にします。 | こちらをクリック | |
| wp_remote_get() | 指定したURLに対してGETリクエストを送信する | wp_remote_get('https://example.com/api/data'); | $url, $args - URL、引数 (任意) | レスポンス (配列) | GETリクエストを送信し、レスポンスを取得します。 | こちらをクリック | |
| wp_remote_post() | 指定したURLに対してPOSTリクエストを送信する | wp_remote_post('https://example.com/api/data', array('body' => array('key' => 'value'))); | $url, $args - URL、引数 (任意) | レスポンス (配列) | POSTリクエストを送信し、レスポンスを取得します。 | こちらをクリック | |
| rest_do_request() | REST APIリクエストを実行する | rest_do_request('/my_namespace/v1/my-route/'); | $request - リクエストオブジェクト (必須) | REST APIレスポンスオブジェクト | REST APIリクエストをプログラム的に実行します。 | こちらをクリック | |
| rest_url() | REST APIのURLを生成する | rest_url('/my_namespace/v1/my-route/'); | $path, $scheme - パス、スキーム (任意) | URL (文字列) | 指定されたパスに基づいてREST APIのURLを生成します。 | こちらをクリック | |
| rest_request() | REST APIリクエストを行う | rest_request('GET', rest_url('/my_namespace/v1/my-route/')); | $method, $url, $args - メソッド、URL、引数 (必須) | レスポンスオブジェクト | REST APIリクエストを直接実行し、レスポンスを取得します。 | こちらをクリック | |
| rest_ensure_response() | 配列またはオブジェクトをREST APIレスポンスに変換する | rest_ensure_response(array('key' => 'value')); | $response - レスポンスデータ (必須) | REST APIレスポンスオブジェクト | 配列やWP_ErrorなどのデータをREST APIレスポンス形式に変換します。 | こちらをクリック | |
| rest_get_server() | 現在のRESTサーバーインスタンスを取得する | rest_get_server(); | なし | WP_REST_Serverオブジェクト | 現在のREST APIサーバーオブジェクトを取得します。 | こちらをクリック |