wp的所有函数

zh-cn:函数参考

Languages: English • 日本語 • ქართული • Português do Brasil • Русский • Türkçe • 中文(简体) • (Add your language)

WordPress 中定义了许多有用的 PHP 函数。这些函数中众所周知的 Template Tags, 是为 WordPress 主题特别准备的。还有些函数与 动作(actions) 和过滤器 (filters)(见 Plugin API)有关，这些函数也因此主要用在插件开发之中。其他的函数则应用在 WordPress 核心功能上。
许多核心函数对插件和主题开发者很有用。所以，本文列举了多数核心函数，包括模板标签(Template Tags)。文章页尾则列举了一些关于 WordPress 函数的资源。本文的完全版 WordPress phpdoc site 中，描述了从 2.6.1 以来的所有 WordPress 函数。
注意: 本参考适用于 2.1 及更高版本。并没有包含不被建议使用的函数。 Function Reference 2.0.x 是一个不完全的 2.0.x 的参考。

你可以帮助完成本页！
你可以：

• 给没有文档的函数添加文档。创建子页面或者至少在下面的列表中添加简短的注释。如果你创建了一个子页面，请包含该函数的使用示例，如果可能，在zh-cn:模板标签添加这些例子。
• 根据类别，列出更多的函数。
• 纠正错误。比如把函数移动到更好更合适的分类下，或者修正排序。注意：一个函数可以出现在多个分类下。

看看 Contributing to WordPress，可以找到更多做出贡献的方法。

函数分类

