欢迎莅临阿Q的项目

专业WP商业设计开发销售中心

[手册]WordPress 函数参考(Function Reference)

Function Reference 函数参考,函数参考目录: 1. Post, Page, Attachment and Bookmarks Functions 文章,页面,附件和链接的函数 - P […]
__ <?php __( $text, $domain ) ?>
检索来自 translate()的被翻译过的字符串。
_e <?php _e( $text, $domain ) ?>
显示 translate()返回的被翻译过的内容。
__ngettext <?php __ngettext( $single, $plural, $number, $domain ) ?>
根据总数检查单复数形式。如果域名不在$110n列表中,会做出一个比较,返回$plural或$single参数。如果域名存在,$single、$plural与$number会首先被传递到域名的ngettext方法。之后域名与这些参数会被传递到 'ngettext'过滤器钩子中。预计返回类型是字符串。
_x <?php string   _x( $single, string $context, [string $domain  = 'default'], string $text); ?>
从获取的文本中返回翻译的字符串。
esc_attr__ <?php esc_attr__( $text, $domain = 'default' ) ?>
Retrieves the translation of $text and escapes it for safe use in an attribute. If there is no translation, or the domain isn't loaded the original text is returned.
esc_attr_e <?php esc_attr_e( $text ) ?>
翻译,编码并响应。
get_locale <?php get_locale() ?>
获取当前的本地区域设置,如果本地区域已设定,该函数会过滤‘locale’过滤器中的区域设置并返回值。如果本地区域未设定且WPLANG常量已定义,可使用WPLANG常量。本地区域设置会被'locale'过滤过滤,返回本地全局设置以及区域设置的值。获取本地区域设置的过程只能一次性完成,但区域设置总由'locale'过滤器过滤。
load_default_textdomain <?php load_default_textdomain() ?>
加载默认、经过翻译的本地字符串。从WordPress根目录下的WP_LANG_DIR绝对路径中加载.mo文件。根据本地情况为翻译后的(.mo)文件命名。
load_plugin_textdomain <?php load_plugin_textdomain( $domain, $abs_rel_path, $plugin_rel_path ) ?>
加载翻译后的插件字符串。如果未给出路径,默认路径为插件根目录。.mo文件路径基于带有破折号的域名命名,域名后应跟有一个破折号,破折号后为本地路径。
load_textdomain <?php load_textdomain( $domain, $mofile ) ?>
将MO文件加载到域名列表中。如果域名已经存在,则加载失败。如果MO文件不可读,加载也以失败告终。加载成功后,MO文件会被$domain存储在全局变量$110n中,并成为gettext_reader的一个对象。
load_theme_textdomain <?php load_theme_textdomain( $domain, $path ) ?>
加载翻译后的主题字符串。如果本地主题根目录下有一个.mo文件,该文件会被包括在$domain的被翻译字符串中。.mo文件必须根据本地设置命名。

spawn_cron <?php spawn_cron( $local_time ) ?>
发送请求,在不停止页面加载的HTTP请求上执行定时事件。
wp_clear_scheduled_hook <?php wp_clear_scheduled_hook('my_schedule_hook'); ?>
清除某预订的定时事件的钩子(hook)。.
wp_cron <?php wp_cron() ?>
为所有预定事件运行预定回调或批量生产定时任务。
wp_get_schedule <?php wp_get_schedule( $hook, $args ) ?>
利用参数检索用于钩子(hook)的定时事件。
wp_get_schedules <?php wp_get_schedules() ?>
检索受支持和被过滤的定时任务的执行周期。有效周期值包括'hourly'和'daily'。可以用插件连接到'cron_schedules'过滤器。过滤器接收一个包含多个数组的数组。外部数组的键值是预定事件的周期,如'weekly'。函数的值是一个带有两个键值的数字,一个键值是'interval',另一个则是 'display'。'internal'表示定时任务运行的周期,以秒数表示。因此'hourly(每小时)'的时间表示法是3600或60*60。而 'weekly(每周)'的时间表示法则是60*60*24*7 或604800,'interval'的值就是604800。
wp_next_scheduled <?php $timestamp = wp_next_scheduled( $hook, $args ); ?>
返回一个定时时间的下一个时间标记。
wp_reschedule_event <?php wp_reschedule_event( timestamp, recurrence, hook, args (optional));
WordPress内部使用该函数来重新安排某个已发生事件。用户可能永远都不需要手动使用这个函数。将函数列在这里是为了保证手册的完整性。
wp_schedule_event <?php wp_schedule_event(time(), 'hourly', 'my_schedule_hook'); ?>
计划某个钩子(hook)的运行周期,用户指定时间周期后,WordPress动作(action)函数每一周期内执行一次该钩子。预定时间过去后,如果有人访问用户的WordPress网站,动作函数钩子会被触发。插件API中有一份钩子(hook)列表。
wp_schedule_single_event <?php wp_schedule_single_event(time(), 'my_schedule_hook'); ?>
计划某个钩子(hook)的使用时间,用户指定时间后,WordPress动作(action)函数执行一次该钩子。预定时间过去后,如果有人访问用户的 WordPress网站,动作函数会停止运行。
wp_unschedule_event <?php wp_unschedule_event(next_scheduled_time, 'my_schedule_hook', original_args ); ?>
注销一个以前预约的定时事件。

