function – web百事通 https://www.askme-121.pw web互联网之家 Sun, 24 Dec 2023 13:07:02 +0000 zh-CN hourly 1 https://wordpress.org/?v=6.5.3 https://www.askme-121.pw/wp-content/uploads/2023/12/cropped-05ee702f-4b38-40f3-915f-c8fc68b10a91-32x32.png function – web百事通 https://www.askme-121.pw 32 32 WordPress常用的函数、方法汇总 https://www.askme-121.pw/wordpress-functions/ https://www.askme-121.pw/wordpress-functions/#respond Sat, 09 Dec 2023 02:48:54 +0000 http://wp.v.cnbbx.com/?p=30 选择使用 WordPress来搭建博客,主要原因便在于 WordPress有较高的流行度,还有各种围绕其进行的开发的扩展功能应有尽有,基本上可以说我们在博客建设中所需的任何功能,都已有人想到并得到实现,让你不必在博客具体的技术实现及功能扩展方面投入过多的精力,而更专注于内容建设。

本文以技术手册的方式简单汇总WordPress主题模板的基本资料,希望能对WordPress主题模板开发的朋友解渴。

WordPress 主题模板基本文件

一套完整的 WordPress 主题模板应至少具有如下文件:,WordPress基本模板文件,WordPress模板必备文件:

style.css : CSS(样式表)文件
index.php : 主页模板
archive.php : Archive/Category模板
404.php : Not Found 错误页模板
comments.php : 留言/回复模板
footer.php : Footer模板
header.php : Header模板
sidebar.php : 侧栏模板
page.php : 内容页(Page)模板
single.php : 内容页(Post)模板
searchform.php : 搜索表单模板
search.php : 搜索结果模板

基本条件判断Tag

is_home() : 是否为主页
is_single() : 是否为内容页(Post)
is_page() : 是否为内容页(Page)
is_category() : 是否为Category/Archive页
is_tag() : 是否为Tag存档页
s_date() : 是否为指定日期存档页
is_year() : 是否为指定年份存档页
is_month() : 是否为指定月份存档页
is_day() : 是否为指定日存档页
is_time() : 是否为指定时间存档页
is_archive() : 是否为存档页
is_search() : 是否为搜索结果页
s_404() : 是否为 “HTTP 404: Not Found” 错误页
is_paged() : 主页/Category/Archive页是否以多页显示

Header部分常用到的PHP函数

<?php bloginfo (’name’); ?> : 博客名称(Title)
<?php bloginfo (’stylesheet_url’); ?> : CSS文件路径
<?php bloginfo (’pingback_url’); ?> : PingBack Url
<?php bloginfo (’template_url’); ?> : 模板文件路径
<?php bloginfo (’version’); ?> : WordPress版本
<?php bloginfo (’atom_url’); ?> : Atom Url
<?php bloginfo (’rss2_url’); ?> : RSS 2.o Url
<?php bloginfo (’url’); ?> : 博客 Url
<?php bloginfo (’html_type’); ?> : 博客网页Html类型
<?php bloginfo (’charset’); ?> : 博客网页编码
<?php bloginfo (’description’); ?> : 博客描述
<?php wp_title(); ?> : 特定内容页(Post/Page)的标题

模板常用的PHP函数及命令

<?php get_header(); ?> : 调用Header模板
<?php get_sidebar(); ?> : 调用Sidebar模板
<?php get_footer(); ?> : 调用Footer模板
<?php the_content(); ?> : 显示内容(Post/Page)
<?php the_excerpt(); ?>: 显示摘要
<?php if(have_posts()) : ?> : 检查是否存在Post/Page
<?php while (have_posts()) : the_post(); ?> : 如果存在Post/Page则予以显示
<?php endwhile; ?> : While 结束
<?php endif; ?> : If 结束
<?php the_time(’字符串’) ?> : 显示时间,时间格式由“字符串”参数决定,具体参考PHP手册
<?php comments_popup_link(); ?> : 正文中的留言链接。如果使用 comments_popup_script() ,则留言会在新窗口中打开,反之,则在当前窗口打开
<?php the_title(); ?> : 内容页(Post/Page)标题
<?php the_permalink() ?> : 内容页(Post/Page) Url
<?php the_category(’, ‘) ?> : 特定内容页(Post/Page)所属Category
<?php the_author(); ?> : 作者
<?php the_ID(); ?> : 特定内容页(Post/Page) ID
<?php edit_post_link(); ?> : 如果用户已登录并具有权限,显示编辑链接
<?php get_links_list(); ?> : 显示Blogroll中的链接
<?php comments_template(); ?> : 调用留言/回复模板
<?php wp_list_pages(); ?> : 显示Page列表
<?php wp_list_categories(); ?> : 显示Categories列表
<?php next_post_link(’ %link ‘); ?> : 下一篇文章链接
<?php previous_post_link(’%link’); ?> : 上一篇文章链接
<?php get_calendar(); ?> : 日历
<?php wp_get_archives() ?> : 显示内容存档
<?php posts_nav_link(); ?> : 导航,显示上一篇/下一篇文章链接
<?php include (TEMPLATEPATH . ‘/文件名’); ?> : 嵌入其他文件,可为定制的模板或其他类型文件

与模板相关的其他函数

