WordPress.org

Ready to get started?Download WordPress

Codex

zh-cn:函数参考

Contents

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,可以找到更多做出贡献的方法。

函数分类

文章,页面,附件,书签

文章

自定义文章类型

文章插入/移除l

页面

自定义域 (文章信息 postmeta)

附件

书签(链接)

条件项

其他

分类,标签,分类法

分类

分类创建

标签

分类法(Taxonomy)

用户和作者

用户和作者

用户 meta

用户添加和删除

登录和注销

供稿(Feed)

评论,通知和引用(Ping,Trackback)

动作(Action),过滤器(Filter)和插件

Filters

Actions

Plugins

Shortcodes

主题相关

Include 函数

其他函数

格式化(Formatting)

杂项 Functions

时间和日期

Serialization

选项

XMLRPC

本地化

Cron (Scheduling)

杂项

下面这些类是 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' 查看当前版本。
  • 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).
本文已被标记为未完成状态。您可以将其补充或翻译完整,以此帮助完善 Codex。