<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.1//EN"
"http://www.w3.org/TR/xhtml11/DTD/xhtml11.dtd">
<html xmlns="http://www.w3.org/1999/xhtml">
<head><meta http-equiv="content-type" content="text/html; charset=utf-8" /><style type="text/css"><!--
#msg dl { border: 1px #006 solid; background: #369; padding: 6px; color: #fff; }
#msg dt { float: left; width: 6em; font-weight: bold; }
#msg dt:after { content:':';}
#msg dl, #msg dt, #msg ul, #msg li, #header, #footer { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; }
#msg dl a { font-weight: bold}
#msg dl a:link { color:#fc3; }
#msg dl a:active { color:#ff0; }
#msg dl a:visited { color:#cc6; }
h3 { font-family: verdana,arial,helvetica,sans-serif; font-size: 10pt; font-weight: bold; }
#msg pre { overflow: auto; background: #ffc; border: 1px #fc0 solid; padding: 6px; }
#msg ul, pre { overflow: auto; }
#header, #footer { color: #fff; background: #636; border: 1px #300 solid; padding: 6px; }
#patch { width: 100%; }
#patch h4 {font-family: verdana,arial,helvetica,sans-serif;font-size:10pt;padding:8px;background:#369;color:#fff;margin:0;}
#patch .propset h4, #patch .binary h4 {margin:0;}
#patch pre {padding:0;line-height:1.2em;margin:0;}
#patch .diff {width:100%;background:#eee;padding: 0 0 10px 0;overflow:auto;}
#patch .propset .diff, #patch .binary .diff {padding:10px 0;}
#patch span {display:block;padding:0 10px;}
#patch .modfile, #patch .addfile, #patch .delfile, #patch .propset, #patch .binary, #patch .copfile {border:1px solid #ccc;margin:10px 0;}
#patch ins {background:#dfd;text-decoration:none;display:block;padding:0 10px;}
#patch del {background:#fdd;text-decoration:none;display:block;padding:0 10px;}
#patch .lines, .info {color:#888;background:#fff;}
--></style>
<title>[14634] trunk/wp-admin/includes/template.php:
Add phpDoc for convert_to_screen() and get_column_headers().</title>
</head>
<body>
<div id="msg">
<dl>
<dt>Revision</dt> <dd><a href="http://trac.wordpress.org/changeset/14634">14634</a></dd>
<dt>Author</dt> <dd>westi</dd>
<dt>Date</dt> <dd>2010-05-14 15:47:14 +0000 (Fri, 14 May 2010)</dd>
</dl>
<h3>Log Message</h3>
<pre>Add phpDoc for convert_to_screen() and get_column_headers().</pre>
<h3>Modified Paths</h3>
<ul>
<li><a href="#trunkwpadminincludestemplatephp">trunk/wp-admin/includes/template.php</a></li>
</ul>
</div>
<div id="patch">
<h3>Diff</h3>
<a id="trunkwpadminincludestemplatephp"></a>
<div class="modfile"><h4>Modified: trunk/wp-admin/includes/template.php (14633 => 14634)</h4>
<pre class="diff"><span>
<span class="info">--- trunk/wp-admin/includes/template.php 2010-05-14 15:03:59 UTC (rev 14633)
+++ trunk/wp-admin/includes/template.php 2010-05-14 15:47:14 UTC (rev 14634)
</span><span class="lines">@@ -664,12 +664,12 @@
</span><span class="cx"> }
</span><span class="cx">
</span><span class="cx"> /**
</span><del>- * {@internal Missing Short Description}}
</del><ins>+ * Get the column headers for a screen
</ins><span class="cx"> *
</span><span class="cx"> * @since unknown
</span><span class="cx"> *
</span><del>- * @param unknown_type $screen
- * @return unknown
</del><ins>+ * @param string|object $screen The screen you want the headers for
+ * @return array Containing the headers in the format id => UI String
</ins><span class="cx"> */
</span><span class="cx"> function get_column_headers($screen) {
</span><span class="cx"> global $_wp_column_headers;
</span><span class="lines">@@ -3545,7 +3545,12 @@
</span><span class="cx"> }
</span><span class="cx"> }
</span><span class="cx">
</span><del>-// Convert a screen string to a screen object
</del><ins>+/**
+ * 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
+ */
</ins><span class="cx"> function convert_to_screen( $screen ) {
</span><span class="cx"> $screen = str_replace('.php', '', $screen);
</span><span class="cx"> $screen = str_replace('-new', '', $screen);
</span></span></pre>
</div>
</div>
</body>
</html>