函数文档

show_message()

💡 云策文档标注

概述

show_message() 函数用于在 WordPress 后台显示给定的管理消息。它接受字符串或 WP_Error 对象作为参数,并处理错误消息的输出。

关键要点

  • 函数接受一个必需参数 $message,可以是字符串或 WP_Error 对象。
  • 如果 $message 是 WP_Error 对象,函数会提取错误消息,并可能包含错误数据。
  • 函数输出消息后,会调用 wp_ob_end_flush_all() 和 flush() 来刷新输出缓冲区。
  • 该函数自 WordPress 2.1.0 版本引入。

代码示例

function show_message( $message ) {
    if ( is_wp_error( $message ) ) {
        if ( $message->get_error_data() && is_string( $message->get_error_data() ) ) {
            $message = $message->get_error_message() . ': ' . $message->get_error_data();
        } else {
            $message = $message->get_error_message();
        }
    }

    echo "$messagen";
    wp_ob_end_flush_all();
    flush();
}

注意事项

  • 函数主要用于后台管理界面,如升级过程中显示消息。
  • 相关函数包括 wp_ob_end_flush_all() 和 is_wp_error()。
  • 被 WP_Upgrader_Skin::feedback() 等函数调用。

📄 原文内容

Displays the given administration message.

Parameters

$messagestring|WP_Errorrequired

Source

function show_message( $message ) {
	if ( is_wp_error( $message ) ) {
		if ( $message->get_error_data() && is_string( $message->get_error_data() ) ) {
			$message = $message->get_error_message() . ': ' . $message->get_error_data();
		} else {
			$message = $message->get_error_message();
		}
	}

	echo "<p>$message</p>n";
	wp_ob_end_flush_all();
	flush();
}

Changelog

Version Description
2.1.0 Introduced.