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

equal deleted inserted replaced

-:c7c34916027a
+:177826044cd9
 * @return string Full path to template file.
 */
 function get_query_template( $type, $templates = array() ) {
 	$type = preg_replace( '|[^a-z0-9-]+|', '', $type );
-	if ( empty( $templates ) )
+	if ( empty( $templates ) ) {
-		$templates = array("{$type}.php");
+		$templates = array( "{$type}.php" );
+	}
 	/**
 	 * Filters the list of template filenames that are searched for when retrieving a template to use.
 	 *
 	 * The last element in the array should always be the fallback template for this query type.
 	 *
 	 * Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
-	 * 'embed', 'home', 'frontpage', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
+	 * 'embed', 'home', 'frontpage', 'privacypolicy', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
 	 *
 	 * @since 4.7.0
 	 *
 	 * @param array $templates A list of template candidates, in descending order of priority.
 	 */
 	 * The dynamic portion of the hook name, `$type`, refers to the filename -- minus the file
 	 * extension and any non-alphanumeric characters delimiting words -- of the file to load.
 	 * This hook also applies to various types of files loaded as part of the Template Hierarchy.
 	 *
 	 * Possible values for `$type` include: 'index', '404', 'archive', 'author', 'category', 'tag', 'taxonomy', 'date',
-	 * 'embed', 'home', 'frontpage', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
+	 * 'embed', 'home', 'frontpage', 'privacypolicy', 'page', 'paged', 'search', 'single', 'singular', and 'attachment'.
 	 *
 	 * @since 1.5.0
 	 * @since 4.8.0 The `$type` and `$templates` parameters were added.
 	 *
 	 * @param string $template  Path to the template. See locate_template().
-	 * @param string $type      Filename without extension.
+	 * @param string $type      Sanitized filename without extension.
 	 * @param array  $templates A list of template candidates, in descending order of priority.
 	 */
 	return apply_filters( "{$type}_template", $template, $type, $templates );
 }
 * @see get_query_template()
 *
 * @return string Full path to index template file.
 */
 function get_index_template() {
-	return get_query_template('index');
+	return get_query_template( 'index' );
 }
 /**
 * Retrieve path of 404 template in current or parent template.
 *
 * @see get_query_template()
 *
 * @return string Full path to 404 template file.
 */
 function get_404_template() {
-	return get_query_template('404');
+	return get_query_template( '404' );
 }
 /**
 * Retrieve path of archive template in current or parent template.
 *
 	$post_types = array_filter( (array) get_query_var( 'post_type' ) );
 	$templates = array();
 	if ( count( $post_types ) == 1 ) {
-		$post_type = reset( $post_types );
+		$post_type   = reset( $post_types );
 		$templates[] = "archive-{$post_type}.php";
 	}
 	$templates[] = 'archive.php';
 	return get_query_template( 'archive', $templates );
 *
 * @return string Full path to archive template file.
 */
 function get_post_type_archive_template() {
 	$post_type = get_query_var( 'post_type' );
-	if ( is_array( $post_type ) )
+	if ( is_array( $post_type ) ) {
 		$post_type = reset( $post_type );
+	}
 	$obj = get_post_type_object( $post_type );
 	if ( ! ( $obj instanceof WP_Post_Type ) || ! $obj->has_archive ) {
 		return '';
 	}
 * @see get_query_template()
 *
 * @return string Full path to date template file.
 */
 function get_date_template() {
-	return get_query_template('date');
+	return get_query_template( 'date' );
 }
 /**
 * Retrieve path of home template in current or parent template.
 *
 * @see get_query_template()
 *
 * @return string Full path to front page template file.
 */
 function get_front_page_template() {
-	$templates = array('front-page.php');
+	$templates = array( 'front-page.php' );
-	return get_query_template( 'front_page', $templates );
+	return get_query_template( 'frontpage', $templates );
+}
+/**
+* Retrieve path of Privacy Policy page template in current or parent template.
+*
+* The template hierarchy and template path are filterable via the {@see '$type_template_hierarchy'}
+* and {@see '$type_template'} dynamic hooks, where `$type` is 'privacypolicy'.
+*
+* @since 5.2.0
+*
+* @see get_query_template()
+*
+* @return string Full path to privacy policy template file.
+*/
+function get_privacy_policy_template() {
+	$templates = array( 'privacy-policy.php' );
+	return get_query_template( 'privacypolicy', $templates );
 }
 /**
 * Retrieve path of page template in current or parent template.
 *
 * @see get_query_template()
 *
 * @return string Full path to page template file.
 */
 function get_page_template() {
-	$id = get_queried_object_id();
+	$id       = get_queried_object_id();
 	$template = get_page_template_slug();
-	$pagename = get_query_var('pagename');
+	$pagename = get_query_var( 'pagename' );
 	if ( ! $pagename && $id ) {
 		// If a static page is set as the front page, $pagename will not be set. Retrieve it from the queried object
 		$post = get_queried_object();
-		if ( $post )
+		if ( $post ) {
 			$pagename = $post->post_name;
-	}
+		}
+	}
-	$templates = array();
-	if ( $template && 0 === validate_file( $template ) )
+	$templates = array();
+	if ( $template && 0 === validate_file( $template ) ) {
 		$templates[] = $template;
+	}
 	if ( $pagename ) {
 		$pagename_decoded = urldecode( $pagename );
 		if ( $pagename_decoded !== $pagename ) {
 			$templates[] = "page-{$pagename_decoded}.php";
 		}
 		$templates[] = "page-{$pagename}.php";
 	}
-	if ( $id )
+	if ( $id ) {
 		$templates[] = "page-{$id}.php";
+	}
 	$templates[] = 'page.php';
 	return get_query_template( 'page', $templates );
 }
 * @see get_query_template()
 *
 * @return string Full path to search template file.
 */
 function get_search_template() {
-	return get_query_template('search');
+	return get_query_template( 'search' );
 }
 /**
 * Retrieve path of single template in current or parent template. Applies to single Posts,
 * single Attachments, and single custom post types.
 *
 * @since 1.5.0
 * @since 4.4.0 `single-{post_type}-{post_name}.php` was added to the top of the template hierarchy.
 * @since 4.7.0 The decoded form of `single-{post_type}-{post_name}.php` was added to the top of the
 *              template hierarchy when the post name contains multibyte characters.
-* @since 4.7.0 {Post Type Template}.php was added to the top of the template hierarchy.
+* @since 4.7.0 `{Post Type Template}.php` was added to the top of the template hierarchy.
 *
 * @see get_query_template()
 *
 * @return string Full path to single template file.
 */
 		$templates[] = "single-{$object->post_type}-{$object->post_name}.php";
 		$templates[] = "single-{$object->post_type}.php";
 	}
