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

equal deleted inserted replaced

-:3d4e9c994f10
+:a86126ab1dd4
 /**
 * Display the ID of the current item in the WordPress Loop.
 *
 * @since 0.71
 */
-function the_ID() {
+function the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	echo get_the_ID();
 }
 /**
 * Retrieve the ID of the current item in the WordPress Loop.
 *
 * @since 2.1.0
 *
 * @return int|false The ID of the current item in the WordPress Loop. False if $post is not set.
 */
-function get_the_ID() {
+function get_the_ID() { // phpcs:ignore WordPress.NamingConventions.ValidFunctionName.FunctionNameInvalid
 	$post = get_post();
 	return ! empty( $post ) ? $post->ID : false;
 }
 /**
 * @since 0.71
 *
 * @param string $before Optional. Markup to prepend to the title. Default empty.
 * @param string $after  Optional. Markup to append to the title. Default empty.
 * @param bool   $echo   Optional. Whether to echo or return the title. Default true for echo.
-* @return string|void Current post title if $echo is false.
+* @return void|string Void if `$echo` argument is true, current post title if `$echo` is false.
 */
 function the_title( $before = '', $after = '', $echo = true ) {
 	$title = get_the_title();
 	if ( strlen( $title ) == 0 ) {
 *     @type string  $before Markup to prepend to the title. Default empty.
 *     @type string  $after  Markup to append to the title. Default empty.
 *     @type bool    $echo   Whether to echo or return the title. Default true for echo.
 *     @type WP_Post $post   Current post object to retrieve the title for.
 * }
-* @return string|void String when echo is false.
+* @return void|string Void if 'echo' argument is true, the title attribute if 'echo' is false.
 */
 function the_title_attribute( $args = '' ) {
-	$defaults = array(
+	$defaults    = array(
 		'before' => '',
 		'after'  => '',
 		'echo'   => true,
 		'post'   => get_post(),
 	);
-	$r        = wp_parse_args( $args, $defaults );
+	$parsed_args = wp_parse_args( $args, $defaults );
-	$title = get_the_title( $r['post'] );
+	$title = get_the_title( $parsed_args['post'] );
 	if ( strlen( $title ) == 0 ) {
 		return;
 	}
-	$title = $r['before'] . $title . $r['after'];
+	$title = $parsed_args['before'] . $title . $parsed_args['after'];
 	$title = esc_attr( strip_tags( $title ) );
-	if ( $r['echo'] ) {
+	if ( $parsed_args['echo'] ) {
 		echo $title;
 	} else {
 		return $title;
 	}
 }
 	$title = isset( $post->post_title ) ? $post->post_title : '';
 	$id    = isset( $post->ID ) ? $post->ID : 0;
 	if ( ! is_admin() ) {
 		if ( ! empty( $post->post_password ) ) {
+			/* translators: %s: Protected post title. */
+			$prepend = __( 'Protected: %s' );
 			/**
 			 * Filters the text prepended to the post title for protected posts.
 			 *
 			 * The filter is only applied on the front end.
 			 *
 			 * @param string  $prepend Text displayed before the post title.
 			 *                         Default 'Protected: %s'.
 			 * @param WP_Post $post    Current post object.
 			 */
-			$protected_title_format = apply_filters( 'protected_title_format', __( 'Protected: %s' ), $post );
+			$protected_title_format = apply_filters( 'protected_title_format', $prepend, $post );
 			$title                  = sprintf( $protected_title_format, $title );
-		} elseif ( isset( $post->post_status ) && 'private' == $post->post_status ) {
+		} elseif ( isset( $post->post_status ) && 'private' === $post->post_status ) {
+			/* translators: %s: Private post title. */
+			$prepend = __( 'Private: %s' );
 			/**
 			 * Filters the text prepended to the post title of private posts.
 			 *
 			 * The filter is only applied on the front end.
 			 *
 			 * @param string  $prepend Text displayed before the post title.
 			 *                         Default 'Private: %s'.
 			 * @param WP_Post $post    Current post object.
 			 */
-			$private_title_format = apply_filters( 'private_title_format', __( 'Private: %s' ), $post );
+			$private_title_format = apply_filters( 'private_title_format', $prepend, $post );
 			$title                = sprintf( $private_title_format, $title );
 		}
 	}
 	/**
 * Display the post content.
 *
 * @since 0.71
 *
 * @param string $more_link_text Optional. Content for when there is more text.
-* @param bool   $strip_teaser   Optional. Strip teaser content before the more text. Default is false.
+* @param bool   $strip_teaser   Optional. Strip teaser content before the more text. Default false.
 */
 function the_content( $more_link_text = null, $strip_teaser = false ) {
 	$content = get_the_content( $more_link_text, $strip_teaser );
 	/**
 * @global array $pages     Array of all pages in post/page. Each array element contains
 *                          part of the content separated by the `<!--nextpage-->` tag.
 * @global int   $multipage Boolean indicator for whether multiple pages are in play.
 *
 * @param string             $more_link_text Optional. Content for when there is more text.
-* @param bool               $strip_teaser   Optional. Strip teaser content before the more text. Default is false.
+* @param bool               $strip_teaser   Optional. Strip teaser content before the more text. Default false.
-* @param WP_Post|object|int $post           Optional. WP_Post instance or Post ID/object. Default is null.
+* @param WP_Post|object|int $post           Optional. WP_Post instance or Post ID/object. Default null.
 * @return string
 */
 function get_the_content( $more_link_text = null, $strip_teaser = false, $post = null ) {
 	global $page, $more, $preview, $pages, $multipage;
 	if ( ! ( $_post instanceof WP_Post ) ) {
 		return '';
 	}
-	if ( null === $post ) {
+	// Use the globals if the $post parameter was not specified,
+	// but only after they have been set up in setup_postdata().
+	if ( null === $post && did_action( 'the_post' ) ) {
 		$elements = compact( 'page', 'more', 'preview', 'pages', 'multipage' );
 	} else {
 		$elements = generate_postdata( $_post );
 	}
 	if ( null === $more_link_text ) {
 		$more_link_text = sprintf(
 			'<span aria-label="%1$s">%2$s</span>',
 			sprintf(
-				/* translators: %s: Name of current post */
+				/* translators: %s: Post title. */
 				__( 'Continue reading %s' ),
 				the_title_attribute(
 					array(
 						'echo' => false,
 						'post' => $_post,
 	// If post password required and it doesn't match the cookie.
 	if ( post_password_required( $_post ) ) {
 		return get_the_password_form( $_post );
 	}
-	if ( $elements['page'] > count( $elements['pages'] ) ) { // if the requested page doesn't exist
+	// If the requested page doesn't exist.
-		$elements['page'] = count( $elements['pages'] ); // give them the highest numbered page that DOES exist
+	if ( $elements['page'] > count( $elements['pages'] ) ) {
+		// Give them the highest numbered page that DOES exist.
+		$elements['page'] = count( $elements['pages'] );
 	}
 	$page_no = $elements['page'];
 	$content = $elements['pages'][ $page_no - 1 ];
 	if ( preg_match( '/<!--more(.*?)?-->/', $content, $matches ) ) {
 		$has_teaser = true;
 	} else {
 		$content = array( $content );
 	}
-	if ( false !== strpos( $_post->post_content, '<!--noteaser-->' ) && ( ! $elements['multipage'] || $elements['page'] == 1 ) ) {
+	if ( false !== strpos( $_post->post_content, '<!--noteaser-->' ) && ( ! $elements['multipage'] || 1 == $elements['page'] ) ) {
 		$strip_teaser = true;
 	}
 	$teaser = $content[0];
 	 * Filters the retrieved post excerpt.
 	 *
 	 * @since 1.2.0
 	 * @since 4.5.0 Introduced the `$post` parameter.
 	 *
-	 * @param string $post_excerpt The post excerpt.
+	 * @param string  $post_excerpt The post excerpt.
-	 * @param WP_Post $post Post object.
+	 * @param WP_Post $post         Post object.
 	 */
 	return apply_filters( 'get_the_excerpt', $post->post_excerpt, $post );
 }
 /**
 *
 * @param string|array $class   One or more classes to add to the class list.
 * @param int|WP_Post  $post_id Optional. Post ID or post object. Defaults to the global `$post`.
 */
 function post_class( $class = '', $post_id = null ) {
-	// Separates classes with a single space, collates classes for post DIV
+	// Separates classes with a single space, collates classes for post DIV.
-	echo 'class="' . join( ' ', get_post_class( $class, $post_id ) ) . '"';
+	echo 'class="' . esc_attr( join( ' ', get_post_class( $class, $post_id ) ) ) . '"';
 }
 /**
 * Retrieves an array of the class names for the post container element.
 *
 		$classes[] = $post->post_type;
 	}
 	$classes[] = 'type-' . $post->post_type;
 	$classes[] = 'status-' . $post->post_status;
-	// Post Format
+	// Post Format.
 	if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
 		$post_format = get_post_format( $post->ID );
 		if ( $post_format && ! is_wp_error( $post_format ) ) {
 			$classes[] = 'format-' . sanitize_html_class( $post_format );
 	// Post thumbnails.
 	if ( current_theme_supports( 'post-thumbnails' ) && has_post_thumbnail( $post->ID ) && ! is_attachment( $post ) && ! $post_password_required ) {
 		$classes[] = 'has-post-thumbnail';
 	}
-	// sticky for Sticky Posts
+	// Sticky for Sticky Posts.
 	if ( is_sticky( $post->ID ) ) {
 		if ( is_home() && ! is_paged() ) {
 			$classes[] = 'sticky';
 		} elseif ( is_admin() ) {
 			$classes[] = 'status-sticky';
 		}
 	}
-	// hentry for hAtom compliance
+	// hentry for hAtom compliance.
 	$classes[] = 'hentry';
-	// All public taxonomies
+	// All public taxonomies.
 	$taxonomies = get_taxonomies( array( 'public' => true ) );
 	foreach ( (array) $taxonomies as $taxonomy ) {
 		if ( is_object_in_taxonomy( $post->post_type, $taxonomy ) ) {
 			foreach ( (array) get_the_terms( $post->ID, $taxonomy ) as $term ) {
 				if ( empty( $term->slug ) ) {
 				if ( is_numeric( $term_class ) || ! trim( $term_class, '-' ) ) {
 					$term_class = $term->term_id;
 				}
 				// 'post_tag' uses the 'tag' prefix for backward compatibility.
-				if ( 'post_tag' == $taxonomy ) {
+				if ( 'post_tag' === $taxonomy ) {
 					$classes[] = 'tag-' . $term_class;
 				} else {
 					$classes[] = sanitize_html_class( $taxonomy . '-' . $term_class, $taxonomy . '-' . $term->term_id );
 				}
 			}
 * @since 2.8.0
 *
 * @param string|string[] $class Space-separated string or array of class names to add to the class list.
 */
 function body_class( $class = '' ) {
-	// Separates class names with a single space, collates class names for body element
+	// Separates class names with a single space, collates class names for body element.
-	echo 'class="' . join( ' ', get_body_class( $class ) ) . '"';
+	echo 'class="' . esc_attr( join( ' ', get_body_class( $class ) ) ) . '"';
 }
 /**
 * Retrieves an array of the class names for the body element.
 *
 * @since 2.8.0
 *
-* @global WP_Query $wp_query
+* @global WP_Query $wp_query WordPress Query object.
 *
 * @param string|string[] $class Space-separated string or array of class names to add to the class list.
 * @return string[] Array of class names.
 */
 function get_body_class( $class = '' ) {
 			$classes[] = 'single';
 			if ( isset( $post->post_type ) ) {
 				$classes[] = 'single-' . sanitize_html_class( $post->post_type, $post_id );
 				$classes[] = 'postid-' . $post_id;
-				// Post Format
+				// Post Format.
 				if ( post_type_supports( $post->post_type, 'post-formats' ) ) {
 					$post_format = get_post_format( $post->ID );
 					if ( $post_format && ! is_wp_error( $post_format ) ) {
 						$classes[] = 'single-format-' . sanitize_html_class( $post_format );
 	 */
 	return apply_filters( 'post_password_required', $required, $post );
 }
 //
-// Page Template Functions for usage in Themes
+// Page Template Functions for usage in Themes.
 //
 /**
 * The formatted output of a list of pages.
 *
 		'previouspagelink' => __( 'Previous page' ),
 		'pagelink'         => '%',
 		'echo'             => 1,
 	);
-	$params = wp_parse_args( $args, $defaults );
+	$parsed_args = wp_parse_args( $args, $defaults );
 	/**
 	 * Filters the arguments used in retrieving page links for paginated posts.
 	 *
 	 * @since 3.0.0
 	 *
-	 * @param array $params An array of arguments for page links for paginated posts.
+	 * @param array $parsed_args An array of arguments for page links for paginated posts.
 	 */
-	$r = apply_filters( 'wp_link_pages_args', $params );
+	$parsed_args = apply_filters( 'wp_link_pages_args', $parsed_args );
 	$output = '';
 	if ( $multipage ) {
-		if ( 'number' == $r['next_or_number'] ) {
+		if ( 'number' === $parsed_args['next_or_number'] ) {
-			$output .= $r['before'];
+			$output .= $parsed_args['before'];
 			for ( $i = 1; $i <= $numpages; $i++ ) {
-				$link = $r['link_before'] . str_replace( '%', $i, $r['pagelink'] ) . $r['link_after'];
+				$link = $parsed_args['link_before'] . str_replace( '%', $i, $parsed_args['pagelink'] ) . $parsed_args['link_after'];
 				if ( $i != $page || ! $more && 1 == $page ) {
 					$link = _wp_link_page( $i ) . $link . '</a>';
 				} elseif ( $i === $page ) {
-					$link = '<span class="post-page-numbers current" aria-current="' . esc_attr( $r['aria_current'] ) . '">' . $link . '</span>';
+					$link = '<span class="post-page-numbers current" aria-current="' . esc_attr( $parsed_args['aria_current'] ) . '">' . $link . '</span>';
 				}
 				/**
 				 * Filters the HTML output of individual page number links.
 				 *
 				 * @since 3.6.0
 				 * @param int    $i    Page number for paginated posts' page links.
 				 */
 				$link = apply_filters( 'wp_link_pages_link', $link, $i );
 				// Use the custom links separator beginning with the second link.
-				$output .= ( 1 === $i ) ? ' ' : $r['separator'];
+				$output .= ( 1 === $i ) ? ' ' : $parsed_args['separator'];
 				$output .= $link;
 			}
-			$output .= $r['after'];
+			$output .= $parsed_args['after'];
 		} elseif ( $more ) {
-			$output .= $r['before'];
+			$output .= $parsed_args['before'];
 			$prev    = $page - 1;
 			if ( $prev > 0 ) {
-				$link = _wp_link_page( $prev ) . $r['link_before'] . $r['previouspagelink'] . $r['link_after'] . '</a>';
+				$link = _wp_link_page( $prev ) . $parsed_args['link_before'] . $parsed_args['previouspagelink'] . $parsed_args['link_after'] . '</a>';
 				/** This filter is documented in wp-includes/post-template.php */
 				$output .= apply_filters( 'wp_link_pages_link', $link, $prev );
 			}
 			$next = $page + 1;
 			if ( $next <= $numpages ) {
 				if ( $prev ) {
-					$output .= $r['separator'];
+					$output .= $parsed_args['separator'];
 				}
-				$link = _wp_link_page( $next ) . $r['link_before'] . $r['nextpagelink'] . $r['link_after'] . '</a>';
+				$link = _wp_link_page( $next ) . $parsed_args['link_before'] . $parsed_args['nextpagelink'] . $parsed_args['link_after'] . '</a>';
 				/** This filter is documented in wp-includes/post-template.php */
 				$output .= apply_filters( 'wp_link_pages_link', $link, $next );
 			}
-			$output .= $r['after'];
+			$output .= $parsed_args['after'];
 		}
 	}
 	/**
 	 * Filters the HTML output of page links for paginated posts.
 	 * @param string $output HTML output of paginated posts' page links.
 	 * @param array  $args   An array of arguments.
 	 */
 	$html = apply_filters( 'wp_link_pages', $output, $args );
-	if ( $r['echo'] ) {
+	if ( $parsed_args['echo'] ) {
 		echo $html;
 	}
 	return $html;
 }
 * Helper function for wp_link_pages().
 *
 * @since 3.1.0
 * @access private
 *
-* @global WP_Rewrite $wp_rewrite
+* @global WP_Rewrite $wp_rewrite WordPress rewrite component.
 *
 * @param int $i Page number.
 * @return string Link.
 */
 function _wp_link_page( $i ) {
 	$query_args = array();
 	if ( 1 == $i ) {
 		$url = get_permalink();
 	} else {
-		if ( '' == get_option( 'permalink_structure' ) || in_array( $post->post_status, array( 'draft', 'pending' ) ) ) {
+		if ( ! get_option( 'permalink_structure' ) || in_array( $post->post_status, array( 'draft', 'pending' ), true ) ) {
 			$url = add_query_arg( 'page', $i, get_permalink() );
-		} elseif ( 'page' == get_option( 'show_on_front' ) && get_option( 'page_on_front' ) == $post->ID ) {
+		} elseif ( 'page' === get_option( 'show_on_front' ) && get_option( 'page_on_front' ) == $post->ID ) {
 			$url = trailingslashit( get_permalink() ) . user_trailingslashit( "$wp_rewrite->pagination_base/" . $i, 'single_paged' );
 		} else {
 			$url = trailingslashit( get_permalink() ) . user_trailingslashit( $i, 'single_paged' );
 		}
 	}
 * Retrieve post custom meta data field.
 *
 * @since 1.5.0
 *
 * @param string $key Meta data key name.
-* @return false|string|array Array of values or single value, if only one element exists. False will be returned if key does not exist.
+* @return array|string|false Array of values, or single value if only one element exists.
+*                            False if the key does not exist.
 */
 function post_custom( $key = '' ) {
 	$custom = get_post_custom();
 	if ( ! isset( $custom[ $key ] ) ) {
 		return false;
-	} elseif ( 1 == count( $custom[ $key ] ) ) {
+	} elseif ( 1 === count( $custom[ $key ] ) ) {
 		return $custom[ $key ][0];
 	} else {
 		return $custom[ $key ];
 	}
 }
 * @since 1.2.0
 *
 * @internal This will probably change at some point...
 */
 function the_meta() {
-	if ( $keys = get_post_custom_keys() ) {
+	$keys = get_post_custom_keys();
+	if ( $keys ) {
 		$li_html = '';
 		foreach ( (array) $keys as $key ) {
 			$keyt = trim( $key );
 			if ( is_protected_meta( $keyt, 'post' ) ) {
 				continue;
 			}
 			$values = array_map( 'trim', get_post_custom_values( $key ) );
-			$value  = implode( $values, ', ' );
+			$value  = implode( ', ', $values );
 			$html = sprintf(
 				"<li><span class='post-meta-key'>%s</span> %s</li>\n",
-				/* translators: %s: Post custom field name */
+				/* translators: %s: Post custom field name. */
 				sprintf( _x( '%s:', 'Post custom field name' ), $key ),
 				$value
 			);
 			/**
 		}
 	}
 }
 //
-// Pages
+// Pages.
 //
 /**
 * Retrieve or display a list of pages as a dropdown (select list).
 *
 *     @type string       $show_option_no_change Text to display for "no change" option. Default empty (does not display).
 *     @type string       $option_none_value     Value to use when no page is selected. Default empty.
 *     @type string       $value_field           Post field used to populate the 'value' attribute of the option
 *                                               elements. Accepts any valid post field. Default 'ID'.
 * }
-* @return string HTML content, if not displaying.
+* @return string HTML dropdown list of pages.
 */
 function wp_dropdown_pages( $args = '' ) {
 	$defaults = array(
 		'depth'                 => 0,
 		'child_of'              => 0,
 		'show_option_no_change' => '',
 		'option_none_value'     => '',
 		'value_field'           => 'ID',
 	);
-	$r = wp_parse_args( $args, $defaults );
+	$parsed_args = wp_parse_args( $args, $defaults );
-	$pages  = get_pages( $r );
+	$pages  = get_pages( $parsed_args );
 	$output = '';
-	// Back-compat with old system where both id and name were based on $name argument
+	// Back-compat with old system where both id and name were based on $name argument.
-	if ( empty( $r['id'] ) ) {
+	if ( empty( $parsed_args['id'] ) ) {
-		$r['id'] = $r['name'];
+		$parsed_args['id'] = $parsed_args['name'];
 	}
 	if ( ! empty( $pages ) ) {
 		$class = '';
-		if ( ! empty( $r['class'] ) ) {
+		if ( ! empty( $parsed_args['class'] ) ) {
-			$class = " class='" . esc_attr( $r['class'] ) . "'";
+			$class = " class='" . esc_attr( $parsed_args['class'] ) . "'";
 		}
-		$output = "<select name='" . esc_attr( $r['name'] ) . "'" . $class . " id='" . esc_attr( $r['id'] ) . "'>\n";
+		$output = "<select name='" . esc_attr( $parsed_args['name'] ) . "'" . $class . " id='" . esc_attr( $parsed_args['id'] ) . "'>\n";
-		if ( $r['show_option_no_change'] ) {
+		if ( $parsed_args['show_option_no_change'] ) {
-			$output .= "\t<option value=\"-1\">" . $r['show_option_no_change'] . "</option>\n";
+			$output .= "\t<option value=\"-1\">" . $parsed_args['show_option_no_change'] . "</option>\n";
 		}
-		if ( $r['show_option_none'] ) {
+		if ( $parsed_args['show_option_none'] ) {
-			$output .= "\t<option value=\"" . esc_attr( $r['option_none_value'] ) . '">' . $r['show_option_none'] . "</option>\n";
+			$output .= "\t<option value=\"" . esc_attr( $parsed_args['option_none_value'] ) . '">' . $parsed_args['show_option_none'] . "</option>\n";
 		}
-		$output .= walk_page_dropdown_tree( $pages, $r['depth'], $r );
+		$output .= walk_page_dropdown_tree( $pages, $parsed_args['depth'], $parsed_args );
 		$output .= "</select>\n";
 	}
 	/**
 	 * Filters the HTML output of a list of pages as a drop down.
 	 *
 	 * @since 2.1.0
-	 * @since 4.4.0 `$r` and `$pages` added as arguments.
+	 * @since 4.4.0 `$parsed_args` and `$pages` added as arguments.
 	 *
-	 * @param string $output HTML output for drop down list of pages.
+	 * @param string    $output      HTML output for drop down list of pages.
-	 * @param array  $r      The parsed arguments array.
+	 * @param array     $parsed_args The parsed arguments array.
-	 * @param array  $pages  List of WP_Post objects returned by `get_pages()`
+	 * @param WP_Post[] $pages       Array of the page objects.
 	 */
-	$html = apply_filters( 'wp_dropdown_pages', $output, $r, $pages );
+	$html = apply_filters( 'wp_dropdown_pages', $output, $parsed_args, $pages );
-	if ( $r['echo'] ) {
+	if ( $parsed_args['echo'] ) {
 		echo $html;
 	}
 	return $html;
 }
 /**
 * Retrieve or display a list of pages (or hierarchical post type items) in list (li) format.
 * @since 1.5.0
 * @since 4.7.0 Added the `item_spacing` argument.
 *
 * @see get_pages()
 *
-* @global WP_Query $wp_query
+* @global WP_Query $wp_query WordPress Query object.
 *
 * @param array|string $args {
 *     Optional. Array or string of arguments to generate a list of pages. See `get_pages()` for additional arguments.
 *
 *     @type int          $child_of     Display only the sub-pages of a single page by ID. Default 0 (all pages).
 *                                      will not be wrapped with unordered list `<ul>` tags. Default 'Pages'.
 *     @type string       $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve' or 'discard'.
 *                                      Default 'preserve'.
 *     @type Walker       $walker       Walker instance to use for listing pages. Default empty (Walker_Page).
 * }
-* @return string|void HTML list of pages.
+* @return void|string Void if 'echo' argument is true, HTML list of pages if 'echo' is false.
 */
 function wp_list_pages( $args = '' ) {
 	$defaults = array(
 		'depth'        => 0,
 		'show_date'    => '',
 		'link_after'   => '',
 		'item_spacing' => 'preserve',
 		'walker'       => '',
 	);
-	$r = wp_parse_args( $args, $defaults );
+	$parsed_args = wp_parse_args( $args, $defaults );
-	if ( ! in_array( $r['item_spacing'], array( 'preserve', 'discard' ), true ) ) {
+	if ( ! in_array( $parsed_args['item_spacing'], array( 'preserve', 'discard' ), true ) ) {
-		// invalid value, fall back to default.
+		// Invalid value, fall back to default.
-		$r['item_spacing'] = $defaults['item_spacing'];
+		$parsed_args['item_spacing'] = $defaults['item_spacing'];
 	}
 	$output       = '';
 	$current_page = 0;
-	// sanitize, mostly to keep spaces out
+	// Sanitize, mostly to keep spaces out.
-	$r['exclude'] = preg_replace( '/[^0-9,]/', '', $r['exclude'] );
+	$parsed_args['exclude'] = preg_replace( '/[^0-9,]/', '', $parsed_args['exclude'] );
-	// Allow plugins to filter an array of excluded pages (but don't put a nullstring into the array)
+	// Allow plugins to filter an array of excluded pages (but don't put a nullstring into the array).
-	$exclude_array = ( $r['exclude'] ) ? explode( ',', $r['exclude'] ) : array();
+	$exclude_array = ( $parsed_args['exclude'] ) ? explode( ',', $parsed_args['exclude'] ) : array();
 	/**
 	 * Filters the array of pages to exclude from the pages list.
 	 *
 	 * @since 2.1.0
 	 *
-	 * @param array $exclude_array An array of page IDs to exclude.
+	 * @param string[] $exclude_array An array of page IDs to exclude.
 	 */
-	$r['exclude'] = implode( ',', apply_filters( 'wp_list_pages_excludes', $exclude_array ) );
+	$parsed_args['exclude'] = implode( ',', apply_filters( 'wp_list_pages_excludes', $exclude_array ) );
+	$parsed_args['hierarchical'] = 0;
 	// Query pages.
-	$r['hierarchical'] = 0;
+	$pages = get_pages( $parsed_args );
-	$pages             = get_pages( $r );
 	if ( ! empty( $pages ) ) {
-		if ( $r['title_li'] ) {
+		if ( $parsed_args['title_li'] ) {
-			$output .= '<li class="pagenav">' . $r['title_li'] . '<ul>';
+			$output .= '<li class="pagenav">' . $parsed_args['title_li'] . '<ul>';
 		}
 		global $wp_query;
 		if ( is_page() || is_attachment() || $wp_query->is_posts_page ) {
 			$current_page = get_queried_object_id();
 		} elseif ( is_singular() ) {
 			if ( is_post_type_hierarchical( $queried_object->post_type ) ) {
 				$current_page = $queried_object->ID;
 			}
 		}
-		$output .= walk_page_tree( $pages, $r['depth'], $current_page, $r );
+		$output .= walk_page_tree( $pages, $parsed_args['depth'], $current_page, $parsed_args );
-		if ( $r['title_li'] ) {
+		if ( $parsed_args['title_li'] ) {
 			$output .= '</ul></li>';
 		}
 	}
 	/**
 	 * @since 1.5.1
 	 * @since 4.4.0 `$pages` added as arguments.
 	 *
 	 * @see wp_list_pages()
 	 *
-	 * @param string $output HTML output of the pages list.
+	 * @param string    $output      HTML output of the pages list.
-	 * @param array  $r      An array of page-listing arguments.
+	 * @param array     $parsed_args An array of page-listing arguments.
-	 * @param array  $pages  List of WP_Post objects returned by `get_pages()`
+	 * @param WP_Post[] $pages       Array of the page objects.
 	 */
-	$html = apply_filters( 'wp_list_pages', $output, $r, $pages );
+	$html = apply_filters( 'wp_list_pages', $output, $parsed_args, $pages );
-	if ( $r['echo'] ) {
+	if ( $parsed_args['echo'] ) {
 		echo $html;
 	} else {
 		return $html;
 	}
 }
 *     @type string          $after        The HTML or text to append to the menu. Default is '</ul>'.
 *     @type string          $item_spacing Whether to preserve whitespace within the menu's HTML. Accepts 'preserve'
 *                                         or 'discard'. Default 'discard'.
 *     @type Walker          $walker       Walker instance to use for listing pages. Default empty (Walker_Page).
 * }
-* @return string|void HTML menu
+* @return void|string Void if 'echo' argument is true, HTML menu if 'echo' is false.
 */
 function wp_page_menu( $args = array() ) {
 	$defaults = array(
 		'sort_column'  => 'menu_order, post_title',
 		'menu_id'      => '',
 		'item_spacing' => 'discard',
 		'walker'       => '',
 	);
 	$args     = wp_parse_args( $args, $defaults );
-	if ( ! in_array( $args['item_spacing'], array( 'preserve', 'discard' ) ) ) {
+	if ( ! in_array( $args['item_spacing'], array( 'preserve', 'discard' ), true ) ) {
-		// invalid value, fall back to default.
+		// Invalid value, fall back to default.
 		$args['item_spacing'] = $defaults['item_spacing'];
 	}
 	if ( 'preserve' === $args['item_spacing'] ) {
 		$t = "\t";
 	$menu = '';
 	$list_args = $args;
-	// Show Home in the menu
+	// Show Home in the menu.
 	if ( ! empty( $args['show_home'] ) ) {
 		if ( true === $args['show_home'] || '1' === $args['show_home'] || 1 === $args['show_home'] ) {
 			$text = __( 'Home' );
 		} else {
 			$text = $args['show_home'];
 		$class = '';
 		if ( is_front_page() && ! is_paged() ) {
 			$class = 'class="current_page_item"';
 		}
 		$menu .= '<li ' . $class . '><a href="' . home_url( '/' ) . '">' . $args['link_before'] . $text . $args['link_after'] . '</a></li>';
-		// If the front page is a page, add it to the exclude list
+		// If the front page is a page, add it to the exclude list.
-		if ( get_option( 'show_on_front' ) == 'page' ) {
+		if ( 'page' === get_option( 'show_on_front' ) ) {
 			if ( ! empty( $list_args['exclude'] ) ) {
 				$list_args['exclude'] .= ',';
 			} else {
 				$list_args['exclude'] = '';
 			}
 		$container = 'div';
 	}
 	if ( $menu ) {
-		// wp_nav_menu doesn't set before and after
+		// wp_nav_menu() doesn't set before and after.
 		if ( isset( $args['fallback_cb'] ) &&
 			'wp_page_menu' === $args['fallback_cb'] &&
 			'ul' !== $container ) {
 			$args['before'] = "<ul>{$n}";
 			$args['after']  = '</ul>';
 	 *
 	 * @param string $menu The HTML output.
 	 * @param array  $args An array of arguments.
 	 */
 	$menu = apply_filters( 'wp_page_menu', $menu, $args );
 	if ( $args['echo'] ) {
 		echo $menu;
 	} else {
 		return $menu;
 	}
 }
 //
-// Page helpers
+// Page helpers.
 //
 /**
 * Retrieve HTML list content for page list.
 *
 */
 function walk_page_tree( $pages, $depth, $current_page, $r ) {
 	if ( empty( $r['walker'] ) ) {
 		$walker = new Walker_Page;
 	} else {
+		/**
+		 * @var Walker $walker
+		 */
 		$walker = $r['walker'];
 	}
 	foreach ( (array) $pages as $page ) {
 		if ( $page->post_parent ) {
 			$r['pages_with_children'][ $page->post_parent ] = true;
 		}
 	}
-	$args = array( $pages, $depth, $r, $current_page );
+	return $walker->walk( $pages, $depth, $r, $current_page );
-	return call_user_func_array( array( $walker, 'walk' ), $args );
 }
 /**
 * Retrieve HTML dropdown (select) content for page list.
 *
+* @since 2.1.0
+* @since 5.3.0 Formalized the existing `...$args` parameter by adding it
+*              to the function signature.
+*
 * @uses Walker_PageDropdown to create HTML dropdown content.
-* @since 2.1.0
 * @see Walker_PageDropdown::walk() for parameters and return description.
 *
+* @param mixed ...$args Elements array, maximum hierarchical depth and optional additional arguments.
 * @return string
 */
-function walk_page_dropdown_tree() {
+function walk_page_dropdown_tree( ...$args ) {
-	$args = func_get_args();
+	if ( empty( $args[2]['walker'] ) ) { // The user's options are the third parameter.
-	if ( empty( $args[2]['walker'] ) ) { // the user's options are the third parameter
 		$walker = new Walker_PageDropdown;
 	} else {
+		/**
+		 * @var Walker $walker
+		 */
 		$walker = $args[2]['walker'];
 	}
-	return call_user_func_array( array( $walker, 'walk' ), $args );
+	return $walker->walk( ...$args );
 }
 //
-// Attachments
+// Attachments.
 //
 /**
 * Display an attachment page link using an image or icon.
 *
 * @since 2.0.0
 *
 * @param int|WP_Post $id Optional. Post ID or post object.
-* @param bool        $fullsize     Optional, default is false. Whether to use full size.
+* @param bool        $fullsize     Optional. Whether to use full size. Default false.
 * @param bool        $deprecated   Deprecated. Not used.
-* @param bool        $permalink    Optional, default is false. Whether to include permalink.
+* @param bool        $permalink    Optional. Whether to include permalink. Default false.
 */
 function the_attachment_link( $id = 0, $fullsize = false, $deprecated = false, $permalink = false ) {
 	if ( ! empty( $deprecated ) ) {
 		_deprecated_argument( __FUNCTION__, '2.5.0' );
 	}
 *
 * @param int|WP_Post  $id        Optional. Post ID or post object.
 * @param string|array $size      Optional. Image size. Accepts any valid image size, or an array
 *                                of width and height values in pixels (in that order).
 *                                Default 'thumbnail'.
-* @param bool         $permalink Optional, Whether to add permalink to image. Default false.
+* @param bool         $permalink Optional. Whether to add permalink to image. Default false.
 * @param bool         $icon      Optional. Whether the attachment is an icon. Default false.
 * @param string|false $text      Optional. Link text to use. Activated by passing a string, false otherwise.
 *                                Default false.
 * @param array|string $attr      Optional. Array or string of attributes. Default empty.
 * @return string HTML content.
 */
 function wp_get_attachment_link( $id = 0, $size = 'thumbnail', $permalink = false, $icon = false, $text = false, $attr = '' ) {
 	$_post = get_post( $id );
-	if ( empty( $_post ) || ( 'attachment' !== $_post->post_type ) || ! $url = wp_get_attachment_url( $_post->ID ) ) {
+	if ( empty( $_post ) || ( 'attachment' !== $_post->post_type ) || ! wp_get_attachment_url( $_post->ID ) ) {
 		return __( 'Missing Attachment' );
 	}
+	$url = wp_get_attachment_url( $_post->ID );
 	if ( $permalink ) {
 		$url = get_attachment_link( $_post->ID );
 	}
 	if ( $text ) {
 		$link_text = $text;
-	} elseif ( $size && 'none' != $size ) {
+	} elseif ( $size && 'none' !== $size ) {
 		$link_text = wp_get_attachment_image( $_post->ID, $size, $icon, $attr );
 	} else {
 		$link_text = '';
 	}
 * @return string
 */
 function prepend_attachment( $content ) {
 	$post = get_post();
-	if ( empty( $post->post_type ) || $post->post_type != 'attachment' ) {
+	if ( empty( $post->post_type ) || 'attachment' !== $post->post_type ) {
 		return $content;
 	}
 	if ( wp_attachment_is( 'video', $post ) ) {
 		$meta = wp_get_attachment_metadata( get_the_ID() );
 		$p = wp_video_shortcode( $atts );
 	} elseif ( wp_attachment_is( 'audio', $post ) ) {
 		$p = wp_audio_shortcode( array( 'src' => wp_get_attachment_url() ) );
 	} else {
 		$p = '<p class="attachment">';
-		// show the medium sized image representation of the attachment if available, and link to the raw file
+		// Show the medium sized image representation of the attachment if available, and link to the raw file.
 		$p .= wp_get_attachment_link( 0, 'medium', false );
 		$p .= '</p>';
 	}
 	/**
 	return "$p\n$content";
 }
 //
-// Misc
+// Misc.
 //
 /**
 * Retrieve protected post password form content.
 *
 /**
 * Determines whether currently in a page template.
 *
 * This template tag allows you to determine if you are in a page template.
-* You can optionally provide a template name or array of template names
+* You can optionally provide a template filename or array of template filenames
 * and then the check will be specific to that template.
 *
 * For more information on this and similar theme functions, check out
 * the {@link https://developer.wordpress.org/themes/basics/conditional-tags/
 * Conditional Tags} article in the Theme Developer Handbook.
 *
 * @since 2.5.0
 * @since 4.2.0 The `$template` parameter was changed to also accept an array of page templates.
 * @since 4.7.0 Now works with any post type, not just pages.
 *
-* @param string|array $template The specific template name or array of templates to match.
+* @param string|array $template The specific template filename or array of templates to match.
 * @return bool True on success, false on failure.
 */
 function is_page_template( $template = '' ) {
 	if ( ! is_singular() ) {
 		return false;
 	return ( 'default' === $template && ! $page_template );
 }
 /**
-* Get the specific template name for a given post.
+* Get the specific template filename for a given post.
 *
 * @since 3.4.0
 * @since 4.7.0 Now works with any post type, not just pages.
 *
 * @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global $post.
 * @return string|false Page template filename. Returns an empty string when the default page template
-*  is in use. Returns false if the post does not exist.
+*                      is in use. Returns false if the post does not exist.
 */
 function get_page_template_slug( $post = null ) {
 	$post = get_post( $post );
 	if ( ! $post ) {
 		return false;
 	}
 	$template = get_post_meta( $post->ID, '_wp_page_template', true );
-	if ( ! $template || 'default' == $template ) {
+	if ( ! $template || 'default' === $template ) {
 		return '';
 	}
 	return $template;
 }
 * Retrieve formatted date timestamp of a revision (linked to that revisions's page).
 *
 * @since 2.6.0
 *
 * @param int|object $revision Revision ID or revision object.
-* @param bool       $link     Optional, default is true. Link to revisions's page?
+* @param bool       $link     Optional. Whether to link to revision's page. Default true.
 * @return string|false i18n formatted datetimestamp or localized 'Current Revision'.
 */
 function wp_post_revision_title( $revision, $link = true ) {
-	if ( ! $revision = get_post( $revision ) ) {
+	$revision = get_post( $revision );
+	if ( ! $revision ) {
 		return $revision;
 	}
-	if ( ! in_array( $revision->post_type, array( 'post', 'page', 'revision' ) ) ) {
+	if ( ! in_array( $revision->post_type, array( 'post', 'page', 'revision' ), true ) ) {
 		return false;
 	}
-	/* translators: revision date format, see https://secure.php.net/date */
+	/* translators: Revision date format, see https://www.php.net/date */
 	$datef = _x( 'F j, Y @ H:i:s', 'revision date format' );
-	/* translators: %s: revision date */
+	/* translators: %s: Revision date. */
 	$autosavef = __( '%s [Autosave]' );
-	/* translators: %s: revision date */
+	/* translators: %s: Revision date. */
 	$currentf = __( '%s [Current Revision]' );
-	$date = date_i18n( $datef, strtotime( $revision->post_modified ) );
+	$date      = date_i18n( $datef, strtotime( $revision->post_modified ) );
-	if ( $link && current_user_can( 'edit_post', $revision->ID ) && $link = get_edit_post_link( $revision->ID ) ) {
+	$edit_link = get_edit_post_link( $revision->ID );
-		$date = "<a href='$link'>$date</a>";
+	if ( $link && current_user_can( 'edit_post', $revision->ID ) && $edit_link ) {
+		$date = "<a href='$edit_link'>$date</a>";
 	}
 	if ( ! wp_is_post_revision( $revision ) ) {
 		$date = sprintf( $currentf, $date );
 	} elseif ( wp_is_post_autosave( $revision ) ) {
 * Retrieve formatted date timestamp of a revision (linked to that revisions's page).
 *
 * @since 3.6.0
 *
 * @param int|object $revision Revision ID or revision object.
-* @param bool       $link     Optional, default is true. Link to revisions's page?
+* @param bool       $link     Optional. Whether to link to revision's page. Default true.
 * @return string|false gravatar, user, i18n formatted datetimestamp or localized 'Current Revision'.
 */
 function wp_post_revision_title_expanded( $revision, $link = true ) {
-	if ( ! $revision = get_post( $revision ) ) {
+	$revision = get_post( $revision );
+	if ( ! $revision ) {
 		return $revision;
 	}
-	if ( ! in_array( $revision->post_type, array( 'post', 'page', 'revision' ) ) ) {
+	if ( ! in_array( $revision->post_type, array( 'post', 'page', 'revision' ), true ) ) {
 		return false;
 	}
 	$author = get_the_author_meta( 'display_name', $revision->post_author );
-	/* translators: revision date format, see https://secure.php.net/date */
+	/* translators: Revision date format, see https://www.php.net/date */
 	$datef = _x( 'F j, Y @ H:i:s', 'revision date format' );
 	$gravatar = get_avatar( $revision->post_author, 24 );
-	$date = date_i18n( $datef, strtotime( $revision->post_modified ) );
+	$date      = date_i18n( $datef, strtotime( $revision->post_modified ) );
-	if ( $link && current_user_can( 'edit_post', $revision->ID ) && $link = get_edit_post_link( $revision->ID ) ) {
+	$edit_link = get_edit_post_link( $revision->ID );
-		$date = "<a href='$link'>$date</a>";
+	if ( $link && current_user_can( 'edit_post', $revision->ID ) && $edit_link ) {
+		$date = "<a href='$edit_link'>$date</a>";
 	}
 	$revision_date_author = sprintf(
-		/* translators: post revision title: 1: author avatar, 2: author name, 3: time ago, 4: date */
+		/* translators: Post revision title. 1: Author avatar, 2: Author name, 3: Time ago, 4: Date. */
 		__( '%1$s %2$s, %3$s ago (%4$s)' ),
 		$gravatar,
 		$author,
-		human_time_diff( strtotime( $revision->post_modified ), current_time( 'timestamp' ) ),
+		human_time_diff( strtotime( $revision->post_modified_gmt ) ),
 		$date
 	);
-	/* translators: %s: revision date with author avatar */
+	/* translators: %s: Revision date with author avatar. */
 	$autosavef = __( '%s [Autosave]' );
-	/* translators: %s: revision date with author avatar */
+	/* translators: %s: Revision date with author avatar. */
 	$currentf = __( '%s [Current Revision]' );
 	if ( ! wp_is_post_revision( $revision ) ) {
 		$revision_date_author = sprintf( $currentf, $revision_date_author );
 	} elseif ( wp_is_post_autosave( $revision ) ) {
 *
 * @param int|WP_Post $post_id Optional. Post ID or WP_Post object. Default is global $post.
 * @param string      $type    'all' (default), 'revision' or 'autosave'
 */
 function wp_list_post_revisions( $post_id = 0, $type = 'all' ) {
-	if ( ! $post = get_post( $post_id ) ) {
+	$post = get_post( $post_id );
+	if ( ! $post ) {
 		return;
 	}
-	// $args array with (parent, format, right, left, type) deprecated since 3.6
+	// $args array with (parent, format, right, left, type) deprecated since 3.6.
 	if ( is_array( $type ) ) {
 		$type = ! empty( $type['type'] ) ? $type['type'] : $type;
 		_deprecated_argument( __FUNCTION__, '3.6.0' );
 	}
-	if ( ! $revisions = wp_get_post_revisions( $post->ID ) ) {
+	$revisions = wp_get_post_revisions( $post->ID );
+	if ( ! $revisions ) {
 		return;
 	}
 	$rows = '';
 	foreach ( $revisions as $revision ) {

changeset 16	a86126ab1dd4
parent 9	177826044cd9
child 18	be944660c56a