Changeset 14752

Timestamp:

05/19/2010 07:11:33 PM (15 years ago)

Author:

ryan

Message:

Meta box and screen option phpdoc and cleanup. Props hakre. fixes #13017

File:

• trunk/wp-admin/includes/template.php (modified) (6 diffs)

trunk/wp-admin/includes/template.php

@@ -2838 +2838 @@
 
 /**
- * {@internal Missing Short Description}}
- *
- * @since unknown
- *
- * @param unknown_type $page
- * @param unknown_type $context
- * @param unknown_type $object
+ * Meta-Box template function
+ *
+ * @since 2.5.0
+ *
+ * @param string $page page identifier, also known as screen identifier
+ * @param string $context box context
+ * @param mixed $object gets passed to the box callback function as first parameter
  * @return int number of meta_boxes
  */
@@ -2851 +2851 @@
     static $already_sorted = false;
 
-    //do_action('do_meta_boxes', $page, $context, $object);
-
     $hidden = get_hidden_meta_boxes($page);
 
-    echo "<div id='$context-sortables' class='meta-box-sortables'>\n";
+    printf('<div id="%s-sortables" class="meta-box-sortables">', htmlspecialchars($context)); 
 
     $i = 0;
@@ -2955 +2953 @@
 }
 
-function get_hidden_meta_boxes($screen) {
-    if ( is_string($screen) )
-        $screen = convert_to_screen($screen);
-
-    $hidden = get_user_option( "metaboxhidden_$screen->id" );
+/**
+ * Get Hidden Meta Boxes
+ *
+ * @since 2.7
+ *
+ * @param string|object $screen Screen identifier
+ * @return array Hidden Meta Boxes
+ */
+function get_hidden_meta_boxes( $screen ) {
+    if ( is_string( $screen ) )
+        $screen = convert_to_screen( $screen );
+
+    $hidden = get_user_option( "metaboxhidden_{$screen->id}" );
 
     // Hide slug boxes by default
-    if ( !is_array($hidden) )
+    if ( !is_array( $hidden ) )
         $hidden = array('slugdiv');
 
@@ -3241 +3247 @@
  * @param unknown_type $page
  */
-function manage_columns_prefs($page) {
-    $columns = get_column_headers($page);
-
-    $hidden = get_hidden_columns($page);
+function manage_columns_prefs( $page ) {
+    $columns = get_column_headers( $page );
+    $hidden  = get_hidden_columns( $page ); 
+    $special = array('_title', 'cb', 'comment', 'media', 'name', 'title', 'username');
 
     foreach ( $columns as $column => $title ) {
         // Can't hide these or they are special
-        if ( '_title' == $column || 'cb' == $column || 'title' == $column || 'name' == $column || 'username' == $column || 'media' == $column || 'comment' == $column )
+        if ( in_array( $column, $special ) )
             continue;
-        if ( empty($title) )
+        if ( empty( $title ) )
             continue;
 
         if ( 'comments' == $column )
-            $title = __('Comments');
+            $title = __( 'Comments' );
         $id = "$column-hide";
         echo '<label for="' . $id . '">';
@@ -3550 +3556 @@
  * Convert a screen string to a screen object
  * 
+ * @since 3.0.0
+ * 
  * @param string $screen The name of the screen
  * @return object An object containing the safe screen name and id
  */
 function convert_to_screen( $screen ) {
-    $screen = str_replace('.php', '', $screen);
-    $screen = str_replace('-new', '', $screen);
-    $screen = str_replace('-add', '', $screen);
-    $screen = apply_filters('screen_meta_screen', $screen);
-
-    $screen = array('id' => $screen, 'base' => $screen);
-    return (object) $screen;
+    $screen = str_replace( array('.php', '-new', '-add' ), '', $screen);
+    $screen = (string) apply_filters( 'screen_meta_screen', $screen );
+    $screen = (object) array('id' => $screen, 'base' => $screen);
+    return $screen;
 }
 
@@ -3596 +3601 @@
             break;
     }
-    if( !empty($settings) )
+    if( ! empty( $settings ) )
         $show_screen = true;
 ?>