函数文档

previous_posts()

💡 云策文档标注

概述

previous_posts() 函数用于显示或检索上一页文章链接,通过参数控制输出方式。

关键要点

  • 参数 $display 为布尔值,可选,默认为 true,决定是否直接输出链接。
  • 当 $display = false 时,函数返回链接字符串;否则直接输出。
  • 函数内部调用 get_previous_posts_page_link() 获取链接,并使用 esc_url() 进行安全处理。

代码示例

function previous_posts( $display = true ) {
    $output = esc_url( get_previous_posts_page_link() );

    if ( $display ) {
        echo $output;
    } else {
        return $output;
    }
}

注意事项

  • 函数自 WordPress 0.71 版本引入,属于核心功能。
  • 相关函数包括 get_previous_posts_page_link() 和 esc_url(),用于链接获取和 URL 清理。
  • 被 get_previous_posts_link() 使用,用于检索上一页文章链接。

📄 原文内容

Displays or retrieves the previous posts page link.

Parameters

$displaybooloptional
Whether to echo the link.

Default:true

Return

string|void The previous posts page link if $display = false.

Source

function previous_posts( $display = true ) {
	$output = esc_url( get_previous_posts_page_link() );

	if ( $display ) {
		echo $output;
	} else {
		return $output;
	}
}

Changelog

Version Description
0.71 Introduced.