<?php _e(’Message’); ?> : 输出相应信息
<?php wp_register(); ?> : 显示注册链接
<?php wp_loginout(); ?> : 显示登录/注销链接
<–next page–> : 将当前内容分页
<–more–> : 将当前内容截断,以不在主页/目录页显示全部内容
<?php timer_stop(1); ?> : 网页加载时间(秒)
<?php echo get_num_queries(); ?> : 网页加载查询量

其它

<?php get_archives(’postbypost’, 10); ?> 调用最近的10篇日志
<?php $rand_posts = get_posts(’numberposts=10&orderby=rand’);
foreach ($rand_posts as $post) :?>
<li><a href="<?php the_permalink(); ?>">
<?php the_title(); ?></a></li>
<?php endforeach; ?> 随机调用10篇日志
<?php the_tags(’Post Tags :’, ‘, ‘, ‘<br />’); ?> 调用标签
<?php if (get_the_tags()) the_tags(’Tags:’,’,’,’ end ’); ?> 标签存在时调用
<?php wp_tag_cloud(’smallest=1&largest=9&’); ?> 调用标签云
<?php $posts = get_posts( “category=12&numberposts=4″ ); ?> 获得4篇12分类中的日志

再来一些更详细的判断函数

<?php if (is_single()):?> 
//这里写你想显示的内容,包括函数
<?php endif;?>
is_single() 判断是否是具体文章的页面
is_single(’17′) 判断是否是具体文章(id=17)的页面
is_single(’Beef Stew’) 判断是否是具体文章(标题判断)的页面
is_single(’beef-stew’) 判断是否是具体文章(slug判断)的页面
comments_open() 是否留言开启
pings_open() 是否开启ping
is_page() 是否是页面
is_page(’42′) 同single,id判断,即是否是id为42的页面
is_page(’About Me’) title判断
is_page(’about-me’) slug判断
is_category() 是否是分类
is_category(’6′) 同single,id判断,即是否是id为6的分类
is_category(’Cheeses’) title判断
is_category(’cheeses’) slug判断
in_category(’5′) 判断当前的文章是否属于分类5
is_author() 将所有的作者的页面显示出来
is_author(’1337′) 显示author number为1337的页面
is_author(’Elite Hacker’) 通过昵称来显示当前作者的页面
is_author(’elite-hacker’)
is_date()
is_year()
is_month()
is_day()
is_time()
is_archive() 判断当前是否是归档页面
is_search() 判断是否是搜索
is_404() 判断页面是否404
is_paged() 判断是否翻页,比如你当前的blog是http: //domain.com,显示http: //domain.com?paged=2的时候,这个判断将返回真,通过这个函数可以配合is_home来控制某些只能在首页显示的界面,例如: if (is_home() && !is_paged())

]]>
https://www.askme-121.pw/wordpress-functions/feed/ 0
100个常用WordPress函数 https://www.askme-121.pw/100-wordpress-function/ https://www.askme-121.pw/100-wordpress-function/#comments Wed, 06 Dec 2023 11:29:59 +0000 http://wp.v.cnbbx.com/?p=1 WordPress 是一个功能强大的平台,数百种核心函数,很难都记住,这里分享一些最常见的WordPress函数,供查询参考。

1. get_theme_mod()

检索当前主题的主题修改值。

获取字段option_name为“theme_mod_主题名称”对应的option_value字段中ID为$name的值,如果获取不到(获取不到这条数据记录才会使用默认值,获取到数据ID对应的值为空也不会使用第2个参数的默认值)会使用第2个参数的默认值。

语法:

get_theme_mod(string $name, mixed $default = false)
例:get_theme_mod('hongsweb', 'website construction')

2. add_setting()

添加自定义设置。

语法:

add_setting($id, $args=array())
例:$wp_customize->add_setting('sample_default_text',
   array(
      'default' => '', // 可选.
      'transport' => 'refresh', // 可选,定义如何更新实时预览。可选值: 'refresh' 或 'postMessage'. 默认: 'refresh'
      'type' => 'theme_mod', // 可选,定义如何保存设置。可选值: 'theme_mod' 或 'option'. 默认: 'theme_mod'
      'capability' => 'edit_theme_options', // 可选,根据用户的权限级别显示或隐藏控件。 默认: 'edit_theme_options'
      'theme_supports' => '', // 可选,根据主题是否支持特定功能(使用add_theme_support)显示或隐藏控件。
      'validate_callback' => '', // 可选,将被调用以验证自定义器设置的函数的名称。
      'sanitize_callback' => '', // 可选,调用该函数,以便在将输入数据保存到数据库之前对其进行清洗。
      'sanitize_js_callback' => '', // 可选,在输出到javascript代码之前,将调用该函数对数据进行清洗。
      'dirty' => false, // 可选,很少用到。设置在创建时是否本来就是脏的。默认:false
   )
);

3. add_menu_page()

添加顶级菜单页

在管理菜单中创建一个新的顶级菜单项。你可以用它来创建一个自定义的仪表盘页面或设置页面。

语法:

add_menu_page($page_title, $menu_title, $capability, $menu_slug, $callback = '', $icon_url = '', $position = null)

例如:

add_menu_page(__("主题设置", 'myself'), __("主题选项", 'myself'), 'edit_theme_options', basename(__FILE__), 'themeoptions_page');

4. apply_filters()

调用添加到过滤器挂钩的函数。将函数或方法挂钩到特定的过滤器动作。

语法:

add_filter($hook_name, $callback, $priority = 10, $accepted_args = 1)

5. esc_attr()

转义 HTML 属性。

