//
/**
- * Walker to output an unordered list of category checkbox <input> elements.
+ * Walker to output an unordered list of category checkbox input elements.
+ *
+ * @since 2.5.1
*
* @see Walker
* @see wp_category_checklist()
* @see wp_terms_checklist()
- * @since 2.5.1
*/
class Walker_Category_Checklist extends Walker {
public $tree_type = 'category';
}
/**
- * Output an unordered list of checkbox <input> elements labelled
+ * Output an unordered list of checkbox input elements labelled
* with category names.
*
- * @see wp_terms_checklist()
* @since 2.5.1
*
+ * @todo Properly document optional arguments as such.
+ *
+ * @see wp_terms_checklist()
+ *
* @param int $post_id Mark categories associated with this post as checked. $selected_cats must not be an array.
* @param int $descendants_and_self ID of the category to output along with its descendents.
* @param bool|array $selected_cats List of categories to mark as checked.
}
/**
- * Output an unordered list of checkbox <input> elements labelled
- * with term names. Taxonomy independent version of wp_category_checklist().
+ * Output an unordered list of checkbox input elements labelled with term names.
+ *
+ * Taxonomy independent version of {@see wp_category_checklist()}.
*
* @since 3.0.0
*
- * @param int $post_id
- * @param array $args
+ * @todo Properly document optional default arguments.
+ *
+ * @param int $post_id Post ID.
+ * @param array $args Arguments to form the terms checklist.
*/
function wp_terms_checklist( $post_id = 0, $args = array() ) {
$defaults = array(
* Retrieve a list of the most popular terms from the specified taxonomy.
*
* If the $echo argument is true then the elements for a list of checkbox
- * <input> elements labelled with the names of the selected terms is output.
+ * `<input>` elements labelled with the names of the selected terms is output.
* If the $post_ID global isn't empty then the terms associated with that
* post will be marked as checked.
*
*
* @since 2.5.1
*
- * @param unknown_type $link_id
+ * @param int $link_id
*/
function wp_link_category_checklist( $link_id = 0 ) {
$default = 1;
*
* @since 2.7.0
*
- * @param unknown_type $post
+ * @param WP_Post $post
*/
function get_inline_data($post) {
$post_type_object = get_post_type_object($post->post_type);
*
* @since 2.7.0
*
- * @param unknown_type $position
- * @param unknown_type $checkbox
- * @param unknown_type $mode
+ * @param int $position
+ * @param bool $checkbox
+ * @param string $mode
+ * @param bool $table_row
*/
function wp_comment_reply($position = '1', $checkbox = false, $mode = 'single', $table_row = true) {
*
* @since 1.2.0
*
- * @param unknown_type $meta
+ * @param array $meta
*/
function list_meta( $meta ) {
// Exit if no meta
*
* @since 2.5.0
*
- * @param unknown_type $entry
- * @param unknown_type $count
- * @return unknown
+ * @param array $entry
+ * @param int $count
+ * @return string
*/
function _list_meta_row( $entry, &$count ) {
static $update_nonce = false;
*
* @since 0.71
*
- * @param int|bool $edit Accepts 1|true for editing the date, 0|false for adding the date.
- * @param int|bool $for_post Accepts 1|true for applying the date to a post, 0|false for a comment.
- * @param int|bool $tab_index The tabindex attribute to add. Default 0.
- * @param int|bool $multi Optional. Whether the additional fields and buttons should be added.
+ * @param int $edit Accepts 1|true for editing the date, 0|false for adding the date.
+ * @param int $for_post Accepts 1|true for applying the date to a post, 0|false for a comment.
+ * @param int $tab_index The tabindex attribute to add. Default 0.
+ * @param int $multi Optional. Whether the additional fields and buttons should be added.
* Default 0|false.
*/
function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) {
}
/**
- * Print out <option> HTML elements for the page templates drop-down.
+ * Print out option HTML elements for the page templates drop-down.
*
* @since 1.5.0
*
}
/**
- * Print out <option> HTML elements for the page parents drop-down.
+ * Print out option HTML elements for the page parents drop-down.
*
* @since 1.5.0
*
* @param int $parent Optional. The parent page ID. Default 0.
* @param int $level Optional. Page depth level. Default 0.
*
- * @return void|bool Boolean False if page has no children, otherwise print out html elements
+ * @return null|false Boolean False if page has no children, otherwise print out html elements
*/
function parent_dropdown( $default = 0, $parent = 0, $level = 0 ) {
global $wpdb;
}
/**
- * Print out <option> html elements for role selectors
+ * Print out option html elements for role selectors.
*
* @since 2.1.0
*
*
* @since 2.5.0
*
- * @param string|object $screen Screen identifier
+ * @staticvar bool $already_sorted
+ * @param string|WP_Screen $screen 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
printf('<div id="%s-sortables" class="meta-box-sortables">', htmlspecialchars($context));
- $i = 0;
- do {
- // Grab the ones the user has manually sorted. Pull them out of their previous context/priority and into the one the user chose
- if ( !$already_sorted && $sorted = get_user_option( "meta-box-order_$page" ) ) {
- foreach ( $sorted as $box_context => $ids ) {
- foreach ( explode(',', $ids ) as $id ) {
- if ( $id && 'dashboard_browser_nag' !== $id )
- add_meta_box( $id, null, null, $screen, $box_context, 'sorted' );
+ // Grab the ones the user has manually sorted. Pull them out of their previous context/priority and into the one the user chose
+ if ( ! $already_sorted && $sorted = get_user_option( "meta-box-order_$page" ) ) {
+ foreach ( $sorted as $box_context => $ids ) {
+ foreach ( explode( ',', $ids ) as $id ) {
+ if ( $id && 'dashboard_browser_nag' !== $id ) {
+ add_meta_box( $id, null, null, $screen, $box_context, 'sorted' );
}
}
}
- $already_sorted = true;
+ }
- if ( !isset($wp_meta_boxes) || !isset($wp_meta_boxes[$page]) || !isset($wp_meta_boxes[$page][$context]) )
- break;
+ $already_sorted = true;
- foreach ( array('high', 'sorted', 'core', 'default', 'low') as $priority ) {
- if ( isset($wp_meta_boxes[$page][$context][$priority]) ) {
- foreach ( (array) $wp_meta_boxes[$page][$context][$priority] as $box ) {
+ $i = 0;
+
+ if ( isset( $wp_meta_boxes[ $page ][ $context ] ) ) {
+ foreach ( array( 'high', 'sorted', 'core', 'default', 'low' ) as $priority ) {
+ if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ]) ) {
+ foreach ( (array) $wp_meta_boxes[ $page ][ $context ][ $priority ] as $box ) {
if ( false == $box || ! $box['title'] )
continue;
$i++;
}
}
}
- } while(0);
+ }
echo "</div>";
<?php
$i = 0;
$first_open = false;
- do {
- if ( ! isset( $wp_meta_boxes ) || ! isset( $wp_meta_boxes[$page] ) || ! isset( $wp_meta_boxes[$page][$context] ) )
- break;
+ if ( isset( $wp_meta_boxes[ $page ][ $context ] ) ) {
foreach ( array( 'high', 'core', 'default', 'low' ) as $priority ) {
- if ( isset( $wp_meta_boxes[$page][$context][$priority] ) ) {
- foreach ( $wp_meta_boxes[$page][$context][$priority] as $box ) {
+ if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) {
+ foreach ( $wp_meta_boxes[ $page ][ $context ][ $priority ] as $box ) {
if ( false == $box || ! $box['title'] )
continue;
$i++;
}
}
}
- } while(0);
+ }
?>
</ul><!-- .outer-border -->
</div><!-- .accordion-container -->
* @since 2.7.0
*
* @param string $page Slug title of the admin page who's settings fields you want to show.
- * @param section $section Slug title of the settings section who's fields you want to show.
+ * @param string $section Slug title of the settings section who's fields you want to show.
*/
function do_settings_fields($page, $section) {
global $wp_settings_fields;
*
* @since 3.0.0
*
+ * @todo Properly document optional arguments as such.
+ *
* @global array $wp_settings_errors Storage array of errors registered during this pageload
*
* @param string $setting Slug title of the setting to which this error applies
- * @param string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
- * @param string $message The formatted message text to display to the user (will be shown inside styled <div> and <p>)
- * @param string $type The type of message it is, controls HTML class. Use 'error' or 'updated'.
+ * @param string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
+ * @param string $message The formatted message text to display to the user (will be shown inside styled
+ * `<div>` and `<p>` tags).
+ * @param string $type The type of message it is, controls HTML class. Use 'error' or 'updated'.
*/
function add_settings_error( $setting, $code, $message, $type = 'error' ) {
global $wp_settings_errors;
}
/**
- * Display settings errors registered by add_settings_error()
+ * Display settings errors registered by {@see add_settings_error()}.
*
- * Part of the Settings API. Outputs a <div> for each error retrieved by get_settings_errors().
+ * Part of the Settings API. Outputs a div for each error retrieved by
+ * {@see get_settings_errors()}.
*
- * This is called automatically after a settings page based on the Settings API is submitted.
- * Errors should be added during the validation callback function for a setting defined in register_setting()
+ * This is called automatically after a settings page based on the
+ * Settings API is submitted. Errors should be added during the validation
+ * callback function for a setting defined in {@see register_setting()}
*
- * The $sanitize option is passed into get_settings_errors() and will re-run the setting sanitization
+ * The $sanitize option is passed into {@see get_settings_errors()} and will
+ * re-run the setting sanitization
* on its current value.
*
- * The $hide_on_update option will cause errors to only show when the settings page is first loaded.
- * if the user has already saved new values it will be hidden to avoid repeating messages already
- * shown in the default error reporting after submission. This is useful to show general errors like missing
- * settings when the user arrives at the settings page.
+ * The $hide_on_update option will cause errors to only show when the settings
+ * page is first loaded. if the user has already saved new values it will be
+ * hidden to avoid repeating messages already shown in the default error
+ * reporting after submission. This is useful to show general errors like
+ * missing settings when the user arrives at the settings page.
*
* @since 3.0.0
*
*
* @since 2.7.0
*
- * @param unknown_type $found_action
+ * @param string $found_action
*/
function find_posts_div($found_action = '') {
?>
* The password is passed through {@link esc_attr()} to ensure that it
* is safe for placing in an html attribute.
*
- * @uses attr
* @since 2.7.0
*/
function the_post_password() {
$title = get_the_title( $post );
if ( empty( $title ) )
$title = __( '(no title)' );
- return $title;
+ return esc_html( $title );
}
/**
* A simple wrapper to display the "s" parameter in a GET URI. This function
* should only be used when {@link the_search_query()} cannot.
*
- * @uses attr
* @since 2.7.0
*
*/
?>
</head>
-<?php /** This filter is documented in wp-admin/admin-header.php */ ?>
-<body<?php if ( isset($GLOBALS['body_id']) ) echo ' id="' . $GLOBALS['body_id'] . '"'; ?> class="wp-admin wp-core-ui no-js iframe <?php echo apply_filters( 'admin_body_class', '' ) . ' ' . $admin_body_class; ?>">
+<?php
+/** This filter is documented in wp-admin/admin-header.php */
+$admin_body_classes = apply_filters( 'admin_body_class', '' );
+?>
+<body<?php if ( isset($GLOBALS['body_id']) ) echo ' id="' . $GLOBALS['body_id'] . '"'; ?> class="wp-admin wp-core-ui no-js iframe <?php echo $admin_body_classes . ' ' . $admin_body_class; ?>">
<script type="text/javascript">
//<![CDATA[
(function(){
function iframe_footer() {
/*
* We're going to hide any footer output on iFrame pages,
- * but run the hooks anyway since they output Javascript
+ * but run the hooks anyway since they output JavaScript
* or other needed content.
*/
?>
if ( $is_IE )
@header('X-UA-Compatible: IE=edge');
-/**
- * Fires inside the HTML tag in the admin header.
- *
- * @since 2.2.0
- */
?>
<!DOCTYPE html>
<!--[if IE 8]>
-<html xmlns="http://www.w3.org/1999/xhtml" class="ie8 <?php echo $admin_html_class; ?>" <?php do_action( 'admin_xml_ns' ); ?> <?php language_attributes(); ?>>
+<html xmlns="http://www.w3.org/1999/xhtml" class="ie8 <?php echo $admin_html_class; ?>" <?php
+ /**
+ * Fires inside the HTML tag in the admin header.
+ *
+ * @since 2.2.0
+ */
+ do_action( 'admin_xml_ns' );
+?> <?php language_attributes(); ?>>
<![endif]-->
<!--[if !(IE 8) ]><!-->
-<?php /** This action is documented in wp-admin/includes/template.php */ ?>
-<html xmlns="http://www.w3.org/1999/xhtml" class="<?php echo $admin_html_class; ?>" <?php do_action( 'admin_xml_ns' ); ?> <?php language_attributes(); ?>>
+<html xmlns="http://www.w3.org/1999/xhtml" class="<?php echo $admin_html_class; ?>" <?php
+ /** This action is documented in wp-admin/includes/template.php */
+ do_action( 'admin_xml_ns' );
+?> <?php language_attributes(); ?>>
<!--<![endif]-->
<head>
<meta http-equiv="Content-Type" content="<?php bloginfo('html_type'); ?>; charset=<?php echo get_option('blog_charset'); ?>" />
*/
$registered_pointers = array(
- 'post-new.php' => 'wp350_media',
- 'post.php' => array( 'wp350_media', 'wp360_revisions' ),
+ 'post-new.php' => 'wp410_dfw',
+ 'post.php' => 'wp410_dfw',
'edit.php' => 'wp360_locks',
'widgets.php' => 'wp390_widgets',
'themes.php' => 'wp390_widgets',
$pointers = (array) $registered_pointers[ $hook_suffix ];
$caps_required = array(
- 'wp350_media' => array( 'upload_files' ),
'wp390_widgets' => array( 'edit_theme_options' ),
);
}
/**
- * Print the pointer javascript data.
+ * Print the pointer JavaScript data.
*
* @since 3.3.0
*
<script type="text/javascript">
//<![CDATA[
(function($){
- var options = <?php echo json_encode( $args ); ?>, setup;
+ var options = <?php echo wp_json_encode( $args ); ?>, setup;
if ( ! options )
return;
public static function pointer_wp330_saving_widgets() {}
public static function pointer_wp340_customize_current_theme_link() {}
public static function pointer_wp340_choose_image_from_library() {}
-
- public static function pointer_wp350_media() {
- $content = '<h3>' . __( 'New Media Manager' ) . '</h3>';
- $content .= '<p>' . __( 'Uploading files and creating image galleries has a whole new look. Check it out!' ) . '</p>';
-
- self::print_js( 'wp350_media', '.insert-media', array(
- 'content' => $content,
- 'position' => array( 'edge' => is_rtl() ? 'right' : 'left', 'align' => 'center' ),
- ) );
- }
-
- public static function pointer_wp360_revisions() {
- $content = '<h3>' . __( 'Compare Revisions' ) . '</h3>';
- $content .= '<p>' . __( 'View, compare, and restore other versions of this content on the improved revisions screen.' ) . '</p>';
-
- self::print_js( 'wp360_revisions', '.misc-pub-section.misc-pub-revisions', array(
- 'content' => $content,
- 'position' => array( 'edge' => is_rtl() ? 'left' : 'right', 'align' => 'center' ),
- ) );
- }
+ public static function pointer_wp350_media() {}
+ public static function pointer_wp360_revisions() {}
public static function pointer_wp360_locks() {
if ( ! is_multi_author() ) {
}
$content = '<h3>' . __( 'New Feature: Live Widget Previews' ) . '</h3>';
- $content .= '<p>' . __( 'Add, edit, and play around with your widgets from the theme customizer.' ) . ' ' . __( 'Preview your changes in real-time and only save them when you’re ready.' ) . '</p>';
+ $content .= '<p>' . __( 'Add, edit, and play around with your widgets from the Customizer.' ) . ' ' . __( 'Preview your changes in real-time and only save them when you’re ready.' ) . '</p>';
if ( 'themes' === get_current_screen()->id ) {
$selector = '.theme.active .customize';
$position = array( 'edge' => is_rtl() ? 'right' : 'left', 'align' => 'center' );
} else {
- $selector = 'a[href="customize.php"]';
+ $selector = 'a[href^="customize.php"]';
if ( is_rtl() ) {
$position = array( 'edge' => 'right', 'align' => 'center', 'my' => 'right-5px' );
} else {
) );
}
+ public static function pointer_wp410_dfw() {
+ // Don't show when editor-scrolling is not used.
+ if ( empty( $GLOBALS['_wp_editor_expand'] ) ) {
+ return;
+ }
+
+ $content = '<h3>' . __( 'Distraction-Free Writing' ) . '</h3>';
+ $content .= '<p>' . __( 'Enable distraction-free writing mode, and everything surrounding the editor will fade away when you start typing. Move your mouse out of the editor to reveal everything again.' ) . '</p>';
+
+ if ( is_rtl() ) {
+ $position = array( 'edge' => 'left', 'align' => 'center', 'my' => 'left+40 top-11', 'at' => 'left top' );
+ } else {
+ $position = array( 'edge' => 'right', 'align' => 'center', 'my' => 'right-40 top-11', 'at' => 'right top' );
+ }
+
+ self::print_js( 'wp410_dfw', '#wp-content-wrap', array(
+ 'content' => $content,
+ 'position' => $position,
+ ) );
+ }
+
/**
* Prevents new users from seeing existing 'new feature' pointers.
*
* @since 3.3.0
*/
public static function dismiss_pointers_for_new_users( $user_id ) {
- add_user_meta( $user_id, 'dismissed_wp_pointers', 'wp350_media,wp360_revisions,wp360_locks,wp390_widgets' );
+ add_user_meta( $user_id, 'dismissed_wp_pointers', 'wp360_locks,wp390_widgets' );
}
}
*/
function _local_storage_notice() {
?>
- <div id="local-storage-notice" class="hidden">
+ <div id="local-storage-notice" class="hidden notice">
<p class="local-restore">
<?php _e('The backup of this post in your browser is different from the version below.'); ?>
<a class="restore-backup" href="#"><?php _e('Restore the backup.'); ?></a>