2023-09-03

第八批模板标签的Tuts+指南


第八批模板标签的Tuts+指南

在本系列的第八部分中,我们浏览了第七批 WordPress 模板标签。在第九部分中,我们将浏览最后一批近 200 个模板标签。在整个教程中,我们将看到有关书签的模板标签以及其他“杂项”模板标签。

有关书签的警告:从 WordPress 3.5 开始,“书签”默认在管理面板中隐藏。要使用书签,您需要安装链接管理器插件。

获取并显示书签列表:wp_list_bookmarks()

此模板标记返回或回显书签列表,这是 WordPress 的一项旧功能。

参数

此模板标记仅接受一个参数:

  • $args (可选—数组)

    以下参数的数组:

    • 'orderby'(字符串):如何排序书签。接受“名称”、“link_id”、“url”、“目标”、“描述”、“所有者”(添加书签的用户)、“评级”、“更新”(更新日期)、“rel”(XFN)书签关系)、’notes’、’rss’、’length’(书签名称长度)、’rand’(随机)。

      (默认:’name’)

    • 'order'(字符串):是否按升序(’ASC’)或降序(’DESC’)排序项目。

      (默认:’ASC’)

    • 'limit'(整数):要显示的项目数。

      (默认:-1 表示所有书签)

    • 'category'(字符串):以逗号分隔的类别 ID,从中获取项目。

      (默认值:’ ‘ 表示所有类别)

    • 'exclude_category'(字符串):要排除的书签类别 ID。

      (默认:’ ‘)

    • 'category_name'(字符串):显示书签的类别名称(覆盖’category’)。

      (默认:”)

    • 'hide_invisible'(整数):是否隐藏不可见链接或显示它们。

      (默认:1)

    • 'show_updated'(整数):是否显示最后更新的时间戳。

      (默认:0)

    • 'echo'(整数):是否回显输出(1)或返回它(0)。

      (默认:1)

    • 'categorize'(整数):是否按类别对书签进行分组(1)或不按类别(0)。

      (默认:1)

    • 'title_li'(字符串):使用

    • 标记包装输出,并在书签列表之前显示标题。您可能希望将其设置为空字符串并禁用换行。

      (默认:“书签”)

    • 'title_before'(字符串):在每个标题之前添加的 HTML 代码。

      (默认:’

      ‘)

    • 'title_after'(字符串):在每个标题后添加的 HTML 代码。

      (默认:”)

    • 'class'(字符串):添加到每个类别的 CSS 类名称。

      (默认:’linkcat’)

    • 'category_before'(字符串):在每个类别之前添加的 HTML 代码。

      (默认:’

    • ‘)
    • 'category_after'(字符串):在每个类别之后添加的 HTML 代码。

      (默认:’

    • ‘)

  • 'category_orderby'(字符串):如何对类别进行排序。接受“name”、“id”、“slug”和“count”。

    (默认:“name”)

  • 'category_order'(字符串):是否按升序(’ASC’)或降序(’DESC’)对类别进行排序。

    (默认:’ASC’)

用法

<?php

$args = array(
    
    // Random order.
    'orderby' => 'rand',
    
    // Take just 5 bookmarks.
    'limit' => 5,
    
    // Take bookmarks from a specific category.
    'category_name' => 'Friends',
    
    // Don't echo.
    'echo' => 0,
    
    // Custom class.
    'class' => 'friends-bookmark-list'
    
);

$bookmarks_list = wp_list_bookmarks( $args );

?>
登录后复制

获取所有书签的数组:get_bookmarks()

此模板标记返回 WordPress 书签的数组。

参数

