enmi-conf.org: comparison wp/wp-admin/includes/template.php

equal deleted inserted replaced

-:be944660c56a
+:3d72ae0968f4
 //
 // Category Checklists.
 //
 /**
-* Output an unordered list of checkbox input elements labeled with category names.
+* Outputs an unordered list of checkbox input elements labeled with category names.
 *
 * @since 2.5.1
 *
 * @see wp_terms_checklist()
 *
 		)
 	);
 }
 /**
-* Output an unordered list of checkbox input elements labelled with term names.
+* Outputs an unordered list of checkbox input elements labelled with term names.
 *
 * Taxonomy-independent version of wp_category_checklist().
 *
 * @since 3.0.0
 * @since 4.4.0 Introduced the `$echo` argument.
 *     @type int    $descendants_and_self ID of the category to output along with its descendants.
 *                                        Default 0.
 *     @type int[]  $selected_cats        Array of category IDs to mark as checked. Default false.
 *     @type int[]  $popular_cats         Array of category IDs to receive the "popular-category" class.
 *                                        Default false.
-*     @type Walker $walker               Walker object to use to build the output.
+*     @type Walker $walker               Walker object to use to build the output. Default empty which
-*                                        Default is a Walker_Category_Checklist instance.
+*                                        results in a Walker_Category_Checklist instance being used.
 *     @type string $taxonomy             Taxonomy to generate the checklist for. Default 'category'.
 *     @type bool   $checked_ontop        Whether to move checked items out of the hierarchy and to
 *                                        the top of the list. Default true.
 *     @type bool   $echo                 Whether to echo the generated markup. False to return the markup instead
 *                                        of echoing it. Default true.
 	 *
 	 * @since 3.4.0
 	 *
 	 * @see wp_terms_checklist()
 	 *
-	 * @param array $args    An array of arguments.
+	 * @param array|string $args    An array or string of arguments.
-	 * @param int   $post_id The post ID.
+	 * @param int          $post_id The post ID.
 	 */
 	$params = apply_filters( 'wp_terms_checklist_args', $args, $post_id );
 	$parsed_args = wp_parse_args( $params, $defaults );
 	return $output;
 }
 /**
-* Retrieve a list of the most popular terms from the specified taxonomy.
+* Retrieves a list of the most popular terms from the specified taxonomy.
 *
-* If the $echo argument is true then the elements for a list of checkbox
+* If the `$display` argument is true then the elements for a list of checkbox
 * `<input>` elements labelled with the names of the selected terms is output.
-* If the $post_ID global isn't empty then the terms associated with that
+* If the `$post_ID` global is not empty then the terms associated with that
 * post will be marked as checked.
 *
 * @since 2.5.0
 *
-* @param string $taxonomy Taxonomy to retrieve terms from.
+* @param string $taxonomy     Taxonomy to retrieve terms from.
-* @param int    $default  Not used.
+* @param int    $default_term Optional. Not used.
-* @param int    $number   Number of terms to retrieve. Defaults to 10.
+* @param int    $number       Optional. Number of terms to retrieve. Default 10.
-* @param bool   $echo     Optionally output the list as well. Defaults to true.
+* @param bool   $display      Optional. Whether to display the list as well. Default true.
 * @return int[] Array of popular term IDs.
 */