-	$templates[] = "single.php";
+	$templates[] = 'single.php';
 	return get_query_template( 'single', $templates );
 }
 /**
 			$templates[] = "embed-{$object->post_type}-{$post_format}.php";
 		}
 		$templates[] = "embed-{$object->post_type}.php";
 	}
-	$templates[] = "embed.php";
+	$templates[] = 'embed.php';
 	return get_query_template( 'embed', $templates );
 }
 /**
 * @param string|array $template_names Template file(s) to search for, in order.
 * @param bool         $load           If true the template file will be loaded if it is found.
 * @param bool         $require_once   Whether to require_once or require. Default true. Has no effect if $load is false.
 * @return string The template filename if one is located.
 */
-function locate_template($template_names, $load = false, $require_once = true ) {
+function locate_template( $template_names, $load = false, $require_once = true ) {
 	$located = '';
 	foreach ( (array) $template_names as $template_name ) {
-		if ( !$template_name )
+		if ( ! $template_name ) {
 			continue;
-		if ( file_exists(STYLESHEETPATH . '/' . $template_name)) {
+		}
+		if ( file_exists( STYLESHEETPATH . '/' . $template_name ) ) {
 			$located = STYLESHEETPATH . '/' . $template_name;
 			break;
-		} elseif ( file_exists(TEMPLATEPATH . '/' . $template_name) ) {
+		} elseif ( file_exists( TEMPLATEPATH . '/' . $template_name ) ) {
 			$located = TEMPLATEPATH . '/' . $template_name;
 			break;
 		} elseif ( file_exists( ABSPATH . WPINC . '/theme-compat/' . $template_name ) ) {
 			$located = ABSPATH . WPINC . '/theme-compat/' . $template_name;
 			break;
 		}
 	}
-	if ( $load && '' != $located )
+	if ( $load && '' != $located ) {
 		load_template( $located, $require_once );
+	}
 	return $located;
 }
 /**
 */
 function load_template( $_template_file, $require_once = true ) {
 	global $posts, $post, $wp_did_header, $wp_query, $wp_rewrite, $wpdb, $wp_version, $wp, $id, $comment, $user_ID;
 	if ( is_array( $wp_query->query_vars ) ) {
+		/*
+		 * This use of extract() cannot be removed. There are many possible ways that
+		 * templates could depend on variables that it creates existing, and no way to
+		 * detect and deprecate it.
+		 *
+		 * Passing the EXTR_SKIP flag is the safest option, ensuring globals and
+		 * function variables cannot be overwritten.
+		 */
+		// phpcs:ignore WordPress.PHP.DontExtract.extract_extract
 		extract( $wp_query->query_vars, EXTR_SKIP );
 	}
 	if ( isset( $s ) ) {
 		$s = esc_attr( $s );

changeset 9	177826044cd9
parent 7	cf61fcea0001
child 16	a86126ab1dd4