3 * Template WordPress Administration API.
5 * A Big Mess. Also some neat functions that are nicely written.
8 * @subpackage Administration
11 /** Walker_Category_Checklist class */
12 require_once( ABSPATH . 'wp-admin/includes/class-walker-category-checklist.php' );
14 /** WP_Internal_Pointers class */
15 require_once( ABSPATH . 'wp-admin/includes/class-wp-internal-pointers.php' );
18 // Category Checklists
22 * Output an unordered list of checkbox input elements labeled with category names.
26 * @see wp_terms_checklist()
28 * @param int $post_id Optional. Post to generate a categories checklist for. Default 0.
29 * $selected_cats must not be an array. Default 0.
30 * @param int $descendants_and_self Optional. ID of the category to output along with its descendants.
32 * @param array $selected_cats Optional. List of categories to mark as checked. Default false.
33 * @param array $popular_cats Optional. List of categories to receive the "popular-category" class.
35 * @param object $walker Optional. Walker object to use to build the output.
36 * Default is a Walker_Category_Checklist instance.
37 * @param bool $checked_ontop Optional. Whether to move checked items out of the hierarchy and to
38 * the top of the list. Default true.
40 function wp_category_checklist( $post_id = 0, $descendants_and_self = 0, $selected_cats = false, $popular_cats = false, $walker = null, $checked_ontop = true ) {
41 wp_terms_checklist( $post_id, array(
42 'taxonomy' => 'category',
43 'descendants_and_self' => $descendants_and_self,
44 'selected_cats' => $selected_cats,
45 'popular_cats' => $popular_cats,
47 'checked_ontop' => $checked_ontop
52 * Output an unordered list of checkbox input elements labelled with term names.
54 * Taxonomy-independent version of wp_category_checklist().
57 * @since 4.4.0 Introduced the `$echo` argument.
59 * @param int $post_id Optional. Post ID. Default 0.
60 * @param array|string $args {
61 * Optional. Array or string of arguments for generating a terms checklist. Default empty array.
63 * @type int $descendants_and_self ID of the category to output along with its descendants.
65 * @type array $selected_cats List of categories to mark as checked. Default false.
66 * @type array $popular_cats List of categories to receive the "popular-category" class.
68 * @type object $walker Walker object to use to build the output.
69 * Default is a Walker_Category_Checklist instance.
70 * @type string $taxonomy Taxonomy to generate the checklist for. Default 'category'.
71 * @type bool $checked_ontop Whether to move checked items out of the hierarchy and to
72 * the top of the list. Default true.
73 * @type bool $echo Whether to echo the generated markup. False to return the markup instead
74 * of echoing it. Default true.
77 function wp_terms_checklist( $post_id = 0, $args = array() ) {
79 'descendants_and_self' => 0,
80 'selected_cats' => false,
81 'popular_cats' => false,
83 'taxonomy' => 'category',
84 'checked_ontop' => true,
89 * Filter the taxonomy terms checklist arguments.
93 * @see wp_terms_checklist()
95 * @param array $args An array of arguments.
96 * @param int $post_id The post ID.
98 $params = apply_filters( 'wp_terms_checklist_args', $args, $post_id );
100 $r = wp_parse_args( $params, $defaults );
102 if ( empty( $r['walker'] ) || ! ( $r['walker'] instanceof Walker ) ) {
103 $walker = new Walker_Category_Checklist;
105 $walker = $r['walker'];
108 $taxonomy = $r['taxonomy'];
109 $descendants_and_self = (int) $r['descendants_and_self'];
111 $args = array( 'taxonomy' => $taxonomy );
113 $tax = get_taxonomy( $taxonomy );
114 $args['disabled'] = ! current_user_can( $tax->cap->assign_terms );
116 $args['list_only'] = ! empty( $r['list_only'] );
118 if ( is_array( $r['selected_cats'] ) ) {
119 $args['selected_cats'] = $r['selected_cats'];
120 } elseif ( $post_id ) {
121 $args['selected_cats'] = wp_get_object_terms( $post_id, $taxonomy, array_merge( $args, array( 'fields' => 'ids' ) ) );
123 $args['selected_cats'] = array();
125 if ( is_array( $r['popular_cats'] ) ) {
126 $args['popular_cats'] = $r['popular_cats'];
128 $args['popular_cats'] = get_terms( $taxonomy, array(
130 'orderby' => 'count',
133 'hierarchical' => false
136 if ( $descendants_and_self ) {
137 $categories = (array) get_terms( $taxonomy, array(
138 'child_of' => $descendants_and_self,
142 $self = get_term( $descendants_and_self, $taxonomy );
143 array_unshift( $categories, $self );
145 $categories = (array) get_terms( $taxonomy, array( 'get' => 'all' ) );
150 if ( $r['checked_ontop'] ) {
151 // Post process $categories rather than adding an exclude to the get_terms() query to keep the query the same across all posts (for any query cache)
152 $checked_categories = array();
153 $keys = array_keys( $categories );
155 foreach ( $keys as $k ) {
156 if ( in_array( $categories[$k]->term_id, $args['selected_cats'] ) ) {
157 $checked_categories[] = $categories[$k];
158 unset( $categories[$k] );
162 // Put checked cats on top
163 $output .= call_user_func_array( array( $walker, 'walk' ), array( $checked_categories, 0, $args ) );
165 // Then the rest of them
166 $output .= call_user_func_array( array( $walker, 'walk' ), array( $categories, 0, $args ) );
176 * Retrieve a list of the most popular terms from the specified taxonomy.
178 * If the $echo argument is true then the elements for a list of checkbox
179 * `<input>` elements labelled with the names of the selected terms is output.
180 * If the $post_ID global isn't empty then the terms associated with that
181 * post will be marked as checked.
185 * @param string $taxonomy Taxonomy to retrieve terms from.
186 * @param int $default Not used.
187 * @param int $number Number of terms to retrieve. Defaults to 10.
188 * @param bool $echo Optionally output the list as well. Defaults to true.
189 * @return array List of popular term IDs.
191 function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $echo = true ) {
194 if ( $post && $post->ID )
195 $checked_terms = wp_get_object_terms($post->ID, $taxonomy, array('fields'=>'ids'));
197 $checked_terms = array();
199 $terms = get_terms( $taxonomy, array( 'orderby' => 'count', 'order' => 'DESC', 'number' => $number, 'hierarchical' => false ) );
201 $tax = get_taxonomy($taxonomy);
203 $popular_ids = array();
204 foreach ( (array) $terms as $term ) {
205 $popular_ids[] = $term->term_id;
206 if ( !$echo ) // hack for AJAX use
208 $id = "popular-$taxonomy-$term->term_id";
209 $checked = in_array( $term->term_id, $checked_terms ) ? 'checked="checked"' : '';
212 <li id="<?php echo $id; ?>" class="popular-category">
213 <label class="selectit">
214 <input id="in-<?php echo $id; ?>" type="checkbox" <?php echo $checked; ?> value="<?php echo (int) $term->term_id; ?>" <?php disabled( ! current_user_can( $tax->cap->assign_terms ) ); ?> />
216 /** This filter is documented in wp-includes/category-template.php */
217 echo esc_html( apply_filters( 'the_category', $term->name ) );
228 * Outputs a link category checklist element.
232 * @param int $link_id
234 function wp_link_category_checklist( $link_id = 0 ) {
237 $checked_categories = array();
240 $checked_categories = wp_get_link_cats( $link_id );
241 // No selected categories, strange
242 if ( ! count( $checked_categories ) ) {
243 $checked_categories[] = $default;
246 $checked_categories[] = $default;
249 $categories = get_terms( 'link_category', array( 'orderby' => 'name', 'hide_empty' => 0 ) );
251 if ( empty( $categories ) )
254 foreach ( $categories as $category ) {
255 $cat_id = $category->term_id;
257 /** This filter is documented in wp-includes/category-template.php */
258 $name = esc_html( apply_filters( 'the_category', $category->name ) );
259 $checked = in_array( $cat_id, $checked_categories ) ? ' checked="checked"' : '';
260 echo '<li id="link-category-', $cat_id, '"><label for="in-link-category-', $cat_id, '" class="selectit"><input value="', $cat_id, '" type="checkbox" name="link_category[]" id="in-link-category-', $cat_id, '"', $checked, '/> ', $name, "</label></li>";
265 * Adds hidden fields with the data for use in the inline editor for posts and pages.
269 * @param WP_Post $post Post object.
271 function get_inline_data($post) {
272 $post_type_object = get_post_type_object($post->post_type);
273 if ( ! current_user_can( 'edit_post', $post->ID ) )
276 $title = esc_textarea( trim( $post->post_title ) );
278 /** This filter is documented in wp-admin/edit-tag-form.php */
280 <div class="hidden" id="inline_' . $post->ID . '">
281 <div class="post_title">' . $title . '</div>' .
282 /** This filter is documented in wp-admin/edit-tag-form.php */
283 '<div class="post_name">' . apply_filters( 'editable_slug', $post->post_name, $post ) . '</div>
284 <div class="post_author">' . $post->post_author . '</div>
285 <div class="comment_status">' . esc_html( $post->comment_status ) . '</div>
286 <div class="ping_status">' . esc_html( $post->ping_status ) . '</div>
287 <div class="_status">' . esc_html( $post->post_status ) . '</div>
288 <div class="jj">' . mysql2date( 'd', $post->post_date, false ) . '</div>
289 <div class="mm">' . mysql2date( 'm', $post->post_date, false ) . '</div>
290 <div class="aa">' . mysql2date( 'Y', $post->post_date, false ) . '</div>
291 <div class="hh">' . mysql2date( 'H', $post->post_date, false ) . '</div>
292 <div class="mn">' . mysql2date( 'i', $post->post_date, false ) . '</div>
293 <div class="ss">' . mysql2date( 's', $post->post_date, false ) . '</div>
294 <div class="post_password">' . esc_html( $post->post_password ) . '</div>';
296 if ( $post_type_object->hierarchical )
297 echo '<div class="post_parent">' . $post->post_parent . '</div>';
299 if ( $post->post_type == 'page' )
300 echo '<div class="page_template">' . esc_html( get_post_meta( $post->ID, '_wp_page_template', true ) ) . '</div>';
302 if ( post_type_supports( $post->post_type, 'page-attributes' ) )
303 echo '<div class="menu_order">' . $post->menu_order . '</div>';
305 $taxonomy_names = get_object_taxonomies( $post->post_type );
306 foreach ( $taxonomy_names as $taxonomy_name) {
307 $taxonomy = get_taxonomy( $taxonomy_name );
309 if ( $taxonomy->hierarchical && $taxonomy->show_ui ) {
311 $terms = get_object_term_cache( $post->ID, $taxonomy_name );
312 if ( false === $terms ) {
313 $terms = wp_get_object_terms( $post->ID, $taxonomy_name );
314 wp_cache_add( $post->ID, $terms, $taxonomy_name . '_relationships' );
316 $term_ids = empty( $terms ) ? array() : wp_list_pluck( $terms, 'term_id' );
318 echo '<div class="post_category" id="' . $taxonomy_name . '_' . $post->ID . '">' . implode( ',', $term_ids ) . '</div>';
320 } elseif ( $taxonomy->show_ui ) {
322 $terms_to_edit = get_terms_to_edit( $post->ID, $taxonomy_name );
323 if ( ! is_string( $terms_to_edit ) ) {
327 echo '<div class="tags_input" id="'.$taxonomy_name.'_'.$post->ID.'">'
328 . esc_html( str_replace( ',', ', ', $terms_to_edit ) ) . '</div>';
333 if ( !$post_type_object->hierarchical )
334 echo '<div class="sticky">' . (is_sticky($post->ID) ? 'sticky' : '') . '</div>';
336 if ( post_type_supports( $post->post_type, 'post-formats' ) )
337 echo '<div class="post_format">' . esc_html( get_post_format( $post->ID ) ) . '</div>';
343 * Outputs the in-line comment reply-to form in the Comments list table.
347 * @global WP_List_Table $wp_list_table
349 * @param int $position
350 * @param bool $checkbox
351 * @param string $mode
352 * @param bool $table_row
354 function wp_comment_reply( $position = 1, $checkbox = false, $mode = 'single', $table_row = true ) {
355 global $wp_list_table;
357 * Filter the in-line comment reply-to form output in the Comments
360 * Returning a non-empty value here will short-circuit display
361 * of the in-line comment-reply form in the Comments list table,
362 * echoing the returned value instead.
366 * @see wp_comment_reply()
368 * @param string $content The reply-to form content.
369 * @param array $args An array of default args.
371 $content = apply_filters( 'wp_comment_reply', '', array( 'position' => $position, 'checkbox' => $checkbox, 'mode' => $mode ) );
373 if ( ! empty($content) ) {
378 if ( ! $wp_list_table ) {
379 if ( $mode == 'single' ) {
380 $wp_list_table = _get_list_table('WP_Post_Comments_List_Table');
382 $wp_list_table = _get_list_table('WP_Comments_List_Table');
388 <?php if ( $table_row ) : ?>
389 <table style="display:none;"><tbody id="com-reply"><tr id="replyrow" class="inline-edit-row" style="display:none;"><td colspan="<?php echo $wp_list_table->get_column_count(); ?>" class="colspanchange">
391 <div id="com-reply" style="display:none;"><div id="replyrow" style="display:none;">
393 <fieldset class="comment-reply">
395 <span class="hidden" id="editlegend"><?php _e( 'Edit Comment' ); ?></span>
396 <span class="hidden" id="replyhead"><?php _e( 'Reply to Comment' ); ?></span>
397 <span class="hidden" id="addhead"><?php _e( 'Add new Comment' ); ?></span>
400 <div id="replycontainer">
401 <label for="replycontent" class="screen-reader-text"><?php _e( 'Comment' ); ?></label>
403 $quicktags_settings = array( 'buttons' => 'strong,em,link,block,del,ins,img,ul,ol,li,code,close' );
404 wp_editor( '', 'replycontent', array( 'media_buttons' => false, 'tinymce' => false, 'quicktags' => $quicktags_settings ) );
408 <div id="edithead" style="display:none;">
410 <label for="author-name"><?php _e( 'Name' ) ?></label>
411 <input type="text" name="newcomment_author" size="50" value="" id="author-name" />
415 <label for="author-email"><?php _e('Email') ?></label>
416 <input type="text" name="newcomment_author_email" size="50" value="" id="author-email" />
420 <label for="author-url"><?php _e('URL') ?></label>
421 <input type="text" id="author-url" name="newcomment_author_url" class="code" size="103" value="" />
425 <p id="replysubmit" class="submit">
426 <a href="#comments-form" class="save button-primary alignright">
427 <span id="addbtn" style="display:none;"><?php _e('Add Comment'); ?></span>
428 <span id="savebtn" style="display:none;"><?php _e('Update Comment'); ?></span>
429 <span id="replybtn" style="display:none;"><?php _e('Submit Reply'); ?></span></a>
430 <a href="#comments-form" class="cancel button-secondary alignleft"><?php _e('Cancel'); ?></a>
431 <span class="waiting spinner"></span>
432 <span class="error" style="display:none;"></span>
435 <input type="hidden" name="action" id="action" value="" />
436 <input type="hidden" name="comment_ID" id="comment_ID" value="" />
437 <input type="hidden" name="comment_post_ID" id="comment_post_ID" value="" />
438 <input type="hidden" name="status" id="status" value="" />
439 <input type="hidden" name="position" id="position" value="<?php echo $position; ?>" />
440 <input type="hidden" name="checkbox" id="checkbox" value="<?php echo $checkbox ? 1 : 0; ?>" />
441 <input type="hidden" name="mode" id="mode" value="<?php echo esc_attr($mode); ?>" />
443 wp_nonce_field( 'replyto-comment', '_ajax_nonce-replyto-comment', false );
444 if ( current_user_can( 'unfiltered_html' ) )
445 wp_nonce_field( 'unfiltered-html-comment', '_wp_unfiltered_html_comment', false );
448 <?php if ( $table_row ) : ?>
449 </td></tr></tbody></table>
458 * Output 'undo move to trash' text for comments
462 function wp_comment_trashnotice() {
464 <div class="hidden" id="trash-undo-holder">
465 <div class="trash-undo-inside"><?php printf(__('Comment by %s moved to the trash.'), '<strong></strong>'); ?> <span class="undo untrash"><a href="#"><?php _e('Undo'); ?></a></span></div>
467 <div class="hidden" id="spam-undo-holder">
468 <div class="spam-undo-inside"><?php printf(__('Comment by %s marked as spam.'), '<strong></strong>'); ?> <span class="undo unspam"><a href="#"><?php _e('Undo'); ?></a></span></div>
474 * Outputs a post's public meta data in the Custom Fields meta box.
480 function list_meta( $meta ) {
484 <table id="list-table" style="display: none;">
487 <th class="left">' . _x( 'Name', 'meta name' ) . '</th>
488 <th>' . __( 'Value' ) . '</th>
491 <tbody id="the-list" data-wp-lists="list:meta">
494 </table>'; //TBODY needed for list-manipulation JS
499 <table id="list-table">
502 <th class="left"><?php _ex( 'Name', 'meta name' ) ?></th>
503 <th><?php _e( 'Value' ) ?></th>
506 <tbody id='the-list' data-wp-lists='list:meta'>
508 foreach ( $meta as $entry )
509 echo _list_meta_row( $entry, $count );
517 * Outputs a single row of public meta data in the Custom Fields meta box.
521 * @staticvar string $update_nonce
523 * @param array $entry
527 function _list_meta_row( $entry, &$count ) {
528 static $update_nonce = '';
530 if ( is_protected_meta( $entry['meta_key'], 'post' ) )
533 if ( ! $update_nonce )
534 $update_nonce = wp_create_nonce( 'add-meta' );
539 if ( is_serialized( $entry['meta_value'] ) ) {
540 if ( is_serialized_string( $entry['meta_value'] ) ) {
541 // This is a serialized string, so we should display it.
542 $entry['meta_value'] = maybe_unserialize( $entry['meta_value'] );
544 // This is a serialized array/object so we should NOT display it.
550 $entry['meta_key'] = esc_attr($entry['meta_key']);
551 $entry['meta_value'] = esc_textarea( $entry['meta_value'] ); // using a <textarea />
552 $entry['meta_id'] = (int) $entry['meta_id'];
554 $delete_nonce = wp_create_nonce( 'delete-meta_' . $entry['meta_id'] );
556 $r .= "\n\t<tr id='meta-{$entry['meta_id']}'>";
557 $r .= "\n\t\t<td class='left'><label class='screen-reader-text' for='meta-{$entry['meta_id']}-key'>" . __( 'Key' ) . "</label><input name='meta[{$entry['meta_id']}][key]' id='meta-{$entry['meta_id']}-key' type='text' size='20' value='{$entry['meta_key']}' />";
559 $r .= "\n\t\t<div class='submit'>";
560 $r .= get_submit_button( __( 'Delete' ), 'deletemeta small', "deletemeta[{$entry['meta_id']}]", false, array( 'data-wp-lists' => "delete:the-list:meta-{$entry['meta_id']}::_ajax_nonce=$delete_nonce" ) );
562 $r .= get_submit_button( __( 'Update' ), 'updatemeta small', "meta-{$entry['meta_id']}-submit", false, array( 'data-wp-lists' => "add:the-list:meta-{$entry['meta_id']}::_ajax_nonce-add-meta=$update_nonce" ) );
564 $r .= wp_nonce_field( 'change-meta', '_ajax_nonce', false, false );
567 $r .= "\n\t\t<td><label class='screen-reader-text' for='meta-{$entry['meta_id']}-value'>" . __( 'Value' ) . "</label><textarea name='meta[{$entry['meta_id']}][value]' id='meta-{$entry['meta_id']}-value' rows='2' cols='30'>{$entry['meta_value']}</textarea></td>\n\t</tr>";
572 * Prints the form in the Custom Fields meta box.
576 * @global wpdb $wpdb WordPress database abstraction object.
578 * @param WP_Post $post Optional. The post being edited.
580 function meta_form( $post = null ) {
582 $post = get_post( $post );
585 * Filter values for the meta key dropdown in the Custom Fields meta box.
587 * Returning a non-null value will effectively short-circuit and avoid a
588 * potentially expensive query against postmeta.
592 * @param array|null $keys Pre-defined meta keys to be used in place of a postmeta query. Default null.
593 * @param WP_Post $post The current post object.
595 $keys = apply_filters( 'postmeta_form_keys', null, $post );
597 if ( null === $keys ) {
599 * Filter the number of custom fields to retrieve for the drop-down
600 * in the Custom Fields meta box.
604 * @param int $limit Number of custom fields to retrieve. Default 30.
606 $limit = apply_filters( 'postmeta_form_limit', 30 );
607 $sql = "SELECT DISTINCT meta_key
609 WHERE meta_key NOT BETWEEN '_' AND '_z'
610 HAVING meta_key NOT LIKE %s
613 $keys = $wpdb->get_col( $wpdb->prepare( $sql, $wpdb->esc_like( '_' ) . '%', $limit ) );
617 natcasesort( $keys );
618 $meta_key_input_id = 'metakeyselect';
620 $meta_key_input_id = 'metakeyinput';
623 <p><strong><?php _e( 'Add New Custom Field:' ) ?></strong></p>
627 <th class="left"><label for="<?php echo $meta_key_input_id; ?>"><?php _ex( 'Name', 'meta name' ) ?></label></th>
628 <th><label for="metavalue"><?php _e( 'Value' ) ?></label></th>
634 <td id="newmetaleft" class="left">
635 <?php if ( $keys ) { ?>
636 <select id="metakeyselect" name="metakeyselect">
637 <option value="#NONE#"><?php _e( '— Select —' ); ?></option>
640 foreach ( $keys as $key ) {
641 if ( is_protected_meta( $key, 'post' ) || ! current_user_can( 'add_post_meta', $post->ID, $key ) )
643 echo "\n<option value='" . esc_attr($key) . "'>" . esc_html($key) . "</option>";
647 <input class="hide-if-js" type="text" id="metakeyinput" name="metakeyinput" value="" />
648 <a href="#postcustomstuff" class="hide-if-no-js" onclick="jQuery('#metakeyinput, #metakeyselect, #enternew, #cancelnew').toggle();return false;">
649 <span id="enternew"><?php _e('Enter new'); ?></span>
650 <span id="cancelnew" class="hidden"><?php _e('Cancel'); ?></span></a>
652 <input type="text" id="metakeyinput" name="metakeyinput" value="" />
655 <td><textarea id="metavalue" name="metavalue" rows="2" cols="25"></textarea></td>
660 <?php submit_button( __( 'Add Custom Field' ), 'secondary', 'addmeta', false, array( 'id' => 'newmeta-submit', 'data-wp-lists' => 'add:the-list:newmeta' ) ); ?>
662 <?php wp_nonce_field( 'add-meta', '_ajax_nonce-add-meta', false ); ?>
671 * Print out HTML form date elements for editing post or comment publish date.
674 * @since 4.4.0 Converted to use get_comment() instead of the global `$comment`.
676 * @global WP_Locale $wp_locale
678 * @param int|bool $edit Accepts 1|true for editing the date, 0|false for adding the date.
679 * @param int|bool $for_post Accepts 1|true for applying the date to a post, 0|false for a comment.
680 * @param int $tab_index The tabindex attribute to add. Default 0.
681 * @param int|bool $multi Optional. Whether the additional fields and buttons should be added.
684 function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) {
689 $edit = ! ( in_array($post->post_status, array('draft', 'pending') ) && (!$post->post_date_gmt || '0000-00-00 00:00:00' == $post->post_date_gmt ) );
691 $tab_index_attribute = '';
692 if ( (int) $tab_index > 0 )
693 $tab_index_attribute = " tabindex=\"$tab_index\"";
695 // todo: Remove this?
696 // echo '<label for="timestamp" style="display: block;"><input type="checkbox" class="checkbox" name="edit_date" value="1" id="timestamp"'.$tab_index_attribute.' /> '.__( 'Edit timestamp' ).'</label><br />';
698 $time_adj = current_time('timestamp');
699 $post_date = ($for_post) ? $post->post_date : get_comment()->comment_date;
700 $jj = ($edit) ? mysql2date( 'd', $post_date, false ) : gmdate( 'd', $time_adj );
701 $mm = ($edit) ? mysql2date( 'm', $post_date, false ) : gmdate( 'm', $time_adj );
702 $aa = ($edit) ? mysql2date( 'Y', $post_date, false ) : gmdate( 'Y', $time_adj );
703 $hh = ($edit) ? mysql2date( 'H', $post_date, false ) : gmdate( 'H', $time_adj );
704 $mn = ($edit) ? mysql2date( 'i', $post_date, false ) : gmdate( 'i', $time_adj );
705 $ss = ($edit) ? mysql2date( 's', $post_date, false ) : gmdate( 's', $time_adj );
707 $cur_jj = gmdate( 'd', $time_adj );
708 $cur_mm = gmdate( 'm', $time_adj );
709 $cur_aa = gmdate( 'Y', $time_adj );
710 $cur_hh = gmdate( 'H', $time_adj );
711 $cur_mn = gmdate( 'i', $time_adj );
713 $month = '<label><span class="screen-reader-text">' . __( 'Month' ) . '</span><select ' . ( $multi ? '' : 'id="mm" ' ) . 'name="mm"' . $tab_index_attribute . ">\n";
714 for ( $i = 1; $i < 13; $i = $i +1 ) {
715 $monthnum = zeroise($i, 2);
716 $monthtext = $wp_locale->get_month_abbrev( $wp_locale->get_month( $i ) );
717 $month .= "\t\t\t" . '<option value="' . $monthnum . '" data-text="' . $monthtext . '" ' . selected( $monthnum, $mm, false ) . '>';
718 /* translators: 1: month number (01, 02, etc.), 2: month abbreviation */
719 $month .= sprintf( __( '%1$s-%2$s' ), $monthnum, $monthtext ) . "</option>\n";
721 $month .= '</select></label>';
723 $day = '<label><span class="screen-reader-text">' . __( 'Day' ) . '</span><input type="text" ' . ( $multi ? '' : 'id="jj" ' ) . 'name="jj" value="' . $jj . '" size="2" maxlength="2"' . $tab_index_attribute . ' autocomplete="off" /></label>';
724 $year = '<label><span class="screen-reader-text">' . __( 'Year' ) . '</span><input type="text" ' . ( $multi ? '' : 'id="aa" ' ) . 'name="aa" value="' . $aa . '" size="4" maxlength="4"' . $tab_index_attribute . ' autocomplete="off" /></label>';
725 $hour = '<label><span class="screen-reader-text">' . __( 'Hour' ) . '</span><input type="text" ' . ( $multi ? '' : 'id="hh" ' ) . 'name="hh" value="' . $hh . '" size="2" maxlength="2"' . $tab_index_attribute . ' autocomplete="off" /></label>';
726 $minute = '<label><span class="screen-reader-text">' . __( 'Minute' ) . '</span><input type="text" ' . ( $multi ? '' : 'id="mn" ' ) . 'name="mn" value="' . $mn . '" size="2" maxlength="2"' . $tab_index_attribute . ' autocomplete="off" /></label>';
728 echo '<div class="timestamp-wrap">';
729 /* translators: 1: month, 2: day, 3: year, 4: hour, 5: minute */
730 printf( __( '%1$s %2$s, %3$s @ %4$s:%5$s' ), $month, $day, $year, $hour, $minute );
732 echo '</div><input type="hidden" id="ss" name="ss" value="' . $ss . '" />';
734 if ( $multi ) return;
738 'mm' => array( $mm, $cur_mm ),
739 'jj' => array( $jj, $cur_jj ),
740 'aa' => array( $aa, $cur_aa ),
741 'hh' => array( $hh, $cur_hh ),
742 'mn' => array( $mn, $cur_mn ),
744 foreach ( $map as $timeunit => $value ) {
745 list( $unit, $curr ) = $value;
747 echo '<input type="hidden" id="hidden_' . $timeunit . '" name="hidden_' . $timeunit . '" value="' . $unit . '" />' . "\n";
748 $cur_timeunit = 'cur_' . $timeunit;
749 echo '<input type="hidden" id="' . $cur_timeunit . '" name="' . $cur_timeunit . '" value="' . $curr . '" />' . "\n";
754 <a href="#edit_timestamp" class="save-timestamp hide-if-no-js button"><?php _e('OK'); ?></a>
755 <a href="#edit_timestamp" class="cancel-timestamp hide-if-no-js button-cancel"><?php _e('Cancel'); ?></a>
761 * Print out option HTML elements for the page templates drop-down.
765 * @param string $default Optional. The template file name. Default empty.
767 function page_template_dropdown( $default = '' ) {
768 $templates = get_page_templates( get_post() );
770 foreach ( array_keys( $templates ) as $template ) {
771 $selected = selected( $default, $templates[ $template ], false );
772 echo "\n\t<option value='" . $templates[ $template ] . "' $selected>$template</option>";
777 * Print out option HTML elements for the page parents drop-down.
780 * @since 4.4.0 `$post` argument was added.
782 * @global wpdb $wpdb WordPress database abstraction object.
784 * @param int $default Optional. The default page ID to be pre-selected. Default 0.
785 * @param int $parent Optional. The parent page ID. Default 0.
786 * @param int $level Optional. Page depth level. Default 0.
787 * @param int|WP_Post $post Post ID or WP_Post object.
789 * @return null|false Boolean False if page has no children, otherwise print out html elements
791 function parent_dropdown( $default = 0, $parent = 0, $level = 0, $post = null ) {
793 $post = get_post( $post );
794 $items = $wpdb->get_results( $wpdb->prepare("SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' ORDER BY menu_order", $parent) );
797 foreach ( $items as $item ) {
798 // A page cannot be its own parent.
799 if ( $post && $post->ID && $item->ID == $post->ID )
802 $pad = str_repeat( ' ', $level * 3 );
803 $selected = selected( $default, $item->ID, false );
805 echo "\n\t<option class='level-$level' value='$item->ID' $selected>$pad " . esc_html($item->post_title) . "</option>";
806 parent_dropdown( $default, $item->ID, $level +1 );
814 * Print out option html elements for role selectors.
818 * @param string $selected Slug for the role that should be already selected.
820 function wp_dropdown_roles( $selected = '' ) {
824 $editable_roles = array_reverse( get_editable_roles() );
826 foreach ( $editable_roles as $role => $details ) {
827 $name = translate_user_role($details['name'] );
828 if ( $selected == $role ) // preselect specified role
829 $p = "\n\t<option selected='selected' value='" . esc_attr($role) . "'>$name</option>";
831 $r .= "\n\t<option value='" . esc_attr($role) . "'>$name</option>";
837 * Outputs the form used by the importers to accept the data to be imported
841 * @param string $action The action attribute for the form.
843 function wp_import_upload_form( $action ) {
846 * Filter the maximum allowed upload size for import files.
850 * @see wp_max_upload_size()
852 * @param int $max_upload_size Allowed upload size. Default 1 MB.
854 $bytes = apply_filters( 'import_upload_size_limit', wp_max_upload_size() );
855 $size = size_format( $bytes );
856 $upload_dir = wp_upload_dir();
857 if ( ! empty( $upload_dir['error'] ) ) :
858 ?><div class="error"><p><?php _e('Before you can upload your import file, you will need to fix the following error:'); ?></p>
859 <p><strong><?php echo $upload_dir['error']; ?></strong></p></div><?php
862 <form enctype="multipart/form-data" id="import-upload-form" method="post" class="wp-upload-form" action="<?php echo esc_url( wp_nonce_url( $action, 'import-upload' ) ); ?>">
864 <label for="upload"><?php _e( 'Choose a file from your computer:' ); ?></label> (<?php printf( __('Maximum size: %s' ), $size ); ?>)
865 <input type="file" id="upload" name="import" size="25" />
866 <input type="hidden" name="action" value="save" />
867 <input type="hidden" name="max_file_size" value="<?php echo $bytes; ?>" />
869 <?php submit_button( __('Upload file and import'), 'primary' ); ?>
876 * Adds a meta box to one or more screens.
879 * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
881 * @global array $wp_meta_boxes
883 * @param string $id Meta box ID (used in the 'id' attribute for the meta box).
884 * @param string $title Title of the meta box.
885 * @param callable $callback Function that fills the box with the desired content.
886 * The function should echo its output.
887 * @param string|array|WP_Screen $screen Optional. The screen or screens on which to show the box
888 * (such as a post type, 'link', or 'comment'). Accepts a single
889 * screen ID, WP_Screen object, or array of screen IDs. Default
890 * is the current screen.
891 * @param string $context Optional. The context within the screen where the boxes
892 * should display. Available contexts vary from screen to
893 * screen. Post edit screen contexts include 'normal', 'side',
894 * and 'advanced'. Comments screen contexts include 'normal'
895 * and 'side'. Menus meta boxes (accordion sections) all use
896 * the 'side' context. Global default is 'advanced'.
897 * @param string $priority Optional. The priority within the context where the boxes
898 * should show ('high', 'low'). Default 'default'.
899 * @param array $callback_args Optional. Data that should be set as the $args property
900 * of the box array (which is the second parameter passed
901 * to your callback). Default null.
903 function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advanced', $priority = 'default', $callback_args = null ) {
904 global $wp_meta_boxes;
906 if ( empty( $screen ) ) {
907 $screen = get_current_screen();
908 } elseif ( is_string( $screen ) ) {
909 $screen = convert_to_screen( $screen );
910 } elseif ( is_array( $screen ) ) {
911 foreach ( $screen as $single_screen ) {
912 add_meta_box( $id, $title, $callback, $single_screen, $context, $priority, $callback_args );
916 if ( ! isset( $screen->id ) ) {
922 if ( !isset($wp_meta_boxes) )
923 $wp_meta_boxes = array();
924 if ( !isset($wp_meta_boxes[$page]) )
925 $wp_meta_boxes[$page] = array();
926 if ( !isset($wp_meta_boxes[$page][$context]) )
927 $wp_meta_boxes[$page][$context] = array();
929 foreach ( array_keys($wp_meta_boxes[$page]) as $a_context ) {
930 foreach ( array('high', 'core', 'default', 'low') as $a_priority ) {
931 if ( !isset($wp_meta_boxes[$page][$a_context][$a_priority][$id]) )
934 // If a core box was previously added or removed by a plugin, don't add.
935 if ( 'core' == $priority ) {
936 // If core box previously deleted, don't add
937 if ( false === $wp_meta_boxes[$page][$a_context][$a_priority][$id] )
941 * If box was added with default priority, give it core priority to
942 * maintain sort order.
944 if ( 'default' == $a_priority ) {
945 $wp_meta_boxes[$page][$a_context]['core'][$id] = $wp_meta_boxes[$page][$a_context]['default'][$id];
946 unset($wp_meta_boxes[$page][$a_context]['default'][$id]);
950 // If no priority given and id already present, use existing priority.
951 if ( empty($priority) ) {
952 $priority = $a_priority;
954 * Else, if we're adding to the sorted priority, we don't know the title
955 * or callback. Grab them from the previously added context/priority.
957 } elseif ( 'sorted' == $priority ) {
958 $title = $wp_meta_boxes[$page][$a_context][$a_priority][$id]['title'];
959 $callback = $wp_meta_boxes[$page][$a_context][$a_priority][$id]['callback'];
960 $callback_args = $wp_meta_boxes[$page][$a_context][$a_priority][$id]['args'];
962 // An id can be in only one priority and one context.
963 if ( $priority != $a_priority || $context != $a_context )
964 unset($wp_meta_boxes[$page][$a_context][$a_priority][$id]);
968 if ( empty($priority) )
971 if ( !isset($wp_meta_boxes[$page][$context][$priority]) )
972 $wp_meta_boxes[$page][$context][$priority] = array();
974 $wp_meta_boxes[$page][$context][$priority][$id] = array('id' => $id, 'title' => $title, 'callback' => $callback, 'args' => $callback_args);
978 * Meta-Box template function
982 * @global array $wp_meta_boxes
984 * @staticvar bool $already_sorted
985 * @param string|WP_Screen $screen Screen identifier
986 * @param string $context box context
987 * @param mixed $object gets passed to the box callback function as first parameter
988 * @return int number of meta_boxes
990 function do_meta_boxes( $screen, $context, $object ) {
991 global $wp_meta_boxes;
992 static $already_sorted = false;
994 if ( empty( $screen ) )
995 $screen = get_current_screen();
996 elseif ( is_string( $screen ) )
997 $screen = convert_to_screen( $screen );
1001 $hidden = get_hidden_meta_boxes( $screen );
1003 printf('<div id="%s-sortables" class="meta-box-sortables">', htmlspecialchars($context));
1005 // Grab the ones the user has manually sorted. Pull them out of their previous context/priority and into the one the user chose
1006 if ( ! $already_sorted && $sorted = get_user_option( "meta-box-order_$page" ) ) {
1007 foreach ( $sorted as $box_context => $ids ) {
1008 foreach ( explode( ',', $ids ) as $id ) {
1009 if ( $id && 'dashboard_browser_nag' !== $id ) {
1010 add_meta_box( $id, null, null, $screen, $box_context, 'sorted' );
1016 $already_sorted = true;
1020 if ( isset( $wp_meta_boxes[ $page ][ $context ] ) ) {
1021 foreach ( array( 'high', 'sorted', 'core', 'default', 'low' ) as $priority ) {
1022 if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ]) ) {
1023 foreach ( (array) $wp_meta_boxes[ $page ][ $context ][ $priority ] as $box ) {
1024 if ( false == $box || ! $box['title'] )
1027 $hidden_class = in_array($box['id'], $hidden) ? ' hide-if-js' : '';
1028 echo '<div id="' . $box['id'] . '" class="postbox ' . postbox_classes($box['id'], $page) . $hidden_class . '" ' . '>' . "\n";
1029 if ( 'dashboard_browser_nag' != $box['id'] ) {
1030 echo '<button type="button" class="handlediv button-link" aria-expanded="true">';
1031 echo '<span class="screen-reader-text">' . sprintf( __( 'Toggle panel: %s' ), $box['title'] ) . '</span>';
1032 echo '<span class="toggle-indicator" aria-hidden="true"></span>';
1035 echo "<h2 class='hndle'><span>{$box['title']}</span></h2>\n";
1036 echo '<div class="inside">' . "\n";
1037 call_user_func($box['callback'], $object, $box);
1052 * Removes a meta box from one or more screens.
1055 * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs.
1057 * @global array $wp_meta_boxes
1059 * @param string $id Meta box ID (used in the 'id' attribute for the meta box).
1060 * @param string|array|WP_Screen $screen The screen or screens on which the meta box is shown (such as a
1061 * post type, 'link', or 'comment'). Accepts a single screen ID,
1062 * WP_Screen object, or array of screen IDs.
1063 * @param string $context Optional. The context within the screen where the boxes
1064 * should display. Available contexts vary from screen to
1065 * screen. Post edit screen contexts include 'normal', 'side',
1066 * and 'advanced'. Comments screen contexts include 'normal'
1067 * and 'side'. Menus meta boxes (accordion sections) all use
1068 * the 'side' context. Global default is 'advanced'.
1070 function remove_meta_box( $id, $screen, $context ) {
1071 global $wp_meta_boxes;
1073 if ( empty( $screen ) ) {
1074 $screen = get_current_screen();
1075 } elseif ( is_string( $screen ) ) {
1076 $screen = convert_to_screen( $screen );
1077 } elseif ( is_array( $screen ) ) {
1078 foreach ( $screen as $single_screen ) {
1079 remove_meta_box( $id, $single_screen, $context );
1083 if ( ! isset( $screen->id ) ) {
1087 $page = $screen->id;
1089 if ( !isset($wp_meta_boxes) )
1090 $wp_meta_boxes = array();
1091 if ( !isset($wp_meta_boxes[$page]) )
1092 $wp_meta_boxes[$page] = array();
1093 if ( !isset($wp_meta_boxes[$page][$context]) )
1094 $wp_meta_boxes[$page][$context] = array();
1096 foreach ( array('high', 'core', 'default', 'low') as $priority )
1097 $wp_meta_boxes[$page][$context][$priority][$id] = false;
1101 * Meta Box Accordion Template Function
1103 * Largely made up of abstracted code from {@link do_meta_boxes()}, this
1104 * function serves to build meta boxes as list items for display as
1105 * a collapsible accordion.
1109 * @uses global $wp_meta_boxes Used to retrieve registered meta boxes.
1111 * @param string|object $screen The screen identifier.
1112 * @param string $context The meta box context.
1113 * @param mixed $object gets passed to the section callback function as first parameter.
1114 * @return int number of meta boxes as accordion sections.
1116 function do_accordion_sections( $screen, $context, $object ) {
1117 global $wp_meta_boxes;
1119 wp_enqueue_script( 'accordion' );
1121 if ( empty( $screen ) )
1122 $screen = get_current_screen();
1123 elseif ( is_string( $screen ) )
1124 $screen = convert_to_screen( $screen );
1126 $page = $screen->id;
1128 $hidden = get_hidden_meta_boxes( $screen );
1130 <div id="side-sortables" class="accordion-container">
1131 <ul class="outer-border">
1134 $first_open = false;
1136 if ( isset( $wp_meta_boxes[ $page ][ $context ] ) ) {
1137 foreach ( array( 'high', 'core', 'default', 'low' ) as $priority ) {
1138 if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) {
1139 foreach ( $wp_meta_boxes[ $page ][ $context ][ $priority ] as $box ) {
1140 if ( false == $box || ! $box['title'] )
1143 $hidden_class = in_array( $box['id'], $hidden ) ? 'hide-if-js' : '';
1146 if ( ! $first_open && empty( $hidden_class ) ) {
1148 $open_class = 'open';
1151 <li class="control-section accordion-section <?php echo $hidden_class; ?> <?php echo $open_class; ?> <?php echo esc_attr( $box['id'] ); ?>" id="<?php echo esc_attr( $box['id'] ); ?>">
1152 <h3 class="accordion-section-title hndle" tabindex="0">
1153 <?php echo esc_html( $box['title'] ); ?>
1154 <span class="screen-reader-text"><?php _e( 'Press return or enter to open this section' ); ?></span>
1156 <div class="accordion-section-content <?php postbox_classes( $box['id'], $page ); ?>">
1157 <div class="inside">
1158 <?php call_user_func( $box['callback'], $object, $box ); ?>
1159 </div><!-- .inside -->
1160 </div><!-- .accordion-section-content -->
1161 </li><!-- .accordion-section -->
1168 </ul><!-- .outer-border -->
1169 </div><!-- .accordion-container -->
1175 * Add a new section to a settings page.
1177 * Part of the Settings API. Use this to define new settings sections for an admin page.
1178 * Show settings sections in your admin page callback function with do_settings_sections().
1179 * Add settings fields to your section with add_settings_field()
1181 * The $callback argument should be the name of a function that echoes out any
1182 * content you want to show at the top of the settings section before the actual
1183 * fields. It can output nothing if you want.
1187 * @global $wp_settings_sections Storage array of all settings sections added to admin pages
1189 * @param string $id Slug-name to identify the section. Used in the 'id' attribute of tags.
1190 * @param string $title Formatted title of the section. Shown as the heading for the section.
1191 * @param string $callback Function that echos out any content at the top of the section (between heading and fields).
1192 * @param string $page The slug-name of the settings page on which to show the section. Built-in pages include 'general', 'reading', 'writing', 'discussion', 'media', etc. Create your own using add_options_page();
1194 function add_settings_section($id, $title, $callback, $page) {
1195 global $wp_settings_sections;
1197 if ( 'misc' == $page ) {
1198 _deprecated_argument( __FUNCTION__, '3.0', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'misc' ) );
1202 if ( 'privacy' == $page ) {
1203 _deprecated_argument( __FUNCTION__, '3.5', sprintf( __( 'The "%s" options group has been removed. Use another settings group.' ), 'privacy' ) );
1207 $wp_settings_sections[$page][$id] = array('id' => $id, 'title' => $title, 'callback' => $callback);
1211 * Add a new field to a section of a settings page
1213 * Part of the Settings API. Use this to define a settings field that will show
1214 * as part of a settings section inside a settings page. The fields are shown using
1215 * do_settings_fields() in do_settings-sections()
1217 * The $callback argument should be the name of a function that echoes out the
1218 * html input tags for this setting field. Use get_option() to retrieve existing
1222 * @since 4.2.0 The `$class` argument was added.
1224 * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections
1226 * @param string $id Slug-name to identify the field. Used in the 'id' attribute of tags.
1227 * @param string $title Formatted title of the field. Shown as the label for the field
1229 * @param string $callback Function that fills the field with the desired form inputs. The
1230 * function should echo its output.
1231 * @param string $page The slug-name of the settings page on which to show the section
1232 * (general, reading, writing, ...).
1233 * @param string $section Optional. The slug-name of the section of the settings page
1234 * in which to show the box. Default 'default'.
1235 * @param array $args {
1236 * Optional. Extra arguments used when outputting the field.
1238 * @type string $label_for When supplied, the setting title will be wrapped
1239 * in a `<label>` element, its `for` attribute populated
1241 * @type string $class CSS Class to be added to the `<tr>` element when the
1245 function add_settings_field($id, $title, $callback, $page, $section = 'default', $args = array()) {
1246 global $wp_settings_fields;
1248 if ( 'misc' == $page ) {
1249 _deprecated_argument( __FUNCTION__, '3.0', __( 'The miscellaneous options group has been removed. Use another settings group.' ) );
1253 if ( 'privacy' == $page ) {
1254 _deprecated_argument( __FUNCTION__, '3.5', __( 'The privacy options group has been removed. Use another settings group.' ) );
1258 $wp_settings_fields[$page][$section][$id] = array('id' => $id, 'title' => $title, 'callback' => $callback, 'args' => $args);
1262 * Prints out all settings sections added to a particular settings page
1264 * Part of the Settings API. Use this in a settings page callback function
1265 * to output all the sections and fields that were added to that $page with
1266 * add_settings_section() and add_settings_field()
1268 * @global $wp_settings_sections Storage array of all settings sections added to admin pages
1269 * @global $wp_settings_fields Storage array of settings fields and info about their pages/sections
1272 * @param string $page The slug name of the page whose settings sections you want to output
1274 function do_settings_sections( $page ) {
1275 global $wp_settings_sections, $wp_settings_fields;
1277 if ( ! isset( $wp_settings_sections[$page] ) )
1280 foreach ( (array) $wp_settings_sections[$page] as $section ) {
1281 if ( $section['title'] )
1282 echo "<h2>{$section['title']}</h2>\n";
1284 if ( $section['callback'] )
1285 call_user_func( $section['callback'], $section );
1287 if ( ! isset( $wp_settings_fields ) || !isset( $wp_settings_fields[$page] ) || !isset( $wp_settings_fields[$page][$section['id']] ) )
1289 echo '<table class="form-table">';
1290 do_settings_fields( $page, $section['id'] );
1296 * Print out the settings fields for a particular settings section
1298 * Part of the Settings API. Use this in a settings page to output
1299 * a specific section. Should normally be called by do_settings_sections()
1300 * rather than directly.
1302 * @global $wp_settings_fields Storage array of settings fields and their pages/sections
1306 * @param string $page Slug title of the admin page who's settings fields you want to show.
1307 * @param string $section Slug title of the settings section who's fields you want to show.
1309 function do_settings_fields($page, $section) {
1310 global $wp_settings_fields;
1312 if ( ! isset( $wp_settings_fields[$page][$section] ) )
1315 foreach ( (array) $wp_settings_fields[$page][$section] as $field ) {
1318 if ( ! empty( $field['args']['class'] ) ) {
1319 $class = ' class="' . esc_attr( $field['args']['class'] ) . '"';
1322 echo "<tr{$class}>";
1324 if ( ! empty( $field['args']['label_for'] ) ) {
1325 echo '<th scope="row"><label for="' . esc_attr( $field['args']['label_for'] ) . '">' . $field['title'] . '</label></th>';
1327 echo '<th scope="row">' . $field['title'] . '</th>';
1331 call_user_func($field['callback'], $field['args']);
1338 * Register a settings error to be displayed to the user
1340 * Part of the Settings API. Use this to show messages to users about settings validation
1341 * problems, missing settings or anything else.
1343 * Settings errors should be added inside the $sanitize_callback function defined in
1344 * register_setting() for a given setting to give feedback about the submission.
1346 * By default messages will show immediately after the submission that generated the error.
1347 * Additional calls to settings_errors() can be used to show errors even when the settings
1348 * page is first accessed.
1352 * @global array $wp_settings_errors Storage array of errors registered during this pageload
1354 * @param string $setting Slug title of the setting to which this error applies
1355 * @param string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output.
1356 * @param string $message The formatted message text to display to the user (will be shown inside styled
1357 * `<div>` and `<p>` tags).
1358 * @param string $type Optional. Message type, controls HTML class. Accepts 'error' or 'updated'.
1361 function add_settings_error( $setting, $code, $message, $type = 'error' ) {
1362 global $wp_settings_errors;
1364 $wp_settings_errors[] = array(
1365 'setting' => $setting,
1367 'message' => $message,
1373 * Fetch settings errors registered by add_settings_error()
1375 * Checks the $wp_settings_errors array for any errors declared during the current
1376 * pageload and returns them.
1378 * If changes were just submitted ($_GET['settings-updated']) and settings errors were saved
1379 * to the 'settings_errors' transient then those errors will be returned instead. This
1380 * is used to pass errors back across pageloads.
1382 * Use the $sanitize argument to manually re-sanitize the option before returning errors.
1383 * This is useful if you have errors or notices you want to show even when the user
1384 * hasn't submitted data (i.e. when they first load an options page, or in admin_notices action hook)
1388 * @global array $wp_settings_errors Storage array of errors registered during this pageload
1390 * @param string $setting Optional slug title of a specific setting who's errors you want.
1391 * @param boolean $sanitize Whether to re-sanitize the setting value before returning errors.
1392 * @return array Array of settings errors
1394 function get_settings_errors( $setting = '', $sanitize = false ) {
1395 global $wp_settings_errors;
1398 * If $sanitize is true, manually re-run the sanitization for this option
1399 * This allows the $sanitize_callback from register_setting() to run, adding
1400 * any settings errors you want to show by default.
1403 sanitize_option( $setting, get_option( $setting ) );
1405 // If settings were passed back from options.php then use them.
1406 if ( isset( $_GET['settings-updated'] ) && $_GET['settings-updated'] && get_transient( 'settings_errors' ) ) {
1407 $wp_settings_errors = array_merge( (array) $wp_settings_errors, get_transient( 'settings_errors' ) );
1408 delete_transient( 'settings_errors' );
1411 // Check global in case errors have been added on this pageload.
1412 if ( ! count( $wp_settings_errors ) )
1415 // Filter the results to those of a specific setting if one was set.
1417 $setting_errors = array();
1418 foreach ( (array) $wp_settings_errors as $key => $details ) {
1419 if ( $setting == $details['setting'] )
1420 $setting_errors[] = $wp_settings_errors[$key];
1422 return $setting_errors;
1425 return $wp_settings_errors;
1429 * Display settings errors registered by {@see add_settings_error()}.
1431 * Part of the Settings API. Outputs a div for each error retrieved by
1432 * {@see get_settings_errors()}.
1434 * This is called automatically after a settings page based on the
1435 * Settings API is submitted. Errors should be added during the validation
1436 * callback function for a setting defined in {@see register_setting()}
1438 * The $sanitize option is passed into {@see get_settings_errors()} and will
1439 * re-run the setting sanitization
1440 * on its current value.
1442 * The $hide_on_update option will cause errors to only show when the settings
1443 * page is first loaded. if the user has already saved new values it will be
1444 * hidden to avoid repeating messages already shown in the default error
1445 * reporting after submission. This is useful to show general errors like
1446 * missing settings when the user arrives at the settings page.
1450 * @param string $setting Optional slug title of a specific setting who's errors you want.
1451 * @param bool $sanitize Whether to re-sanitize the setting value before returning errors.
1452 * @param bool $hide_on_update If set to true errors will not be shown if the settings page has already been submitted.
1454 function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) {
1456 if ( $hide_on_update && ! empty( $_GET['settings-updated'] ) )
1459 $settings_errors = get_settings_errors( $setting, $sanitize );
1461 if ( empty( $settings_errors ) )
1465 foreach ( $settings_errors as $key => $details ) {
1466 $css_id = 'setting-error-' . $details['code'];
1467 $css_class = $details['type'] . ' settings-error notice is-dismissible';
1468 $output .= "<div id='$css_id' class='$css_class'> \n";
1469 $output .= "<p><strong>{$details['message']}</strong></p>";
1470 $output .= "</div> \n";
1476 * Outputs the modal window used for attaching media to posts or pages in the media-listing screen.
1480 * @param string $found_action
1482 function find_posts_div($found_action = '') {
1484 <div id="find-posts" class="find-box" style="display: none;">
1485 <div id="find-posts-head" class="find-box-head">
1486 <?php _e( 'Find Posts or Pages' ); ?>
1487 <div id="find-posts-close"></div>
1489 <div class="find-box-inside">
1490 <div class="find-box-search">
1491 <?php if ( $found_action ) { ?>
1492 <input type="hidden" name="found_action" value="<?php echo esc_attr($found_action); ?>" />
1494 <input type="hidden" name="affected" id="affected" value="" />
1495 <?php wp_nonce_field( 'find-posts', '_ajax_nonce', false ); ?>
1496 <label class="screen-reader-text" for="find-posts-input"><?php _e( 'Search' ); ?></label>
1497 <input type="text" id="find-posts-input" name="ps" value="" />
1498 <span class="spinner"></span>
1499 <input type="button" id="find-posts-search" value="<?php esc_attr_e( 'Search' ); ?>" class="button" />
1500 <div class="clear"></div>
1502 <div id="find-posts-response"></div>
1504 <div class="find-box-buttons">
1505 <?php submit_button( __( 'Select' ), 'button-primary alignright', 'find-posts-submit', false ); ?>
1506 <div class="clear"></div>
1513 * Display the post password.
1515 * The password is passed through {@link esc_attr()} to ensure that it
1516 * is safe for placing in an html attribute.
1520 function the_post_password() {
1522 if ( isset( $post->post_password ) )
1523 echo esc_attr( $post->post_password );
1527 * Get the post title.
1529 * The post title is fetched and if it is blank then a default string is
1534 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
1535 * @return string The post title if set.
1537 function _draft_or_post_title( $post = 0 ) {
1538 $title = get_the_title( $post );
1539 if ( empty( $title ) )
1540 $title = __( '(no title)' );
1541 return esc_html( $title );
1545 * Display the search query.
1547 * A simple wrapper to display the "s" parameter in a GET URI. This function
1548 * should only be used when {@link the_search_query()} cannot.
1552 function _admin_search_query() {
1553 echo isset($_REQUEST['s']) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : '';
1557 * Generic Iframe header for use with Thickbox
1561 * @global string $hook_suffix
1562 * @global string $admin_body_class
1563 * @global WP_Locale $wp_locale
1565 * @param string $title Optional. Title of the Iframe page. Default empty.
1566 * @param bool $deprecated Not used.
1568 function iframe_header( $title = '', $deprecated = false ) {
1569 show_admin_bar( false );
1570 global $hook_suffix, $admin_body_class, $wp_locale;
1571 $admin_body_class = preg_replace('/[^a-z0-9_-]+/i', '-', $hook_suffix);
1573 $current_screen = get_current_screen();
1575 @header( 'Content-Type: ' . get_option( 'html_type' ) . '; charset=' . get_option( 'blog_charset' ) );
1576 _wp_admin_html_begin();
1578 <title><?php bloginfo('name') ?> › <?php echo $title ?> — <?php _e('WordPress'); ?></title>
1580 wp_enqueue_style( 'colors' );
1582 <script type="text/javascript">
1583 addLoadEvent = function(func){if(typeof jQuery!="undefined")jQuery(document).ready(func);else if(typeof wpOnload!='function'){wpOnload=func;}else{var oldonload=wpOnload;wpOnload=function(){oldonload();func();}}};
1584 function tb_close(){var win=window.dialogArguments||opener||parent||top;win.tb_remove();}
1585 var ajaxurl = '<?php echo admin_url( 'admin-ajax.php', 'relative' ); ?>',
1586 pagenow = '<?php echo $current_screen->id; ?>',
1587 typenow = '<?php echo $current_screen->post_type; ?>',
1588 adminpage = '<?php echo $admin_body_class; ?>',
1589 thousandsSeparator = '<?php echo addslashes( $wp_locale->number_format['thousands_sep'] ); ?>',
1590 decimalPoint = '<?php echo addslashes( $wp_locale->number_format['decimal_point'] ); ?>',
1591 isRtl = <?php echo (int) is_rtl(); ?>;
1594 /** This action is documented in wp-admin/admin-header.php */
1595 do_action( 'admin_enqueue_scripts', $hook_suffix );
1597 /** This action is documented in wp-admin/admin-header.php */
1598 do_action( "admin_print_styles-$hook_suffix" );
1600 /** This action is documented in wp-admin/admin-header.php */
1601 do_action( 'admin_print_styles' );
1603 /** This action is documented in wp-admin/admin-header.php */
1604 do_action( "admin_print_scripts-$hook_suffix" );
1606 /** This action is documented in wp-admin/admin-header.php */
1607 do_action( 'admin_print_scripts' );
1609 /** This action is documented in wp-admin/admin-header.php */
1610 do_action( "admin_head-$hook_suffix" );
1612 /** This action is documented in wp-admin/admin-header.php */
1613 do_action( 'admin_head' );
1615 $admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_locale() ) ) );
1618 $admin_body_class .= ' rtl';
1623 /** This filter is documented in wp-admin/admin-header.php */
1624 $admin_body_classes = apply_filters( 'admin_body_class', '' );
1628 * @global string $body_id
1630 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; ?>">
1631 <script type="text/javascript">
1633 var c = document.body.className;
1634 c = c.replace(/no-js/, 'js');
1635 document.body.className = c;
1642 * Generic Iframe footer for use with Thickbox
1646 function iframe_footer() {
1648 * We're going to hide any footer output on iFrame pages,
1649 * but run the hooks anyway since they output JavaScript
1650 * or other needed content.
1653 <div class="hidden">
1655 /** This action is documented in wp-admin/admin-footer.php */
1656 do_action( 'admin_footer', '' );
1658 /** This action is documented in wp-admin/admin-footer.php */
1659 do_action( 'admin_print_footer_scripts' );
1662 <script type="text/javascript">if(typeof wpOnload=="function")wpOnload();</script>
1670 * @param WP_Post $post
1672 function _post_states($post) {
1673 $post_states = array();
1674 if ( isset( $_REQUEST['post_status'] ) )
1675 $post_status = $_REQUEST['post_status'];
1679 if ( !empty($post->post_password) )
1680 $post_states['protected'] = __('Password protected');
1681 if ( 'private' == $post->post_status && 'private' != $post_status )
1682 $post_states['private'] = __('Private');
1683 if ( 'draft' == $post->post_status && 'draft' != $post_status )
1684 $post_states['draft'] = __('Draft');
1685 if ( 'pending' == $post->post_status && 'pending' != $post_status )
1686 /* translators: post state */
1687 $post_states['pending'] = _x('Pending', 'post state');
1688 if ( is_sticky($post->ID) )
1689 $post_states['sticky'] = __('Sticky');
1691 if ( 'future' === $post->post_status ) {
1692 $post_states['scheduled'] = __( 'Scheduled' );
1695 if ( 'page' === get_option( 'show_on_front' ) ) {
1696 if ( intval( get_option( 'page_on_front' ) ) === $post->ID ) {
1697 $post_states['page_on_front'] = __( 'Front Page' );
1700 if ( intval( get_option( 'page_for_posts' ) ) === $post->ID ) {
1701 $post_states['page_for_posts'] = __( 'Posts Page' );
1706 * Filter the default post display states used in the posts list table.
1710 * @param array $post_states An array of post display states.
1711 * @param WP_Post $post The current post object.
1713 $post_states = apply_filters( 'display_post_states', $post_states, $post );
1715 if ( ! empty($post_states) ) {
1716 $state_count = count($post_states);
1719 foreach ( $post_states as $state ) {
1721 ( $i == $state_count ) ? $sep = '' : $sep = ', ';
1722 echo "<span class='post-state'>$state$sep</span>";
1730 * @param WP_Post $post
1732 function _media_states( $post ) {
1733 $media_states = array();
1734 $stylesheet = get_option('stylesheet');
1736 if ( current_theme_supports( 'custom-header') ) {
1737 $meta_header = get_post_meta($post->ID, '_wp_attachment_is_custom_header', true );
1738 if ( ! empty( $meta_header ) && $meta_header == $stylesheet )
1739 $media_states[] = __( 'Header Image' );
1742 if ( current_theme_supports( 'custom-background') ) {
1743 $meta_background = get_post_meta($post->ID, '_wp_attachment_is_custom_background', true );
1744 if ( ! empty( $meta_background ) && $meta_background == $stylesheet )
1745 $media_states[] = __( 'Background Image' );
1748 if ( $post->ID == get_option( 'site_icon' ) ) {
1749 $media_states[] = __( 'Site Icon' );
1753 * Filter the default media display states for items in the Media list table.
1757 * @param array $media_states An array of media states. Default 'Header Image',
1758 * 'Background Image', 'Site Icon'.
1760 $media_states = apply_filters( 'display_media_states', $media_states );
1762 if ( ! empty( $media_states ) ) {
1763 $state_count = count( $media_states );
1766 foreach ( $media_states as $state ) {
1768 ( $i == $state_count ) ? $sep = '' : $sep = ', ';
1769 echo "<span class='post-state'>$state$sep</span>";
1775 * Test support for compressing JavaScript from PHP
1777 * Outputs JavaScript that tests if compression from PHP works as expected
1778 * and sets an option with the result. Has no effect when the current user
1779 * is not an administrator. To run the test again the option 'can_compress_scripts'
1780 * has to be deleted.
1784 function compression_test() {
1786 <script type="text/javascript">
1787 var testCompression = {
1788 get : function(test) {
1790 if ( window.XMLHttpRequest ) {
1791 x = new XMLHttpRequest();
1793 try{x=new ActiveXObject('Msxml2.XMLHTTP');}catch(e){try{x=new ActiveXObject('Microsoft.XMLHTTP');}catch(e){};}
1797 x.onreadystatechange = function() {
1799 if ( x.readyState == 4 ) {
1800 r = x.responseText.substr(0, 18);
1801 h = x.getResponseHeader('Content-Encoding');
1802 testCompression.check(r, h, test);
1806 x.open('GET', ajaxurl + '?action=wp-compression-test&test='+test+'&'+(new Date()).getTime(), true);
1811 check : function(r, h, test) {
1812 if ( ! r && ! test )
1816 if ( h && ( h.match(/deflate/i) || h.match(/gzip/i) ) )
1825 if ( '"wpCompressionTest' == r )
1832 testCompression.check();
1838 * Echoes a submit button, with provided text and appropriate class(es).
1842 * @see get_submit_button()
1844 * @param string $text The text of the button (defaults to 'Save Changes')
1845 * @param string $type Optional. The type and CSS class(es) of the button. Core values
1846 * include 'primary', 'secondary', 'delete'. Default 'primary'
1847 * @param string $name The HTML name of the submit button. Defaults to "submit". If no
1848 * id attribute is given in $other_attributes below, $name will be
1849 * used as the button's id.
1850 * @param bool $wrap True if the output button should be wrapped in a paragraph tag,
1851 * false otherwise. Defaults to true
1852 * @param array|string $other_attributes Other attributes that should be output with the button, mapping
1853 * attributes to their values, such as setting tabindex to 1, etc.
1854 * These key/value attribute pairs will be output as attribute="value",
1855 * where attribute is the key. Other attributes can also be provided
1856 * as a string such as 'tabindex="1"', though the array format is
1857 * preferred. Default null.
1859 function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = null ) {
1860 echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );
1864 * Returns a submit button, with provided text and appropriate class
1868 * @param string $text Optional. The text of the button. Default 'Save Changes'.
1869 * @param string $type Optional. The type of button. Accepts 'primary', 'secondary',
1870 * or 'delete'. Default 'primary large'.
1871 * @param string $name Optional. The HTML name of the submit button. Defaults to "submit".
1872 * If no id attribute is given in $other_attributes below, `$name` will
1873 * be used as the button's id. Default 'submit'.
1874 * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph
1875 * tag, false otherwise. Default true.
1876 * @param array|string $other_attributes Optional. Other attributes that should be output with the button,
1877 * mapping attributes to their values, such as `array( 'tabindex' => '1' )`.
1878 * These attributes will be output as `attribute="value"`, such as
1879 * `tabindex="1"`. Other attributes can also be provided as a string such
1880 * as `tabindex="1"`, though the array format is typically cleaner.
1882 * @return string Submit button HTML.
1884 function get_submit_button( $text = '', $type = 'primary large', $name = 'submit', $wrap = true, $other_attributes = '' ) {
1885 if ( ! is_array( $type ) )
1886 $type = explode( ' ', $type );
1888 $button_shorthand = array( 'primary', 'small', 'large' );
1889 $classes = array( 'button' );
1890 foreach ( $type as $t ) {
1891 if ( 'secondary' === $t || 'button-secondary' === $t )
1893 $classes[] = in_array( $t, $button_shorthand ) ? 'button-' . $t : $t;
1895 $class = implode( ' ', array_unique( $classes ) );
1897 if ( 'delete' === $type )
1898 $class = 'button-secondary delete';
1900 $text = $text ? $text : __( 'Save Changes' );
1902 // Default the id attribute to $name unless an id was specifically provided in $other_attributes
1904 if ( is_array( $other_attributes ) && isset( $other_attributes['id'] ) ) {
1905 $id = $other_attributes['id'];
1906 unset( $other_attributes['id'] );
1910 if ( is_array( $other_attributes ) ) {
1911 foreach ( $other_attributes as $attribute => $value ) {
1912 $attributes .= $attribute . '="' . esc_attr( $value ) . '" '; // Trailing space is important
1914 } elseif ( ! empty( $other_attributes ) ) { // Attributes provided as a string
1915 $attributes = $other_attributes;
1918 // Don't output empty name and id attributes.
1919 $name_attr = $name ? ' name="' . esc_attr( $name ) . '"' : '';
1920 $id_attr = $id ? ' id="' . esc_attr( $id ) . '"' : '';
1922 $button = '<input type="submit"' . $name_attr . $id_attr . ' class="' . esc_attr( $class );
1923 $button .= '" value="' . esc_attr( $text ) . '" ' . $attributes . ' />';
1926 $button = '<p class="submit">' . $button . '</p>';
1934 * @global bool $is_IE
1936 function _wp_admin_html_begin() {
1939 $admin_html_class = ( is_admin_bar_showing() ) ? 'wp-toolbar' : '';
1942 @header('X-UA-Compatible: IE=edge');
1947 <html xmlns="http://www.w3.org/1999/xhtml" class="ie8 <?php echo $admin_html_class; ?>" <?php
1949 * Fires inside the HTML tag in the admin header.
1953 do_action( 'admin_xml_ns' );
1954 ?> <?php language_attributes(); ?>>
1956 <!--[if !(IE 8) ]><!-->
1957 <html xmlns="http://www.w3.org/1999/xhtml" class="<?php echo $admin_html_class; ?>" <?php
1958 /** This action is documented in wp-admin/includes/template.php */
1959 do_action( 'admin_xml_ns' );
1960 ?> <?php language_attributes(); ?>>
1963 <meta http-equiv="Content-Type" content="<?php bloginfo('html_type'); ?>; charset=<?php echo get_option('blog_charset'); ?>" />
1968 * Convert a screen string to a screen object
1972 * @param string $hook_name The hook name (also known as the hook suffix) used to determine the screen.
1973 * @return WP_Screen Screen object.
1975 function convert_to_screen( $hook_name ) {
1976 if ( ! class_exists( 'WP_Screen', false ) ) {
1977 _doing_it_wrong( 'convert_to_screen(), add_meta_box()', __( "Likely direct inclusion of wp-admin/includes/template.php in order to use add_meta_box(). This is very wrong. Hook the add_meta_box() call into the add_meta_boxes action instead." ), '3.3' );
1978 return (object) array( 'id' => '_invalid', 'base' => '_are_belong_to_us' );
1981 return WP_Screen::get( $hook_name );
1985 * Output the HTML for restoring the post data from DOM storage
1990 function _local_storage_notice() {
1992 <div id="local-storage-notice" class="hidden notice">
1993 <p class="local-restore">
1994 <?php _e('The backup of this post in your browser is different from the version below.'); ?>
1995 <a class="restore-backup" href="#"><?php _e('Restore the backup.'); ?></a>
1997 <p class="undo-restore hidden">
1998 <?php _e('Post restored successfully.'); ?>
1999 <a class="undo-restore-backup" href="#"><?php _e('Undo.'); ?></a>
2006 * Output a HTML element with a star rating for a given rating.
2008 * Outputs a HTML element with the star rating exposed on a 0..5 scale in
2009 * half star increments (ie. 1, 1.5, 2 stars). Optionally, if specified, the
2010 * number of ratings may also be displayed by passing the $number parameter.
2013 * @since 4.4.0 Introduced the `echo` parameter.
2015 * @param array $args {
2016 * Optional. Array of star ratings arguments.
2018 * @type int $rating The rating to display, expressed in either a 0.5 rating increment,
2019 * or percentage. Default 0.
2020 * @type string $type Format that the $rating is in. Valid values are 'rating' (default),
2021 * or, 'percent'. Default 'rating'.
2022 * @type int $number The number of ratings that makes up this rating. Default 0.
2023 * @type bool $echo Whether to echo the generated markup. False to return the markup instead
2024 * of echoing it. Default true.
2027 function wp_star_rating( $args = array() ) {
2034 $r = wp_parse_args( $args, $defaults );
2036 // Non-english decimal places when the $rating is coming from a string
2037 $rating = str_replace( ',', '.', $r['rating'] );
2039 // Convert Percentage to star rating, 0..5 in .5 increments
2040 if ( 'percent' == $r['type'] ) {
2041 $rating = round( $rating / 10, 0 ) / 2;
2044 // Calculate the number of each type of star needed
2045 $full_stars = floor( $rating );
2046 $half_stars = ceil( $rating - $full_stars );
2047 $empty_stars = 5 - $full_stars - $half_stars;
2049 if ( $r['number'] ) {
2050 /* translators: 1: The rating, 2: The number of ratings */
2051 $format = _n( '%1$s rating based on %2$s rating', '%1$s rating based on %2$s ratings', $r['number'] );
2052 $title = sprintf( $format, number_format_i18n( $rating, 1 ), number_format_i18n( $r['number'] ) );
2054 /* translators: 1: The rating */
2055 $title = sprintf( __( '%s rating' ), number_format_i18n( $rating, 1 ) );
2058 $output = '<div class="star-rating" title="' . esc_attr( $title ) . '">';
2059 $output .= '<span class="screen-reader-text">' . $title . '</span>';
2060 $output .= str_repeat( '<div class="star star-full"></div>', $full_stars );
2061 $output .= str_repeat( '<div class="star star-half"></div>', $half_stars );
2062 $output .= str_repeat( '<div class="star star-empty"></div>', $empty_stars );
2063 $output .= '</div>';
2073 * Output a notice when editing the page for posts (internal use only).
2078 function _wp_posts_page_notice() {
2079 echo '<div class="notice notice-warning inline"><p>' . __( 'You are currently editing the page that shows your latest posts.' ) . '</p></div>';