-function wp_popular_terms_checklist( $taxonomy, $default = 0, $number = 10, $echo = true ) {
+function wp_popular_terms_checklist( $taxonomy, $default_term = 0, $number = 10, $display = true ) {
 	$post = get_post();
 	if ( $post && $post->ID ) {
 		$checked_terms = wp_get_object_terms( $post->ID, $taxonomy, array( 'fields' => 'ids' ) );
 	} else {
 	$popular_ids = array();
 	foreach ( (array) $terms as $term ) {
 		$popular_ids[] = $term->term_id;
-		if ( ! $echo ) { // Hack for Ajax use.
+		if ( ! $display ) { // Hack for Ajax use.
 			continue;
 		}
 		$id      = "popular-$taxonomy-$term->term_id";
 		$checked = in_array( $term->term_id, $checked_terms, true ) ? 'checked="checked"' : '';
 		?>
 		<li id="<?php echo $id; ?>" class="popular-category">
 	$taxonomy_names = get_object_taxonomies( $post->post_type );
 	foreach ( $taxonomy_names as $taxonomy_name ) {
 		$taxonomy = get_taxonomy( $taxonomy_name );
-		if ( $taxonomy->hierarchical && $taxonomy->show_ui ) {
+		if ( ! $taxonomy->show_in_quick_edit ) {
+			continue;
+		}
+		if ( $taxonomy->hierarchical ) {
 			$terms = get_object_term_cache( $post->ID, $taxonomy_name );
 			if ( false === $terms ) {
 				$terms = wp_get_object_terms( $post->ID, $taxonomy_name );
 				wp_cache_add( $post->ID, wp_list_pluck( $terms, 'term_id' ), $taxonomy_name . '_relationships' );
 			}
 			$term_ids = empty( $terms ) ? array() : wp_list_pluck( $terms, 'term_id' );
 			echo '<div class="post_category" id="' . $taxonomy_name . '_' . $post->ID . '">' . implode( ',', $term_ids ) . '</div>';
-		} elseif ( $taxonomy->show_ui ) {
+		} else {
 			$terms_to_edit = get_terms_to_edit( $post->ID, $taxonomy_name );
 			if ( ! is_string( $terms_to_edit ) ) {
 				$terms_to_edit = '';
 			}
 </form>
 	<?php
 }
 /**
-* Output 'undo move to Trash' text for comments
+* Outputs 'undo move to Trash' text for comments.
 *
 * @since 2.9.0
 */
 function wp_comment_trashnotice() {
 	?>
 	<?php
 }
 /**
-* Print out HTML form date elements for editing post or comment publish date.
+* Prints out HTML form date elements for editing post or comment publish date.
 *
 * @since 0.71
 * @since 4.4.0 Converted to use get_comment() instead of the global `$comment`.
 *
 * @global WP_Locale $wp_locale WordPress date and time locale object.
 </p>
 	<?php
 }
 /**
-* Print out option HTML elements for the page templates drop-down.
+* Prints out option HTML elements for the page templates drop-down.
 *
 * @since 1.5.0
 * @since 4.7.0 Added the `$post_type` parameter.
 *
-* @param string $default   Optional. The template file name. Default empty.
+* @param string $default_template Optional. The template file name. Default empty.
-* @param string $post_type Optional. Post type to get templates for. Default 'post'.
+* @param string $post_type        Optional. Post type to get templates for. Default 'post'.
 */
-function page_template_dropdown( $default = '', $post_type = 'page' ) {
+function page_template_dropdown( $default_template = '', $post_type = 'page' ) {
 	$templates = get_page_templates( null, $post_type );
 	ksort( $templates );
 	foreach ( array_keys( $templates ) as $template ) {
-		$selected = selected( $default, $templates[ $template ], false );
+		$selected = selected( $default_template, $templates[ $template ], false );
 		echo "\n\t<option value='" . esc_attr( $templates[ $template ] ) . "' $selected>" . esc_html( $template ) . '</option>';
 	}
 }
 /**
-* Print out option HTML elements for the page parents drop-down.
+* Prints out option HTML elements for the page parents drop-down.
 *
 * @since 1.5.0
 * @since 4.4.0 `$post` argument was added.
 *
 * @global wpdb $wpdb WordPress database abstraction object.
 *
-* @param int         $default Optional. The default page ID to be pre-selected. Default 0.
+* @param int         $default_page Optional. The default page ID to be pre-selected. Default 0.
-* @param int         $parent  Optional. The parent page ID. Default 0.
+* @param int         $parent       Optional. The parent page ID. Default 0.
-* @param int         $level   Optional. Page depth level. Default 0.
+* @param int         $level        Optional. Page depth level. Default 0.
-* @param int|WP_Post $post    Post ID or WP_Post object.
+* @param int|WP_Post $post         Post ID or WP_Post object.
 * @return void|false Void on success, false if the page has no children.
 */
-function parent_dropdown( $default = 0, $parent = 0, $level = 0, $post = null ) {
+function parent_dropdown( $default_page = 0, $parent = 0, $level = 0, $post = null ) {
 	global $wpdb;
 	$post  = get_post( $post );
 	$items = $wpdb->get_results( $wpdb->prepare( "SELECT ID, post_parent, post_title FROM $wpdb->posts WHERE post_parent = %d AND post_type = 'page' ORDER BY menu_order", $parent ) );
 			if ( $post && $post->ID && (int) $item->ID === $post->ID ) {
 				continue;
 			}
 			$pad      = str_repeat( '&nbsp;', $level * 3 );
-			$selected = selected( $default, $item->ID, false );
+			$selected = selected( $default_page, $item->ID, false );
 			echo "\n\t<option class='level-$level' value='$item->ID' $selected>$pad " . esc_html( $item->post_title ) . '</option>';
-			parent_dropdown( $default, $item->ID, $level + 1 );
+			parent_dropdown( $default_page, $item->ID, $level + 1 );
 		}
 	} else {
 		return false;
 	}
 }
 /**
-* Print out option HTML elements for role selectors.
+* Prints out option HTML elements for role selectors.
 *
 * @since 2.1.0
 *
 * @param string $selected Slug for the role that should be already selected.
 */
 	);
 }
 /**
-* Function that renders a "fake" meta box with an information message,
+* Renders a "fake" meta box with an information message,
 * shown on the block editor, when an incompatible meta box is found.
 *
 * @since 5.0.0
 *
-* @param mixed $object The data object being rendered on this screen.
+* @param mixed $data_object The data object being rendered on this screen.
-* @param array $box    {
+* @param array $box         {
 *     Custom formats meta box arguments.
 *
 *     @type string   $id           Meta box 'id' attribute.
 *     @type string   $title        Meta box title.
 *     @type callable $old_callback The original callback for this meta box.
 *     @type array    $args         Extra meta box arguments.
 * }
 */
-function do_block_editor_incompatible_meta_box( $object, $box ) {
+function do_block_editor_incompatible_meta_box( $data_object, $box ) {
 	$plugin  = _get_plugin_from_callback( $box['old_callback'] );
 	$plugins = get_plugins();
 	echo '<p>';
 	if ( $plugin ) {
 		/* translators: %s: The name of the plugin that generated this meta box. */
-		printf( __( "This meta box, from the %s plugin, isn't compatible with the block editor." ), "<strong>{$plugin['Name']}</strong>" );
+		printf( __( 'This meta box, from the %s plugin, is not compatible with the block editor.' ), "<strong>{$plugin['Name']}</strong>" );
 	} else {
-		_e( "This meta box isn't compatible with the block editor." );
+		_e( 'This meta box is not compatible with the block editor.' );
 	}
 	echo '</p>';
 	if ( empty( $plugins['classic-editor/classic-editor.php'] ) ) {
 		if ( current_user_can( 'install_plugins' ) ) {
 			echo '<p>';
 			/* translators: %s: A link to activate the Classic Editor plugin. */
 			printf( __( 'Please activate the <a href="%s">Classic Editor plugin</a> to use this meta box.' ), esc_url( $activate_url ) );
 			echo '</p>';
 		}
-	} elseif ( $object instanceof WP_Post ) {
+	} elseif ( $data_object instanceof WP_Post ) {
 		$edit_url = add_query_arg(
 			array(
 				'classic-editor'         => '',
 				'classic-editor__forget' => '',
 			),
-			get_edit_post_link( $object )
+			get_edit_post_link( $data_object )
 		);
 		echo '<p>';
 		/* translators: %s: A link to use the Classic Editor plugin. */
 		printf( __( 'Please open the <a href="%s">classic editor</a> to use this meta box.' ), esc_url( $edit_url ) );
 		echo '</p>';
 *
 * @since 2.5.0
 *
 * @global array $wp_meta_boxes
 *
-* @param string|WP_Screen $screen  The screen identifier. If you have used add_menu_page() or
+* @param string|WP_Screen $screen      The screen identifier. If you have used add_menu_page() or
-*                                  add_submenu_page() to create a new screen (and hence screen_id)
+*                                      add_submenu_page() to create a new screen (and hence screen_id)
-*                                  make sure your menu slug conforms to the limits of sanitize_key()
+*                                      make sure your menu slug conforms to the limits of sanitize_key()
-*                                  otherwise the 'screen' menu may not correctly render on your page.
+*                                      otherwise the 'screen' menu may not correctly render on your page.
-* @param string           $context The screen context for which to display meta boxes.
+* @param string           $context     The screen context for which to display meta boxes.
-* @param mixed            $object  Gets passed to the meta box callback function as the first parameter.
+* @param mixed            $data_object Gets passed to the meta box callback function as the first parameter.
-*                                  Often this is the object that's the focus of the current screen, for
+*                                      Often this is the object that's the focus of the current screen,
-*                                  example a `WP_Post` or `WP_Comment` object.
+*                                      for example a `WP_Post` or `WP_Comment` object.
 * @return int Number of meta_boxes.
 */
-function do_meta_boxes( $screen, $context, $object ) {
+function do_meta_boxes( $screen, $context, $data_object ) {
 	global $wp_meta_boxes;
 	static $already_sorted = false;
 	if ( empty( $screen ) ) {
 		$screen = get_current_screen();
 							?>
 							<div class="error inline">
 								<p>
 									<?php
 										/* translators: %s: The name of the plugin that generated this meta box. */
-										printf( __( "This meta box, from the %s plugin, isn't compatible with the block editor." ), "<strong>{$plugin['Name']}</strong>" );
+										printf( __( 'This meta box, from the %s plugin, is not compatible with the block editor.' ), "<strong>{$plugin['Name']}</strong>" );
 									?>
 								</p>
 							</div>
 							<?php
 						}
 					}
-					call_user_func( $box['callback'], $object, $box );
+					call_user_func( $box['callback'], $data_object, $box );
 					echo "</div>\n";
 					echo "</div>\n";
 				}
 			}
 		}
 *
 * @since 3.6.0
 *
 * @uses global $wp_meta_boxes Used to retrieve registered meta boxes.
 *
-* @param string|object $screen  The screen identifier.
+* @param string|object $screen      The screen identifier.
-* @param string        $context The screen context for which to display accordion sections.
+* @param string        $context     The screen context for which to display accordion sections.
-* @param mixed         $object  Gets passed to the section callback function as the first parameter.
+* @param mixed         $data_object Gets passed to the section callback function as the first parameter.
 * @return int Number of meta boxes as accordion sections.
 */
-function do_accordion_sections( $screen, $context, $object ) {
+function do_accordion_sections( $screen, $context, $data_object ) {
 	global $wp_meta_boxes;
 	wp_enqueue_script( 'accordion' );
 	if ( empty( $screen ) ) {
 							<?php echo esc_html( $box['title'] ); ?>
 							<span class="screen-reader-text"><?php _e( 'Press return or enter to open this section' ); ?></span>
 						</h3>
 						<div class="accordion-section-content <?php postbox_classes( $box['id'], $page ); ?>">
 							<div class="inside">
-								<?php call_user_func( $box['callback'], $object, $box ); ?>
+								<?php call_user_func( $box['callback'], $data_object, $box ); ?>
 							</div><!-- .inside -->
 						</div><!-- .accordion-section-content -->
 					</li><!-- .accordion-section -->
 					<?php
 				}
 	<?php
 	return $i;
 }
 /**
-* Add a new section to a settings page.
+* Adds a new section to a settings page.
 *
 * Part of the Settings API. Use this to define new settings sections for an admin page.
 * Show settings sections in your admin page callback function with do_settings_sections().
 * Add settings fields to your section with add_settings_field().
 *
 		'callback' => $callback,
 	);
 }
 /**
-* Add a new field to a section of a settings page.
+* Adds a new field to a section of a settings page.
 *
 * Part of the Settings API. Use this to define a settings field that will show
 * as part of a settings section inside a settings page. The fields are shown using
 * do_settings_fields() in do_settings_sections().
 *
 		echo '</table>';
 	}
 }
 /**
-* Print out the settings fields for a particular settings section.
+* Prints out the settings fields for a particular settings section.
 *
 * Part of the Settings API. Use this in a settings page to output
 * a specific section. Should normally be called by do_settings_sections()
 * rather than directly.
 *
 		echo '</tr>';
 	}
 }
 /**
-* Register a settings error to be displayed to the user.
+* Registers a settings error to be displayed to the user.
 *
 * Part of the Settings API. Use this to show messages to users about settings validation
 * problems, missing settings or anything else.
 *
 * Settings errors should be added inside the $sanitize_callback function defined in
 		'type'    => $type,
 	);
 }
 /**
-* Fetch settings errors registered by add_settings_error().
+* Fetches settings errors registered by add_settings_error().
 *
 * Checks the $wp_settings_errors array for any errors declared during the current
 * pageload and returns them.
 *
 * If changes were just submitted ($_GET['settings-updated']) and settings errors were saved
 	return $wp_settings_errors;
 }
 /**
-* Display settings errors registered by add_settings_error().
+* Displays settings errors registered by add_settings_error().
 *
 * Part of the Settings API. Outputs a div for each error retrieved by
 * get_settings_errors().
 *
 * This is called automatically after a settings page based on the
 		echo esc_attr( $post->post_password );
 	}
 }
 /**
-* Get the post title.
+* Gets the post title.
 *
 * The post title is fetched and if it is blank then a default string is
 * returned.
 *
 * @since 2.7.0
 function _admin_search_query() {
 	echo isset( $_REQUEST['s'] ) ? esc_attr( wp_unslash( $_REQUEST['s'] ) ) : '';
 }
 /**
-* Generic Iframe header for use with Thickbox
+* Generic Iframe header for use with Thickbox.
 *
 * @since 2.7.0
 *
 * @global string    $hook_suffix
 * @global string    $admin_body_class
 <title><?php bloginfo( 'name' ); ?> &rsaquo; <?php echo $title; ?> &#8212; <?php _e( 'WordPress' ); ?></title>
 	<?php
 	wp_enqueue_style( 'colors' );
 	?>
 <script type="text/javascript">
-addLoadEvent = function(func){if(typeof jQuery!=='undefined')jQuery(document).ready(func);else if(typeof wpOnload!=='function'){wpOnload=func;}else{var oldonload=wpOnload;wpOnload=function(){oldonload();func();}}};
+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();}}};
 function tb_close(){var win=window.dialogArguments||opener||parent||top;win.tb_remove();}
 var ajaxurl = '<?php echo esc_js( admin_url( 'admin-ajax.php', 'relative' ) ); ?>',
 	pagenow = '<?php echo esc_js( $current_screen->id ); ?>',
 	typenow = '<?php echo esc_js( $current_screen->post_type ); ?>',
 	adminpage = '<?php echo esc_js( $admin_body_class ); ?>',
 </script>
 	<?php
 }
 /**
-* Generic Iframe footer for use with Thickbox
+* Generic Iframe footer for use with Thickbox.
 *
 * @since 2.7.0
 */
 function iframe_footer() {
 	/*
 </html>
 	<?php
 }
 /**
-* Function to echo or return the post states as HTML.
+* Echoes or returns the post states as HTML.
 *
 * @since 2.7.0
-* @since 5.3.0 Added the `$echo` parameter and a return value.
+* @since 5.3.0 Added the `$display` parameter and a return value.
 *
 * @see get_post_states()
 *
-* @param WP_Post $post The post to retrieve states for.
+* @param WP_Post $post    The post to retrieve states for.
-* @param bool    $echo Optional. Whether to echo the post states as an HTML string. Default true.
+* @param bool    $display Optional. Whether to display the post states as an HTML string.
+*                         Default true.
 * @return string Post states string.
 */
-function _post_states( $post, $echo = true ) {
+function _post_states( $post, $display = true ) {
 	$post_states        = get_post_states( $post );
 	$post_states_string = '';
 	if ( ! empty( $post_states ) ) {
 		$state_count = count( $post_states );
-		$i           = 0;
+		$i = 0;
 		$post_states_string .= ' &mdash; ';
 		foreach ( $post_states as $state ) {
-			$sep = ( ++$i === $state_count ) ? '' : ', ';
+			++$i;
+			$sep = ( $i < $state_count ) ? ', ' : '';
 			$post_states_string .= "<span class='post-state'>$state$sep</span>";
 		}
 	}
-	if ( $echo ) {
+	if ( $display ) {
 		echo $post_states_string;
 	}
 	return $post_states_string;
 }
 /**
 * Outputs the attachment media states as HTML.
 *
 * @since 3.2.0
-* @since 5.6.0 Added the `$echo` parameter and a return value.
+* @since 5.6.0 Added the `$display` parameter and a return value.
 *
-* @param WP_Post $post The attachment post to retrieve states for.
+* @param WP_Post $post    The attachment post to retrieve states for.
-* @param bool    $echo Optional. Whether to echo the post states as an HTML string. Default true.
+* @param bool    $display Optional. Whether to display the post states as an HTML string.
+*                         Default true.
 * @return string Media states string.
 */
-function _media_states( $post, $echo = true ) {
+function _media_states( $post, $display = true ) {
 	$media_states        = get_media_states( $post );
 	$media_states_string = '';
 	if ( ! empty( $media_states ) ) {
 		$state_count = count( $media_states );
-		$i           = 0;
+		$i = 0;
 		$media_states_string .= ' &mdash; ';
 		foreach ( $media_states as $state ) {
-			$sep = ( ++$i === $state_count ) ? '' : ', ';
+			++$i;
+			$sep = ( $i < $state_count ) ? ', ' : '';
 			$media_states_string .= "<span class='post-state'>$state$sep</span>";
 		}
 	}
-	if ( $echo ) {
+	if ( $display ) {
 		echo $media_states_string;
 	}
 	return $media_states_string;
 }
 	 */
 	return apply_filters( 'display_media_states', $media_states, $post );
 }
 /**
-* Test support for compressing JavaScript from PHP
+* Tests support for compressing JavaScript from PHP.
 *
 * Outputs JavaScript that tests if compression from PHP works as expected
 * and sets an option with the result. Has no effect when the current user
 * is not an administrator. To run the test again the option 'can_compress_scripts'
 * has to be deleted.
 function submit_button( $text = null, $type = 'primary', $name = 'submit', $wrap = true, $other_attributes = null ) {
 	echo get_submit_button( $text, $type, $name, $wrap, $other_attributes );
 }
 /**
-* Returns a submit button, with provided text and appropriate class
+* Returns a submit button, with provided text and appropriate class.
 *
 * @since 3.1.0
 *
 * @param string       $text             Optional. The text of the button. Default 'Save Changes'.
 * @param string       $type             Optional. The type and CSS class(es) of the button. Core values
 <meta http-equiv="Content-Type" content="<?php bloginfo( 'html_type' ); ?>; charset=<?php echo get_option( 'blog_charset' ); ?>" />
 	<?php
 }
 /**
-* Convert a screen string to a screen object
+* Converts a screen string to a screen object.
 *
 * @since 3.0.0
 *
 * @param string $hook_name The hook name (also known as the hook suffix) used to determine the screen.
 * @return WP_Screen Screen object.
 	</div>
 	<?php
 }
 /**
-* Output a HTML element with a star rating for a given rating.
+* Outputs a HTML element with a star rating for a given rating.
 *
 * Outputs a HTML element with the star rating exposed on a 0..5 scale in
 * half star increments (ie. 1, 1.5, 2 stars). Optionally, if specified, the
 * number of ratings may also be displayed by passing the $number parameter.
 *

changeset 19	3d72ae0968f4
parent 18	be944660c56a
child 21	48c4eec2b7e6