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