云策 WordPress 开发者社区

函数文档

permalink_anchor()

查看官方原文 ↗
💡 云策文档标注

概述

permalink_anchor() 函数用于显示当前文章的固定链接锚点，支持基于标题或ID生成HTML 'id' 属性。

关键要点

  • 函数生成一个HTML锚点链接，用于文章内部导航。
  • 接受可选参数 $mode，默认为 'id'，可选 'title' 或 'id'。
  • 在 'title' 模式下，使用文章标题的 sanitize_title() 版本和ID组合作为 'id' 属性。
  • 在 'id' 模式下，使用 'post-' 加文章ID作为 'id' 属性。

代码示例

permalink_anchor( $type );

注意事项

  • 函数直接输出HTML，无返回值。
  • 依赖 get_post() 获取当前文章数据。
  • 使用 sanitize_title() 确保标题在URL中安全。
📄 原文内容

Displays the permalink anchor for the current post.

Description

The permalink mode title will use the post title for the ‘a’ element ‘id’ attribute. The id mode uses ‘post-‘ with the post ID for the ‘id’ attribute.

Parameters

$modestringoptional
Permalink mode. Accepts 'title' or 'id'. Default 'id'.

More Information

Usage:
permalink_anchor( $type );

Source

function permalink_anchor( $mode = 'id' ) {
	$post = get_post();
	switch ( strtolower( $mode ) ) {
		case 'title':
			$title = sanitize_title( $post->post_title ) . '-' . $post->ID;
			echo '<a id="' . $title . '"></a>';
			break;
		case 'id':
		default:
			echo '<a id="post-' . $post->ID . '"></a>';
			break;
	}
}

View all references View on Trac View on GitHub

Uses Description
sanitize_title()wp-includes/formatting.php

Sanitizes a string into a slug, which can be used in URLs or HTML attributes.
get_post()wp-includes/post.php

Retrieves post data given a post ID or post object.

Changelog

Version Description
0.71 Introduced.

User Contributed Notes