这个函数用来转义一个字符串,以便在HTML属性中使用。它接受一个字符串作为唯一的参数,并返回转义后的字符串。

语法:

esc_attr($text)

6. get_option()

根据选项名称检索选项值。

它从数据库中检索一个选项值。WordPress中的选项是可以由用户设置和调整的。 这个函数接受一个参数,它是你想检索的选项的名称。例如,如果你想检索”blogname”选项的值,你会调用get_option(‘blogname’), 该函数返回该选项的值。

语法:

get_option($option, $default = false)

7. esc_url()

检查并清理 URL。

语法:

esc_url($url, $protocols = null, $_context = 'display')

8. esc_html()

转义 HTML 块。

这个函数用来转义一个字符串,以便在HTML输出中使用。它接收一个字符串作为唯一的参数,并返回转义后的字符串。

语法:

esc_html($text)

9. __()和_e()

语言本地化

在 WordPress 中,php 文件中的字符串被标记为翻译成其他语言,并使用两个函数进行本地化:__() 和 _e()。__: 这是翻译函数的一个别名,带有上下文, 当一个单词或短语根据上下文有多种含义时,它就会被使用。_e: 这是WordPress中echo __函数的一个简写函数。它用来呼应翻译后的字符串。

语法:

__($text, $domain = 'default') //检索$text的翻译
_e($text, $domain = 'default') //回显$text的翻译

10. absint()

将值转换为非负整数。

该函数用于将一个变量转换为整数,确保结果总是一个正数。它通常用于净化用户输入,防止SQL注入攻击。

语法:

absint($maybeint)

11. get_template_part()

将模板部件加载到模板中。

这个函数检索一个模板部分文件的内容。它需要两个参数:模板部分的文件名,和一个可选的当前主题目录下的子目录名称。它以字符串形式返回模板部分文件的内容。

语法:

get_template_part($slug, $name = null, $args = array())
// 对于$name参数,如果文件被称为”{slug}-special.php”,那么指定”special”。

12. is_singular()

确定查询是否为任何文章类型(文章、附件、页面、自定义文章类型)的现有单个文章

这个函数检查当前页面是否是一个单一的文章、页面或附件。如果该页面是一个单独的文章、页面或附件,则返回 true,否则返回 false。如果指定了$post_types参数,该函数将额外检查该查询是否为指定的文章类型之一。

语法:

is_singular($post_types = '')

13.get_post_type()

检索当前文章或某一特定文章的文章类型。

这个函数检索一个给定文章的文章类型。它接受一个文章ID或文章对象作为其参数,并返回文章类型名称。

语法:

get_post_type($post = null)

14. get_the_id()

检索 WordPress 循环中当前项目的 ID。

这个函数检索当前文章或页面的ID。它不接受任何参数,以整数形式返回ID。

语法:

get_the_id()

15.the_content()

显示文章内容。

这个函数用来显示一个文章或页面的内容。它需要几个参数,允许自定义输出,如摘录的长度和是否显示图片或视频。

语法:

the_content ($more_link_text = null, $strip_teaser = false)

16. have_posts()

当前的 WordPress 查询是否有结果要循环。

用于检查当前查询是否有任何文章可以显示。文章是WordPress网站上的主要内容类型,它们可以通过查询以各种方式组织和过滤。have_posts函数通常用于一个循环,在查询结果集中迭代每个文章。

语法:

have_posts()

17. post_class()

显示文章容器元素的类。

这个函数用来根据文章的类型、状态和其他属性,为当前的文章输出CSS类。

语法:

post_class($class = '', $post = null)

18. get_comments_number()

检索一个文章的评论数量。

语法:

get_comments_number($post = 0)

19. the_id()

显示 WordPress 循环中当前项目的 ID。

语法:

the_id()

20. is_single()

确定查询是否是针对现有的单个文章

这个函数检查当前页面是否是一个单一的文章或页面。如果该页面是一个单一的文章或页面,它返回true,否则返回false。适用于任何文章类型,除了附件和页面。如果指定了$post参数,这个函数将额外检查查询是否为指定的文章之一。

语法:

is_single($post = '')

21.get_permalink()

检索当前文章或文章ID的完整固定链接

此函数接受一个参数,即要检索URL的文章或页面ID: 该函数返回文章或页面的URL。

语法:

get_permalink($post = 0, $leavename = false)

22. get_the_title()

检索文章的标题

用于返回循环中的当前文章的标题: 这个函数可以在循环中或在循环之外使用: 这个函数返回的标题是经过格式化的,可以安全显示。如果文章是受保护的,并且访问者不是管理员,那么”受保护的”将被插入到文章标题前。如果文章是私有的,那么”私有”将被插入到文章标题前。

语法:

get_the_title($post = 0)

23. admin_url()

检索当前网站的管理区的URL

这是一个WordPress的函数,返回管理区的URL。它需要一个可选的$path参数来指定链接到一个特定的管理页面。

语法:

admin_url($path = '', $scheme = 'admin')

24.add_section()

添加章节/部分

节是控件驻留的地方。在每个Section中通常会有多个控件。节可以添加到面板,但在大多数情况下,这是不必要的。

语法:

add_section($id, $args=array())

25.is_home()

确定查询是否为博客主页

如果当前页面是网站的博客首页,该函数返回true。博客主页是显示网站最新的博客文章的页面。如果一个静态页面被设置为网站的首页,这个函数将只在你设置为”文章页面”的页面上返回真。

