関数リファレンス

出典: WordPress Codex 日本語版

このページ「関数リファレンス」は未翻訳です。和訳や日本語情報を加筆してくださる協力者を求めています


WordPress のファイルには、便利な PHP 関数がたくさん定義されています。テンプレートタグとして知られる一部の関数は、特に WordPress テーマ用に定義されているものです。また、主にプラグインの開発に用いるアクションフック・フィルターフックに関する関数(プラグイン API)もあります。あとは WordPress のコア機能の形成に使われます。

コアの WordPress 関数の多くはプラグイン開発にも便利で、ものによってはテーマの開発にも使えるかもしれません。このページは、コア関数の大部分をカテゴリ別に一覧表にしたものです。関数名から別ページの詳細説明へリンクしているものもあります。各カテゴリは、関数が書かれているコアファイル(WordPress のディレクトリの wp-includes 内にあり)の一覧でもあります。

  • このリファレンスは WordPress バージョン 2.1 以降を対象としており、非推奨となった関数は含まれていません。WordPress バージョン 2.0.x 向けの不完全なページは Function Reference 2.0.x(英語)にあります。
  • テンプレートタグに掲載しているテンプレート用の関数(wp-includes/*_template.php にあるもの)は、以下の一覧には載せていません。
  • WordPress Functions History Tool(非公式ツール)は、ある関数が追加/削除された時点を知るのに役立ちます。

このページをもっと完璧なものにするために貢献してください!

あなたは以下のような貢献ができます:

  • サブページを作ったり、以下のリストにちょっとしたコメントを付け加えたり、ドキュメントのない関数にドキュメントを加えてください。もし関数用のサブページを作っていただけるならば、その関数に関する情報と使用例を含めてください。そして可能ならば、Template Tagsにあるような形式にしてください。
  • プラグイン開発者にとって有用でない、もしくは、不要と言われている関数があるならば、以下のリストからそれを削除してください。
  • 不適切なカテゴリーにある場合は、関数を適切なカテゴリーに移動してください。そして、誤字脱字を訂してください。一つの関数が複数のカテゴリーに含まれていても構いません。

WordPress への協力を読んで、貢献のための詳細な情報をご覧下さい!


カテゴリー別関数

投稿、ページ、添付ファイルの関数

これらの関数はformatting.phppost.phpに含まれています。テンプレートタグも見てください。

カテゴリー、タグ、タクソノミーの関数

WordPressの投稿・ページ・リンクなどを分類するカテゴリーとタグを含むtermsテーブルの関数。 カテゴリー関数はcategory.phpに含まれます。

  • get_all_category_ids
  • &get_categories($args='') /en
  • &get_category
  • get_category_by_path
  • get_category_by_slug
  • get_cat_ID($cat_name='General') - カテゴリー名からカテゴリーIDを取得
  • get_cat_name($cat_id) - カテゴリーIDからカテゴリー名を取得
  • cat_is_ancestor_of /en

タグ関数はcategory.phpに含まれます。

  • &get_tags
  • &get_tag

Term関数はtaxonomy.phpに含まれます。

  • is_taxonomy - タクソノミーが存在するかどうかチェックする
  • is_taxonomy_hierarchical - タクソノミーオブジェクトが階層を持つかをチェック
  • &get_term
  • get_term_by
  • get_term_children - タクソノミーの子を一つの配列にまとめる
  • &get_terms
  • is_term - タームが存在するかどうかチェックする
  • wp_get_object_terms - 与えられたタクソノミーのオブジェクトに紐づけられたタームを返す

その他のカテゴリー関数


ユーザと投稿者の関数

これらの関数はuser.php、pluggable.php、registration.phpに含まれています。テンプレートタグも見てください。

  • get_profile
  • get_usernumposts /en — 特定のユーザの投稿数を取得
  • delete_usermeta /en — 渡されたIDのユーザからusermetaの情報を削除
  • get_usermeta /en — 特定のユーザのメタデータを取得
  • update_usermeta /en — ユーザのメタデータを更新
  • set_current_user
  • wp_set_current_user
  • wp_get_current_user
  • get_currentuserinfo /en — 現在のユーザの情報を取得
  • get_userdata /en — 任意のユーザの情報を取得
  • get_userdatabylogin
  • wp_login
  • is_user_logged_in /en — ページを閲覧しているユーザがログイン済みかをチェック
  • auth_redirect /en - ユーザがログイン済みか否かをチェックし、ログインしていない場合はログインページへリダイレクト
  • username_exists /en — 渡されたユーザ名が存在するかをチェック
  • email_exists /en - 渡されたeメールアドレスが既存のユーザのものとして登録されているかチェック
  • validate_username
  • wp_insert_user
  • wp_update_user
  • wp_create_user /en — ユーザを生成し、userテーブルに挿入する

フィード関数

これらの関数はfunctions.phpfeed.phprss.phpに含まれています。

  • fetch_rss /en -- URLからRSSフィードを取得し、自動でキャッシュする(rss_functions.phpに含まれています)
  • wp_rss /en -- RSSフィードを取得し、番号なしリストとして表示する(rss_functions.phpに含まれています)
  • get_rss /en -- RSSフィードを取得して、リストとして表示します(オプションに依存します) (rss_functions.phpに含まれています)
  • do_feed
  • do_feed_rdf
  • do_feed_rss
  • do_feed_rss2
  • do_feed_atom
  • get_bloginfo_rss
  • bloginfo_rss
  • get_the_title_rss
  • the_title_rss
  • the_content_rss
  • the_excerpt_rss
  • permalink_single_rss
  • comment_link
  • get_comment_author_rss
  • comment_author_rss
  • comment_text_rss
  • comments_rss_link
  • comments_rss
  • get_author_rss_link
  • get_category_rss_link /en
  • get_category_feed_link /en(2.5以上)
  • get_the_category_rss
  • the_category_rss
  • rss_enclosure
  • get_search_feed_link (2.5以上)
  • get_search_comments_feed_link (2.5以上)

コメント、ピン、トラックバックの関数

これらの関数はcomment.phpfunctions.phppost.phpに含まれています。テンプレートタグも見てください。

  • check_comment
  • get_approved_comments /en
  • get_comment /en
  • get_lastcommentmodified
  • sanitize_comment_cookies
  • wp_allow_comment
  • wp_delete_comment
  • wp_get_comment_status
  • wp_get_current_commenter
  • wp_insert_comment
  • wp_filter_comment
  • wp_throttle_comment_flood
  • wp_new_comment
  • wp_set_comment_status
  • wp_update_comment
  • wp_update_comment_count
  • discover_pingback_server_uri
  • do_all_pings
  • do_trackbacks
  • generic_ping
  • pingback
  • privacy_ping_filter
  • trackback
  • weblog_ping
  • do_enclose
  • add_ping
  • get_enclosed
  • get_pung
  • get_to_ping
  • trackback_url_list

アクション、フィルター、プラグインの関数

これらの関数はplugin.phpに含まれています。プラグイン APIも見てください。

テーマに関わる関数

これらの関数はtheme.phpに含まれています。

  • get_stylesheet
  • get_stylesheet_directory
  • get_stylesheet_directory_uri
  • get_stylesheet_uri
  • get_locale_stylesheet_uri
  • get_template
  • get_template_directory
  • get_template_directory_uri
  • get_theme_data /en
  • get_themes
  • get_theme
  • get_current_theme
  • get_theme_root
  • get_theme_root_uri
  • get_query_template
  • get_404_template
  • get_archive_template
  • get_author_template
  • get_category_template
  • get_date_template
  • get_home_template
  • get_page_template
  • get_paged_template
  • get_search_template
  • get_single_template
  • get_attachment_template
  • get_comments_popup_template
  • load_template
  • locale_stylesheet
  • validate_current_theme
  • get_theme_mod
  • set_theme_mod
  • get_header_textcolor
  • get_header_image
  • header_image
  • add_custom_image_header


フォーマッティング関数

これらの関数はformatting.phpfunctions.phpkses.phpに含まれています。

  • wptexturize( $text ) /en
  • clean_pre( $text ) /en - brタグなしのテキストを返し、pタグを改行に変更する
  • wpautop( $pee, $br = 1 ) /en - 段落で書式付けされたHTMLテキストを返す
  • seems_utf8($Str) /en - 与えられた文字列がURF-8エンコードならばtrueを返す
  • wp_specialchars( $text, $quotes = 0 ) /en - PHP関数のhtmlspecialcharsと同じだが、HTML実体参照を二重にエンコードしない
  • utf8_uri_encode
  • remove_accents($string) /en - アクセント記号やウムラウトを取り除いた文字列を返す
  • sanitize_file_name
  • sanitize_user( $username, $strict = false ) /en - ユーザ名を機械が読み取りやすい形式に変える。Strictオプションを用いれば、アスキー文字のみになる
  • sanitize_title($title, $fallback_title = ) /en
  • sanitize_title_with_dashes($title) /en
  • convert_chars($content, $flag = 'obsolete') /en - 無効なユニコードの参照範囲を有効なものに変換する
  • funky_javascript_fix
  • balanceTags($text, $is_comment = 0) /en - 修正されたstack〔訳注:不明〕を用い、タグを調整する。管理画面で無効にできる。
  • force_balance_tags /en
  • format_to_edit
  • format_to_post
  • zeroise($number,$threshold) /en - 必要に応じて、数字にゼロ・リーディングを付け加える〔訳注:15から015へ〕
  • backslashit
  • trailingslashit
  • addslashes_gpc
  • stripslashes_deep
  • antispambot - eメールアドレスをスパム対応のものへ変換する
  • make_clickable
  • wp_rel_nofollow
  • convert_smilies
  • is_email
  • wp_iso_descrambler
  • popuplinks - リンクを別ウィンドウを用いたポップアップリンクに変更する
  • sanitize_email
  • ent2ncr($text) /en - 番号に応じたHTML実態参照を返す
  • wp_richedit_pre
  • clean_url
  • htmlentities2
  • js_escape
  • attribute_escape
  • wp_make_link_relative - 絶対パスのリンクを相対パスに変える
  • add_magic_quotes
  • wp_kses /en
  • wp_kses_hook
  • wp_kses_version
  • wp_kses_split
  • wp_kses_split2
  • wp_kses_attr
  • wp_kses_hair
  • wp_kses_check_attr_val
  • wp_kses_bad_protocol
  • wp_kses_no_null
  • wp_kses_strip_slashes
  • wp_kses_array_lc
  • wp_kses_js_entities
  • wp_kses_html_error
  • wp_kses_bad_protocol_once
  • wp_kses_bad_protocol_once2
  • wp_kses_normalize_entities
  • wp_kses_normalize_entities2
  • wp_kses_decode_entities
  • wp_filter_kses
  • wp_filter_post_kses
  • wp_filter_nohtml_kses

その他の関数

これらの関数はformatting.phpfunctions.phpbookmarks.phpcron.phpl10n.php, user.phppluggable.phpに含まれます。

日時に関わる関数

  • get_gmt_from_date - datetime文字列のタイムゾーンをローカルからGMTに変更
  • get_date_from_gmt - datetime文字列のタイムゾーンをGMTからローカルに変更
  • iso8601_timezone_to_offset
  • iso8601_to_datetime
  • human_time_diff
  • mysql2date
  • current_time /en
  • date_i18n
  • get_weekendstartend
  • get_lastpostdate
  • get_lastpostmodified
  • is_new_day

シリアライズ

  • maybe_serialize
  • maybe_unserialize
  • is_serialized
  • is_serialized_string

オプション

XMLRPC

  • xmlrpc_getposttitle
  • xmlrpc_getpostcategory
  • xmlrpc_removepostdata
  • user_pass_ok

ローカライズ

Translating WordPressも見てください。

  • get_locale
  • __
  • _e
  • _ngettext
  • load_textdomain
  • load_default_textdomain
  • load_plugin_textdomain
  • load_theme_textdomain

Cron (スケジューリング)

その他いろいろ

  • gzip_compression
  • make_url_footnote
  • wp_get_http_headers
  • add_query_arg
  • remove_query_arg
  • wp_remote_fopen
  • wp
  • status_header
  • nocache_headers
  • cache_javascript_headers
  • get_num_queries
  • bool_from_yn - "Y/N"変数を真偽値true/falseに変換
  • do_robots
  • is_blog_installed
  • wp_nonce_url
  • wp_nonce_field
  • wp_referer_field
  • wp_original_referer_field
  • wp_get_referer
  • wp_get_original_referer
  • wp_mkdir_p
  • wp_upload_dir
  • wp_upload_bits
  • wp_check_filetype
  • wp_explain_nonce
  • wp_nonce_ays
  • wp_die
  • get_bookmark
  • get_bookmarks
  • wp_mail /en
  • check_admin_referer
  • check_ajax_referer
  • wp_redirect /en
  • wp_get_cookie_login
  • wp_setcookie
  • wp_clearcookie
  • wp_notify_postauthor
  • wp_notify_moderator
  • wp_new_user_notification
  • wp_verify_nonce
  • wp_create_nonce
  • wp_salt
  • wp_hash

クラス

次のクラスはWordPressの開発者によって作られたもので、capabilities.phpclasses.phpclass-snoopy.phplocale.phpquery.phprewrite.phpscript-loader.phpwp-db.php内に含まれています:

  • WP - リクエスト全体を扱う
  • WP_Ajax_Response - AJAXを扱う
  • WP_Object_Cache /en (以前の形式:WP_Cache) - キャッシュ用オブジェクト(メソッドはwp_cache_add、wp_cache_close、wp_cache_delete、wp_cache_flush、wp_cache_get、wp_cache_init、wp_cache_replace、wp_cache_set)
  • WP_Error - エラーを扱う(メソッドはis_wp_error)
  • WP_Locale - ローカルの日時を扱う
  • WP_Query /en - 投稿を取得して、解析・操作するリクエスト(メソッドはget_query_var, query_posts, have_posts, in_the_loop, rewind_posts, the_post, wp_old_slug_redirect, setup_postdata,と条件タグ is_*)
  • WP_Rewrite /en - リライト・ルール(メソッドは add_rewrite_rule, add_rewrite_tag, add_feed, add_rewrite_endpoint, url_to_postid)
  • WP_Roles, WP_Role, WP_User - ユーザと権限(メソッドはmap_meta_cap, current_user_can, get_role, add_role, remove_role)
  • WP_Scripts - JavaScript読み込み(メソッドはwp_print_scripts, wp_register_script, wp_deregister_script, wp_enqueue_script /en)
  • Walker /en, Walker_Page, Walker_PageDropdown, Walker_Category, Walker_CategoryDropdown - ツリー構造でデータを表示
  • wpdb /en - データベース接続用インターフェース

以下のクラスは外部の開発者によって作られ、class-IXR.phpclass-pop3.phpclass-snoopy.phpgettext.phprss.phpstreams.php内に含まれています:

  • IXR - XML-RPCクラス(メソッドはIXR_Value, IXR_Message, IXR_Server, IXR_IntrospectionServer, IXR_Request, IXR_Client, IXR_ClientMulticall, IXR_Error, IXR_Date, IXR_Base64
  • Snoopy - HTTPクライアント
  • gettext_reader (PHP-gettextの一部) - 翻訳用クラス
  • RSSクラス (MagpieRSSとRSSCache) (メソッドはfetch_rss, is_info, is_success, is_redirect, is_error, is_client_error, is_server_error, parse_w3cdtf, wp_rss, get_rss)
  • POP3: SquirrelMailラッパー
  • StreamReader, StringReader, FileReader, CachedFileReader

Template:stub

原文・最新版: WordPress Codex » Function Reference最新版との差分

他の言語