add_query_arg <?php add_query_arg( $param1, $param2, $old_query_or_uri ) ?>
检索修改后的URL查询字符串。用户可利用该函数重建URL并为URL查询语句添加新的查询变量。还可以用查询数据检索完整URL。添加单键、单一值或一个关联数组。为空字符串设置键值可移除该键。用$_SERVER['REQUEST_URI']的值来忽略 'oldquery_or_uri' 。该函数帮助性较强。利用该函数,在添加额外的GET变量时,用户不必担心是否需要将?符号或&符号加入到URL中。
bool_from_yn <?php bool_from_yn( $yn ) ?>
判断输入内容为“yes”或“No”。仅当为“y”时返回true。
cache_javascript_headers <?php cache_javascript_headers() ?>
设置页头,将有JavaScript类型的页头保存十天。
check_admin_referer <?php check_admin_referer( $action, $query_arg ) ?>
Tests if the current request was referred from an admin page, or (given $action  parameter) if the current request carries a valid nonce. Used to avoid security exploits.
check_ajax_referer <?php check_ajax_referer( $action, $query_arg, $die ) ?>
该函数可由插件代替。若插件无法重新定义函数,则使用该函数。该函数验证AJAX请求以阻止执行来自博客外部的请求。
do_robots <?php do_robots() ?>
显示robot.txt文件内容。回应的内容应该用于永久链接或用于创建robot.txt文件。
get_bloginfo <?php $bloginfo = get_bloginfo( $show ); ?>
该函数返回用户博客的相关信息,可将返回的信息用在PHP代码中。该函数与bloginfo()均可以显示博客相关信息。
get_num_queries <?php echo get_num_queries();?>
计划某个钩子(hook)的运行周期,用户指定时间周期后,WordPress动作(action)函数每一周期内执行一次该钩子。预定时间过去后,如果有人访问用户的WordPress网站,动作函数钩子会被触发。插件API中有一份钩子(hook)列表。
get_num_queries <?php echo get_num_queries();?>
检索执行WordPress时的数据库查询次数。
is_blog_installed <?php is_blog_installed() ?>
检查博客是否已经安装完毕。首先检查缓存。如果有保存了缓存值的缓存插件,这时缓存插件会开始运行。如果使用WordPress的默认缓存功能,数据库会无法作用,然后可能就会出错。检查网站地址选项,查看WordPress是否已经安装完毕。
is_ssl <?php is_ssl() ?>
检查ssl是否可用。
make_url_footnote <?php make_url_footnote( $content ) ?>
在已剥离文本最下方除去HTML 代码并添加链接。查找所有链接,除去链接中的文字,然后将链接以编号形式放置在文本最下方。
nocache_headers <?php nocache_headers() ?>
设置页头,使之阻止不同浏览器的缓存。不同浏览器支持不同的nocache页头,因此必须要发送多个页头才能保证所有浏览器都 不进行缓存。
remove_query_arg <?php remove_query_arg( $key, $query ) ?>
从查询字符串中删除某个条目或列表项。
status_header <?php status_header( $header ) ?>
设定HTTP状态页头。
wp <?php wp( $query_vars ) ?>
设置WordPress查询。
wp_check_filetype <?php wp_check_filetype( $filename, $mimes ) ?>
从文件名中检索文件类型。必要时用户可以选择定义MIME数组。
wp_clearcookie <?php wp_clearcookie() ?>
该函数可由插件代替。若插件无法重新定义函数,则使用该函数。该函数清除身份验证cookie,退出用户的登录状态。可用 wp_set_auth_cookie()函数代替该函数。(已弃用)
wp_create_nonce <?php $nonce= wp_create_nonce( $action ); ?>
生成一个随机的、一次性的令牌。
wp_die <?php wp_die( $message, $title, $args ) ?>
终断WordPress执行并显示错误HTML信息。一个该函数的调用与PHP函数 die()互为补充。区别在于,HTML是显示给用户看的。推荐仅在进程不能再继续时,再使用该函数。不推荐经常调用该函数,尽量低调处理各种错误。
wp_explain_nonce <?php wp_explain_nonce( $action ) ?>
检索随机数动作函数“Are you sure”信息。
该动作函数分裂为动词和名词。动作函数格式为verb(动词)-action(名词)_extra。破折号前是动作名称,动作名称均为字母,不包括空格和数字。破折号后、下划线(如果有下划线)前是名词,名词也由字母组成。
动作函数需要调用过滤器,而WordPress并未定义过滤器。用户可用插件的过滤器来解释访问者看到“Are you sure”时的随机数动作函数。过滤器格式为“explain_nonce_$verb-$noun”,用所找到的动词代替其中的$verb,所找到的名次代替其中的$noun。这两个参数来源于带有额外文本(动作函数下划线后的内容)的'Are you sure you want to do this?'信息。
wp_footer <?php wp_footer(); ?>
激活 'wp_foter' 动作。
wp_get_cookie_login <?php wp_get_cookie_login() ?>
该函数可由插件代替。若插件无法重新定义函数,则使用该函数。该函数获取用户登录的cookie。用户不能继续在WordPress中使用该函数。也不可以用插件来代替该函数。(已弃用)
wp_get_http_headers <?php wp_get_http_headers( $url, $deprecated ) ?>
从URL中检索HTTP信息头
wp_get_original_referer <?php wp_get_original_referer() ?>
检索原始引用页(若引用页存在)。
wp_get_referer <?php wp_get_referer() ?>
分别从 '_wp_http_referer'、HTTP引用页或当前页面检索引用页。
wp_hash <?php wp_hash( $data, $scheme ) ?>
该函数可由插件代替。若插件无法重新定义函数,则使用该函数。该函数获取已知字符串的hash值。
wp_head <?php wp_head(); ?>
激活 'wp_head' 动作。
wp_mail <?php wp_mail( $to, $subject, $message, $headers, $attachments ); ?>
发送一封邮件。
wp_mkdir_p <?php wp_mkdir_p( $target ) ?>
新建绝对路径的递归式文件夹。试图设置文件夹的访问权限。
wp_new_user_notification <?php wp_new_user_notification( $user_id, $plaintext_pass ) ?>
该函数通知博客管理者有新用户注册,通常通过E-mail通知。该函数可由插件代替。若插件无法重新定义函数,则使用该函数。
wp_nonce_ays <?php wp_nonce_ays( $action ) ?>
显示“Are You Sure”信息以使用户确认当前进行的操作。如果动作有随机数解释信息,解释信息会随“Are you suire?”信息一同展现。
wp_nonce_field <?php wp_nonce_field( $action, $name, $referer, $echo ) ?>
为输入框检索或显示随机数隐藏字段。
随机数字段用来验证输入框中、来自当前网站位置而非其他区域的内容。随机数不能提供完全绝对的安全保护,但可以有效阻止大多数不安全情况。
如果将$echo和$referer都设为true,需要检索wp_referer_field()。如果将$referer设为true且回应随机字段,那么它也会回应referer字段。
$action和$name参数都是可选的,但如果希望进一步提高安全措施,强烈推荐设置这两个参数。调用一个没有参数的 wp_nonce_field函数虽然方便(验证随机字段不要求参数的参与),但一旦黑客掌握了随机数的规律,很容易就可以找到方法破解随机验证,使网站安全受到威胁。
input名称即用户赋予$name的值。input的值则是随机数值。
wp_nonce_url <?php wp_nonce_url( $actionurl, $action ) ?>
检索在查询中添加了随机数的URL。
wp_notify_moderator <?php wp_notify_moderator( $comment_id ) ?>
该函数可由插件代替。若插件无法重新定义函数,则使用该函数。该函数通知博客审核者有新评论正等待审核。
wp_notify_postauthor <?php wp_notify_postauthor( $comment_id, $comment_type ) ?>
该函数可由插件代替。若插件无法重新定义函数,则使用该函数。该函数过滤用于重定向的URL。
wp_original_referer_field <?php wp_original_referer_field( $echo, $jump_back_to ) ?>
为表格检索或显示初始引用页隐藏字段。若字段已显示,则输入名称为'_wp_original_http_referer'且值与wp_referer_field() 相同,如果字段不存在,则输入名为当前页面。
wp_parse_args <?php $args = wp_parse_args( $args, $defaults ); ?>
wp_parse_args is a generic utility for merging together an array of arguments and an array of default values. It can also be given a URL query type string which will be converted into an array (i.e. "id=5&status=draft").
wp_redirect <?php wp_redirect($location, $status); ?>
将用户重定向到一个预先制定的绝对URI。
wp_referer_field <?php wp_referer_field( $echo ) ?>
为表格检索或显示引用页隐藏字段。引用页链接即来自服务器超级全局变量的当前请求URI。如果希望手动检索,请使用输入名称'_wp_http_referer'。
wp_remote_fopen <?php $contents = wp_remote_fopen($uri); ?>
返回某个远程URI的内容。先尝试用fopen函数检索HTTP内容,若fopen无效则用cURL继续尝试。
wp_salt <?php wp_salt( $scheme ) ?>
该函数可由插件代替。若插件无法重新定义函数,则使用该函数。
该函数获取salt值并添加到哈希列表中,以预防攻击。
密钥位于两个位置:一是数据库(防止另一处没有定义密钥),二是wp-config.php文件。如果需要设置密钥,需要在wp- config.php文件中完成。
数据库中的密钥是随机生成的,有时会被赋值给wp-config.php文件中的密钥。记住,要在wp-config.php文件中定义或修改密钥。
如果你安装的是WordPress 2.5及更高版本,那么wp-config.php文件中已经定义了SECRET_KEY。但你需要更改它的值,因为黑客可能已经知道这个值。如果你从 WP 2.5之前的版本升级到WP 2.5或者更高版本,需要在wp-config.php中添加常量SECRET_KEY。
有一种解密工具中存储了常用字典字符串的哈希值,为密码添加salt值可以防止这种解密工具破解你的密码。如果添加的值强度够高,密码就更不容易被破解。
wp_set_auth_cookie <?php wp_set_auth_cookie( $user_id, $remember, $secure ) ?>
该函数可由插件代替。若插件无法重新定义函数,则使用该函数。
设置基于User ID身份证明的cookie。
wp_upload_bits <?php wp_upload_bits( $name, $deprecated, $bits, $time ) ?>
用所给内容在上传文件夹中新建一个文件。
如果发生错误,错误信息中会出现关键字'key'。如果文件新建成功,则关键字'file'会被赋予唯一的文件路径,而'url'关键字则被赋予新文件的链接。'error'键值被设为false。
该函数不会将已经上传的文件再次上传到上传文件夹中。该函数会用$bits参数中的内容新建一个文件。如果用户移动上传文件,读取已上传文件中的内容,就可以将文件名和文件内容赋值给该函数,函数再将文件名和内容添加到上传文件夹。
该函数会自动设置新文件的访问权限。
wp_upload_dir <?php $upload_dir = wp_upload_dir(); ?>
返回当前上传目录配置的信息数组。
wp_verify_nonce <?php wp_verify_nonce($nonce, $action); ?>
检查是否在时间范围内使用了正确的随机数。
如果喜欢本文,请分享给朋友们

[手册]WordPress 函数参考(Function Reference)19 篇评论

  1. fannar

    博主,你好,我想问下,为什么我在你的网站里搜索esc_attr时,搜不到,在百度里面搜esc_attr,反而能搜到,想问下这是怎么回事?

    • 阿Q管理员

      我可以搜到包含esc_attr的三篇文章哦。

  2. 戈饭

    你NB,我特意来顶了,我不客气地COPY了!THANK YOU! :mrgreen:

  3. 我的天,实在是太长太多了.
    收藏回去慢慢看..

  4. 博主好

    百度快照就是不更新不知道为什么