Skip to content

Commit

Permalink
Docs: Use third-person singular verbs in Template Loading functions d…
Browse files Browse the repository at this point in the history
…escriptions, as per docblocks standards.

See #55646.

Built from https://develop.svn.wordpress.org/trunk@54180
  • Loading branch information
audrasjb committed Sep 15, 2022
1 parent c0ec82f commit 9c34199
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 20 deletions.
38 changes: 19 additions & 19 deletions wp-includes/template.php
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@
*/

/**
* Retrieve path to a template
* Retrieves path to a template.
*
* Used to quickly retrieve the path of a template without including the file
* extension. It will also check the parent theme, if the file exists, with
Expand Down Expand Up @@ -104,7 +104,7 @@ function get_query_template( $type, $templates = array() ) {
}

/**
* Retrieve path of index template in current or parent template.
* Retrieves path of index 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 'index'.
Expand All @@ -120,7 +120,7 @@ function get_index_template() {
}

/**
* Retrieve path of 404 template in current or parent template.
* Retrieves path of 404 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 '404'.
Expand All @@ -136,7 +136,7 @@ function get_404_template() {
}

/**
* Retrieve path of archive template in current or parent template.
* Retrieves path of archive 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 'archive'.
Expand All @@ -162,7 +162,7 @@ function get_archive_template() {
}

/**
* Retrieve path of post type archive template in current or parent template.
* Retrieves path of post type archive 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 'archive'.
Expand All @@ -188,7 +188,7 @@ function get_post_type_archive_template() {
}

/**
* Retrieve path of author template in current or parent template.
* Retrieves path of author template in current or parent template.
*
* The hierarchy for this template looks like:
*
Expand Down Expand Up @@ -226,7 +226,7 @@ function get_author_template() {
}

/**
* Retrieve path of category template in current or parent template.
* Retrieves path of category template in current or parent template.
*
* The hierarchy for this template looks like:
*
Expand Down Expand Up @@ -272,7 +272,7 @@ function get_category_template() {
}

/**
* Retrieve path of tag template in current or parent template.
* Retrieves path of tag template in current or parent template.
*
* The hierarchy for this template looks like:
*
Expand Down Expand Up @@ -318,7 +318,7 @@ function get_tag_template() {
}

/**
* Retrieve path of custom taxonomy term template in current or parent template.
* Retrieves path of custom taxonomy term template in current or parent template.
*
* The hierarchy for this template looks like:
*
Expand Down Expand Up @@ -365,7 +365,7 @@ function get_taxonomy_template() {
}

/**
* Retrieve path of date template in current or parent template.
* Retrieves path of date 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 'date'.
Expand All @@ -381,7 +381,7 @@ function get_date_template() {
}

/**
* Retrieve path of home template in current or parent template.
* Retrieves path of home 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 'home'.
Expand All @@ -399,7 +399,7 @@ function get_home_template() {
}

/**
* Retrieve path of front page template in current or parent template.
* Retrieves path of front 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 'frontpage'.
Expand All @@ -417,7 +417,7 @@ function get_front_page_template() {
}

/**
* Retrieve path of Privacy Policy page template in current or parent template.
* Retrieves 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'.
Expand All @@ -435,7 +435,7 @@ function get_privacy_policy_template() {
}

/**
* Retrieve path of page template in current or parent template.
* Retrieves path of page template in current or parent template.
*
* Note: For block themes, use locate_block_template function instead.
*
Expand Down Expand Up @@ -498,7 +498,7 @@ function get_page_template() {
}

/**
* Retrieve path of search template in current or parent template.
* Retrieves path of search 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 'search'.
Expand All @@ -514,7 +514,7 @@ function get_search_template() {
}

/**
* Retrieve path of single template in current or parent template. Applies to single Posts,
* Retrieves path of single template in current or parent template. Applies to single Posts,
* single Attachments, and single custom post types.
*
* The hierarchy for this template looks like:
Expand Down Expand Up @@ -628,7 +628,7 @@ function get_singular_template() {
}

/**
* Retrieve path of attachment template in current or parent template.
* Retrieves path of attachment template in current or parent template.
*
* The hierarchy for this template looks like:
*
Expand Down Expand Up @@ -680,7 +680,7 @@ function get_attachment_template() {
}

/**
* Retrieve the name of the highest priority template file that exists.
* Retrieves the name of the highest priority template file that exists.
*
* Searches in the STYLESHEETPATH before TEMPLATEPATH and wp-includes/theme-compat
* so that themes which inherit from a parent theme can just overload one file.
Expand Down Expand Up @@ -746,7 +746,7 @@ function locate_template( $template_names, $load = false, $require_once = true,
}

/**
* Require the template file with WordPress environment.
* Requires the template file with WordPress environment.
*
* The globals are set up for the template file to ensure that the WordPress
* environment is available from within the function. The query variables are
Expand Down
2 changes: 1 addition & 1 deletion wp-includes/version.php
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@
*
* @global string $wp_version
*/
$wp_version = '6.1-alpha-54179';
$wp_version = '6.1-alpha-54180';

/**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.
Expand Down

0 comments on commit 9c34199

Please sign in to comment.