| [ Index ] |
PHP Cross Reference of WordPress Trunk (Updated Daily) |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Template WordPress Administration API. 4 * 5 * A Big Mess. Also some neat functions that are nicely written. 6 * 7 * @package WordPress 8 * @subpackage Administration 9 */ 10 11 /** Walker_Category_Checklist class */ 12 require_once ABSPATH . 'wp-admin/includes/class-walker-category-checklist.php'; 13 14 /** WP_Internal_Pointers class */ 15 require_once ABSPATH . 'wp-admin/includes/class-wp-internal-pointers.php'; 16 17 // 18 // Category Checklists. 19 // 20 21 /** 22 * Outputs an unordered list of checkbox input elements labeled with category names. 23 * 24 * @since 2.5.1 25 * 26 * @see wp_terms_checklist() 27 * 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. 31 * Default 0. 32 * @param int[]|false $selected_cats Optional. Array of category IDs to mark as checked. Default false. 33 * @param int[]|false $popular_cats Optional. Array of category IDs to receive the "popular-category" class. 34 * Default false. 35 * @param Walker $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. 39 */ 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( 42 $post_id, 43 array( 44 'taxonomy' => 'category', 45 'descendants_and_self' => $descendants_and_self, 46 'selected_cats' => $selected_cats, 47 'popular_cats' => $popular_cats, 48 'walker' => $walker, 49 'checked_ontop' => $checked_ontop, 50 ) 51 ); 52 } 53 54 /** 55 * Outputs an unordered list of checkbox input elements labelled with term names. 56 * 57 * Taxonomy-independent version of wp_category_checklist(). 58 * 59 * @since 3.0.0 60 * @since 4.4.0 Introduced the `$echo` argument. 61 * 62 * @param int $post_id Optional. Post ID. Default 0. 63 * @param array|string $args { 64 * Optional. Array or string of arguments for generating a terms checklist. Default empty array. 65 * 66 * @type int $descendants_and_self ID of the category to output along with its descendants. 67 * Default 0. 68 * @type int[] $selected_cats Array of category IDs to mark as checked. Default false. 69 * @type int[] $popular_cats Array of category IDs to receive the "popular-category" class. 70 * Default false. 71 * @type Walker $walker Walker object to use to build the output. Default empty which 72 * results in a Walker_Category_Checklist instance being used. 73 * @type string $taxonomy Taxonomy to generate the checklist for. Default 'category'. 74 * @type bool $checked_ontop Whether to move checked items out of the hierarchy and to 75 * the top of the list. Default true. 76 * @type bool $echo Whether to echo the generated markup. False to return the markup instead 77 * of echoing it. Default true. 78 * } 79 * @return string HTML list of input elements. 80 */ 81 function wp_terms_checklist( $post_id = 0, $args = array() ) { 82 $defaults = array( 83 'descendants_and_self' => 0, 84 'selected_cats' => false, 85 'popular_cats' => false, 86 'walker' => null, 87 'taxonomy' => 'category', 88 'checked_ontop' => true, 89 'echo' => true, 90 ); 91 92 /** 93 * Filters the taxonomy terms checklist arguments. 94 * 95 * @since 3.4.0 96 * 97 * @see wp_terms_checklist() 98 * 99 * @param array|string $args An array or string of arguments. 100 * @param int $post_id The post ID. 101 */ 102 $params = apply_filters( 'wp_terms_checklist_args', $args, $post_id ); 103 104 $parsed_args = wp_parse_args( $params, $defaults ); 105 106 if ( empty( $parsed_args['walker'] ) || ! ( $parsed_args['walker'] instanceof Walker ) ) { 107 $walker = new Walker_Category_Checklist(); 108 } else { 109 $walker = $parsed_args['walker']; 110 } 111 112 $taxonomy = $parsed_args['taxonomy']; 113 $descendants_and_self = (int) $parsed_args['descendants_and_self']; 114 115 $args = array( 'taxonomy' => $taxonomy ); 116 117 $tax = get_taxonomy( $taxonomy ); 118 $args['disabled'] = ! current_user_can( $tax->cap->assign_terms ); 119 120 $args['list_only'] = ! empty( $parsed_args['list_only'] ); 121 122 if ( is_array( $parsed_args['selected_cats'] ) ) { 123 $args['selected_cats'] = array_map( 'intval', $parsed_args['selected_cats'] ); 124 } elseif ( $post_id ) { 125 $args['selected_cats'] = wp_get_object_terms( $post_id, $taxonomy, array_merge( $args, array( 'fields' => 'ids' ) ) ); 126 } else { 127 $args['selected_cats'] = array(); 128 } 129 130 if ( is_array( $parsed_args['popular_cats'] ) ) { 131 $args['popular_cats'] = array_map( 'intval', $parsed_args['popular_cats'] ); 132 } else { 133 $args['popular_cats'] = get_terms( 134 array( 135 'taxonomy' => $taxonomy, 136 'fields' => 'ids', 137 'orderby' => 'count', 138 'order' => 'DESC', 139 'number' => 10, 140 'hierarchical' => false, 141 ) 142 ); 143 } 144 145 if ( $descendants_and_self ) { 146 $categories = (array) get_terms( 147 array( 148 'taxonomy' => $taxonomy, 149 'child_of' => $descendants_and_self, 150 'hierarchical' => 0, 151 'hide_empty' => 0, 152 ) 153 ); 154 $self = get_term( $descendants_and_self, $taxonomy ); 155 array_unshift( $categories, $self ); 156 } else { 157 $categories = (array) get_terms( 158 array( 159 'taxonomy' => $taxonomy, 160 'get' => 'all', 161 ) 162 ); 163 } 164 165 $output = ''; 166 167 if ( $parsed_args['checked_ontop'] ) { 168 /* 169 * Post-process $categories rather than adding an exclude to the get_terms() query 170 * to keep the query the same across all posts (for any query cache). 171 */ 172 $checked_categories = array(); 173 $keys = array_keys( $categories ); 174 175 foreach ( $keys as $k ) { 176 if ( in_array( $categories[ $k ]->term_id, $args['selected_cats'], true ) ) { 177 $checked_categories[] = $categories[ $k ]; 178 unset( $categories[ $k ] ); 179 } 180 } 181 182 // Put checked categories on top. 183 $output .= $walker->walk( $checked_categories, 0, $args ); 184 } 185 // Then the rest of them. 186 $output .= $walker->walk( $categories, 0, $args ); 187 188 if ( $parsed_args['echo'] ) { 189 echo $output; 190 } 191 192 return $output; 193 } 194 195 /** 196 * Retrieves a list of the most popular terms from the specified taxonomy. 197 * 198 * If the `$display` argument is true then the elements for a list of checkbox 199 * `<input>` elements labelled with the names of the selected terms is output. 200 * If the `$post_ID` global is not empty then the terms associated with that 201 * post will be marked as checked. 202 * 203 * @since 2.5.0 204 * 205 * @param string $taxonomy Taxonomy to retrieve terms from. 206 * @param int $default_term Optional. Not used. 207 * @param int $number Optional. Number of terms to retrieve. Default 10. 208 * @param bool $display Optional. Whether to display the list as well. Default true. 209 * @return int[] Array of popular term IDs. 210 */ 211 function wp_popular_terms_checklist( $taxonomy, $default_term = 0, $number = 10, $display = true ) { 212 $post = get_post(); 213 214 if ( $post && $post->ID ) { 215 $checked_terms = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) ); 216 } else { 217 $checked_terms = array(); 218 } 219 220 $terms = get_terms( 221 array( 222 'taxonomy' => $taxonomy, 223 'orderby' => 'count', 224 'order' => 'DESC', 225 'number' => $number, 226 'hierarchical' => false, 227 ) 228 ); 229 230 $tax = get_taxonomy( $taxonomy ); 231 232 $popular_ids = array(); 233 234 foreach ( (array) $terms as $term ) { 235 $popular_ids[] = $term->term_id; 236 237 if ( ! $display ) { // Hack for Ajax use. 238 continue; 239 } 240 241 $id = "popular-$taxonomy-$term->term_id"; 242 $checked = in_array( $term->term_id, $checked_terms, true ) ? 'checked="checked"' : ''; 243 ?> 244 245 <li id="<?php echo $id; ?>" class="popular-category"> 246 <label class="selectit"> 247 <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 ) ); ?> /> 248 <?php 249 /** This filter is documented in wp-includes/category-template.php */ 250 echo esc_html( apply_filters( 'the_category', $term->name, '', '' ) ); 251 ?> 252 </label> 253 </li> 254 255 <?php 256 } 257 return $popular_ids; 258 } 259 260 /** 261 * Outputs a link category checklist element. 262 * 263 * @since 2.5.1 264 * 265 * @param int $link_id Optional. The link ID. Default 0. 266 */ 267 function wp_link_category_checklist( $link_id = 0 ) { 268 $default = 1; 269 270 $checked_categories = array(); 271 272 if ( $link_id ) { 273 $checked_categories = wp_get_link_cats( $link_id ); 274 // No selected categories, strange. 275 if ( ! count( $checked_categories ) ) { 276 $checked_categories[] = $default; 277 } 278 } else { 279 $checked_categories[] = $default; 280 } 281 282 $categories = get_terms( 283 array( 284 'taxonomy' => 'link_category', 285 'orderby' => 'name', 286 'hide_empty' => 0, 287 ) 288 ); 289 290 if ( empty( $categories ) ) { 291 return; 292 } 293 294 foreach ( $categories as $category ) { 295 $cat_id = $category->term_id; 296 297 /** This filter is documented in wp-includes/category-template.php */ 298 $name = esc_html( apply_filters( 'the_category', $category->name, '', '' ) ); 299 $checked = in_array( $cat_id, $checked_categories, true ) ? ' checked="checked"' : ''; 300 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>'; 301 } 302 } 303 304 /** 305 * Adds hidden fields with the data for use in the inline editor for posts and pages. 306 * 307 * @since 2.7.0 308 * 309 * @param WP_Post $post Post object. 310 */ 311 function get_inline_data( $post ) { 312 $post_type_object = get_post_type_object( $post->post_type ); 313 if ( ! current_user_can( 'edit_post', $post->ID ) ) { 314 return; 315 } 316 317 $title = esc_textarea( trim( $post->post_title ) ); 318 319 /** This filter is documented in wp-admin/edit-tag-form.php */ 320 $editable_slug = apply_filters( 'editable_slug', $post->post_name, $post ); 321 322 echo ' 323 <div class="hidden" id="inline_' . $post->ID . '"> 324 <div class="post_title">' . $title . '</div> 325 <div class="post_name">' . $editable_slug . '</div> 326 <div class="post_author">' . $post->post_author . '</div> 327 <div class="comment_status">' . esc_html( $post->comment_status ) . '</div> 328 <div class="ping_status">' . esc_html( $post->ping_status ) . '</div> 329 <div class="_status">' . esc_html( $post->post_status ) . '</div> 330 <div class="jj">' . mysql2date( 'd', $post->post_date, false ) . '</div> 331 <div class="mm">' . mysql2date( 'm', $post->post_date, false ) . '</div> 332 <div class="aa">' . mysql2date( 'Y', $post->post_date, false ) . '</div> 333 <div class="hh">' . mysql2date( 'H', $post->post_date, false ) . '</div> 334 <div class="mn">' . mysql2date( 'i', $post->post_date, false ) . '</div> 335 <div class="ss">' . mysql2date( 's', $post->post_date, false ) . '</div> 336 <div class="post_password">' . esc_html( $post->post_password ) . '</div>'; 337 338 if ( $post_type_object->hierarchical ) { 339 echo '<div class="post_parent">' . $post->post_parent . '</div>'; 340 } 341 342 echo '<div class="page_template">' . ( $post->page_template ? esc_html( $post->page_template ) : 'default' ) . '</div>'; 343 344 if ( post_type_supports( $post->post_type, 'page-attributes' ) ) { 345 echo '<div class="menu_order">' . $post->menu_order . '</div>'; 346 } 347 348 $taxonomy_names = get_object_taxonomies( $post->post_type ); 349 350 foreach ( $taxonomy_names as $taxonomy_name ) { 351 $taxonomy = get_taxonomy( $taxonomy_name ); 352 353 if ( ! $taxonomy->show_in_quick_edit ) { 354 continue; 355 } 356 357 if ( $taxonomy->hierarchical ) { 358 359 $terms = get_object_term_cache( $post->ID, $taxonomy_name ); 360 if ( false === $terms ) { 361 $terms = wp_get_object_terms( $post->ID, $taxonomy_name ); 362 wp_cache_add( $post->ID, wp_list_pluck( $terms, 'term_id' ), $taxonomy_name . '_relationships' ); 363 } 364 $term_ids = empty( $terms ) ? array() : wp_list_pluck( $terms, 'term_id' ); 365 366 echo '<div class="post_category" id="' . $taxonomy_name . '_' . $post->ID . '">' . implode( ',', $term_ids ) . '</div>'; 367 368 } else { 369 370 $terms_to_edit = get_terms_to_edit( $post->ID, $taxonomy_name ); 371 if ( ! is_string( $terms_to_edit ) ) { 372 $terms_to_edit = ''; 373 } 374 375 echo '<div class="tags_input" id="' . $taxonomy_name . '_' . $post->ID . '">' 376 . esc_html( str_replace( ',', ', ', $terms_to_edit ) ) . '</div>'; 377 378 } 379 } 380 381 if ( ! $post_type_object->hierarchical ) { 382 echo '<div class="sticky">' . ( is_sticky( $post->ID ) ? 'sticky' : '' ) . '</div>'; 383 } 384 385 if ( post_type_supports( $post->post_type, 'post-formats' ) ) { 386 echo '<div class="post_format">' . esc_html( get_post_format( $post->ID ) ) . '</div>'; 387 } 388 389 /** 390 * Fires after outputting the fields for the inline editor for posts and pages. 391 * 392 * @since 4.9.8 393 * 394 * @param WP_Post $post The current post object. 395 * @param WP_Post_Type $post_type_object The current post's post type object. 396 */ 397 do_action( 'add_inline_data', $post, $post_type_object ); 398 399 echo '</div>'; 400 } 401 402 /** 403 * Outputs the in-line comment reply-to form in the Comments list table. 404 * 405 * @since 2.7.0 406 * 407 * @global WP_List_Table $wp_list_table 408 * 409 * @param int $position Optional. The value of the 'position' input field. Default 1. 410 * @param bool $checkbox Optional. The value of the 'checkbox' input field. Default false. 411 * @param string $mode Optional. If set to 'single', will use WP_Post_Comments_List_Table, 412 * otherwise WP_Comments_List_Table. Default 'single'. 413 * @param bool $table_row Optional. Whether to use a table instead of a div element. Default true. 414 */ 415 function wp_comment_reply( $position = 1, $checkbox = false, $mode = 'single', $table_row = true ) { 416 global $wp_list_table; 417 /** 418 * Filters the in-line comment reply-to form output in the Comments 419 * list table. 420 * 421 * Returning a non-empty value here will short-circuit display 422 * of the in-line comment-reply form in the Comments list table, 423 * echoing the returned value instead. 424 * 425 * @since 2.7.0 426 * 427 * @see wp_comment_reply() 428 * 429 * @param string $content The reply-to form content. 430 * @param array $args An array of default args. 431 */ 432 $content = apply_filters( 433 'wp_comment_reply', 434 '', 435 array( 436 'position' => $position, 437 'checkbox' => $checkbox, 438 'mode' => $mode, 439 ) 440 ); 441 442 if ( ! empty( $content ) ) { 443 echo $content; 444 return; 445 } 446 447 if ( ! $wp_list_table ) { 448 if ( 'single' === $mode ) { 449 $wp_list_table = _get_list_table( 'WP_Post_Comments_List_Table' ); 450 } else { 451 $wp_list_table = _get_list_table( 'WP_Comments_List_Table' ); 452 } 453 } 454 455 ?> 456 <form method="get"> 457 <?php if ( $table_row ) : ?> 458 <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"> 459 <?php else : ?> 460 <div id="com-reply" style="display:none;"><div id="replyrow" style="display:none;"> 461 <?php endif; ?> 462 <fieldset class="comment-reply"> 463 <legend> 464 <span class="hidden" id="editlegend"><?php _e( 'Edit Comment' ); ?></span> 465 <span class="hidden" id="replyhead"><?php _e( 'Reply to Comment' ); ?></span> 466 <span class="hidden" id="addhead"><?php _e( 'Add Comment' ); ?></span> 467 </legend> 468 469 <div id="replycontainer"> 470 <label for="replycontent" class="screen-reader-text"> 471 <?php 472 /* translators: Hidden accessibility text. */ 473 _e( 'Comment' ); 474 ?> 475 </label> 476 <?php 477 $quicktags_settings = array( 'buttons' => 'strong,em,link,block,del,ins,img,ul,ol,li,code,close' ); 478 wp_editor( 479 '', 480 'replycontent', 481 array( 482 'media_buttons' => false, 483 'tinymce' => false, 484 'quicktags' => $quicktags_settings, 485 ) 486 ); 487 ?> 488 </div> 489 490 <div id="edithead" style="display:none;"> 491 <div class="inside"> 492 <label for="author-name"><?php _e( 'Name' ); ?></label> 493 <input type="text" name="newcomment_author" size="50" value="" id="author-name" /> 494 </div> 495 496 <div class="inside"> 497 <label for="author-email"><?php _e( 'Email' ); ?></label> 498 <input type="text" name="newcomment_author_email" size="50" class="code" value="" id="author-email" /> 499 </div> 500 501 <div class="inside"> 502 <label for="author-url"><?php _e( 'URL' ); ?></label> 503 <input type="text" id="author-url" name="newcomment_author_url" class="code" size="103" value="" /> 504 </div> 505 </div> 506 507 <div id="replysubmit" class="submit"> 508 <p class="reply-submit-buttons"> 509 <button type="button" class="save button button-primary"> 510 <span id="addbtn" style="display: none;"><?php _e( 'Add Comment' ); ?></span> 511 <span id="savebtn" style="display: none;"><?php _e( 'Update Comment' ); ?></span> 512 <span id="replybtn" style="display: none;"><?php _e( 'Submit Reply' ); ?></span> 513 </button> 514 <button type="button" class="cancel button"><?php _e( 'Cancel' ); ?></button> 515 <span class="waiting spinner"></span> 516 </p> 517 <?php 518 wp_admin_notice( 519 '<p class="error"></p>', 520 array( 521 'type' => 'error', 522 'additional_classes' => array( 'notice-alt', 'inline', 'hidden' ), 523 'paragraph_wrap' => false, 524 ) 525 ); 526 ?> 527 </div> 528 529 <input type="hidden" name="action" id="action" value="" /> 530 <input type="hidden" name="comment_ID" id="comment_ID" value="" /> 531 <input type="hidden" name="comment_post_ID" id="comment_post_ID" value="" /> 532 <input type="hidden" name="status" id="status" value="" /> 533 <input type="hidden" name="position" id="position" value="<?php echo $position; ?>" /> 534 <input type="hidden" name="checkbox" id="checkbox" value="<?php echo $checkbox ? 1 : 0; ?>" /> 535 <input type="hidden" name="mode" id="mode" value="<?php echo esc_attr( $mode ); ?>" /> 536 <?php 537 wp_nonce_field( 'replyto-comment', '_ajax_nonce-replyto-comment', false ); 538 if ( current_user_can( 'unfiltered_html' ) ) { 539 wp_nonce_field( 'unfiltered-html-comment', '_wp_unfiltered_html_comment', false ); 540 } 541 ?> 542 </fieldset> 543 <?php if ( $table_row ) : ?> 544 </td></tr></tbody></table> 545 <?php else : ?> 546 </div></div> 547 <?php endif; ?> 548 </form> 549 <?php 550 } 551 552 /** 553 * Outputs 'undo move to Trash' text for comments. 554 * 555 * @since 2.9.0 556 */ 557 function wp_comment_trashnotice() { 558 ?> 559 <div class="hidden" id="trash-undo-holder"> 560 <div class="trash-undo-inside"> 561 <?php 562 /* translators: %s: Comment author, filled by Ajax. */ 563 printf( __( 'Comment by %s moved to the Trash.' ), '<strong></strong>' ); 564 ?> 565 <span class="undo untrash"><a href="#"><?php _e( 'Undo' ); ?></a></span> 566 </div> 567 </div> 568 <div class="hidden" id="spam-undo-holder"> 569 <div class="spam-undo-inside"> 570 <?php 571 /* translators: %s: Comment author, filled by Ajax. */ 572 printf( __( 'Comment by %s marked as spam.' ), '<strong></strong>' ); 573 ?> 574 <span class="undo unspam"><a href="#"><?php _e( 'Undo' ); ?></a></span> 575 </div> 576 </div> 577 <?php 578 } 579 580 /** 581 * Outputs a post's public meta data in the Custom Fields meta box. 582 * 583 * @since 1.2.0 584 * 585 * @param array[] $meta An array of meta data arrays keyed on 'meta_key' and 'meta_value'. 586 */ 587 function list_meta( $meta ) { 588 // Exit if no meta. 589 if ( ! $meta ) { 590 echo ' 591 <table id="list-table" style="display: none;"> 592 <thead> 593 <tr> 594 <th class="left">' . _x( 'Name', 'meta name' ) . '</th> 595 <th>' . __( 'Value' ) . '</th> 596 </tr> 597 </thead> 598 <tbody id="the-list" data-wp-lists="list:meta"> 599 <tr><td></td></tr> 600 </tbody> 601 </table>'; // TBODY needed for list-manipulation JS. 602 return; 603 } 604 $count = 0; 605 ?> 606 <table id="list-table"> 607 <thead> 608 <tr> 609 <th class="left"><?php _ex( 'Name', 'meta name' ); ?></th> 610 <th><?php _e( 'Value' ); ?></th> 611 </tr> 612 </thead> 613 <tbody id='the-list' data-wp-lists='list:meta'> 614 <?php 615 foreach ( $meta as $entry ) { 616 echo _list_meta_row( $entry, $count ); 617 } 618 ?> 619 </tbody> 620 </table> 621 <?php 622 } 623 624 /** 625 * Outputs a single row of public meta data in the Custom Fields meta box. 626 * 627 * @since 2.5.0 628 * 629 * @param array $entry An array of meta data keyed on 'meta_key' and 'meta_value'. 630 * @param int $count Reference to the row number. 631 * @return string A single row of public meta data. 632 */ 633 function _list_meta_row( $entry, &$count ) { 634 static $update_nonce = ''; 635 636 if ( is_protected_meta( $entry['meta_key'], 'post' ) ) { 637 return ''; 638 } 639 640 if ( ! $update_nonce ) { 641 $update_nonce = wp_create_nonce( 'add-meta' ); 642 } 643 644 $r = ''; 645 ++$count; 646 647 if ( is_serialized( $entry['meta_value'] ) ) { 648 if ( is_serialized_string( $entry['meta_value'] ) ) { 649 // This is a serialized string, so we should display it. 650 $entry['meta_value'] = maybe_unserialize( $entry['meta_value'] ); 651 } else { 652 // This is a serialized array/object so we should NOT display it. 653 --$count; 654 return ''; 655 } 656 } 657 658 $entry['meta_key'] = esc_attr( $entry['meta_key'] ); 659 $entry['meta_value'] = esc_textarea( $entry['meta_value'] ); // Using a <textarea />. 660 $entry['meta_id'] = (int) $entry['meta_id']; 661 662 $delete_nonce = wp_create_nonce( 'delete-meta_' . $entry['meta_id'] ); 663 664 $r .= "\n\t<tr id='meta-{$entry['meta_id']}'>"; 665 $r .= "\n\t\t<td class='left'><label class='screen-reader-text' for='meta-{$entry['meta_id']}-key'>" . 666 /* translators: Hidden accessibility text. */ 667 __( 'Key' ) . 668 "</label><input name='meta[{$entry['meta_id']}][key]' id='meta-{$entry['meta_id']}-key' type='text' size='20' value='{$entry['meta_key']}' />"; 669 670 $r .= "\n\t\t<div class='submit'>"; 671 $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" ) ); 672 $r .= "\n\t\t"; 673 $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" ) ); 674 $r .= '</div>'; 675 $r .= wp_nonce_field( 'change-meta', '_ajax_nonce', false, false ); 676 $r .= '</td>'; 677 678 $r .= "\n\t\t<td><label class='screen-reader-text' for='meta-{$entry['meta_id']}-value'>" . 679 /* translators: Hidden accessibility text. */ 680 __( 'Value' ) . 681 "</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>"; 682 return $r; 683 } 684 685 /** 686 * Prints the form in the Custom Fields meta box. 687 * 688 * @since 1.2.0 689 * 690 * @global wpdb $wpdb WordPress database abstraction object. 691 * 692 * @param WP_Post $post Optional. The post being edited. 693 */ 694 function meta_form( $post = null ) { 695 global $wpdb; 696 $post = get_post( $post ); 697 698 /** 699 * Filters values for the meta key dropdown in the Custom Fields meta box. 700 * 701 * Returning a non-null value will effectively short-circuit and avoid a 702 * potentially expensive query against postmeta. 703 * 704 * @since 4.4.0 705 * 706 * @param array|null $keys Pre-defined meta keys to be used in place of a postmeta query. Default null. 707 * @param WP_Post $post The current post object. 708 */ 709 $keys = apply_filters( 'postmeta_form_keys', null, $post ); 710 711 if ( null === $keys ) { 712 /** 713 * Filters the number of custom fields to retrieve for the drop-down 714 * in the Custom Fields meta box. 715 * 716 * @since 2.1.0 717 * 718 * @param int $limit Number of custom fields to retrieve. Default 30. 719 */ 720 $limit = apply_filters( 'postmeta_form_limit', 30 ); 721 722 $keys = $wpdb->get_col( 723 $wpdb->prepare( 724 "SELECT DISTINCT meta_key 725 FROM $wpdb->postmeta 726 WHERE meta_key NOT BETWEEN '_' AND '_z' 727 HAVING meta_key NOT LIKE %s 728 ORDER BY meta_key 729 LIMIT %d", 730 $wpdb->esc_like( '_' ) . '%', 731 $limit 732 ) 733 ); 734 } 735 736 if ( $keys ) { 737 natcasesort( $keys ); 738 } 739 ?> 740 <p><strong><?php _e( 'Add Custom Field:' ); ?></strong></p> 741 <table id="newmeta"> 742 <thead> 743 <tr> 744 <th class="left"><label for="metakeyselect"><?php _ex( 'Name', 'meta name' ); ?></label></th> 745 <th><label for="metavalue"><?php _e( 'Value' ); ?></label></th> 746 </tr> 747 </thead> 748 749 <tbody> 750 <tr> 751 <td id="newmetaleft" class="left"> 752 <?php if ( $keys ) { ?> 753 <select id="metakeyselect" name="metakeyselect"> 754 <option value="#NONE#"><?php _e( '— Select —' ); ?></option> 755 <?php 756 foreach ( $keys as $key ) { 757 if ( is_protected_meta( $key, 'post' ) || ! current_user_can( 'add_post_meta', $post->ID, $key ) ) { 758 continue; 759 } 760 echo "\n<option value='" . esc_attr( $key ) . "'>" . esc_html( $key ) . '</option>'; 761 } 762 ?> 763 </select> 764 <input class="hidden" type="text" id="metakeyinput" name="metakeyinput" value="" aria-label="<?php _e( 'New custom field name' ); ?>" /> 765 <button type="button" id="newmeta-button" class="button button-small hide-if-no-js" onclick="jQuery('#metakeyinput, #metakeyselect, #enternew, #cancelnew').toggleClass('hidden');jQuery('#metakeyinput, #metakeyselect').filter(':visible').trigger('focus');"> 766 <span id="enternew"><?php _e( 'Enter new' ); ?></span> 767 <span id="cancelnew" class="hidden"><?php _e( 'Cancel' ); ?></span></button> 768 <?php } else { ?> 769 <input type="text" id="metakeyinput" name="metakeyinput" value="" /> 770 <?php } ?> 771 </td> 772 <td><textarea id="metavalue" name="metavalue" rows="2" cols="25"></textarea> 773 <?php wp_nonce_field( 'add-meta', '_ajax_nonce-add-meta', false ); ?> 774 </td> 775 </tr> 776 </tbody> 777 </table> 778 <div class="submit add-custom-field"> 779 <?php 780 submit_button( 781 __( 'Add Custom Field' ), 782 '', 783 'addmeta', 784 false, 785 array( 786 'id' => 'newmeta-submit', 787 'data-wp-lists' => 'add:the-list:newmeta', 788 ) 789 ); 790 ?> 791 </div> 792 <?php 793 } 794 795 /** 796 * Prints out HTML form date elements for editing post or comment publish date. 797 * 798 * @since 0.71 799 * @since 4.4.0 Converted to use get_comment() instead of the global `$comment`. 800 * 801 * @global WP_Locale $wp_locale WordPress date and time locale object. 802 * 803 * @param int|bool $edit Accepts 1|true for editing the date, 0|false for adding the date. 804 * @param int|bool $for_post Accepts 1|true for applying the date to a post, 0|false for a comment. 805 * @param int $tab_index The tabindex attribute to add. Default 0. 806 * @param int|bool $multi Optional. Whether the additional fields and buttons should be added. 807 * Default 0|false. 808 */ 809 function touch_time( $edit = 1, $for_post = 1, $tab_index = 0, $multi = 0 ) { 810 global $wp_locale; 811 $post = get_post(); 812 813 if ( $for_post ) { 814 $edit = ! ( in_array( $post->post_status, array( 'draft', 'pending' ), true ) && ( ! $post->post_date_gmt || '0000-00-00 00:00:00' === $post->post_date_gmt ) ); 815 } 816 817 $tab_index_attribute = ''; 818 if ( (int) $tab_index > 0 ) { 819 $tab_index_attribute = " tabindex=\"$tab_index\""; 820 } 821 822 $post_date = ( $for_post ) ? $post->post_date : get_comment()->comment_date; 823 $jj = ( $edit ) ? mysql2date( 'd', $post_date, false ) : current_time( 'd' ); 824 $mm = ( $edit ) ? mysql2date( 'm', $post_date, false ) : current_time( 'm' ); 825 $aa = ( $edit ) ? mysql2date( 'Y', $post_date, false ) : current_time( 'Y' ); 826 $hh = ( $edit ) ? mysql2date( 'H', $post_date, false ) : current_time( 'H' ); 827 $mn = ( $edit ) ? mysql2date( 'i', $post_date, false ) : current_time( 'i' ); 828 $ss = ( $edit ) ? mysql2date( 's', $post_date, false ) : current_time( 's' ); 829 830 $cur_jj = current_time( 'd' ); 831 $cur_mm = current_time( 'm' ); 832 $cur_aa = current_time( 'Y' ); 833 $cur_hh = current_time( 'H' ); 834 $cur_mn = current_time( 'i' ); 835 836 $month = '<label><span class="screen-reader-text">' . 837 /* translators: Hidden accessibility text. */ 838 __( 'Month' ) . 839 '</span><select class="form-required" ' . ( $multi ? '' : 'id="mm" ' ) . 'name="mm"' . $tab_index_attribute . ">\n"; 840 for ( $i = 1; $i < 13; $i = $i + 1 ) { 841 $monthnum = zeroise( $i, 2 ); 842 $monthtext = $wp_locale->get_month_abbrev( $wp_locale->get_month( $i ) ); 843 $month .= "\t\t\t" . '<option value="' . $monthnum . '" data-text="' . $monthtext . '" ' . selected( $monthnum, $mm, false ) . '>'; 844 /* translators: 1: Month number (01, 02, etc.), 2: Month abbreviation. */ 845 $month .= sprintf( __( '%1$s-%2$s' ), $monthnum, $monthtext ) . "</option>\n"; 846 } 847 $month .= '</select></label>'; 848 849 $day = '<label><span class="screen-reader-text">' . 850 /* translators: Hidden accessibility text. */ 851 __( 'Day' ) . 852 '</span><input type="text" ' . ( $multi ? '' : 'id="jj" ' ) . 'name="jj" value="' . $jj . '" size="2" maxlength="2"' . $tab_index_attribute . ' autocomplete="off" class="form-required" inputmode="numeric" /></label>'; 853 $year = '<label><span class="screen-reader-text">' . 854 /* translators: Hidden accessibility text. */ 855 __( 'Year' ) . 856 '</span><input type="text" ' . ( $multi ? '' : 'id="aa" ' ) . 'name="aa" value="' . $aa . '" size="4" maxlength="4"' . $tab_index_attribute . ' autocomplete="off" class="form-required" inputmode="numeric" /></label>'; 857 $hour = '<label><span class="screen-reader-text">' . 858 /* translators: Hidden accessibility text. */ 859 __( 'Hour' ) . 860 '</span><input type="text" ' . ( $multi ? '' : 'id="hh" ' ) . 'name="hh" value="' . $hh . '" size="2" maxlength="2"' . $tab_index_attribute . ' autocomplete="off" class="form-required" inputmode="numeric" /></label>'; 861 $minute = '<label><span class="screen-reader-text">' . 862 /* translators: Hidden accessibility text. */ 863 __( 'Minute' ) . 864 '</span><input type="text" ' . ( $multi ? '' : 'id="mn" ' ) . 'name="mn" value="' . $mn . '" size="2" maxlength="2"' . $tab_index_attribute . ' autocomplete="off" class="form-required" inputmode="numeric" /></label>'; 865 866 echo '<div class="timestamp-wrap">'; 867 /* translators: 1: Month, 2: Day, 3: Year, 4: Hour, 5: Minute. */ 868 printf( __( '%1$s %2$s, %3$s at %4$s:%5$s' ), $month, $day, $year, $hour, $minute ); 869 870 echo '</div><input type="hidden" id="ss" name="ss" value="' . $ss . '" />'; 871 872 if ( $multi ) { 873 return; 874 } 875 876 echo "\n\n"; 877 878 $map = array( 879 'mm' => array( $mm, $cur_mm ), 880 'jj' => array( $jj, $cur_jj ), 881 'aa' => array( $aa, $cur_aa ), 882 'hh' => array( $hh, $cur_hh ), 883 'mn' => array( $mn, $cur_mn ), 884 ); 885 886 foreach ( $map as $timeunit => $value ) { 887 list( $unit, $curr ) = $value; 888 889 echo '<input type="hidden" id="hidden_' . $timeunit . '" name="hidden_' . $timeunit . '" value="' . $unit . '" />' . "\n"; 890 $cur_timeunit = 'cur_' . $timeunit; 891 echo '<input type="hidden" id="' . $cur_timeunit . '" name="' . $cur_timeunit . '" value="' . $curr . '" />' . "\n"; 892 } 893 ?> 894 895 <p> 896 <a href="#edit_timestamp" class="save-timestamp hide-if-no-js button"><?php _e( 'OK' ); ?></a> 897 <a href="#edit_timestamp" class="cancel-timestamp hide-if-no-js button-cancel"><?php _e( 'Cancel' ); ?></a> 898 </p> 899 <?php 900 } 901 902 /** 903 * Prints out option HTML elements for the page templates drop-down. 904 * 905 * @since 1.5.0 906 * @since 4.7.0 Added the `$post_type` parameter. 907 * 908 * @param string $default_template Optional. The template file name. Default empty. 909 * @param string $post_type Optional. Post type to get templates for. Default 'page'. 910 */ 911 function page_template_dropdown( $default_template = '', $post_type = 'page' ) { 912 $templates = get_page_templates( null, $post_type ); 913 914 ksort( $templates ); 915 916 foreach ( array_keys( $templates ) as $template ) { 917 $selected = selected( $default_template, $templates[ $template ], false ); 918 echo "\n\t<option value='" . esc_attr( $templates[ $template ] ) . "' $selected>" . esc_html( $template ) . '</option>'; 919 } 920 } 921 922 /** 923 * Prints out option HTML elements for the page parents drop-down. 924 * 925 * @since 1.5.0 926 * @since 4.4.0 `$post` argument was added. 927 * 928 * @global wpdb $wpdb WordPress database abstraction object. 929 * 930 * @param int $default_page Optional. The default page ID to be pre-selected. Default 0. 931 * @param int $parent_page Optional. The parent page ID. Default 0. 932 * @param int $level Optional. Page depth level. Default 0. 933 * @param int|WP_Post $post Post ID or WP_Post object. 934 * @return void|false Void on success, false if the page has no children. 935 */ 936 function parent_dropdown( $default_page = 0, $parent_page = 0, $level = 0, $post = null ) { 937 global $wpdb; 938 939 $post = get_post( $post ); 940 $items = $wpdb->get_results( 941 $wpdb->prepare( 942 "SELECT ID, post_parent, post_title 943 FROM $wpdb->posts 944 WHERE post_parent = %d AND post_type = 'page' 945 ORDER BY menu_order", 946 $parent_page 947 ) 948 ); 949 950 if ( $items ) { 951 foreach ( $items as $item ) { 952 // A page cannot be its own parent. 953 if ( $post && $post->ID && (int) $item->ID === $post->ID ) { 954 continue; 955 } 956 957 $pad = str_repeat( ' ', $level * 3 ); 958 $selected = selected( $default_page, $item->ID, false ); 959 960 echo "\n\t<option class='level-$level' value='$item->ID' $selected>$pad " . esc_html( $item->post_title ) . '</option>'; 961 parent_dropdown( $default_page, $item->ID, $level + 1 ); 962 } 963 } else { 964 return false; 965 } 966 } 967 968 /** 969 * Prints out option HTML elements for role selectors. 970 * 971 * @since 2.1.0 972 * @since 7.0.0 Added $editable_roles parameter. 973 * 974 * @param string $selected Slug for the role that should be already selected. 975 * @param array $editable_roles Array of roles to include in the dropdown. Defaults to all 976 * roles the current user is allowed to edit. 977 */ 978 function wp_dropdown_roles( $selected = '', $editable_roles = null ) { 979 $r = ''; 980 981 if ( null === $editable_roles ) { 982 $editable_roles = array_reverse( get_editable_roles() ); 983 } 984 985 foreach ( $editable_roles as $role => $details ) { 986 $name = translate_user_role( $details['name'] ); 987 // Preselect specified role. 988 if ( $selected === $role ) { 989 $r .= "\n\t<option selected='selected' value='" . esc_attr( $role ) . "'>$name</option>"; 990 } else { 991 $r .= "\n\t<option value='" . esc_attr( $role ) . "'>$name</option>"; 992 } 993 } 994 995 echo $r; 996 } 997 998 /** 999 * Outputs the form used by the importers to accept the data to be imported. 1000 * 1001 * @since 2.0.0 1002 * 1003 * @param string $action The action attribute for the form. 1004 */ 1005 function wp_import_upload_form( $action ) { 1006 1007 /** 1008 * Filters the maximum allowed upload size for import files. 1009 * 1010 * @since 2.3.0 1011 * 1012 * @see wp_max_upload_size() 1013 * 1014 * @param int $max_upload_size Allowed upload size. Default 1 MB. 1015 */ 1016 $bytes = apply_filters( 'import_upload_size_limit', wp_max_upload_size() ); 1017 $size = size_format( $bytes ); 1018 $upload_dir = wp_upload_dir(); 1019 if ( ! empty( $upload_dir['error'] ) ) : 1020 $upload_directory_error = '<p>' . __( 'Before you can upload your import file, you will need to fix the following error:' ) . '</p>'; 1021 $upload_directory_error .= '<p><strong>' . $upload_dir['error'] . '</strong></p>'; 1022 wp_admin_notice( 1023 $upload_directory_error, 1024 array( 1025 'additional_classes' => array( 'error' ), 1026 'paragraph_wrap' => false, 1027 ) 1028 ); 1029 else : 1030 ?> 1031 <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' ) ); ?>"> 1032 <p> 1033 <?php 1034 printf( 1035 '<label for="upload">%s</label> (%s)', 1036 __( 'Choose a file from your computer:' ), 1037 /* translators: %s: Maximum allowed file size. */ 1038 sprintf( __( 'Maximum size: %s' ), $size ) 1039 ); 1040 ?> 1041 <input type="file" id="upload" name="import" size="25" /> 1042 <input type="hidden" name="action" value="save" /> 1043 <input type="hidden" name="max_file_size" value="<?php echo $bytes; ?>" /> 1044 </p> 1045 <?php submit_button( __( 'Upload file and import' ), 'primary' ); ?> 1046 </form> 1047 <?php 1048 endif; 1049 } 1050 1051 /** 1052 * Adds a meta box to one or more screens. 1053 * 1054 * @since 2.5.0 1055 * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs. 1056 * 1057 * @global array $wp_meta_boxes Global meta box state. 1058 * 1059 * @param string $id Meta box ID (used in the 'id' attribute for the meta box). 1060 * @param string $title Title of the meta box. 1061 * @param callable $callback Function that fills the box with the desired content. 1062 * The function should echo its output. 1063 * @param string|array|WP_Screen $screen Optional. The screen or screens on which to show the box 1064 * (such as a post type, 'link', or 'comment'). Accepts a single 1065 * screen ID, WP_Screen object, or array of screen IDs. Default 1066 * is the current screen. If you have used add_menu_page() or 1067 * add_submenu_page() to create a new screen (and hence screen_id), 1068 * make sure your menu slug conforms to the limits of sanitize_key() 1069 * otherwise the 'screen' menu may not correctly render on your page. 1070 * @param string $context Optional. The context within the screen where the box 1071 * should display. Available contexts vary from screen to 1072 * screen. Post edit screen contexts include 'normal', 'side', 1073 * and 'advanced'. Comments screen contexts include 'normal' 1074 * and 'side'. Menus meta boxes (accordion sections) all use 1075 * the 'side' context. Global default is 'advanced'. 1076 * @param string $priority Optional. The priority within the context where the box should show. 1077 * Accepts 'high', 'core', 'default', or 'low'. Default 'default'. 1078 * @param array $callback_args Optional. Data that should be set as the $args property 1079 * of the box array (which is the second parameter passed 1080 * to your callback). Default null. 1081 */ 1082 function add_meta_box( $id, $title, $callback, $screen = null, $context = 'advanced', $priority = 'default', $callback_args = null ) { 1083 global $wp_meta_boxes; 1084 1085 if ( empty( $screen ) ) { 1086 $screen = get_current_screen(); 1087 } elseif ( is_string( $screen ) ) { 1088 $screen = convert_to_screen( $screen ); 1089 } elseif ( is_array( $screen ) ) { 1090 foreach ( $screen as $single_screen ) { 1091 add_meta_box( $id, $title, $callback, $single_screen, $context, $priority, $callback_args ); 1092 } 1093 } 1094 1095 if ( ! isset( $screen->id ) ) { 1096 return; 1097 } 1098 1099 $page = $screen->id; 1100 1101 if ( ! isset( $wp_meta_boxes ) ) { 1102 $wp_meta_boxes = array(); 1103 } 1104 if ( ! isset( $wp_meta_boxes[ $page ] ) ) { 1105 $wp_meta_boxes[ $page ] = array(); 1106 } 1107 if ( ! isset( $wp_meta_boxes[ $page ][ $context ] ) ) { 1108 $wp_meta_boxes[ $page ][ $context ] = array(); 1109 } 1110 1111 foreach ( array_keys( $wp_meta_boxes[ $page ] ) as $a_context ) { 1112 foreach ( array( 'high', 'core', 'default', 'low' ) as $a_priority ) { 1113 if ( ! isset( $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ] ) ) { 1114 continue; 1115 } 1116 1117 // If a core box was previously removed, don't add. 1118 if ( ( 'core' === $priority || 'sorted' === $priority ) 1119 && false === $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ] 1120 ) { 1121 return; 1122 } 1123 1124 // If a core box was previously added by a plugin, don't add. 1125 if ( 'core' === $priority ) { 1126 /* 1127 * If the box was added with default priority, give it core priority 1128 * to maintain sort order. 1129 */ 1130 if ( 'default' === $a_priority ) { 1131 $wp_meta_boxes[ $page ][ $a_context ]['core'][ $id ] = $wp_meta_boxes[ $page ][ $a_context ]['default'][ $id ]; 1132 unset( $wp_meta_boxes[ $page ][ $a_context ]['default'][ $id ] ); 1133 } 1134 return; 1135 } 1136 1137 // If no priority given and ID already present, use existing priority. 1138 if ( empty( $priority ) ) { 1139 $priority = $a_priority; 1140 /* 1141 * Else, if we're adding to the sorted priority, we don't know the title 1142 * or callback. Grab them from the previously added context/priority. 1143 */ 1144 } elseif ( 'sorted' === $priority ) { 1145 $title = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['title']; 1146 $callback = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['callback']; 1147 $callback_args = $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ]['args']; 1148 } 1149 1150 // An ID can be in only one priority and one context. 1151 if ( $priority !== $a_priority || $context !== $a_context ) { 1152 unset( $wp_meta_boxes[ $page ][ $a_context ][ $a_priority ][ $id ] ); 1153 } 1154 } 1155 } 1156 1157 if ( empty( $priority ) ) { 1158 $priority = 'low'; 1159 } 1160 1161 if ( ! isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) { 1162 $wp_meta_boxes[ $page ][ $context ][ $priority ] = array(); 1163 } 1164 1165 $wp_meta_boxes[ $page ][ $context ][ $priority ][ $id ] = array( 1166 'id' => $id, 1167 'title' => $title, 1168 'callback' => $callback, 1169 'args' => $callback_args, 1170 ); 1171 } 1172 1173 1174 /** 1175 * Renders a "fake" meta box with an information message, 1176 * shown on the block editor, when an incompatible meta box is found. 1177 * 1178 * @since 5.0.0 1179 * 1180 * @param mixed $data_object The data object being rendered on this screen. 1181 * @param array $box { 1182 * Custom formats meta box arguments. 1183 * 1184 * @type string $id Meta box 'id' attribute. 1185 * @type string $title Meta box title. 1186 * @type callable $old_callback The original callback for this meta box. 1187 * @type array $args Extra meta box arguments. 1188 * } 1189 */ 1190 function do_block_editor_incompatible_meta_box( $data_object, $box ) { 1191 $plugin = _get_plugin_from_callback( $box['old_callback'] ); 1192 $plugins = get_plugins(); 1193 echo '<p>'; 1194 if ( $plugin ) { 1195 /* translators: %s: The name of the plugin that generated this meta box. */ 1196 printf( __( 'This meta box, from the %s plugin, is not compatible with the block editor.' ), "<strong>{$plugin['Name']}</strong>" ); 1197 } else { 1198 _e( 'This meta box is not compatible with the block editor.' ); 1199 } 1200 echo '</p>'; 1201 1202 if ( empty( $plugins['classic-editor/classic-editor.php'] ) ) { 1203 if ( current_user_can( 'install_plugins' ) ) { 1204 $install_url = wp_nonce_url( 1205 self_admin_url( 'plugin-install.php?tab=favorites&user=wordpressdotorg&save=0' ), 1206 'save_wporg_username_' . get_current_user_id() 1207 ); 1208 1209 echo '<p>'; 1210 /* translators: %s: A link to install the Classic Editor plugin. */ 1211 printf( __( 'Please install the <a href="%s">Classic Editor plugin</a> to use this meta box.' ), esc_url( $install_url ) ); 1212 echo '</p>'; 1213 } 1214 } elseif ( is_plugin_inactive( 'classic-editor/classic-editor.php' ) ) { 1215 if ( current_user_can( 'activate_plugins' ) ) { 1216 $activate_url = wp_nonce_url( 1217 self_admin_url( 'plugins.php?action=activate&plugin=classic-editor/classic-editor.php' ), 1218 'activate-plugin_classic-editor/classic-editor.php' 1219 ); 1220 1221 echo '<p>'; 1222 /* translators: %s: A link to activate the Classic Editor plugin. */ 1223 printf( __( 'Please activate the <a href="%s">Classic Editor plugin</a> to use this meta box.' ), esc_url( $activate_url ) ); 1224 echo '</p>'; 1225 } 1226 } elseif ( $data_object instanceof WP_Post ) { 1227 $edit_url = add_query_arg( 1228 array( 1229 'classic-editor' => '', 1230 'classic-editor__forget' => '', 1231 ), 1232 get_edit_post_link( $data_object ) 1233 ); 1234 echo '<p>'; 1235 /* translators: %s: A link to use the Classic Editor plugin. */ 1236 printf( __( 'Please open the <a href="%s">classic editor</a> to use this meta box.' ), esc_url( $edit_url ) ); 1237 echo '</p>'; 1238 } 1239 } 1240 1241 /** 1242 * Internal helper function to find the plugin from a meta box callback. 1243 * 1244 * @since 5.0.0 1245 * 1246 * @access private 1247 * 1248 * @param callable $callback The callback function to check. 1249 * @return array|null The plugin that the callback belongs to, or null if it doesn't belong to a plugin. 1250 */ 1251 function _get_plugin_from_callback( $callback ) { 1252 try { 1253 if ( is_array( $callback ) ) { 1254 $reflection = new ReflectionMethod( $callback[0], $callback[1] ); 1255 } elseif ( is_string( $callback ) && str_contains( $callback, '::' ) ) { 1256 $reflection = new ReflectionMethod( $callback ); 1257 } else { 1258 $reflection = new ReflectionFunction( $callback ); 1259 } 1260 } catch ( ReflectionException $exception ) { 1261 // We could not properly reflect on the callable, so we abort here. 1262 return null; 1263 } 1264 1265 // Don't show an error if it's an internal PHP function. 1266 if ( ! $reflection->isInternal() ) { 1267 1268 // Only show errors if the meta box was registered by a plugin. 1269 $filename = wp_normalize_path( $reflection->getFileName() ); 1270 $plugin_dir = wp_normalize_path( WP_PLUGIN_DIR ); 1271 1272 if ( str_starts_with( $filename, $plugin_dir ) ) { 1273 $filename = str_replace( $plugin_dir, '', $filename ); 1274 $filename = preg_replace( '|^/([^/]*/).*$|', '\\1', $filename ); 1275 1276 $plugins = get_plugins(); 1277 1278 foreach ( $plugins as $name => $plugin ) { 1279 if ( str_starts_with( $name, $filename ) ) { 1280 return $plugin; 1281 } 1282 } 1283 } 1284 } 1285 1286 return null; 1287 } 1288 1289 /** 1290 * Meta-Box template function. 1291 * 1292 * @since 2.5.0 1293 * 1294 * @global array $wp_meta_boxes Global meta box state. 1295 * 1296 * @param string|WP_Screen $screen The screen identifier. If you have used add_menu_page() or 1297 * add_submenu_page() to create a new screen (and hence screen_id) 1298 * make sure your menu slug conforms to the limits of sanitize_key() 1299 * otherwise the 'screen' menu may not correctly render on your page. 1300 * @param string $context The screen context for which to display meta boxes. 1301 * @param mixed $data_object Gets passed to the meta box callback function as the first parameter. 1302 * Often this is the object that's the focus of the current screen, 1303 * for example a `WP_Post` or `WP_Comment` object. 1304 * @return int Number of meta_boxes. 1305 */ 1306 function do_meta_boxes( $screen, $context, $data_object ) { 1307 global $wp_meta_boxes; 1308 static $already_sorted = false; 1309 1310 if ( empty( $screen ) ) { 1311 $screen = get_current_screen(); 1312 } elseif ( is_string( $screen ) ) { 1313 $screen = convert_to_screen( $screen ); 1314 } 1315 1316 $page = $screen->id; 1317 1318 $hidden = get_hidden_meta_boxes( $screen ); 1319 1320 printf( '<div id="%s-sortables" class="meta-box-sortables">', esc_attr( $context ) ); 1321 1322 /* 1323 * Grab the ones the user has manually sorted. 1324 * Pull them out of their previous context/priority and into the one the user chose. 1325 */ 1326 $sorted = get_user_option( "meta-box-order_$page" ); 1327 1328 if ( ! $already_sorted && $sorted ) { 1329 foreach ( $sorted as $box_context => $ids ) { 1330 foreach ( explode( ',', $ids ) as $id ) { 1331 if ( $id && 'dashboard_browser_nag' !== $id ) { 1332 add_meta_box( $id, null, null, $screen, $box_context, 'sorted' ); 1333 } 1334 } 1335 } 1336 } 1337 1338 $already_sorted = true; 1339 1340 $i = 0; 1341 1342 if ( isset( $wp_meta_boxes[ $page ][ $context ] ) ) { 1343 foreach ( array( 'high', 'sorted', 'core', 'default', 'low' ) as $priority ) { 1344 if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) { 1345 foreach ( (array) $wp_meta_boxes[ $page ][ $context ][ $priority ] as $box ) { 1346 if ( false === $box || ! $box['title'] ) { 1347 continue; 1348 } 1349 1350 $block_compatible = true; 1351 if ( is_array( $box['args'] ) ) { 1352 // If a meta box is just here for back compat, don't show it in the block editor. 1353 if ( $screen->is_block_editor() && isset( $box['args']['__back_compat_meta_box'] ) && $box['args']['__back_compat_meta_box'] ) { 1354 continue; 1355 } 1356 1357 if ( isset( $box['args']['__block_editor_compatible_meta_box'] ) ) { 1358 $block_compatible = (bool) $box['args']['__block_editor_compatible_meta_box']; 1359 unset( $box['args']['__block_editor_compatible_meta_box'] ); 1360 } 1361 1362 // If the meta box is declared as incompatible with the block editor, override the callback function. 1363 if ( ! $block_compatible && $screen->is_block_editor() ) { 1364 $box['old_callback'] = $box['callback']; 1365 $box['callback'] = 'do_block_editor_incompatible_meta_box'; 1366 } 1367 1368 if ( isset( $box['args']['__back_compat_meta_box'] ) ) { 1369 $block_compatible = $block_compatible || (bool) $box['args']['__back_compat_meta_box']; 1370 unset( $box['args']['__back_compat_meta_box'] ); 1371 } 1372 } 1373 1374 ++$i; 1375 // get_hidden_meta_boxes() doesn't apply in the block editor. 1376 $hidden_class = ( ! $screen->is_block_editor() && in_array( $box['id'], $hidden, true ) ) ? ' hide-if-js' : ''; 1377 echo '<div id="' . $box['id'] . '" class="postbox ' . postbox_classes( $box['id'], $page ) . $hidden_class . '" ' . ' role="region" aria-label="' . esc_attr( wp_strip_all_tags( $box['title'] ) ) . '">' . "\n"; 1378 1379 echo '<div class="postbox-header">'; 1380 echo '<h2 class="hndle" id="' . $box['id'] . '-title">'; 1381 if ( 'dashboard_php_nag' === $box['id'] ) { 1382 echo '<span aria-hidden="true" class="dashicons dashicons-warning"></span>'; 1383 echo '<span class="screen-reader-text">' . 1384 /* translators: Hidden accessibility text. */ 1385 __( 'Warning:' ) . 1386 ' </span>'; 1387 } 1388 echo $box['title']; 1389 echo "</h2>\n"; 1390 1391 if ( 'dashboard_browser_nag' !== $box['id'] ) { 1392 $widget_title = $box['title']; 1393 1394 if ( is_array( $box['args'] ) && isset( $box['args']['__widget_basename'] ) ) { 1395 $widget_title = $box['args']['__widget_basename']; 1396 // Do not pass this parameter to the user callback function. 1397 unset( $box['args']['__widget_basename'] ); 1398 } 1399 1400 echo '<div class="handle-actions hide-if-no-js">'; 1401 1402 $move_up_button = '<button type="button" class="handle-order-higher" aria-describedby="' . $box['id'] . '-title"> 1403 <span class="screen-reader-text">' . __( 'Move up' ) . '</span> 1404 <span class="order-higher-indicator" aria-hidden="true"></span> 1405 </button>'; 1406 $move_up_args = array( 1407 'id' => $box['id'] . '-handle-order-higher-description', 1408 'button' => $move_up_button, 1409 ); 1410 echo wp_get_tooltip( __( 'Move up' ), $move_up_args ); 1411 1412 $move_down_button = '<button type="button" class="handle-order-lower" aria-describedby="' . $box['id'] . '-title"> 1413 <span class="screen-reader-text">' . __( 'Move down' ) . '</span> 1414 <span class="order-lower-indicator" aria-hidden="true"></span> 1415 </button>'; 1416 $move_down_args = array( 1417 'id' => $box['id'] . '-handle-order-lower-description', 1418 'button' => $move_down_button, 1419 ); 1420 echo wp_get_tooltip( __( 'Move down' ), $move_down_args ); 1421 1422 $show_hide_button = '<button type="button" class="handlediv" aria-expanded="true" aria-describedby="' . $box['id'] . '-title"> 1423 <span class="screen-reader-text">' . __( 'Show or hide panel' ) . '</span> 1424 <span class="toggle-indicator" aria-hidden="true"></span> 1425 </button>'; 1426 $show_hide_args = array( 1427 'id' => $box['id'] . '-handlediv', 1428 'button' => $show_hide_button, 1429 ); 1430 echo wp_get_tooltip( __( 'Show or hide panel' ), $show_hide_args ); 1431 1432 echo '</div>'; 1433 } 1434 echo '</div>'; 1435 1436 echo '<div class="inside">' . "\n"; 1437 1438 if ( WP_DEBUG && ! $block_compatible && 'edit' === $screen->parent_base && ! $screen->is_block_editor() && ! isset( $_GET['meta-box-loader'] ) ) { 1439 $plugin = _get_plugin_from_callback( $box['callback'] ); 1440 if ( $plugin ) { 1441 $meta_box_not_compatible_message = sprintf( 1442 /* translators: %s: The name of the plugin that generated this meta box. */ 1443 __( 'This meta box, from the %s plugin, is not compatible with the block editor.' ), 1444 "<strong>{$plugin['Name']}</strong>" 1445 ); 1446 wp_admin_notice( 1447 $meta_box_not_compatible_message, 1448 array( 1449 'additional_classes' => array( 'error', 'inline' ), 1450 ) 1451 ); 1452 } 1453 } 1454 1455 call_user_func( $box['callback'], $data_object, $box ); 1456 echo "</div>\n"; 1457 echo "</div>\n"; 1458 } 1459 } 1460 } 1461 } 1462 1463 echo '</div>'; 1464 1465 return $i; 1466 } 1467 1468 /** 1469 * Removes a meta box from one or more screens. 1470 * 1471 * @since 2.6.0 1472 * @since 4.4.0 The `$screen` parameter now accepts an array of screen IDs. 1473 * 1474 * @global array $wp_meta_boxes Global meta box state. 1475 * 1476 * @param string $id Meta box ID (used in the 'id' attribute for the meta box). 1477 * @param string|array|WP_Screen $screen The screen or screens on which the meta box is shown (such as a 1478 * post type, 'link', or 'comment'). Accepts a single screen ID, 1479 * WP_Screen object, or array of screen IDs. 1480 * @param string $context The context within the screen where the box is set to display. 1481 * Contexts vary from screen to screen. Post edit screen contexts 1482 * include 'normal', 'side', and 'advanced'. Comments screen contexts 1483 * include 'normal' and 'side'. Menus meta boxes (accordion sections) 1484 * all use the 'side' context. 1485 */ 1486 function remove_meta_box( $id, $screen, $context ) { 1487 global $wp_meta_boxes; 1488 1489 if ( empty( $screen ) ) { 1490 $screen = get_current_screen(); 1491 } elseif ( is_string( $screen ) ) { 1492 $screen = convert_to_screen( $screen ); 1493 } elseif ( is_array( $screen ) ) { 1494 foreach ( $screen as $single_screen ) { 1495 remove_meta_box( $id, $single_screen, $context ); 1496 } 1497 } 1498 1499 if ( ! isset( $screen->id ) ) { 1500 return; 1501 } 1502 1503 $page = $screen->id; 1504 1505 if ( ! isset( $wp_meta_boxes ) ) { 1506 $wp_meta_boxes = array(); 1507 } 1508 if ( ! isset( $wp_meta_boxes[ $page ] ) ) { 1509 $wp_meta_boxes[ $page ] = array(); 1510 } 1511 if ( ! isset( $wp_meta_boxes[ $page ][ $context ] ) ) { 1512 $wp_meta_boxes[ $page ][ $context ] = array(); 1513 } 1514 1515 foreach ( array( 'high', 'core', 'default', 'low' ) as $priority ) { 1516 $wp_meta_boxes[ $page ][ $context ][ $priority ][ $id ] = false; 1517 } 1518 } 1519 1520 /** 1521 * Meta Box Accordion Template Function. 1522 * 1523 * Largely made up of abstracted code from do_meta_boxes(), this 1524 * function serves to build meta boxes as list items for display as 1525 * a collapsible accordion. 1526 * 1527 * @since 3.6.0 1528 * 1529 * @uses global $wp_meta_boxes Used to retrieve registered meta boxes. 1530 * 1531 * @param string|object $screen The screen identifier. 1532 * @param string $context The screen context for which to display accordion sections. 1533 * @param mixed $data_object Gets passed to the section callback function as the first parameter. 1534 * @return int Number of meta boxes as accordion sections. 1535 */ 1536 function do_accordion_sections( $screen, $context, $data_object ) { 1537 global $wp_meta_boxes; 1538 1539 wp_enqueue_script( 'accordion' ); 1540 1541 if ( empty( $screen ) ) { 1542 $screen = get_current_screen(); 1543 } elseif ( is_string( $screen ) ) { 1544 $screen = convert_to_screen( $screen ); 1545 } 1546 1547 $page = $screen->id; 1548 1549 $hidden = get_hidden_meta_boxes( $screen ); 1550 ?> 1551 <div id="side-sortables" class="accordion-container"> 1552 <ul class="outer-border"> 1553 <?php 1554 $i = 0; 1555 $first_open = false; 1556 1557 if ( isset( $wp_meta_boxes[ $page ][ $context ] ) ) { 1558 foreach ( array( 'high', 'core', 'default', 'low' ) as $priority ) { 1559 if ( isset( $wp_meta_boxes[ $page ][ $context ][ $priority ] ) ) { 1560 foreach ( $wp_meta_boxes[ $page ][ $context ][ $priority ] as $box ) { 1561 if ( false === $box || ! $box['title'] ) { 1562 continue; 1563 } 1564 1565 ++$i; 1566 $hidden_class = in_array( $box['id'], $hidden, true ) ? 'hide-if-js' : ''; 1567 1568 $open_class = ''; 1569 $aria_expanded = 'false'; 1570 if ( ! $first_open && empty( $hidden_class ) ) { 1571 $first_open = true; 1572 $open_class = 'open'; 1573 $aria_expanded = 'true'; 1574 } 1575 ?> 1576 <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'] ); ?>"> 1577 <h3 class="accordion-section-title hndle"> 1578 <button type="button" class="accordion-trigger" aria-expanded="<?php echo $aria_expanded; ?>" aria-controls="<?php echo esc_attr( $box['id'] ); ?>-content"> 1579 <span class="accordion-title"> 1580 <?php echo esc_html( $box['title'] ); ?> 1581 <span class="dashicons dashicons-arrow-down" aria-hidden="true"></span> 1582 </span> 1583 </button> 1584 </h3> 1585 <div class="accordion-section-content <?php postbox_classes( $box['id'], $page ); ?>" id="<?php echo esc_attr( $box['id'] ); ?>-content"> 1586 <div class="inside"> 1587 <?php call_user_func( $box['callback'], $data_object, $box ); ?> 1588 </div><!-- .inside --> 1589 </div><!-- .accordion-section-content --> 1590 </li><!-- .accordion-section --> 1591 <?php 1592 } 1593 } 1594 } 1595 } 1596 ?> 1597 </ul><!-- .outer-border --> 1598 </div><!-- .accordion-container --> 1599 <?php 1600 return $i; 1601 } 1602 1603 /** 1604 * Adds a new section to a settings page. 1605 * 1606 * Part of the Settings API. Use this to define new settings sections for an admin page. 1607 * Show settings sections in your admin page callback function with do_settings_sections(). 1608 * Add settings fields to your section with add_settings_field(). 1609 * 1610 * The $callback argument should be the name of a function that echoes out any 1611 * content you want to show at the top of the settings section before the actual 1612 * fields. It can output nothing if you want. 1613 * 1614 * @since 2.7.0 1615 * @since 6.1.0 Added an `$args` parameter for the section's HTML wrapper and class name. 1616 * 1617 * @global array $wp_settings_sections Storage array of all settings sections added to admin pages. 1618 * 1619 * @param string $id Slug-name to identify the section. Used in the 'id' attribute of tags. 1620 * @param string $title Formatted title of the section. Shown as the heading for the section. 1621 * @param callable $callback Function that displays any content at the top of the section (between heading and fields). 1622 * @param string $page The slug-name of the settings page on which to show the section. Built-in pages include 1623 * 'general', 'reading', 'writing', 'discussion', 'media', etc. Create your own using 1624 * add_options_page(); 1625 * @param array $args { 1626 * Arguments used to create the settings section. 1627 * 1628 * @type string $before_section HTML content to prepend to the section's HTML output. 1629 * Receives the section's class name as `%s`. Default empty. 1630 * @type string $after_section HTML content to append to the section's HTML output. Default empty. 1631 * @type string $section_class The class name to use for the section. Default empty. 1632 * } 1633 */ 1634 function add_settings_section( $id, $title, $callback, $page, $args = array() ) { 1635 global $wp_settings_sections; 1636 1637 $defaults = array( 1638 'id' => $id, 1639 'title' => $title, 1640 'callback' => $callback, 1641 'before_section' => '', 1642 'after_section' => '', 1643 'section_class' => '', 1644 ); 1645 1646 $section = wp_parse_args( $args, $defaults ); 1647 1648 if ( 'misc' === $page ) { 1649 _deprecated_argument( 1650 __FUNCTION__, 1651 '3.0.0', 1652 sprintf( 1653 /* translators: %s: misc */ 1654 __( 'The "%s" options group has been removed. Use another settings group.' ), 1655 'misc' 1656 ) 1657 ); 1658 $page = 'general'; 1659 } 1660 1661 if ( 'privacy' === $page ) { 1662 _deprecated_argument( 1663 __FUNCTION__, 1664 '3.5.0', 1665 sprintf( 1666 /* translators: %s: privacy */ 1667 __( 'The "%s" options group has been removed. Use another settings group.' ), 1668 'privacy' 1669 ) 1670 ); 1671 $page = 'reading'; 1672 } 1673 1674 $wp_settings_sections[ $page ][ $id ] = $section; 1675 } 1676 1677 /** 1678 * Adds a new field to a section of a settings page. 1679 * 1680 * Part of the Settings API. Use this to define a settings field that will show 1681 * as part of a settings section inside a settings page. The fields are shown using 1682 * do_settings_fields() in do_settings_sections(). 1683 * 1684 * The $callback argument should be the name of a function that echoes out the 1685 * HTML input tags for this setting field. Use get_option() to retrieve existing 1686 * values to show. 1687 * 1688 * @since 2.7.0 1689 * @since 4.2.0 The `$class` argument was added. 1690 * 1691 * @global array $wp_settings_fields Storage array of settings fields and info about their pages/sections. 1692 * 1693 * @param string $id Slug-name to identify the field. Used in the 'id' attribute of tags. 1694 * @param string $title Formatted title of the field. Shown as the label for the field 1695 * during output. 1696 * @param callable $callback Function that fills the field with the desired form inputs. The 1697 * function should echo its output. 1698 * @param string $page The slug-name of the settings page on which to show the section 1699 * (general, reading, writing, ...). 1700 * @param string $section Optional. The slug-name of the section of the settings page 1701 * in which to show the box. Default 'default'. 1702 * @param array $args { 1703 * Optional. Extra arguments that get passed to the callback function. 1704 * 1705 * @type string $label_for When supplied, the setting title will be wrapped 1706 * in a `<label>` element, its `for` attribute populated 1707 * with this value. 1708 * @type string $class CSS Class to be added to the `<tr>` element when the 1709 * field is output. 1710 * } 1711 */ 1712 function add_settings_field( $id, $title, $callback, $page, $section = 'default', $args = array() ) { 1713 global $wp_settings_fields; 1714 1715 if ( 'misc' === $page ) { 1716 _deprecated_argument( 1717 __FUNCTION__, 1718 '3.0.0', 1719 sprintf( 1720 /* translators: %s: misc */ 1721 __( 'The "%s" options group has been removed. Use another settings group.' ), 1722 'misc' 1723 ) 1724 ); 1725 $page = 'general'; 1726 } 1727 1728 if ( 'privacy' === $page ) { 1729 _deprecated_argument( 1730 __FUNCTION__, 1731 '3.5.0', 1732 sprintf( 1733 /* translators: %s: privacy */ 1734 __( 'The "%s" options group has been removed. Use another settings group.' ), 1735 'privacy' 1736 ) 1737 ); 1738 $page = 'reading'; 1739 } 1740 1741 $wp_settings_fields[ $page ][ $section ][ $id ] = array( 1742 'id' => $id, 1743 'title' => $title, 1744 'callback' => $callback, 1745 'args' => $args, 1746 ); 1747 } 1748 1749 /** 1750 * Prints out all settings sections added to a particular settings page. 1751 * 1752 * Part of the Settings API. Use this in a settings page callback function 1753 * to output all the sections and fields that were added to that $page with 1754 * add_settings_section() and add_settings_field() 1755 * 1756 * @since 2.7.0 1757 * 1758 * @global array $wp_settings_sections Storage array of all settings sections added to admin pages. 1759 * @global array $wp_settings_fields Storage array of settings fields and info about their pages/sections. 1760 * 1761 * @param string $page The slug name of the page whose settings sections you want to output. 1762 */ 1763 function do_settings_sections( $page ) { 1764 global $wp_settings_sections, $wp_settings_fields; 1765 1766 if ( ! isset( $wp_settings_sections[ $page ] ) ) { 1767 return; 1768 } 1769 1770 foreach ( (array) $wp_settings_sections[ $page ] as $section ) { 1771 if ( '' !== $section['before_section'] ) { 1772 if ( '' !== $section['section_class'] ) { 1773 echo wp_kses_post( sprintf( $section['before_section'], esc_attr( $section['section_class'] ) ) ); 1774 } else { 1775 echo wp_kses_post( $section['before_section'] ); 1776 } 1777 } 1778 1779 if ( $section['title'] ) { 1780 $unique_id = wp_unique_id( 'wp-settings-section-' . $section['id'] . '-' ); 1781 echo '<h2 id="' . esc_attr( $unique_id ) . '">' . $section['title'] . "</h2>\n"; 1782 } 1783 1784 if ( $section['callback'] ) { 1785 call_user_func( $section['callback'], $section ); 1786 } 1787 1788 if ( isset( $wp_settings_fields[ $page ][ $section['id'] ] ) ) { 1789 echo '<table class="form-table" role="presentation">'; 1790 do_settings_fields( $page, $section['id'] ); 1791 echo '</table>'; 1792 } 1793 1794 if ( '' !== $section['after_section'] ) { 1795 echo wp_kses_post( $section['after_section'] ); 1796 } 1797 } 1798 } 1799 1800 /** 1801 * Prints out the settings fields for a particular settings section. 1802 * 1803 * Part of the Settings API. Use this in a settings page to output 1804 * a specific section. Should normally be called by do_settings_sections() 1805 * rather than directly. 1806 * 1807 * @since 2.7.0 1808 * 1809 * @global array $wp_settings_fields Storage array of settings fields and their pages/sections. 1810 * 1811 * @param string $page Slug title of the admin page whose settings fields you want to show. 1812 * @param string $section Slug title of the settings section whose fields you want to show. 1813 */ 1814 function do_settings_fields( $page, $section ) { 1815 global $wp_settings_fields; 1816 1817 if ( ! isset( $wp_settings_fields[ $page ][ $section ] ) ) { 1818 return; 1819 } 1820 1821 foreach ( (array) $wp_settings_fields[ $page ][ $section ] as $field ) { 1822 $class = ''; 1823 1824 if ( ! empty( $field['args']['class'] ) ) { 1825 $class = ' class="' . esc_attr( $field['args']['class'] ) . '"'; 1826 } 1827 1828 echo "<tr{$class}>"; 1829 1830 if ( ! empty( $field['args']['label_for'] ) ) { 1831 echo '<th scope="row"><label for="' . esc_attr( $field['args']['label_for'] ) . '">' . $field['title'] . '</label></th>'; 1832 } else { 1833 echo '<th scope="row">' . $field['title'] . '</th>'; 1834 } 1835 1836 echo '<td>'; 1837 call_user_func( $field['callback'], $field['args'] ); 1838 echo '</td>'; 1839 echo '</tr>'; 1840 } 1841 } 1842 1843 /** 1844 * Registers a settings error to be displayed to the user. 1845 * 1846 * Part of the Settings API. Use this to show messages to users about settings validation 1847 * problems, missing settings or anything else. 1848 * 1849 * Settings errors should be added inside the $sanitize_callback function defined in 1850 * register_setting() for a given setting to give feedback about the submission. 1851 * 1852 * By default messages will show immediately after the submission that generated the error. 1853 * Additional calls to settings_errors() can be used to show errors even when the settings 1854 * page is first accessed. 1855 * 1856 * @since 3.0.0 1857 * @since 5.3.0 Added `warning` and `info` as possible values for `$type`. 1858 * 1859 * @global array[] $wp_settings_errors Storage array of errors registered during this pageload 1860 * 1861 * @param string $setting Slug title of the setting to which this error applies. 1862 * @param string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output. 1863 * @param string $message The formatted message text to display to the user (will be shown inside styled 1864 * `<div>` and `<p>` tags). 1865 * @param string $type Optional. Message type, controls HTML class. Possible values include 'error', 1866 * 'success', 'warning', 'info'. Default 'error'. 1867 */ 1868 function add_settings_error( $setting, $code, $message, $type = 'error' ) { 1869 global $wp_settings_errors; 1870 1871 $wp_settings_errors[] = array( 1872 'setting' => $setting, 1873 'code' => $code, 1874 'message' => $message, 1875 'type' => $type, 1876 ); 1877 } 1878 1879 /** 1880 * Fetches settings errors registered by add_settings_error(). 1881 * 1882 * Checks the $wp_settings_errors array for any errors declared during the current 1883 * pageload and returns them. 1884 * 1885 * If changes were just submitted ($_GET['settings-updated']) and settings errors were saved 1886 * to the 'settings_errors' transient then those errors will be returned instead. This 1887 * is used to pass errors back across pageloads. 1888 * 1889 * Use the $sanitize argument to manually re-sanitize the option before returning errors. 1890 * This is useful if you have errors or notices you want to show even when the user 1891 * hasn't submitted data (i.e. when they first load an options page, or in the {@see 'admin_notices'} 1892 * action hook). 1893 * 1894 * @since 3.0.0 1895 * 1896 * @global array[] $wp_settings_errors Storage array of errors registered during this pageload 1897 * 1898 * @param string $setting Optional. Slug title of a specific setting whose errors you want. 1899 * @param bool $sanitize Optional. Whether to re-sanitize the setting value before returning errors. 1900 * @return array[] { 1901 * Array of settings error arrays. 1902 * 1903 * @type array ...$0 { 1904 * Associative array of setting error data. 1905 * 1906 * @type string $setting Slug title of the setting to which this error applies. 1907 * @type string $code Slug-name to identify the error. Used as part of 'id' attribute in HTML output. 1908 * @type string $message The formatted message text to display to the user (will be shown inside styled 1909 * `<div>` and `<p>` tags). 1910 * @type string $type Optional. Message type, controls HTML class. Possible values include 'error', 1911 * 'success', 'warning', 'info'. Default 'error'. 1912 * } 1913 * } 1914 */ 1915 function get_settings_errors( $setting = '', $sanitize = false ) { 1916 global $wp_settings_errors; 1917 1918 /* 1919 * If $sanitize is true, manually re-run the sanitization for this option 1920 * This allows the $sanitize_callback from register_setting() to run, adding 1921 * any settings errors you want to show by default. 1922 */ 1923 if ( $sanitize ) { 1924 sanitize_option( $setting, get_option( $setting ) ); 1925 } 1926 1927 // If settings were passed back from options.php then use them. 1928 if ( isset( $_GET['settings-updated'] ) && $_GET['settings-updated'] && get_transient( 'settings_errors' ) ) { 1929 $wp_settings_errors = array_merge( (array) $wp_settings_errors, get_transient( 'settings_errors' ) ); 1930 delete_transient( 'settings_errors' ); 1931 } 1932 1933 // Check global in case errors have been added on this pageload. 1934 if ( empty( $wp_settings_errors ) ) { 1935 return array(); 1936 } 1937 1938 // Filter the results to those of a specific setting if one was set. 1939 if ( $setting ) { 1940 $setting_errors = array(); 1941 1942 foreach ( (array) $wp_settings_errors as $key => $details ) { 1943 if ( $setting === $details['setting'] ) { 1944 $setting_errors[] = $wp_settings_errors[ $key ]; 1945 } 1946 } 1947 1948 return $setting_errors; 1949 } 1950 1951 return $wp_settings_errors; 1952 } 1953 1954 /** 1955 * Displays settings errors registered by add_settings_error(). 1956 * 1957 * Part of the Settings API. Outputs a div for each error retrieved by 1958 * get_settings_errors(). 1959 * 1960 * This is called automatically after a settings page based on the 1961 * Settings API is submitted. Errors should be added during the validation 1962 * callback function for a setting defined in register_setting(). 1963 * 1964 * The $sanitize option is passed into get_settings_errors() and will 1965 * re-run the setting sanitization 1966 * on its current value. 1967 * 1968 * The $hide_on_update option will cause errors to only show when the settings 1969 * page is first loaded. if the user has already saved new values it will be 1970 * hidden to avoid repeating messages already shown in the default error 1971 * reporting after submission. This is useful to show general errors like 1972 * missing settings when the user arrives at the settings page. 1973 * 1974 * @since 3.0.0 1975 * @since 5.3.0 Legacy `error` and `updated` CSS classes are mapped to 1976 * `notice-error` and `notice-success`. 1977 * @since 7.2.0 Uses `wp_admin_notice()` to echo the notices so that the CSS 1978 * classes, filters, and hooks are handled consistently. 1979 * 1980 * @param string $setting Optional slug title of a specific setting whose errors you want. 1981 * @param bool $sanitize Whether to re-sanitize the setting value before returning errors. 1982 * @param bool $hide_on_update If set to true errors will not be shown if the settings page has 1983 * already been submitted. 1984 */ 1985 function settings_errors( $setting = '', $sanitize = false, $hide_on_update = false ) { 1986 1987 if ( $hide_on_update && ! empty( $_GET['settings-updated'] ) ) { 1988 return; 1989 } 1990 1991 $settings_errors = get_settings_errors( $setting, $sanitize ); 1992 1993 if ( empty( $settings_errors ) ) { 1994 return; 1995 } 1996 1997 foreach ( $settings_errors as $key => $details ) { 1998 $type = trim( $details['type'] ); 1999 2000 if ( 'updated' === $type ) { 2001 $type = 'success'; 2002 } 2003 2004 $additional_classes = array( 'settings-error' ); 2005 2006 /* 2007 * Backward compatibility: `wp_admin_notice()` generates the admin notice 2008 * CSS classes based on the passed message type. For example, 'error', 2009 * 'success', 'warning', 'info'. Custom types will be treated as 2010 * additional classes and appended to the end of the CSS classes. 2011 */ 2012 if ( ! in_array( $type, array( 'error', 'success', 'warning', 'info' ), true ) ) { 2013 $additional_classes = array_merge( $additional_classes, explode( ' ', $type ) ); 2014 $type = ''; 2015 } 2016 2017 /* 2018 * Note that the setting error code contains underscores, for example: 2019 * `settings_updated`. This will build a CSS ID selector that contains 2020 * underscores, which are currently not allowed by the WordPress CSS 2021 * Coding Standards. Kept for backwards compatibility. 2022 */ 2023 $css_id = sprintf( 2024 'setting-error-%s', 2025 $details['code'], 2026 ); 2027 2028 wp_admin_notice( 2029 "<strong>{$details['message']}</strong>", 2030 array( 2031 'type' => $type, 2032 'code' => $details['code'], 2033 'id' => $css_id, 2034 'paragraph_wrap' => true, 2035 'dismissible' => true, 2036 'additional_classes' => $additional_classes, 2037 ) 2038 ); 2039 } 2040 } 2041 2042 /** 2043 * Outputs the modal window used for attaching media to posts or pages in the media-listing screen. 2044 * 2045 * @since 2.7.0 2046 * 2047 * @param string $found_action Optional. The value of the 'found_action' input field. Default empty string. 2048 */ 2049 function find_posts_div( $found_action = '' ) { 2050 ?> 2051 <div id="find-posts" class="find-box" style="display: none;"> 2052 <div id="find-posts-head" class="find-box-head"> 2053 <?php _e( 'Attach to existing content' ); ?> 2054 <button type="button" id="find-posts-close"><span class="screen-reader-text"> 2055 <?php 2056 /* translators: Hidden accessibility text. */ 2057 _e( 'Close media attachment panel' ); 2058 ?> 2059 </span></button> 2060 </div> 2061 <div class="find-box-inside"> 2062 <div class="find-box-search"> 2063 <?php if ( $found_action ) { ?> 2064 <input type="hidden" name="found_action" value="<?php echo esc_attr( $found_action ); ?>" /> 2065 <?php } ?> 2066 <input type="hidden" name="affected" id="affected" value="" /> 2067 <?php wp_nonce_field( 'find-posts', '_ajax_nonce', false ); ?> 2068 <label class="screen-reader-text" for="find-posts-input"> 2069 <?php 2070 /* translators: Hidden accessibility text. */ 2071 _e( 'Search' ); 2072 ?> 2073 </label> 2074 <input type="text" id="find-posts-input" name="ps" value="" /> 2075 <span class="spinner"></span> 2076 <input type="button" id="find-posts-search" value="<?php esc_attr_e( 'Search' ); ?>" class="button" /> 2077 <div class="clear"></div> 2078 </div> 2079 <div id="find-posts-response"></div> 2080 </div> 2081 <div class="find-box-buttons"> 2082 <?php submit_button( __( 'Select' ), 'primary alignright', 'find-posts-submit', false ); ?> 2083 <div class="clear"></div> 2084 </div> 2085 </div> 2086 <?php 2087 } 2088 2089 /** 2090 * Displays the post password. 2091 * 2092 * The password is passed through esc_attr() to ensure that it is safe for placing in an HTML attribute. 2093 * 2094 * @since 2.7.0 2095 */ 2096 function the_post_password() { 2097 $post = get_post(); 2098 if ( isset( $post->post_password ) ) { 2099 echo esc_attr( $post->post_password ); 2100 } 2101 } 2102 2103 /** 2104 * Gets the post title. 2105 * 2106 * The post title is fetched and if it is blank then a default string is 2107 * returned. 2108 * 2109 * @since 2.7.0 2110 * 2111 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post. 2112 * @return string The post title if set. 2113 */ 2114 function _draft_or_post_title( $post = 0 ) { 2115 $title = get_the_title( $post ); 2116 if ( empty( $title ) ) { 2117 $title = __( '(no title)' ); 2118 } 2119 return esc_html( $title ); 2120 } 2121 2122 /** 2123 * Displays the search query. 2124 * 2125 * A simple wrapper to display the "s" parameter in a `GET` URI. This function 2126 * should only be used when the_search_query() cannot. 2127 * 2128 * @since 2.7.0 2129 */ 2130 function _admin_search_query() { 2131 echo isset( $_REQUEST['s'] ) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : ''; 2132 } 2133 2134 /** 2135 * Generic Iframe header for use with Thickbox. 2136 * 2137 * @since 2.7.0 2138 * 2139 * @global string $hook_suffix 2140 * @global string $admin_body_class 2141 * @global string $body_id 2142 * @global WP_Locale $wp_locale WordPress date and time locale object. 2143 * 2144 * @param string $title Optional. Title of the Iframe page. Default empty. 2145 * @param bool $deprecated Not used. 2146 */ 2147 function iframe_header( $title = '', $deprecated = false ) { 2148 global $hook_suffix, $admin_body_class, $body_id, $wp_locale; 2149 2150 show_admin_bar( false ); 2151 2152 $admin_body_class = preg_replace( '/[^a-z0-9_-]+/i', '-', $hook_suffix ); 2153 2154 $current_screen = get_current_screen(); 2155 2156 header( 'Content-Type: ' . get_option( 'html_type' ) . '; charset=' . get_option( 'blog_charset' ) ); 2157 _wp_admin_html_begin(); 2158 ?> 2159 <title><?php bloginfo( 'name' ); ?> › <?php echo $title; ?> — <?php _e( 'WordPress' ); ?></title> 2160 <?php 2161 wp_enqueue_style( 'colors' ); 2162 2163 // Print the global admin inline scripts through the script tag API so the 2164 // `wp_inline_script_attributes` filter (e.g. a CSP nonce) applies. 2165 wp_print_inline_script_tag( 2166 <<<'JS' 2167 function addLoadEvent( func ) { 2168 if ( typeof jQuery !== 'undefined' ) { 2169 jQuery( function () { 2170 func(); 2171 } ); 2172 } else if ( typeof wpOnload !== 'function' ) { 2173 window.wpOnload = func; 2174 } else { 2175 const oldOnload = window.wpOnload; 2176 window.wpOnload = function () { 2177 oldOnload(); 2178 func(); 2179 }; 2180 } 2181 } 2182 2183 function tb_close() { 2184 ( window.dialogArguments || opener || parent || top ).tb_remove(); 2185 } 2186 JS 2187 ); 2188 wp_print_inline_script_tag( 2189 sprintf( 2190 'Object.assign( window, %s );', 2191 wp_json_encode( 2192 array( 2193 'ajaxurl' => admin_url( 'admin-ajax.php', 'relative' ), 2194 'pagenow' => $current_screen->id ?? '', 2195 'typenow' => $current_screen->post_type ?? '', 2196 'adminpage' => $admin_body_class, 2197 'thousandsSeparator' => $wp_locale->number_format['thousands_sep'], 2198 'decimalPoint' => $wp_locale->number_format['decimal_point'], 2199 'isRtl' => (int) is_rtl(), 2200 ), 2201 JSON_HEX_TAG | JSON_UNESCAPED_SLASHES 2202 ) 2203 ) 2204 ); 2205 2206 /** This action is documented in wp-admin/admin-header.php */ 2207 do_action( 'admin_enqueue_scripts', $hook_suffix ); 2208 2209 /** This action is documented in wp-admin/admin-header.php */ 2210 do_action( "admin_print_styles-{$hook_suffix}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 2211 2212 /** This action is documented in wp-admin/admin-header.php */ 2213 do_action( 'admin_print_styles' ); 2214 2215 /** This action is documented in wp-admin/admin-header.php */ 2216 do_action( "admin_print_scripts-{$hook_suffix}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 2217 2218 /** This action is documented in wp-admin/admin-header.php */ 2219 do_action( 'admin_print_scripts' ); 2220 2221 /** This action is documented in wp-admin/admin-header.php */ 2222 do_action( "admin_head-{$hook_suffix}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 2223 2224 /** This action is documented in wp-admin/admin-header.php */ 2225 do_action( 'admin_head' ); 2226 2227 $admin_body_class .= ' locale-' . sanitize_html_class( strtolower( str_replace( '_', '-', get_user_locale() ) ) ); 2228 $admin_body_class .= ' admin-color-' . sanitize_html_class( get_user_option( 'admin_color' ), 'modern' ); 2229 2230 if ( is_rtl() ) { 2231 $admin_body_class .= ' rtl'; 2232 } 2233 2234 ?> 2235 </head> 2236 <?php 2237 $admin_body_id = isset( $body_id ) ? 'id="' . $body_id . '" ' : ''; 2238 2239 /** This filter is documented in wp-admin/admin-header.php */ 2240 $admin_body_classes = apply_filters( 'admin_body_class', '' ); 2241 $admin_body_classes = ltrim( $admin_body_classes . ' ' . $admin_body_class ); 2242 ?> 2243 <body <?php echo $admin_body_id; ?>class="wp-admin wp-core-ui no-js iframe <?php echo esc_attr( $admin_body_classes ); ?>"> 2244 <?php 2245 wp_print_inline_script_tag( 2246 <<<'JS' 2247 document.body.className = document.body.className.replace( 'no-js', 'js' ); 2248 JS 2249 ); 2250 } 2251 2252 /** 2253 * Generic Iframe footer for use with Thickbox. 2254 * 2255 * @since 2.7.0 2256 */ 2257 function iframe_footer() { 2258 /* 2259 * We're going to hide any footer output on iFrame pages, 2260 * but run the hooks anyway since they output JavaScript 2261 * or other needed content. 2262 */ 2263 2264 /** 2265 * @global string $hook_suffix 2266 */ 2267 global $hook_suffix; 2268 ?> 2269 <div class="hidden"> 2270 <?php 2271 /** This action is documented in wp-admin/admin-footer.php */ 2272 do_action( 'admin_footer', $hook_suffix ); 2273 2274 /** This action is documented in wp-admin/admin-footer.php */ 2275 do_action( "admin_print_footer_scripts-{$hook_suffix}" ); // phpcs:ignore WordPress.NamingConventions.ValidHookName.UseUnderscores 2276 2277 /** This action is documented in wp-admin/admin-footer.php */ 2278 do_action( 'admin_print_footer_scripts' ); 2279 ?> 2280 </div> 2281 <?php 2282 wp_print_inline_script_tag( 2283 <<<'JS' 2284 if ( typeof wpOnload === 'function' ) { 2285 wpOnload(); 2286 } 2287 JS 2288 ); 2289 ?> 2290 </body> 2291 </html> 2292 <?php 2293 } 2294 2295 /** 2296 * Echoes or returns the post states as HTML. 2297 * 2298 * @since 2.7.0 2299 * @since 5.3.0 Added the `$display` parameter and a return value. 2300 * 2301 * @see get_post_states() 2302 * 2303 * @param WP_Post $post The post to retrieve states for. 2304 * @param bool $display Optional. Whether to display the post states as an HTML string. 2305 * Default true. 2306 * @return string Post states string. 2307 */ 2308 function _post_states( $post, $display = true ) { 2309 $post_states = get_post_states( $post ); 2310 $post_states_html = ''; 2311 2312 if ( ! empty( $post_states ) ) { 2313 $state_count = count( $post_states ); 2314 $separator = wp_get_list_item_separator(); 2315 2316 $i = 0; 2317 2318 $post_states_html .= ' — '; 2319 2320 foreach ( $post_states as $state ) { 2321 ++$i; 2322 2323 $suffix = ( $i < $state_count ) ? $separator : ''; 2324 2325 $post_states_html .= "<span class='post-state'>{$state}{$suffix}</span>"; 2326 } 2327 } 2328 2329 /** 2330 * Filters the HTML string of post states. 2331 * 2332 * @since 6.9.0 2333 * 2334 * @param string $post_states_html All relevant post states combined into an HTML string for display. 2335 * E.g. `— <span class='post-state'>Draft, </span><span class='post-state'>Sticky</span>`. 2336 * @param array<string, string> $post_states A mapping of post state slugs to translated post state labels. 2337 * E.g. `array( 'draft' => __( 'Draft' ), 'sticky' => __( 'Sticky' ), ... )`. 2338 * @param WP_Post $post The current post object. 2339 */ 2340 $post_states_html = apply_filters( 'post_states_html', $post_states_html, $post_states, $post ); 2341 2342 if ( $display ) { 2343 echo $post_states_html; 2344 } 2345 2346 return $post_states_html; 2347 } 2348 2349 /** 2350 * Retrieves an array of post states from a post. 2351 * 2352 * @since 5.3.0 2353 * 2354 * @param WP_Post $post The post to retrieve states for. 2355 * @return string[] Array of post state labels keyed by their state. 2356 */ 2357 function get_post_states( $post ) { 2358 $post_states = array(); 2359 if ( ! $post instanceof WP_Post ) { 2360 return $post_states; 2361 } 2362 2363 $post_status = $_REQUEST['post_status'] ?? ''; 2364 2365 if ( ! empty( $post->post_password ) ) { 2366 $post_states['protected'] = _x( 'Password protected', 'post status' ); 2367 } 2368 2369 if ( 'private' === $post->post_status && 'private' !== $post_status ) { 2370 $post_states['private'] = _x( 'Private', 'post status' ); 2371 } 2372 2373 if ( 'draft' === $post->post_status ) { 2374 if ( get_post_meta( $post->ID, '_customize_changeset_uuid', true ) ) { 2375 $post_states[] = __( 'Customization Draft' ); 2376 } elseif ( 'draft' !== $post_status ) { 2377 $post_states['draft'] = _x( 'Draft', 'post status' ); 2378 } 2379 } elseif ( 'trash' === $post->post_status && get_post_meta( $post->ID, '_customize_changeset_uuid', true ) ) { 2380 $post_states[] = _x( 'Customization Draft', 'post status' ); 2381 } 2382 2383 if ( 'pending' === $post->post_status && 'pending' !== $post_status ) { 2384 $post_states['pending'] = _x( 'Pending', 'post status' ); 2385 } 2386 2387 if ( is_sticky( $post->ID ) ) { 2388 $post_states['sticky'] = _x( 'Sticky', 'post status' ); 2389 } 2390 2391 if ( 'future' === $post->post_status ) { 2392 $post_states['scheduled'] = _x( 'Scheduled', 'post status' ); 2393 } 2394 2395 if ( 'page' === get_option( 'show_on_front' ) ) { 2396 if ( (int) get_option( 'page_on_front' ) === $post->ID ) { 2397 $post_states['page_on_front'] = _x( 'Front Page', 'page label' ); 2398 } 2399 2400 if ( (int) get_option( 'page_for_posts' ) === $post->ID ) { 2401 $post_states['page_for_posts'] = _x( 'Posts Page', 'page label' ); 2402 } 2403 } 2404 2405 if ( (int) get_option( 'wp_page_for_privacy_policy' ) === $post->ID ) { 2406 $post_states['page_for_privacy_policy'] = _x( 'Privacy Policy Page', 'page label' ); 2407 } 2408 2409 /** 2410 * Filters the default post display states used in the posts list table. 2411 * 2412 * @since 2.8.0 2413 * @since 3.6.0 Added the `$post` parameter. 2414 * @since 5.5.0 Also applied in the Customizer context. If any admin functions 2415 * are used within the filter, their existence should be checked 2416 * with `function_exists()` before being used. 2417 * 2418 * @param array<string, string> $post_states A mapping of post state slugs to translated post state labels. 2419 * E.g. `array( 'draft' => __( 'Draft' ), 'sticky' => __( 'Sticky' ), ... )`. 2420 * @param WP_Post $post The current post object. 2421 */ 2422 return apply_filters( 'display_post_states', $post_states, $post ); 2423 } 2424 2425 /** 2426 * Outputs the attachment media states as HTML. 2427 * 2428 * @since 3.2.0 2429 * @since 5.6.0 Added the `$display` parameter and a return value. 2430 * 2431 * @param WP_Post $post The attachment post to retrieve states for. 2432 * @param bool $display Optional. Whether to display the post states as an HTML string. 2433 * Default true. 2434 * @return string Media states string. 2435 */ 2436 function _media_states( $post, $display = true ) { 2437 $media_states = get_media_states( $post ); 2438 $media_states_string = ''; 2439 2440 if ( ! empty( $media_states ) ) { 2441 $state_count = count( $media_states ); 2442 $separator = wp_get_list_item_separator(); 2443 2444 $i = 0; 2445 2446 $media_states_string .= ' — '; 2447 2448 foreach ( $media_states as $state ) { 2449 ++$i; 2450 2451 $suffix = ( $i < $state_count ) ? $separator : ''; 2452 2453 $media_states_string .= "<span class='post-state'>{$state}{$suffix}</span>"; 2454 } 2455 } 2456 2457 if ( $display ) { 2458 echo $media_states_string; 2459 } 2460 2461 return $media_states_string; 2462 } 2463 2464 /** 2465 * Retrieves an array of media states from an attachment. 2466 * 2467 * @since 5.6.0 2468 * 2469 * @param WP_Post $post The attachment to retrieve states for. 2470 * @return string[] Array of media state labels keyed by their state. 2471 */ 2472 function get_media_states( $post ) { 2473 static $header_images; 2474 2475 $media_states = array(); 2476 $stylesheet = get_option( 'stylesheet' ); 2477 2478 if ( current_theme_supports( 'custom-header' ) ) { 2479 $meta_header = get_post_meta( $post->ID, '_wp_attachment_is_custom_header', true ); 2480 2481 if ( is_random_header_image() ) { 2482 if ( ! isset( $header_images ) ) { 2483 $header_images = wp_list_pluck( get_uploaded_header_images(), 'attachment_id' ); 2484 } 2485 2486 if ( $meta_header === $stylesheet && in_array( $post->ID, $header_images, true ) ) { 2487 $media_states[] = __( 'Header Image' ); 2488 } 2489 } else { 2490 $header_image = get_header_image(); 2491 2492 // Display "Header Image" if the image was ever used as a header image. 2493 if ( ! empty( $meta_header ) && $meta_header === $stylesheet && wp_get_attachment_url( $post->ID ) !== $header_image ) { 2494 $media_states[] = __( 'Header Image' ); 2495 } 2496 2497 // Display "Current Header Image" if the image is currently the header image. 2498 if ( $header_image && wp_get_attachment_url( $post->ID ) === $header_image ) { 2499 $media_states[] = __( 'Current Header Image' ); 2500 } 2501 } 2502 2503 if ( get_theme_support( 'custom-header', 'video' ) && has_header_video() ) { 2504 $mods = get_theme_mods(); 2505 if ( isset( $mods['header_video'] ) && $post->ID === $mods['header_video'] ) { 2506 $media_states[] = __( 'Current Header Video' ); 2507 } 2508 } 2509 } 2510 2511 if ( current_theme_supports( 'custom-background' ) ) { 2512 $meta_background = get_post_meta( $post->ID, '_wp_attachment_is_custom_background', true ); 2513 2514 if ( ! empty( $meta_background ) && $meta_background === $stylesheet ) { 2515 $media_states[] = __( 'Background Image' ); 2516 2517 $background_image = get_background_image(); 2518 if ( $background_image && wp_get_attachment_url( $post->ID ) === $background_image ) { 2519 $media_states[] = __( 'Current Background Image' ); 2520 } 2521 } 2522 } 2523 2524 if ( (int) get_option( 'site_icon' ) === $post->ID ) { 2525 $media_states[] = __( 'Site Icon' ); 2526 } 2527 2528 if ( (int) get_theme_mod( 'custom_logo' ) === $post->ID ) { 2529 $media_states[] = __( 'Logo' ); 2530 } 2531 2532 /** 2533 * Filters the default media display states for items in the Media list table. 2534 * 2535 * @since 3.2.0 2536 * @since 4.8.0 Added the `$post` parameter. 2537 * 2538 * @param string[] $media_states An array of media states. Default 'Header Image', 2539 * 'Background Image', 'Site Icon', 'Logo'. 2540 * @param WP_Post $post The current attachment object. 2541 */ 2542 return apply_filters( 'display_media_states', $media_states, $post ); 2543 } 2544 2545 /** 2546 * Tests support for compressing JavaScript from PHP. 2547 * 2548 * Outputs JavaScript that tests if compression from PHP works as expected 2549 * and sets an option with the result. Has no effect when the current user 2550 * is not an administrator. To run the test again the option 'can_compress_scripts' 2551 * has to be deleted. 2552 * 2553 * @since 2.8.0 2554 */ 2555 function compression_test() { 2556 ?> 2557 <script> 2558 var compressionNonce = <?php echo wp_json_encode( wp_create_nonce( 'update_can_compress_scripts' ), JSON_HEX_TAG | JSON_UNESCAPED_SLASHES ); ?>; 2559 var testCompression = { 2560 get : function(test) { 2561 var x; 2562 if ( window.XMLHttpRequest ) { 2563 x = new XMLHttpRequest(); 2564 } else { 2565 try{x=new ActiveXObject('Msxml2.XMLHTTP');}catch(e){try{x=new ActiveXObject('Microsoft.XMLHTTP');}catch(e){};} 2566 } 2567 2568 if (x) { 2569 x.onreadystatechange = function() { 2570 var r, h; 2571 if ( x.readyState == 4 ) { 2572 r = x.responseText.substr(0, 18); 2573 h = x.getResponseHeader('Content-Encoding'); 2574 testCompression.check(r, h, test); 2575 } 2576 }; 2577 2578 x.open('GET', ajaxurl + '?action=wp-compression-test&test='+test+'&_ajax_nonce='+compressionNonce+'&'+(new Date()).getTime(), true); 2579 x.send(''); 2580 } 2581 }, 2582 2583 check : function(r, h, test) { 2584 if ( ! r && ! test ) 2585 this.get(1); 2586 2587 if ( 1 == test ) { 2588 if ( h && ( h.match(/deflate/i) || h.match(/gzip/i) ) ) 2589 this.get('no'); 2590 else 2591 this.get(2); 2592 2593 return; 2594 } 2595 2596 if ( 2 == test ) { 2597 if ( '"wpCompressionTest' === r ) 2598 this.get('yes'); 2599 else 2600 this.get('no'); 2601 } 2602 } 2603 }; 2604 testCompression.check(); 2605 </script> 2606 <?php 2607 } 2608 2609 /** 2610 * Echoes a submit button, with provided text and appropriate class(es). 2611 * 2612 * @since 3.1.0 2613 * 2614 * @see get_submit_button() 2615 * 2616 * @param string $text Optional. The text of the button. Defaults to 'Save Changes'. 2617 * @param string $type Optional. The type and CSS class(es) of the button. Core values 2618 * include 'primary', 'small', 'compact' and 'large'. Default 'primary'. 2619 * @param string $name Optional. The HTML name of the submit button. If no `id` attribute 2620 * is given in the `$other_attributes` parameter, `$name` will be used 2621 * as the button's `id`. Default 'submit'. 2622 * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph tag, 2623 * false otherwise. Default true. 2624 * @param array|string $other_attributes Optional. Other attributes that should be output with the button, 2625 * mapping attributes to their values, e.g. `array( 'id' => 'search-submit' )`. 2626 * These key/value attribute pairs will be output as `attribute="value"`, 2627 * where attribute is the key. Attributes can also be provided as a string, 2628 * e.g. `id="search-submit"`, though the array format is generally preferred. 2629 * Default empty string. 2630 */ 2631 function submit_button( $text = '', $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = '' ) { 2632 echo get_submit_button( $text, $type, $name, $wrap, $other_attributes ); 2633 } 2634 2635 /** 2636 * Returns a submit button, with provided text and appropriate class. 2637 * 2638 * @since 3.1.0 2639 * 2640 * @param string $text Optional. The text of the button. Defaults to 'Save Changes'. 2641 * @param string $type Optional. The type and CSS class(es) of the button. Core values 2642 * include 'primary', 'small', 'compact' and 'large'. Default 'primary large'. 2643 * @param string $name Optional. The HTML name of the submit button. If no `id` attribute 2644 * is given in the `$other_attributes` parameter, `$name` will be used 2645 * as the button's `id`. Default 'submit'. 2646 * @param bool $wrap Optional. True if the output button should be wrapped in a paragraph tag, 2647 * false otherwise. Default true. 2648 * @param array|string $other_attributes Optional. Other attributes that should be output with the button, 2649 * mapping attributes to their values, e.g. `array( 'id' => 'search-submit' )`. 2650 * These key/value attribute pairs will be output as `attribute="value"`, 2651 * where attribute is the key. Attributes can also be provided as a string, 2652 * e.g. `id="search-submit"`, though the array format is generally preferred. 2653 * Default empty string. 2654 * @return string Submit button HTML. 2655 */ 2656 function get_submit_button( $text = '', $type = 'primary large', $name = 'submit', $wrap = true, $other_attributes = '' ) { 2657 if ( ! is_array( $type ) ) { 2658 $type = explode( ' ', $type ); 2659 } 2660 2661 $button_shorthand = array( 'primary', 'small', 'large', 'compact' ); 2662 $classes = array( 'button' ); 2663 2664 foreach ( $type as $t ) { 2665 if ( 'secondary' === $t || 'button-secondary' === $t ) { 2666 continue; 2667 } 2668 2669 $classes[] = in_array( $t, $button_shorthand, true ) ? 'button-' . $t : $t; 2670 } 2671 2672 // Remove empty items, remove duplicate items, and finally build a string. 2673 $class = implode( ' ', array_unique( array_filter( $classes ) ) ); 2674 2675 $text = $text ? $text : __( 'Save Changes' ); 2676 2677 // Default the id attribute to $name unless an id was specifically provided in $other_attributes. 2678 $id = $name; 2679 if ( is_array( $other_attributes ) && isset( $other_attributes['id'] ) ) { 2680 $id = $other_attributes['id']; 2681 unset( $other_attributes['id'] ); 2682 } 2683 2684 $attributes = ''; 2685 if ( is_array( $other_attributes ) ) { 2686 foreach ( $other_attributes as $attribute => $value ) { 2687 $attributes .= $attribute . '="' . esc_attr( $value ) . '" '; // Trailing space is important. 2688 } 2689 } elseif ( ! empty( $other_attributes ) ) { // Attributes provided as a string. 2690 $attributes = $other_attributes; 2691 } 2692 2693 // Don't output empty name and id attributes. 2694 $name_attr = $name ? ' name="' . esc_attr( $name ) . '"' : ''; 2695 $id_attr = $id ? ' id="' . esc_attr( $id ) . '"' : ''; 2696 2697 $button = '<input type="submit"' . $name_attr . $id_attr . ' class="' . esc_attr( $class ); 2698 $button .= '" value="' . esc_attr( $text ) . '" ' . $attributes . ' />'; 2699 2700 if ( $wrap ) { 2701 $button = '<p class="submit">' . $button . '</p>'; 2702 } 2703 2704 return $button; 2705 } 2706 2707 /** 2708 * Prints out the beginning of the admin HTML header. 2709 * 2710 * @since 3.3.0 2711 * 2712 * @global bool $is_IE 2713 */ 2714 function _wp_admin_html_begin() { 2715 global $is_IE; 2716 2717 $admin_html_class = ( is_admin_bar_showing() ) ? 'wp-toolbar' : ''; 2718 2719 if ( $is_IE ) { 2720 header( 'X-UA-Compatible: IE=edge' ); 2721 } 2722 2723 ?> 2724 <!DOCTYPE html> 2725 <html class="<?php echo $admin_html_class; ?>" 2726 <?php 2727 /** 2728 * Fires inside the HTML tag in the admin header. 2729 * 2730 * @since 2.2.0 2731 */ 2732 do_action( 'admin_xml_ns' ); 2733 2734 language_attributes(); 2735 ?> 2736 > 2737 <head> 2738 <meta http-equiv="Content-Type" content="<?php bloginfo( 'html_type' ); ?>; charset=<?php echo get_option( 'blog_charset' ); ?>" /> 2739 <?php 2740 } 2741 2742 /** 2743 * Converts a screen string to a screen object. 2744 * 2745 * @since 3.0.0 2746 * 2747 * @param string|WP_Screen|null $hook_name The hook name (also known as the hook suffix) used to determine the screen. 2748 * A `WP_Screen` instance is returned as-is. If null, the current 2749 * $hook_suffix global is used. 2750 * @return WP_Screen Screen object. 2751 */ 2752 function convert_to_screen( $hook_name ) { 2753 if ( ! class_exists( 'WP_Screen' ) ) { 2754 _doing_it_wrong( 2755 'convert_to_screen(), add_meta_box()', 2756 sprintf( 2757 /* translators: 1: wp-admin/includes/template.php, 2: add_meta_box(), 3: add_meta_boxes */ 2758 __( 'Likely direct inclusion of %1$s in order to use %2$s. This is very wrong. Hook the %2$s call into the %3$s action instead.' ), 2759 '<code>wp-admin/includes/template.php</code>', 2760 '<code>add_meta_box()</code>', 2761 '<code>add_meta_boxes</code>' 2762 ), 2763 '3.3.0' 2764 ); 2765 return (object) array( 2766 'id' => '_invalid', 2767 'base' => '_are_belong_to_us', 2768 ); 2769 } 2770 2771 return WP_Screen::get( $hook_name ); 2772 } 2773 2774 /** 2775 * Outputs the HTML for restoring the post data from DOM storage 2776 * 2777 * @since 3.6.0 2778 * @access private 2779 */ 2780 function _local_storage_notice() { 2781 $local_storage_message = '<p class="local-restore">'; 2782 $local_storage_message .= __( 'The backup of this post in your browser is different from the version below.' ); 2783 $local_storage_message .= '<button type="button" class="button restore-backup">' . __( 'Restore the backup' ) . '</button></p>'; 2784 $local_storage_message .= '<p class="help">'; 2785 $local_storage_message .= __( 'This will replace the current editor content with the last backup version. You can use undo and redo in the editor to get the old content back or to return to the restored version.' ); 2786 $local_storage_message .= '</p>'; 2787 2788 wp_admin_notice( 2789 $local_storage_message, 2790 array( 2791 'id' => 'local-storage-notice', 2792 'additional_classes' => array( 'hidden' ), 2793 'dismissible' => true, 2794 'paragraph_wrap' => false, 2795 ) 2796 ); 2797 } 2798 2799 /** 2800 * Outputs a HTML element with a star rating for a given rating. 2801 * 2802 * Outputs a HTML element with the star rating exposed on a 0..5 scale in 2803 * half star increments (ie. 1, 1.5, 2 stars). Optionally, if specified, the 2804 * number of ratings may also be displayed by passing the $number parameter. 2805 * 2806 * @since 3.8.0 2807 * @since 4.4.0 Introduced the `echo` parameter. 2808 * 2809 * @param array $args { 2810 * Optional. Array of star ratings arguments. 2811 * 2812 * @type int|float $rating The rating to display, expressed in either a 0.5 rating increment, 2813 * or percentage. Default 0. 2814 * @type string $type Format that the $rating is in. Valid values are 'rating' (default), 2815 * or, 'percent'. Default 'rating'. 2816 * @type int $number The number of ratings that makes up this rating. Default 0. 2817 * @type bool $echo Whether to echo the generated markup. False to return the markup instead 2818 * of echoing it. Default true. 2819 * } 2820 * @return string Star rating HTML. 2821 */ 2822 function wp_star_rating( $args = array() ) { 2823 $defaults = array( 2824 'rating' => 0, 2825 'type' => 'rating', 2826 'number' => 0, 2827 'echo' => true, 2828 ); 2829 $parsed_args = wp_parse_args( $args, $defaults ); 2830 2831 // Non-English decimal places when the $rating is coming from a string. 2832 $rating = (float) str_replace( ',', '.', $parsed_args['rating'] ); 2833 2834 // Convert percentage to star rating, 0..5 in .5 increments. 2835 if ( 'percent' === $parsed_args['type'] ) { 2836 $rating = round( $rating / 10, 0 ) / 2; 2837 } 2838 2839 // Calculate the number of each type of star needed. 2840 $full_stars = floor( $rating ); 2841 $half_stars = ceil( $rating - $full_stars ); 2842 $empty_stars = 5 - $full_stars - $half_stars; 2843 2844 if ( $parsed_args['number'] ) { 2845 /* translators: Hidden accessibility text. 1: The rating, 2: The number of ratings. */ 2846 $format = _n( '%1$s rating based on %2$s rating', '%1$s rating based on %2$s ratings', $parsed_args['number'] ); 2847 $title = sprintf( $format, number_format_i18n( $rating, 1 ), number_format_i18n( $parsed_args['number'] ) ); 2848 } else { 2849 /* translators: Hidden accessibility text. %s: The rating. */ 2850 $title = sprintf( __( '%s rating' ), number_format_i18n( $rating, 1 ) ); 2851 } 2852 2853 $output = '<div class="star-rating">'; 2854 $output .= '<span class="screen-reader-text">' . $title . '</span>'; 2855 $output .= str_repeat( '<div class="star star-full" aria-hidden="true"></div>', $full_stars ); 2856 $output .= str_repeat( '<div class="star star-half" aria-hidden="true"></div>', $half_stars ); 2857 $output .= str_repeat( '<div class="star star-empty" aria-hidden="true"></div>', $empty_stars ); 2858 $output .= '</div>'; 2859 2860 if ( $parsed_args['echo'] ) { 2861 echo $output; 2862 } 2863 2864 return $output; 2865 } 2866 2867 /** 2868 * Outputs a notice when editing the page for posts (internal use only). 2869 * 2870 * @ignore 2871 * @since 4.2.0 2872 */ 2873 function _wp_posts_page_notice() { 2874 wp_admin_notice( 2875 __( 'You are currently editing the page that shows your latest posts.' ), 2876 array( 2877 'type' => 'warning', 2878 'additional_classes' => array( 'inline' ), 2879 ) 2880 ); 2881 } 2882 2883 /** 2884 * Outputs a notice when editing the page for posts in the block editor (internal use only). 2885 * 2886 * @ignore 2887 * @since 5.8.0 2888 */ 2889 function _wp_block_editor_posts_page_notice() { 2890 wp_add_inline_script( 2891 'wp-notices', 2892 sprintf( 2893 'wp.data.dispatch( "core/notices" ).createWarningNotice( "%s", { isDismissible: false } )', 2894 __( 'You are currently editing the page that shows your latest posts.' ) 2895 ), 2896 'after' 2897 ); 2898 }
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated : Sun Sep 27 08:20:30 2026 | Cross-referenced by PHPXref |