文章，页面，附件，书签 文章 get_post get_post_mime_type get_post_status get_post_type get_posts get_children get_extended wp_get_recent_posts wp_get_single_post is_single is_sticky is_post 文章插入/移除l wp_delete_post wp_insert_post wp_update_post wp_publish_post 页面 is_page get_all_page_ids get_page get_page_by_path get_page_by_title get_page_children get_page_hierarchy get_page_uri get_pages page_uri_index wp_list_pages 自定义域 (文章信息 postmeta) add_post_meta delete_post_meta update_post_meta get_post_meta get_post_custom get_post_custom_keys get_post_custom_values 附件 is_attachment get_attached_file update_attached_file is_local_attachment wp_insert_attachment wp_delete_attachment wp_get_attachment_image wp_get_attachment_image_src wp_get_attachment_metadata wp_update_attachment_metadata wp_get_attachment_url wp_get_attachment_thumb_file wp_get_attachment_thumb_url wp_attachment_is_image wp_mime_type_icon wp_check_for_changed_slugs wp_count_posts 书签(链接) wp_list_bookmarks get_bookmark get_bookmarks 其他 wp_trim_excerpt add_meta_box wp_get_post_categories wp_set_post_categories get_the_ID get_the_content get_the_author	分类，标签，分类法 分类 is_category in_category cat_is_ancestor_of get_category_parents get_all_category_ids get_categories get_the_category get_category get_category_by_path get_category_by_slug get_cat_ID get_cat_name get_category_link 分类创建 wp_create_category wp_insert_category 标签 is_tag get_tag get_tags get_the_tags get_the_tag_list get_tag_link 分类法(Taxonomy) is_taxonomy is_taxonomy_hierarchical register_taxonomy is_term get_term get_term_by get_term_children get_terms wp_get_object_terms wp_insert_term term_exists
用户和作者 用户和作者 get_profile get_usernumposts set_current_user wp_set_current_user wp_get_current_user get_currentuserinfo get_userdata get_userdatabylogin auth_redirect username_exists email_exists validate_username user_pass_ok 用户 meta get_usermeta delete_usermeta update_usermeta 用户添加和删除 wp_insert_user wp_update_user wp_delete_user wp_create_user 登录和注销 wp_signon is_user_logged_in	供稿(Feed) fetch_rss wp_rss get_rss 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_link get_comment_author_rss comment_author_rss comment_text_rss post_comments_feed_link get_post_comments_feed_link get_author_feed_link get_category_feed_link get_the_category_rss the_category_rss rss_enclosure get_search_feed_link get_search_comments_feed_link
评论，通知和引用(Ping,Trackback) paginate_comments_links previous_comments_link next_comments_link check_comment get_approved_comments get_comment get_comments 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	动作(Action)，过滤器(Filter)和插件 Filters add_filter remove_filter apply_filters merge_filters Actions add_action remove_action do_action did_action do_action_ref_array Plugins plugin_basename register_activation_hook register_deactivation_hook register_setting unregister_setting settings_fields Shortcodes add_shortcode remove_shortcode remove_all_shortcodes do_shortcode get_shortcode_regex do_shortcode_tag shortcode_parse_atts shortcode_atts strip_shortcodes
主题相关 Include 函数 get_header get_sidebar get_search_form comments_template get_footer 其他函数 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 get_themes get_theme get_theme_support 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 preview_theme preview_theme_ob_filter preview_theme_ob_filter_callback validate_current_theme switch_theme get_theme_mod set_theme_mod get_header_textcolor get_header_image header_image add_custom_image_header	格式化(Formatting) wptexturize clean_pre wpautop seems_utf8 wp_specialchars utf8_uri_encode remove_accents sanitize_file_name sanitize_user sanitize_title sanitize_title_with_dashes convert_chars funky_javascript_fix balanceTags force_balance_tags format_to_edit format_to_post zeroise backslashit trailingslashit untrailingslashit addslashes_gpc stripslashes_deep antispambot make_clickable wp_rel_nofollow convert_smilies is_email wp_iso_descrambler popuplinks sanitize_email ent2ncr wp_richedit_pre clean_url htmlentities2 js_escape attribute_escape wp_make_link_relative add_magic_quotes wp_kses 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_stripslashes 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
杂项 Functions 时间和日期 get_the_time get_day_link get_month_link get_year_link get_calendar get_gmt_from_date get_date_from_gmt iso8601_timezone_to_offset iso8601_to_datetime human_time_diff mysql2date current_time date_i18n get_weekstartend get_lastpostdate get_lastpostmodified is_new_day Serialization maybe_serialize maybe_unserialize is_serialized is_serialized_string 选项 get_option form_option get_alloptions update_option add_option delete_option get_user_option update_user_option XMLRPC xmlrpc_getposttitle xmlrpc_getpostcategory xmlrpc_removepostdata user_pass_ok 本地化 get_locale __ _e _ngettext load_textdomain load_default_textdomain load_plugin_textdomain load_theme_textdomain Cron (Scheduling) wp_schedule_single_event wp_schedule_event wp_reschedule_event wp_unschedule_event wp_clear_scheduled_hook wp_next_scheduled spawn_cron wp_cron wp_get_schedules wp_get_schedule 杂项 get_bloginfo 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 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 wp_mail check_admin_referer check_ajax_referer wp_redirect 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.php, classes.php, class-snoopy.php, locale.php, query.php, rewrite.php, script-loader.php, wp-db.php: WP - 通用请求处理 WP_Ajax_Response - AJAX 处理 WP_Object_Cache (formerly 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 - 请求分析处理，文章匹配(函数 get_query_var, query_posts, have_posts, in_the_loop, rewind_posts, the_post, wp_old_slug_redirect, setup_postdata, as well as the Conditional Tags is_*) WP_Rewrite - Rewrite rules (and functions add_rewrite_rule, add_rewrite_tag, add_feed, add_rewrite_endpoint, url_to_postid) WP_Roles, WP_Role, WP_User - Users and capabilities - 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) WP_Styles - CSS 样式表加载 (函数 wp_print_styles, wp_register_style, wp_deregister_style, wp_enqueue_style ) 树形数据显示 - Walker, Walker_Page, Walker_PageDropdown, Walker_Category, Walker_CategoryDropdown wpdb - Database interface 下面的类由外部开发者创建，可以在这些文件中找到 class-IXR.php, class-pop3.php, class-snoopy.php, gettext.php, rss.php, streams.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 client gettext_reader (part of PHP-gettext) - Localization Class RSS Classes (MagpieRSS and 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 wrapper StreamReader, StringReader, FileReader, CachedFileReader

官方以及非官方参考

• WordPress.org PHPDoc - Nearly all the functions in WordPress have "PHPDoc" headers. This site shows all the PHPDoc.

• Trac Browser - WordPress 源代码。选择 'Tags' 查看特定版本，选择 'Trunk' 查看当前版本。

• PHPXref for WordPress - Cross reference of WordPress files, functions, and variables, which seems to point to the latest released version. This redalt.com PHPXref site has the bleeding-edge Trunk version, as well as 1.5 and 2.0, but the Trunk version may not be updating any more. So, there is now a new Trunk Xref site on ftwr.co.uk available.

• WordPress Function History Table - List each WordPress function with including the version it was introduced in or dropped in. PlanetOzh recommends: "see related WordPress Functions Implementation History Tool for more information (and for a more usable tool)"

WordPress Variable Report - A list of WordPress functions, listing what version of PHP every function requires (and if there's a compatible function available), what varables/arguments in functions are unused, and what functions/variables each class contains (and their default values)。

from http://codex.wordpress.org/zh-cn:%E5%87%BD%E6%95%B0%E5%8F%82%E8%80%83