Docs: Add more complete information to DocBlocks for private core functions _wp_dashboard_control_callback() and _wp_dashboard_recent_comments_row().

See #32246.


git-svn-id: https://develop.svn.wordpress.org/trunk@36474 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes 2016-02-03 20:19:31 +00:00
parent 5572e1d4f4
commit 9f52463206

View File

@ -169,9 +169,13 @@ function wp_add_dashboard_widget( $widget_id, $widget_name, $callback, $control_
}
/**
* Outputs controls for the current dashboard widget.
*
* @param type $dashboard
* @param type $meta_box
* @access private
* @since 2.7.0
*
* @param mixed $dashboard
* @param array $meta_box
*/
function _wp_dashboard_control_callback( $dashboard, $meta_box ) {
echo '<form method="post" class="dashboard-widget-control-form">';
@ -566,10 +570,15 @@ function wp_dashboard_recent_drafts( $drafts = false ) {
}
/**
* Outputs a row for the Recent Comments widget.
*
* @access private
* @since 2.7.0
*
* @global WP_Comment $comment
*
* @param WP_Comment $comment
* @param bool $show_date
* @param WP_Comment $comment The current comment.
* @param bool $show_date Optional. Whether to display the date.
*/
function _wp_dashboard_recent_comments_row( &$comment, $show_date = true ) {
$GLOBALS['comment'] = clone $comment;