语法:

is_home()

26.get_sidebar()

加载侧边栏模板。

用于检索一个特定侧边栏的HTML标记: 这个函数把侧边栏的名称作为参数,并返回侧边栏的HTML标记。对于参数,如果文件被称为”sidebar-special.php”,那么指定”special”。

语法:

get_sidebar($name = null, $args = array())

27.get_footer()

加载页脚模板。

这个函数是用来检索当前WordPress主题的页脚模板文件的。页脚模板文件通常用于显示网站的版权信息、信用或任何其他应该出现在每个页面底部的内容。对于参数,如果文件被称为”footer-special.php”,那么指定”special”。

语法:

get_footer($name = null, $args = array())

28. is_customize_preview()

是否在定制器中预览站点。

如果当前页面在定制器预览中被查看,这个WordPress函数返回真。自定义器是WordPress中的一个工具,它允许用户自定义他们网站的外观和功能,而不需要对代码进行修改。

语法:

is_customize_preview()

29. wp_nav_menu()

显示导航菜单。

这个函数用于在WordPress中显示一个导航菜单。它接受一些参数,包括菜单位置、菜单ID以及容器和菜单类名称。

语法:

wp_nav_menu($args = array())

30.the_title()

显示或检索当前文章的标题,并带有可选标记。

这个函数显示当前文章或页面的标题。它通常在The Loop中使用,可以用来显示文章或页面的链接,标题是链接的文本。

语法:

the_title($before = '', $after = '', $echo = true)

31. current_user_can()

当前用户是否具有特定的能力。

这个函数检查当前用户是否有特定的权限,如编辑文章或管理选项。它通常用于WordPress代码中,根据用户角色和权限限制对某些功能或内容的访问。这个函数也接受一个对象的ID,以检查该权限是否是元权限。元权限,如`edit_post`和`edit_user`是由`map_meta_cap()`函数用来映射到一个用户或角色拥有的原始权限,如`edit_posts`和`edit_others_posts`。

语法:

current_user_can($capability, $args)

使用实例

current_user_can('edit_posts');
current_user_can('edit_post', $post->ID);
current_user_can('edit_post_meta', $post->ID, $meta_key);

注意: 如果当前用户是超级管理员,将总是返回true,除非特别拒绝。

32. is_active_sidebar()

侧边栏是否正在使用。

这个函数用来检查一个侧边栏是否有任何小工具被添加到它。它把侧边栏的ID作为一个参数,如果侧边栏有任何小工具,则返回true,否则返回false。

语法:

is_active_sidebar($index)

33. wp_link_pages()

页面列表的格式化输出。

这个函数用来显示被分成多个页面的文章的分页链接。显示分页文章的页面链接(即包括`<!–nextpage–>`快速标签一次或多次)。这个标签必须在The Loop内。

语法:

wp_link_pages($args = '')

34.get_the_time()

检索文章的写作时间

这个函数返回当前文章或作为参数传递给它的文章的时间,根据函数的参数中指定的格式进行格式化。

语法:

get_the_time($format = '', $post = null)

35. get_the_date()

检索文章的写作日期

这个函数检索当前文章或页面的日期,根据WordPress设置中的日期格式进行格式化。它需要两个可选参数:日期格式和文章ID。它以字符串形式返回格式化的日期。与the_date()不同的是,这个函数将总是返回日期。

语法:

get_the_date($format = '', $post = null)

36. the_permalink()

显示当前文章的固定链接

它显示当前文章或指定文章的固定链接: 该函数检索循环中文章的固定链接,并输出封装在锚标记中的URL。

语法:

the_permalink($post = 0)

37. the_post()

在循环中迭代文章索引

用于在循环中设置当前文章。WordPress循环调用它来检索当前文章,并设置各种全局变量,如$post和$id。

语法:

the_post()

38. esc_attr_e()

显示已转义以在属性中安全使用的翻译文本。

这个函数用来转义一个字符串,用于翻译的HTML属性中,并对其进行回显。它接收一个字符串、一个文本域和一个可选的标志,以表示是否回显结果。

语法:

esc_attr_e($text, $domain = 'default')

39. is_front_page()

确定查询是否为网站的首页

如果当前页面是网站的首页,该函数返回true。前台页面是网站的主页面,当有人访问网站时就会显示。这是针对在你的网站的主URL上显示的内容。取决于网站的”首页显示” 设置’show_on_front’和’page_on_front’。如果你为网站的首页设置了一个静态页面,在查看该页面时,这个函数将返回true,否则与is_home()相同。

语法:

is_front_page()

40. bloginfo()

显示关于当前站点的信息

这个函数用来输出关于当前网站的信息,比如网站的标题、描述和URL: 该函数需要一个参数,指定要显示的信息类型(例如,”名称”、”描述”、”URL”)。

语法:

bloginfo($show = '')

41. comments_open()

确定当前文章是否开放评论

用来确定一个特定的文章或页面的评论是否开放。它接受一个文章的ID作为参数,如果评论是开放的,则返回真,否则返回假。

语法:

comments_open($post = null)

42. post_password_required()

确定文章是否需要密码,以及是否已经提供了正确的密码。

用于检查一个文章是否有密码保护,以及当前用户是否输入了正确的密码。如果文章是受密码保护的,而用户没有输入正确的密码,这个函数将返回true,否则将返回false。

语法:

post_password_required($post = null)

43. has_post_thumbnail()

确定一个文章是否有一个图片附件

