WordPressのファイルは、多くの便利なPHP関数を定義します。 いくつかの機能は、テンプレートタグと呼ばれ、特にWordPressのテーマで使用するために定義されます。また、一部の機能は、主にプラグインを開発のために使用される、アクションとフィルタ(プラグインAPI)に関連します。残りの部分は、WordPressのコア機能を作成するために使用されます。
The files of WordPress define many useful PHP functions. Some of the functions, known as Template Tags, are defined especially for use in WordPress Themes. There are also some functions related to actions and filters (the Plugin API), which are therefore used primarily for developing Plugins. The rest are used to create the core WordPress functionality.
WordPressのコア機能の多くは、プラグインやテーマ開発者に便利です。そのため、この資料は、テンプレートタグを除くほとんどのコア機能の一覧です。ページ下部には、WordPressの機能についての情報を見つけるための他のリソースのセクション一覧です。この機能に加えて、WordPressのphpdocサイトは、バージョン2.6.1以降で全てのWordPressの機能を詳述します。
Many of the core WordPress functions are useful to Plugin and Theme developers. So, this article lists most of the core functions, excluding Template Tags. At the bottom of the page, there is a section listing other resources for finding information about WordPress functions. In addition to this information, the WordPress phpdoc site details all the WordPress functions by version since 2.6.1.
投稿、ページ、添付ファイル、ブックマーク関連のファンクションタグ
投稿、ページ、添付ファイル、ブックマーク関連に属するファンクションタグ一覧です。
投稿タグ
記事に関するファンクションタグです。
- get_post_format記事の投稿フォーマットを返します。WordPress.org
- get_delete_post_link文字列の値としてゴミ箱に投稿を移動するためのURLを返します。WordPress.org
- get_next_posts_link現在のページの記事のセットへのリンクを返します。WordPress.org
- wp_get_single_post投稿IDに基づいて、シングル投稿を取得します。WordPress.org
- wp_get_recent_posts最近の投稿を取得します。WordPress.org
- register_post_type投稿タイプを作成または変更します。WordPress.org
- get_previous_post現在の投稿に隣接している、前の投稿を取得します。WordPress.org
- get_edit_post_link投稿のための投稿編集リンクを取得します。WordPress.org
- get_post_type現在の投稿か、特定の投稿の投稿タイプを取得します。WordPress.org
- get_post_status投稿IDに基づいて投稿ステータスを取得します。WordPress.org
- get_post_mime_typeIDに基づいて添付ファイルのMIMEタイプを取得します。WordPress.org
- get_post_ancestors投稿IDに基づいて、投稿の親を取得します。WordPress.org
- get_post投稿IDを取得し、その投稿のためにデータベースのレコードを返します。WordPress.org
- get permalinkPHPで使用するために投稿のパーマリンクを返します。WordPress.org
- get_the_excerpt変数への代入のための投稿抜粋を返します。WordPress.org
- get_next_post現在の投稿に隣接する次のエントリーを取得します。WordPress.org
- get_extended<!--more-->で拡張されたエントリー情報を取得します。WordPress.org
- get_boundary_post公開日によって、最初または最後の投稿を取得します。WordPress.org
- get_children親記事によって可能な、添付ファイル、リビジョン、またはサブページを取得します。WordPress.org
- is_sticky"フロントページへこの投稿を固定する"チェックボックス現在の投稿にチェックされている場合にチェックします。WordPress.org
- get_adjacent_post隣接した記事リンクを取得します。WordPress.org
- get_posts複数のループを作成するためのシンプルな関数です。WordPress.org
- get_the_post_thumbnail投稿に添付された画像が(true)かない(false)かで、booleanの値を返します。WordPress.org
- is_single任意のシングル投稿が表示されている場合にチェックします。WordPress.org
- the_ID記事IDを出力します。WordPress.org
- the_permalink記事内のパーマリンクを出力します。WordPress.org
- the_date記事の日付を表示または返します。同じ日に公開されている場合、記事をセットにして表示します。WordPress.org
投稿挿入/削除タグ
記事の挿入/削除に関するファンクションタグです。
- wp_update_postデータベースに投稿(とページ)を更新します。WordPress.org
- wp_publish_post投稿ステータスを推移させることによって投稿を公開します。WordPress.org
- wp_insert_postデータベースに投稿(およびページ)を挿入します。WordPress.org
- wp_delete_post投稿、添付ファイル、またはページを削除します。WordPress.org
ページタグ
ページに関するファンクションタグです。
- page_uri_indexページURLの全てのページ及び添付ファイルを読み出します。WordPress.org
- get_pagesブログで定義されている全てのページのリストを取得するために使用します。WordPress.org
- get_page_uriページのURIを構築します。WordPress.org
- get_page_hierarchyフラットリフト内に親下の子とページを順序付けます。WordPress.org
- get_page_by_title投稿に対してタイトルを返します。WordPress.org
- get_page_childrenページIDに一致するページのリストから子ページを取得します。WordPress.org
- get_page_by_pathパスを取得するページを取得します。WordPress.org
- get_pageページIDまたはページオブジェクトを取得してページデータを指定します。WordPress.org
- get_ancestors指定されたオブジェクトの親を含む配列を返します。WordPress.org
- get_all_page_idsページIDのリストを取得します。WordPress.org
- get_page_link最初の引数として渡された場合、現在のページ(ループ内の場合)または任意のページIDのパーマリンクを取得します。WordPress.org
- is_pageページが表示されている場合にチェックします。WordPress.org
- wp_page_menuページのリンク一覧を表示します。WordPress.org
- wp_list_pagesページ機能を使って作成したWordPressページのリンク付きタイトル一覧を出力します。WordPress.org
添付ファイルタグ
添付ファイルに関するファンクションタグです。
- wp_get_attachment_link添付ファイルまたはページにHTMLのハイパーリンクを返します。WordPress.org
- wp_get_attachment_metadata添付ファイルIDに対して添付ファイルのメタフィールドを取得します。WordPress.org
- wp_get_attachment_image添付ファイルを表すHTMLの画像要素、それ以外の場合は空の文字列のいずれかを返します。WordPress.org
- wp_get_attachment_image_src添付ファイルがある場合は添付ファイルを表示する画像を返します。WordPress.org
- wp_attachment_is_image記事が画像である場合に決定します。WordPress.org
- wp_count_posts投稿タイプのそれぞれの投稿ステータスの数を出力します。WordPress.org
カスタム投稿タイプ
- remove_post_type_support取得する投稿タイプの為に特定の機能のサポートを削除します。WordPress.org
- add_post_type_support任意の投稿タイプの特定の機能のサポートを登録します。WordPress.org
- set_post_type投稿IDの投稿タイプを更新します。WordPress.org
- is_post_type_archiveクエリーが取得する投稿タイプのアーカイブページをチェックします。WordPress.org
- post_type_archive_title投稿タイプのアーカイブのタイトルを取得・表示します。WordPress.org
カテゴリー、タグ、タクソノミーのファンクションタグ
カテゴリー、タグ、タクソノミーに属するファンクションタグ一覧です。
カテゴリータグ
カテゴリーに関するファンクションタグです。
- get_ancestors指定されたオブジェクトの親を含む配列を返します。WordPress.org
- get_all_category_idsすべてのカテゴリIDを取得します。WordPress.org
- cat_is_ancestor_ofカテゴリーが別のカテゴリーの祖先の場合、この条件タグはチェックします。WordPress.org
- get_category_by_slugカテゴリースラッグによってカテゴリーオブジェクトを取得します。WordPress.org
- get_categoryカテゴリーIDまたはカテゴリーオブジェクトを指定したカテゴリーデータを取得します。WordPress.org
- get_category_by_pathカテゴリースラッグを含んでいるURLに基づいてカテゴリーを取得します。WordPress.org
- get_categoriesクエリパラメータに一致するカテゴリーオブジェクトの配列を返します。WordPress.org
- get_cat_IDカテゴリー名からカテゴリIDを取得します。WordPress.org
- get_cat_nameIDからカテゴリー名を返します。WordPress.org
- get_the_categoryWordPress.org
- get_category_parentsIDでソートされた、カテゴリーを含むカテゴリーの親のリストを返します。WordPress.org
タグ
タグに関するファンクションタグです。
- get_tagspost_tagタクソノミーに各タームにおけるオブジェクトの配列を返します。WordPress.org
- get_the_tags記事に割り当てられた各タグごとに1つのオブジェクトである、オブジェクトの配列を返します。WordPress.org
- get_tagタグIDやタグオブジェクトで投稿タグを取得します。WordPress.org
- get_tag_link指定されたタグIDの現在のリンクURLを返します。WordPress.org
- get_the_tag_list現在の投稿に関連するタグのHTML文字列を生成させます。WordPress.org
- the_tags記事が属すタグかタグへのリンクを表示します。WordPress.org
タクソノミータグ
タクソノミータグに関するファンクションタグです。
- wp_set_object_termsタームとタクソノミータイプ(タグ、カテゴリー、など)にオブジェクト(投稿、リンクなど)関するものです。WordPress.org
- wp_get_object_terms提供しているタクソノミーに、指定されたオブジェクトに関連しているタームを取得します。WordPress.org
- register_taxonomy_for_object_typeregister_taxonomy_for_object_typeは、既に登録されている投稿タイプに既に登録されているタクソノミーを追加します。WordPress.org
- register_taxonomyタクソノミーを追加または上書きします。WordPress.org
- is_taxonomy_hierarchicalWordPress.org
- get_term_linkタクソノミーのタームアーカイブのためにパーマリンクを返すか、タームが存在しない場合WP_Error オブジェクトを返します。WordPress.org
- wp_terms_checklistwp_category_checklist()のタクソノミーの独自バージョンです。WordPress.org
- wp_delete_termデータベースからタームを削除します。WordPress.org
- wp_insert_termデータベースに新しいタームを追加します。WordPress.org
- wp_update_term指定された引数に基づいてタームを更新します。WordPress.org
- get_term_childrenシングルの配列に全てのタームの子をマージします。WordPress.org
- get_the_terms記事に所属しているタクソノミーのタームを取得します。WordPress.org
- get_taxonomies登録されているタクソノミーオブジェクトのリストを取得します。WordPress.org
- taxonomy_existsこの条件タグは、引数としてタクソノミー名を渡すことでタクソノミー名が存在している場合にチェックします。WordPress.org
- term_exists取得したタームが存在するかどうかを確認し、タームIDを返します。WordPress.org
- get_termsタクソノミーのタームやタクソノミーのリストを取得します。WordPress.org
- get_termタームIDによってデータベースから全てのタームデータを取得します。WordPress.org
- get_the_term_list投稿と取得したタクソノミーで関連付けられているタクソノミーのタームのHTML文字列を返します。タームはそれぞれのタームをリストアップしたページにリンクします。WordPress.org
- get_term_byタームフィールドとデータで、データベースからすべてのタームデータを取得します。WordPress.org
ユーザー、投稿者のファンクションタグ
ユーザー、投稿者に属するファンクションタグ一覧です。
フィードタグ
フィードタグに関するファンクションタグです。
コメント、ピング、トラックバックタグ
コメント、ピング、トラックバックタグに関するファンクションタグです。
アクション、フィルター、プラグインのファンクションタグ
アクション、フィルター、プラグインに属するファンクションタグ一覧です。
テーマ関連のファンクションタグ
テーマ関連に属するファンクションタグ一覧です。
インクルードタグ
インクルードタグに属するファンクションタグ一覧です。
- comments_templateコメントテンプレートを読み込みます。WordPress.org
- get_search_form検索フォームを表示するsearchform.phpを呼び出します。WordPress.org
- get_sidebarsidebar.phpテンプレートファイルをインクルードします。WordPress.org
- get_headerheader.phpテンプレートファイルをインクルードします。WordPress.org
- get_footerfooter.phpテンプレートファイルをインクルードします。WordPress.org
テーマに関するその他のタグ
テーマに関するその他のタグに属するファンクションタグ一覧です。
- get_query_template拡張子を使用せずにファイルのパスを取得します。WordPress.org
- get_stylesheet_uri現在のテーマのスタイルシートのURIを取得します。WordPress.org
- switch_theme新しいテンプレートとスタイルシートの名前に現在のテーマを切り替えます。WordPress.org
- get_stylesheet_directory現在のテーマのスタイルシートディレクトリーパスを取得します。WordPress.org
- get_stylesheet現在のスタイルシートの名前を取得します。WordPress.org
- get_stylesheet_directory_uriWordPress.org
- register_sidebars複数のサイドバーを作成します。WordPress.org
- register_nav_menusカスタムメニューエディターに、複数のカスタムナビゲーションメニューを登録します。WordPress.org
- remove_theme_support特定のテーマの機能のサポートの登録を解除することをテーマが許可します。WordPress.org
- get_single_template現在または親のテンプレート内にシングルテンプレートのパスを取得します。WordPress.org
- get_paged_template現在または親のテンプレートでページテンプレートのパスを取得します。WordPress.org
- get_locale_stylesheet_uriローカライズされたスタイルシートのURIを取得します。WordPress.org
- get_header_textcolorカスタムヘッダーのテキスト色を取得します。WordPress.org
- get_home_template現在あるいは親テンプレート内のホームテンプレートのパスを取得します。WordPress.org
- get_date_template現在あるいは親テンプレート内の日付テンプレートのパスを取得します。WordPress.org
- get_header_imageカスタムヘッダーのヘッダー画像を取得します。WordPress.org
- get_comments_popup_templateWordPressのテーマ関連のファンクションタグ、get_comments_popup_templateのリファレンスです。WordPress.org
- get_404_template現在または親テンプレート内の404テンプレートのパスを取得します。WordPress.org
- get_current_theme現在のテーマ名を取得します。WordPress.org
- get_category_template現在または親テンプレート内にカテゴリテンプレートのパスを取得します。WordPress.org
- get_author_template現在あるいは親テンプレート内に、著者テンプレートのパスを取得します。WordPress.org
- get_attachment_template現在または親テンプレートに添付ファイルのテンプレートの取得パスを指定します。WordPress.org
- get_archive_template現在、あるいは親テンプレート内のアーカイブテンプレートのパスを取得します。WordPress.org
- dynamic_sidebarサイドバーのマークアップで出力された、ソート内でコールバックされた有効な各ウィジェットを呼び出します。1WordPress.org
- add_theme_support特定のテーマ機能のサポートを登録するためのテーマあるいはプラグインを許可します。WordPress.org
- current_theme_supportsテーマ機能のために与えられたテーマのサポートをチェックします。WordPress.org
- add_custom_image_headerヘッダー画像を表示するためにコールバックを追加します。WordPress.org
- add_custom_background背景画像を表示するためにコールバックを追加します。WordPress.org
- wp_nav_menuナビゲーションメニューを表示します。WordPress.org
- get_template_part(ヘッダー、サイドバー、フッター以外の)テンプレート部分をテンプレートを読み込みます。WordPress.org
- wp_page_menuページのリンク一覧を表示します。WordPress.org
- wp_get_archives月別・日別・週別・個別記事アーカイブへのリンクを出力します。WordPress.org
フォーマットタグ
フォーマットタグに属するファンクションタグ一覧です。
その他の関数
その他の関数に属するファンクションタグ一覧です
条件タグ
条件タグに関するファンクションタグです。
- is_post_type_archiveクエリーが取得する投稿タイプのアーカイブページをチェックします。WordPress.org
- is_attachment添付ファイルが表示されている場合にチェックします。WordPress.org
- is_sticky"フロントページへこの投稿を固定する"チェックボックス現在の投稿にチェックされている場合にチェックします。WordPress.org
- is_pageページが表示されている場合にチェックします。WordPress.org
- is_single任意のシングル投稿が表示されている場合にチェックします。WordPress.org
日時タグ
日時タグに属するファンクションタグ一覧です。
- get_day_linkPHPで使用するための特定の年、月、および1日まで毎日のアーカイブURLを返します。WordPress.org
- get_month_linkPHPで使用するために特定の年と1カ月まで毎月のアーカイブURLを返します。WordPress.org
- get_year_linkPHPで使用するために特定の年まで年一度のアーカイブURLを返します。WordPress.org
- get_calendarカレンダー(現在の月/年をデフォルトとする)を表示します。WordPress.org
ローカライゼーションタグ
ローカライゼーションタグに属するファンクションタグ一覧です。
- load_plugin_textdomainプラグインの翻訳された文字列を読み込みます。WordPress.org
その他のタグ
その他のタグに属するファンクションタグ一覧です。
- pre_get_postspre_get_postsアクションは、開発者が参照することによって、$queryオブジェクトへのアクセスを提供します。WordPress.org
- is_main_queryこの関数は、pre_get_postsにフックを有効にし、メインクエリーのみ修正します。WordPress.org
- wp_is_mobileユーザーがモバイルデバイスを使用して訪問しているかをチェックします。WordPress.org
- site_url適切なプロトコルである現在のサイト(ここでは、WordPressのコアファイル)のためにサイトURLを取得し、'https'がis_ssl()と'http'の場合、上書きします。WordPress.org
- home_urlhome_urlテンプレートタグは、現在のサイトのホームURLを取得します。WordPress.org
Geoタグ
Geoタグに関するファンクションタグ一覧です。
クラスタグ
クラスタグに関するファンクションタグ一覧です。