此模板标记仅接受一个参数:

  • $args (可选—数组)

    以下参数的数组:

    • 'orderby'(字符串):如何对链接进行排序。接受“名称”、“ID”、“标题”、“日期”等帖子字段。

      (默认:“名称”)

    • 'order'(字符串):是否按升序(’ASC’)或降序(’DESC’)排序项目。

      (默认:’ASC’)

    • 'limit'(整数):要显示的项目数。

      (默认值:-1 表示全部)

    • 'category'(字符串):以逗号分隔的类别 ID,从中获取项目。

      (默认:空)

    • 'category_name'(字符串):从中获取项目的类别名称。

      (默认:空)

    • 'hide_invisible'(整数或布尔值):是否显示或隐藏标记为“不可见”的链接。

      (默认:1|TRUE

    • 'show_updated'(整数或布尔值):是否显示书签上次更新时间。

      (默认:0|FALSE

    • 'include'(字符串):要包含的以逗号分隔的 ID 列表。

      (默认:空)

    • 'exclude'(字符串):要排除的 ID 的逗号分隔列表。

      (默认:空)

用法

<?php

$args = array(
    'orderby' => 'title',
    'order' => 'ASC',
    'limit' => 15,
    'hide_invisible' => false,
    'exclude' => '12,16,23'
);

$bookmarks_array =  get_bookmarks( $args );

?>
登录后复制

获取书签数据:get_bookmark()

此模板标记返回给定书签的所有数据。

参数

此模板标记接受三个参数:

  • $bookmark (必需 – 混合)

    书签 ID 或对象。

    (默认:NULL >

  • $output (可选 – 字符串)

    OBJECT、ARRAY_N 或 ARRAY_A 常量。

    (默认:OBJECT

  • $filter (可选—字符串)

    是否转义输出。如果您想过滤输出,请将其设置为“display”。

    (默认:“raw”)

用法

<?php

// Getting a specific bookmark's fields with escaping the output.
$bookmark_data( 19, OBJECT, 'display' );

?>
登录后复制

获取单个书签字段的数据:get_bookmark_field()

此模板标记可让您获取单个书签字段的数据。

参数

此模板标记接受三个参数:

  • $field (必填—字符串)

    字段名称。

    (默认:NULL

  • $bookmark (必需 — 整数)

    书签 ID。

    (默认:NULL

  • $context (可选—字符串)

    如何过滤字段值—“raw”、“edit”、“attribute”、“js”、“db” ‘,或’显示’。

    (默认:’显示’)

用法

<?php

// Get the bookmark with the id 16 and escape & echo its title.
echo get_bookmark_field( 'title', 16, 'display' );

?>
登录后复制

获取并显示“编辑书签”链接:get_edit_bookmark_link() & edit_bookmark_link()

这些模板标签可让您获取或回显“编辑此书签”链接以在模板中使用。

参数

get_edit_bookmark_link() 只接受一个参数:

  • $bookmark_id (必需 – 整数)

    书签的 ID。

    (默认:0)

edit_bookmark_link() 接受四个参数:

  • $text (可选—字符串)

    显示链接的文本。

    (默认:“编辑此”) EM>

  • $before (可选—字符串)

    在输出之前显示的文本或 HTML 代码。

    (默认:空)

  • $after (可选—字符串)

    输出后显示的文本或 HTML 代码。

    (默认:空)

  • $bookmark_id (必需 – 整数)

    书签的 ID。

    (默认:NULL >

用法

<?php

// Retrieve the current bookmark's "edit bookmark" link.
$edit_bookmark_link = get_edit_bookmark_link();

// Retrieve a specific bookmark's "edit bookmark" link.
$edit_bookmark_link = get_edit_bookmark_link( 98 );

// Display the current bookmark's "edit bookmark" link.
edit_bookmark_link( __( 'Edit', 'translation-domain' ), '<strong>', '</strong>' );

// Display a specific bookmark's "edit bookmark" link.
edit_bookmark_link( __( 'Edit', 'translation-domain' ), '', '', 98 );

?>
登录后复制

获取并显示您网站的信息:get_bloginfo() & bloginfo()

这些非常流行的模板标签返回并显示您网站的一般信息。

参数

get_bloginfo() 接受两个参数:

  • $show (可选—字符串)

    要获取的信息位。以下值之一:

    • 'url'(字符串):主页 URL。
    • 'wpurl'(字符串):安装 WordPress 的 URL。
    • 'description'(字符串):站点描述。
    • 'rdf_url'(字符串):RDF/RSS 1.0 提要 URL。
    • 'rss_url'(字符串):RSS 0.92 提要 URL。
    • 'rss2_url'(字符串):RSS 2.0 提要 URL。
    • 'atom_url'(字符串):Atom 提要 URL。
    • 'comments_rss2_url'(字符串):评论的 RSS 2.0 提要 URL。
    • 'comments_atom_url'(字符串):评论的 Atom 提要 URL。
    • 'pingback_url'(字符串):pingback XML-RPC 文件的 URL。
    • 'stylesheet_url'(字符串):主题主 CSS 文件的 URL。
    • 'stylesheet_directory'(字符串):主题主 CSS 文件目录的 URL。
    • 'template_directory''template_url' (字符串):活动主题目录的 URL。
    • 'admin_email'(字符串):安装WordPress时输入的电子邮件地址。
    • 'charset'(字符串):站点的字符集。
    • 'html_type'(字符串):WordPress HTML 页面的内容类型。
    • 'version'(字符串):WordPress 版本。
    • 'language'(字符串):WordPress 安装的语言。
    • 'text_direction'(字符串):语言的文本方向。
    • 'name'(字符串):站点名称。

    (默认:’名称’)

  • $filter (可选—字符串)

    将其设置为 'filter' 以过滤从此模板标记返回的 URL。

    (默认:’原始’)

bloginfo() 只接受一个参数:

  • $show (可选—字符串)

    与上面相同的详细信息。

    (默认:’blogname’)

用法

<?php

// Display the name of the site.
bloginfo();

// Get the stylesheet url.
$stylesheet = get_bloginfo( 'stylesheet_url' );

// Display the WordPress version.
bloginfo( 'version' );

?>
登录后复制

获取并显示自动 类:get_body_class() & body_class()

这些非常流行的模板标签生成语义类并让我们回显或返回它们。他们还让我们添加额外的类名。

参数

两个模板标签只接受一个参数:

  • $class (可选 – 字符串或数组)

    要添加的额外 CSS 类名称。

    (默认:空) EM>

用法

<?php

// Display the body class.
body_class();

// Retrieve the body class with an extra class.
$body_class = get_body_class( 'mytheme-body' );

?>
登录后复制

获取并显示导航菜单:wp_nav_menu()

此模板标签返回或显示导航菜单,这是 WordPress 的核心功能。您可能会在 2013 年或以后发布的所有新 WordPress 主题中看到此模板标签。

参数

此模板标记仅接受一个参数:

  • $args (可选—数组)

    以下参数的数组:

    • 'menu'(字符串):菜单的 ID、slug 或名称。

      (默认:空)

    • 'menu_class'(字符串):菜单的 UL 元素的 CSS 类。

      (默认:’menu’)

    • 'menu_id'(字符串):菜单的 UL 元素的 ID。

      (默认:菜单slug,递增)

    • 'container' (string): 是否包裹UL,以及用什么包裹它。

      (默认:DIV

    • 'container_class'(字符串):包装元素的 CSS 类。

      (默认:’menu-{menu slug}-container’)

    • 'container_id'(字符串):包装元素的 ID。

      (默认:空)

    • 'fallback_cb' (回调或布尔值):菜单不存在时运行的后备函数的名称。设置为 false 则不进行回退。

      (默认:'wp_page_menu'

    • 'before'(字符串):链接文本之前的文本。

      (默认:空)

    • 'after'(字符串):链接文本后的文本。

      (默认:空)

    • 'link_before'(字符串):链接之前的文本。

      (默认:空)

    • 'link_after'(字符串):链接后的文本。

      (默认:空)

    • 'echo' (boolean): 是否回显模板标签。

      (默认: TRUE)

    • 'depth'(整数):要包含多少级层次结构。

      (默认:0,表示所有级别)

    • 'walker'(对象):自定义 walker 类的实例。

      (默认:空)

    • 'theme_location'(字符串):要使用的主题位置。必须使用 register_nav_menu() 注册才能被用户选择。

      (默认:空)

    • 'items_wrap'(字符串):列表项应如何包装。

      (默认:

        %3$s

      )

用法

<?php

$args = array(
    'container_id' => 'primary-nav',
    'link_before' => '<i class="icon-link"></i>',
    'theme_location' => 'primary'
);

wp_nav_menu( $args );

?>
登录后复制

获取并显示页面标题:wp_title()

此模板标记返回或回显您页面的页面标题。

参数

此模板标记接受三个参数:

  • $sep (可选 — 字符串)

    用作分隔符的文本。

    (默认值:’»’ )

  • $echo (可选—布尔值)

    是否回显(TRUE)或返回(FALSE)标签。

    (默认:TRUE

  • $seplocation (可选—字符串)

    分隔符的位置和面包屑的方向。将其设置为“right”以反转面包屑。

    (默认:空)

用法

<?php

wp_title( ' - ', true );

// Reverse the separator location to use left-hand indicators.
$page_title = wp_title( ' &laquo ', false, 'right' );

?>
登录后复制

获取并显示主页 URL:get_home_url() & home_url()

这些模板标签仅返回主页 URL。

参数

get_home_url() 接受三个参数:

  • $blog_id (可选—整数)

    博客的 ID。

    (默认:NULL >

  • $path (可选—字符串)

    附加到 URL 的可选路径。

    (默认:空) >

  • $scheme (可选—字符串)

    提供主页 URL 上下文的方案(“http”、“https”或“相对”)。

    (默认:NULL

并且 home_url() 接受两个参数:

  • $path (可选—字符串)

    附加到 URL 的可选路径。

    (默认:空) >

  • $scheme (可选—字符串)

    提供主页 URL 上下文的方案(“http”、“https”或“相对”)。

    (默认:NULL

不要将这两个函数误认为“一个返回输出,另一个显示它”——我知道我就是这么做的。区别有点奇怪: get_home_url() 函数返回特定博客的主页 URL,而 home_url() 函数返回当前站点.请记住:它们都没有回应任何内容!

用法

<?php

// Getting a specific blog's home url with https.
$home_url_of_petes_blog = get_home_url( 2, '', 'https' );

// Echoes the current home url with a little addition.
echo home_url( '?rel=navlink' );

?>
登录后复制

获取并显示站点 URL:get_site_url() & site_url()

这些模板标签获取并回显“站点 URL”,即安装 WordPress 的地址。

参数

get_site_url() 接受三个参数:

  • $blog_id (可选 – 整数)

    博客的 ID。

    (默认:当前站点)

  • $path (可选—字符串)

    附加到 URL 的可选路径。

    (默认:空) >

  • $scheme (可选—字符串)

    提供主页 URL 上下文的方案(“http”、“https”或“相对”)。

    (默认:正常或安全连接,取决于is_ssl()

并且 site_url() 接受两个参数:

  • $path (可选—字符串)

    附加到 URL 的可选路径。

    (默认:空) >

  • $scheme (可选—字符串)

    提供主页 URL 上下文的方案(“http”、“https”或“相对”)。

    (默认:正常或安全连接,取决于is_ssl()

home_url()get_home_url() 一样,不要将这两个函数误认为“一个返回输出,另一个显示输出”。 get_site_url() 函数返回特定博客的站点 URL,而 site_url() 函数返回当前站点的站点 URL。请记住:它们都没有回应任何内容!

用法

<?php

// Getting a specific blog's site url with https.
$site_url_of_janes_blog = get_site_url( 3, '', 'https' );

// Echoes the current site url.
echo site_url();

?>
登录后复制

获取当前站点的 ID:get_current_blog_id()

此模板标记仅返回多站点网络中当前站点的 ID。

参数

此模板标记不接受任何参数。

用法

<?php

get_current_blog_id();

?>
登录后复制

获取并显示管理面板的 URL:get_admin_url() & admin_url()

这些模板标签返回并显示您网站仪表板的 URL。

参数

get_admin_url() 接受三个参数:

  • $blog_id (可选 – 整数)

    博客的 ID。

    (默认:当前站点)

  • $path (可选—字符串)

    附加到 URL 的可选路径。

    (默认:空) >

  • $scheme (可选 – 字符串)

    要使用的方案。 “admin”遵循定义的方案(使用 is_ssl() 函数),但您可以通过设置此参数来覆盖它。接受“http”、“https”、“admin”、“rpc”、“login”和“login_post”。

    (默认:“admin”)

并且 admin_url() 接受两个参数:

  • $path (可选—字符串)

    附加到 URL 的可选路径。

    (默认:空) >

  • $scheme (可选 – 字符串)

    要使用的方案。 “admin”遵循定义的方案(使用 is_ssl() 函数),但您可以通过将此参数设置为“http”或“https”来覆盖它。

    (默认值:“管理员’)

用法

<?php

// Get the dashboard url of the current blog.
$admin_url = get_admin_url();

// Display the admin url and force a secure connection.
admin_url( '', 'https' );

?>
登录后复制

获取并显示 Feed 类型的固定链接:get_feed_link() & the_feed_link()

这些模板标记返回并输出提要的永久链接。

参数

get_feed_link() 只接受一个参数:

  • $feed_type (可选 — 字符串)

    提要类型。

    (默认:默认提要类型)

并且 the_feed_link() 接受两个参数:

  • $anchor (必需 — 字符串)

    链接显示的文本。

    (默认:NULL) EM>

  • $feed_type (可选 — 字符串)

    提要类型。

    (默认:默认提要类型)

用法

<?php

// Get default feed type's link.
get_feed_link();

// Display a link for the "atom" feed.
the_feed_link( __( 'Atom Feed', 'translation-domain' ), 'atom' );

?>
登录后复制

使字符串结尾有或没有尾部斜杠:user_trailingslashit()

此模板标记检查您的永久链接结构,并在给定 URL 末尾添加尾部斜杠或删除现有的尾部斜杠。

参数

此模板标记接受两个参数:

  • $string (必需 — 字符串)

    带或不带尾部斜杠的 URL。

    (默认:NULL

  • $type_of_url (已弃用 – 字符串)

    这在技术上并没有被弃用,但它没有在函数中使用,因此它没有任何效果。

用法

<?php

$url_to_fix = user_trailingslashit( get_home_url() . 'some-special-page' );

?>
登录后复制

获取自本周开始以来的天数:calendar_week_mod()

这个奇怪的模板标签获取自一周开始以来的天数。它基本上是一个“模运算”。

老实说,我不知道如何使用它或为什么使用它。如果您知道为什么存在此模板标签,请发表评论以告知我和我们的读者!

参数

此模板标记仅接受一个参数:

  • $number (必需 – 整数)

    自本周开始以来的天数。

    (默认值:0) >

用法

<?php

// Umm...
echo calendar_week_mod( 199 );

// Right? (it echoes "3" by the way).

?>
登录后复制

获取并显示日历:get_calendar()

还记得我们曾经放在博客侧边栏中的那些日历吗?此模板标记正是这样做的:它返回或显示日历。

参数

此模板标记接受两个参数:

  • $initial (可选 – 布尔值)

    使用初始日历名称 (TRUE) 或不使用 (FALSE)。

    (默认:TRUE

  • $echo (可选—布尔值)

    是否回显(TRUE)或返回(FALSE)输出。

    (默认:TRUE

用法

<?php

// Return the calendar.
$my_calendar = get_calendar( true, false );

// Display the calendar. 
get_calendar();

?>
登录后复制

结论

希望您喜欢最后一批模板标签。在下一部分,即系列结局中,我们将回顾我们所学到的内容并结束该系列。

如果您有任何问题、意见或更正,您可以在评论部分与我们分享您的想法。如果您喜欢这篇文章,请不要忘记与您的朋友分享!

以上就是第八批模板标签的Tuts+指南的详细内容,更多请关注php中文网其它相关文章!

https://www.php.cn/faq/601499.html

发表回复

Your email address will not be published. Required fields are marked *