用于检查当前文章是否有一个特色图片(也被称为文章缩略图)分配给它。特色图片被用来在各种情况下代表文章或页面的内容,例如在搜索结果或社交媒体上。has_post_thumbnail函数接受一个参数,即文章的ID或对象,如果文章有一个特色图片分配给它,则返回true。

语法:

has_post_thumbnail($post = null)

44. get_bloginfo()

检索关于当前网站的信息

这个函数检索关于当前站点或多站点网络中当前站点的父站点的信息: 该函数接收一个参数,指定要检索的信息类型,如网站标题、描述、URL等。

$show的可能值包括:

  • name – 网站标题(在设置> General中设定)。
  • description- 网站标语(在设置> General中设置)。
  • wpurl – WordPress的地址(URL)(在设置> 常规中设置)。
  • url – 网站地址(URL)(在设置> General中设置)。
  • admin_email – 管理员的电子邮件(在设置> General中设置)。
  • charset -页面和feeds的编码(在Settings > Reading中设置)。
  • version – 当前WordPress的版本
  • html_type – 内容类型(默认:”text/html”)。主题和插件可以使用‘pre_option_html_type’过滤器覆盖默认值。
  • text_direction – 由网站语言决定的文本方向。
  • language – 当前网站的语言代码
  • styleheet_url – 活动主题的样式表的URL。一个活跃的子主题将优先于这个值
  • stylesheet_directory – 活动主题的目录路径。 一个活动的子主题将会优先于这个值
  • template_url / template_directory – 活动主题目录的URL。一个活跃的子主题不会优先考虑这个值。
  • pingback_url – 回传的XML-RPC文件的URL(xmlrpc.php)。
  • atom_url – Atom feed URL (/feed/atom)
  • rdf_url – RDF/RSS 1.0馈送URL(/feed/rdf)
  • rss_url – RSS 0.92 feed URL (/feed/rss)
  • rss2_url – RSS 2.0的URL(/feed)
  • comments_atom_url – 评论的Atom feed URL (/comments/feed)
  • comments_rss2_url – 评论RSS2.0的URL(/comments/feed)

语法:

get_bloginfo($show = '', $filter = 'raw')

45.get_post_format()

检索一个文章的格式slug

返回文章的格式。文章格式是区分不同类型内容的一种方式,如标准、旁白、图库、视频、音频等。此函数需要一个参数,即文章的ID。如果文章没有格式,则此函数返回false。

语法:

get_post_format($post = null)

46.dynamic_sidebar()

显示动态侧边栏。

这个函数在WordPress中显示一个小工具区域(sidebar)的内容。它通常用于sidebar.php模板文件,显示在WordPress管理面板中添加的小工具。默认情况下,这将显示默认的侧边栏或’sidebar-1’。如果你的主题为其注册的侧边栏指定了’id’或’name’参数,你可以传递一个ID或名称作为$index参数。否则,你可以传入一个数字索引来显示该索引的侧边栏。

语法:

dynamic_sidebar($index = 1)

47.is_search()

确定该查询是否为搜索

这个函数检查当前页面是否是一个搜索结果页面。如果该页是搜索结果页,则返回true,否则返回false。

语法:

is_search()

48.home_url()

检索可访问前端的当前站点的 URL。

用于检索网站主页的URL。主页是网站的主页面,通常显示最近的文章列表、静态页面或自定义布局。home_url函数可以用来动态生成主页的链接,或者在自定义位置显示主页的URL。

语法:

home_url($path = '', $scheme = null)

49.comments_template()

加载 $file 中指定的评论模板

这个函数加载一个文章或页面的评论模板。评论模板用于显示文章或页面的评论部分。如果不是在单个文章或页面上,或者文章没有评论,将不显示评论模板。

语法:

comments_template($file = '/comments.php', $separate_comments = false)

50. add_theme_support()

注册主题对某一特定功能的支持

注册对一个特定主题功能的支持: 这个函数允许开发者向他们的主题添加将被WordPress识别的功能,例如自定义标题或文章格式。必须在主题的functions.php文件中调用才行。如果连接到一个钩子,它必须是{@see ‘after_setup_theme’}。{@see ‘init’}钩子对某些功能来说可能太晚了。

语法:

add_theme_support($feature, $args)

51. add_query_arg()

检索一个修改过的URL查询字符串

你可以通过使用这个函数重建URL并将查询变量附加到URL查询中。有两种方法可以使用这个函数,一种是单键和值,一种是关联数组。

使用单一的键和值

add_query_arg('key', 'value', 'http://example.com');

使用一个关联数组

add_query_arg( array(
'key1' => 'value1',
'key2' => 'value2',
), 'http://example.com' );

语法:
add_query_arg($args)

52. has_nav_menu()

确定一个已注册的导航菜单位置是否有一个菜单分配给它。

用于检查是否有一个特定的导航菜单被注册。导航菜单是自定义菜单,用于显示网站上不同页面或类别的链接。函数接收一个参数,即菜单的名称,如果该菜单已经被注册,则返回true,如果没有则返回false。

语法:

has_nav_menu($location)

53. is_wp_error()

检查给定的变量是否是WordPress错误

用来检查一个变量是否是WP_Error对象。WP_Error对象在WordPress中用来表示错误和错误信息: 这个函数可以用来检查一个变量是否是WP_Error的一个实例。

语法:

is_wp_error($thing)

54. get_the_author_meta()

