Changeset 47182 for trunk/src/wp-includes/post-template.php

Timestamp:

02/05/2020 03:12:14 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Clarify that is_page_template() accepts a template filename, not the Template Name file header.

Props mkaz.
Fixes #49362.

File:

• trunk/src/wp-includes/post-template.php (modified) (4 diffs)

trunk/src/wp-includes/post-template.php

@@ -1731 +1731 @@
  *
  * 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.
  *
@@ -1742 +1742 @@
  * @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.
  */
@@ -1772 +1772 @@
 
 /**
- * Get the specific template name for a given post.
+ * Get the specific template filename for a given post.
  *
  * @since 3.4.0
@@ -1779 +1779 @@
  * @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 ) {