Add phpDoc for convert_to_screen() and get_column_headers().

git-svn-id: http://svn.automattic.com/wordpress/trunk@14634 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
westi 2010-05-14 15:47:14 +00:00
parent 518b19a404
commit 30128f636e
1 changed files with 9 additions and 4 deletions

View File

@ -664,12 +664,12 @@ function wp_manage_pages_columns() {
} }
/** /**
* {@internal Missing Short Description}} * Get the column headers for a screen
* *
* @since unknown * @since unknown
* *
* @param unknown_type $screen * @param string|object $screen The screen you want the headers for
* @return unknown * @return array Containing the headers in the format id => UI String
*/ */
function get_column_headers($screen) { function get_column_headers($screen) {
global $_wp_column_headers; global $_wp_column_headers;
@ -3545,7 +3545,12 @@ function _post_states($post) {
} }
} }
// Convert a screen string to a screen object /**
* Convert a screen string to a screen object
*
* @param string $screen The name of the screen
* @return object An object containing the safe screen name and id
*/
function convert_to_screen( $screen ) { function convert_to_screen( $screen ) {
$screen = str_replace('.php', '', $screen); $screen = str_replace('.php', '', $screen);
$screen = str_replace('-new', '', $screen); $screen = str_replace('-new', '', $screen);