检索当前文章的作者的请求数据

该函数检索文章作者的特定元数据字段的值。它需要两个参数:元数据字段名称和文章作者的ID。它以字符串形式返回元数据字段的值。

语法:

get_the_author_meta($field = '', $user_id = false)

55. edit_post_link()

显示编辑文章的链接

此函数生成一个链接,用于在WordPress管理面板中编辑一个指定的文章。

语法:

edit_post_link($text = null, $before = '', $after = '', $post = 0, $class = 'post-edit-link')

56. is_admin()

判断当前请求是否是管理界面的页面

这个函数用来检查当前的请求是否是一个管理页面。如果当前页面是一个管理页面,它返回真,否则返回假。

语法:

is_admin()

57. the_excerpt()

显示文章的摘要

这个函数用来输出一个文章或页面的内容的缩短版。摘录的长度是由WordPress设置中的摘录长度决定的。

语法:

the_excerpt()

58. wp_get_attachment_image_src()

检索一个特定附件的图像

此函数返回一个包含特定图片附件的URL、宽度和高度的数组。

语法:

wp_get_attachment_image_src($attachment_id, $size = 'thumbnail', $icon = false)

59. _x()

检索具有gettext上下文的翻译字符串

这个函数用于WordPress的国际化(i18n)目的。它类似于__()和_e()函数,但允许指定一个上下文参数,这可以帮助消除有多种含义的单词或短语的翻译。通过在pot文件中包括上下文,译者可以对这两个字符串进行不同的翻译。

语法:

_x($text, $context, $domain = 'default')

60. language_attributes()

显示html标签的语言属性

用于输出当前页面的HTML语言属性。它可以在你的主题的模板文件中使用,以指定页面内容的语言。建立一套HTML属性,包含页面的文本方向和语言信息。

语法:

language_attributes($doctype = 'html')

61. body_class()

显示body元素的类名

这个函数输出一系列的CSS类,它们被应用于网站每一页的”body”元素。这些类是基于各种因素的,比如当前的页面模板、用户的角色,以及网站是否在移动设备上被浏览。

语法:

body_class($class = '')

62. add_filter()

为一个过滤器钩子添加一个回调函数

这个函数用来向WordPress添加一个新的过滤器: 该函数有三个参数:钩子名称、回调函数和过滤器的优先级。WordPress提供过滤器钩子,允许插件在运行时修改各种类型的内部数据。一个插件可以通过绑定一个回调函数到一个过滤器钩子来修改数据: 当过滤器后来被应用时,每个绑定的回调函数按优先顺序运行,并有机会通过返回一个新值来修改一个值。

语法:

add_filter($hook_name, $callback, $priority = 10, $accepted_args = 1)

63. is_page()

确定查询是否是针对现有的单一页面

如果指定了$page参数,这个函数将额外检查查询是否为指定的页面之一。

语法:

is_page($page = '')

64. register_sidebar()

注册一个新的侧边栏并返回ID

这个函数用来在WordPress中注册一个新的侧边栏。侧边栏是用来在WordPress网站上显示小工具的,比如最近的文章列表或搜索栏。接受一个字符串或一个数组,然后根据新侧边栏的一组默认参数来解析它。如果不包括这些参数,WordPress会根据当前注册的侧边栏的数量自动生成一个侧边栏的ID和名称。当允许自动生成名称和ID参数时,请记住,你的侧边栏的增量可以随着时间的推移而改变,这取决于安装了哪些其他插件和主题。如果在调用这个函数时,还没有添加对”小工具”的主题支持,它将通过使用add_theme_support()自动启用。

语法:

register_sidebar($args = array())

65. get_the_category_list()

以HTML列表或自定义格式检索一个文章的类别列表。

这个函数检索分配给当前文章的分类的格式化字符串,以及它们的档案页的链接。它需要两个可选参数:类别链接之间的分隔符,以及在类别列表前显示的文本。它返回格式化的类别列表,是一个字符串。

语法:

get_the_category_list($separator = '', $parents = '', $post_id = false)

66. get_the_tag_list()

检索一个文章的标签,格式为字符串

这个函数返回当前文章或作为参数传递给它的文章的标签列表。

语法:

get_the_tag_list($before = '', $sep = '', $after = '', $post_id = 0)

67. esc_attr_x()

使用gettext上下文翻译字符串,并将其转义以便在属性中安全使用。

这个函数用来转义一个字符串,以便在一个带有翻译和上下文的HTML属性中使用。它接受一个字符串、一个上下文和一个文本域作为参数,并返回转义后的字符串。如果没有翻译,或者没有加载文本域,则转义原始文本并返回。

语法:

esc_attr_x($text, $context, $domain = 'default')

68. get_settings()

根据选项获取值

它检索网站所有选项的数组: 这个函数不接受任何参数,并返回一个网站选项的数组。

语法:

get_settings($option)

69. add_action()

为动作钩子添加回调函数

这个函数用来向WordPress添加一个新的动作钩。它被插件和主题开发者用来在WordPress执行流程的特定点上执行自定义代码。动作是WordPress核心在执行过程中的特定点,或在特定事件发生时启动的钩子。插件可以指定在这些点上执行它的一个或多个PHP函数,使用动作API。

语法:

add_action($hook_name, $callback, $priority = 10, $accepted_args = 1)

70. have_comments()

是否有评论要循环。

用来检查当前的文章或页面是否有任何评论可以显示。评论是访问者在网站上留下反馈或提出问题的一种方式,它们可以由网站管理员进行调节和管理。如果有评论,函数have_comments返回true,如果没有则返回false。

语法:

have_comments()

71.is_archive()

确定查询是否是针对现有的档案页

这个函数用于检查当前请求是否是一个存档页。如果当前页面是一个归档页面,它返回true,否则返回false。档案页包括类别、标签、作者、日期、自定义文章类型和基于自定义分类法的档案。

语法:

is_archive()

72. wp_list_comments()

列出评论

这个函数使用一组你可以自定义的参数来检索和显示评论列表。你可以使用这个函数来显示WordPress文章或页面上的评论。

语法:

wp_list_comments($args = array(), $comments = null)

73. wp_enqueue_style()

排队一个CSS样式表

这个函数是用来在WordPress的样式表中查询的。样式表用于定义网站的视觉风格,包括其排版、颜色和布局: 这个函数需要几个参数,包括样式表的句柄、样式表的源文件、样式表可能具有的任何依赖性,以及样式表是否应该被加载到页脚。如果提供了$src,则注册该样式表(不覆盖),并排队等待它。

语法:

wp_enqueue_style($handle, $src = '', $deps = array(), $ver = false, $media = 'all')

74. set_transient()

设置/更新瞬态值

用来设置一个临时选项。它类似于set_site_transient,但用于存储临时数据,这些数据只能在当前页面或会话中访问: 这个函数需要三个参数:暂存器的名称,要存储的数据,以及过期时间(秒)。您不需要序列化值。如果需要序列化该值,则将在设置该值之前对其进行序列化。

语法:

set_transient($transient, $value, $expiration = 0)

75. wp_enqueue_script()

排队等候脚本

这个函数用于在WordPress中排队等候一个脚本。脚本通常用于向网站添加动态行为,如互动元素或动画: 这个函数需要几个参数,包括脚本的句柄、脚本的源文件、脚本可能具有的任何依赖性,以及脚本是否应该在页脚加载。如果提供了$src,则注册该脚本(不覆盖),并排队等待它。

语法:

wp_enqueue_script($handle, $src = '', $deps = array(), $ver = false, $in_footer = false)

76. get_search_form()

显示搜索表单

用于检索搜索表单的HTML标记: 这个函数接受一个可选的表单属性参数,并返回搜索表单的HTML标记。将首先尝试在子目录或父目录中找到 searchform.php 文件,然后加载它。如果它不存在,那么默认的搜索表单将被显示。默认的搜索表单是HTML,它将被显示。有一个过滤器应用于搜索表单的HTML,以便编辑或替换它。该过滤器是 ‘get_search_form’。这个函数主要被那些想把搜索表单硬编码到侧边栏的主题使用,也被WordPress中的搜索小工具使用。

语法:

get_search_form($args = array())

77. get_post_thumbnail_id()

检索文章的缩略图ID

这个函数检索给定文章的特色图片的ID。它接受一个文章ID或文章对象作为其参数,并返回特色图片的ID。

语法:

get_post_thumbnail_id($post = null)

78.get_transient()

读取一个暂存器的值

这个函数检索一个暂存器的值。瞬态是在数据库中缓存一段时间的临时数据: 该函数将暂存器的名称作为参数,并返回暂存器的值,如果它存在的话。如果暂存器不存在,没有值,或者已经过期,那么返回值将是false。

语法:

get_transient($transient)

79. the_post_thumbnail()

显示文章的缩略图

显示当前文章或指定文章的缩略图。它检索文章的特色图像并输出相应的HTML标记。当一个主题增加了对”post-thumbnail”的支持时,一个特殊的”post-thumbnail”图片尺寸被注册,它与通过设置>媒体屏幕管理的”thumbnail”图片尺寸不同。当使用the_post_thumbnail()或相关函数时,默认使用’post-thumbnail’图片尺寸,尽管可以根据需要指定不同的尺寸。

语法:

the_post_thumbnail($size = 'post-thumbnail', $attr = '')

80.get_search_query()

检索搜索 WordPress 查询变量的内容。

用于检索搜索查询字符串: 这个函数不接受任何参数,并返回搜索查询字符串。搜索查询字符串通过esc_attr()传递,以确保它可以安全地放在一个HTML属性中。

语法:

get_search_query($escaped = true)

81. add_partial()

增加AJAX刷新预览窗口

要使用PHP函数(通过AJAX)刷新预览窗口,首先需要注册一个Partial。当你使用add_partial()注册一个Partial时,你的选择器也会收到一个编辑快捷方式,当点击这个快捷方式时,它会把用户直接带到Customizer中可以编辑该选项的那个部分。

语法:

add_partial($id, $args=array())

82.get_the_modified_date()

检索文章最后被修改的日期

这个函数检索当前文章或页面最后一次被修改的日期,格式为WordPress设置中的日期格式。它需要两个可选参数:日期格式和文章ID。它以字符串形式返回格式化的日期。

语法:

get_the_modified_date($format = '', $post = null)

83. get_author_posts_url()

为提供ID的用户检索到作者页面的URL

语法:

get_author_posts_url($author_id, $author_nicename = '')

84. wp_footer()

触发wp_footer动作

这个动作钩子在WordPress模板的页脚部分被调用,允许开发者在页面的底部添加脚本或内容。它通常用于添加跟踪代码、脚本或其他需要最后加载的内容。

语法:

wp_footer()

85. wp_head()

触发wp_head动作

这个函数用于输出当前页面的HTML头部部分。它通常在header.php模板文件中调用。

语法:

wp_head()

86. get_the_post_thumbnail()

检索文章的缩略图

该函数返回当前文章或作为参数传递给它的文章的缩略图或特色图片。当一个主题增加了对”post-thumbnail”的支持时,一个特殊的”post-thumbnail”图片尺寸被注册,它与通过设置>媒体屏幕管理的”thumbnail”图片尺寸不同。当使用the_post_thumbnail()或相关函数时,默认使用’post-thumbnail’图片尺寸,尽管可以根据需要指定不同的尺寸。

语法:

get_the_post_thumbnail($post = null, $size = 'post-thumbnail', $attr = '')

87. comment_form()

在模板中输出一个完整的评论表单

这个函数为文章或页面上的评论表格输出HTML。它包括评论者的姓名、电子邮件和网站等字段,以及一个评论文本区。它还包括一个提交按钮来提交评论。大多数字符串和表单字段可以通过传递到函数中的`$args`数组来控制,同时你也可以选择使用{@see ‘comment_form_default_fields’}过滤器来修改默认字段数组,如果你只想添加一个新字段或删除一个字段。所有字段也会单独通过{@see ‘comment_form_field_$name’}过滤器,其中`$name’是字段数组中使用的键。

语法:

comment_form($args = array(), $post = null)

88. number_format_i18n()

将浮点数转换为基于当地语言的格式

这个函数根据当前地区的千位分隔符和小数点的约定来格式化一个数字。它被用来确保不同语言和地区的数字格式的一致性。

语法:

number_format_i18n($number, $decimals = 0)

89.get_header()

加载标题模板

这个函数用来检索当前WordPress主题的标题模板文件。头部模板文件通常用于显示网站的标志、导航菜单或任何其他应该出现在每个页面顶部的内容。包括一个主题的标题模板,如果指定了一个名称,那么将包括一个专门的标题。对于参数,如果文件被称为”header-special.php”,那么指定”special”。

语法:

get_header($name = null, $args = array())

90.the_posts_pagination()

在适用的情况下,显示一个分页导航

用于显示当前查询的分页链接。它可用于为用户提供轻松的导航以阅读上一组或下一组文章,并允许自定义分页输出。

语法:

the_posts_pagination($args = array())

91. register_nav_menus()

注册一个主题的导航菜单位置

这个函数是用来为一个WordPress主题注册多个导航菜单的。它接收一个菜单位置的关联数组作为参数,并将它们添加到WordPress管理面板中的可用菜单位置。

语法:

register_nav_menus($locations = array())

92. wp_die()

终止 WordPress 执行并显示带有错误消息的 HTML 页面。

这个函数用来显示错误信息并退出WordPress中当前的PHP脚本执行。它可以用来处理WordPress网站中的致命错误或其他意外状况。这个函数是对`die()`PHP函数的补充。不同的是,HTML将被显示给用户。建议只在执行不应继续下去的时候使用这个函数。不建议经常调用这个函数,而应该尽可能多地处理错误,默默地或更优雅地处理。

语法:

wp_die($message = '', $title = '', $args = array())

93. wp_reset_postdata()

在循环一个单独的查询之后,这个函数将 $post 全局恢复到主查询中的当前文章。

这个函数重置了全局变量$post,并恢复了原来的文章数据。它被用在一个自定义的WP_Query循环之后,以恢复原始的查询。

语法:

wp_reset_postdata()

94. load_theme_textdomain()

加载主题的翻译字符串

用于加载一个主题的翻译文件。你可以使用这个函数来翻译你的主题的模板文件和其他PHP代码中的字符串。如果当前的locale在主题的根目录下以.mo文件的形式存在,它将被$domain包含在翻译后的字符串中。.mo文件必须完全根据locale来命名。

语法:

load_theme_textdomain($domain, $path = false)

95. get_queried_object_id()

检索当前被查询对象的 ID。

用于检索当前被查询对象的ID: 这个函数返回当前被查询对象的ID,比如说一个文章、术语或用户的ID。

语法:

get_queried_object_id()

96. esc_url_raw()

对数据库或重定向使用的URL进行净化

这个函数用来转义一个URL,用于查询字符串参数。这个函数是sanitize_url()的一个别名。

语法:

esc_url_raw($url, $protocols = null)

97.the_archive_title()

显示基于查询对象的档案标题

语法:

the_archive_title($before = '', $after = '')

98. add_image_size()

注册新的图像尺寸

这个函数用于在WordPress中添加一个新的自定义图片尺寸: 该函数有四个参数:图片尺寸名称,宽度,高度,以及图片是否应该被裁剪。

语法:

add_image_size($name, $width = 0, $height = 0, $crop = false)

99. get_theme_file_uri()

检索主题中一个文件的URL

这个函数返回当前主题目录中一个给定文件的URI。该URI是相对于主题目录的。

语法:

get_theme_file_uri($file = '')

100. get_stylesheet_uri()

检索当前主题样式表的 URI。

这个函数可以检索到当前主题的样式表文件的URL。它不接受任何参数,并以字符串的形式返回URL。样式表的文件名是’style.css’,它被附加到样式表目录URI路径上。

语法:

get_stylesheet_uri()

要查看更多函数及钩子用法,请前往WP开发宝典

]]>
https://www.askme-121.pw/100-wordpress-function/feed/ 1