Upstream
/
WordPress
mirror of https://github.com/WordPress/WordPress.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

Adjust DocBlocks for `get_|the_post_thumbnail()` to clarify the difference between the 'thumbnail' and 'post-thumbnail' image sizes. 

Also fleshes out parameter documentation for the two functions.

Props magicroundabout for the initial patch.
Fixes #31351.

Built from https://develop.svn.wordpress.org/trunk@31853


git-svn-id: http://core.svn.wordpress.org/trunk@31832 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2015-03-20 19:57:26 +00:00
parent bb3ca077ce
commit 2e1ebd7b97
1 changed files with 25 additions and 7 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
wp-includes/post-thumbnail-template.php
View File

@ -35,12 +35,22 @@ function get_post_thumbnail_id( $post_id = null ) {
}
/**
* Display Post Thumbnail.
* Display the post thumbnail.
*
* When a theme adds 'post-thumbnail' support, a special 'post-thumbnail' image size
* is registered, which differs from the 'thumbnail' image size managed via the
* Settings > Media screen.
*
* When using the_post_thumbnail() or related functions, the 'post-thumbnail' image
* size is used by default, though a different size can be specified instead as needed.
*
* @since 2.9.0
*
* @param string|array $size Optional. Image size. Defaults to 'post-thumbnail', which theme sets using set_post_thumbnail_size( $width, $height, $crop_flag );.
* @param string|array $attr Optional. Query string or array of attributes.
* @see get_the_post_thumbnail()
*
* @param string|array $size Optional. Registered image size to use, or flat array of height
* and width values. Default 'post-thumbnail'.
* @param string|array $attr Optional. Query string or array of attributes. Default empty.
*/
function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) {
echo get_the_post_thumbnail( null, $size, $attr );
@ -74,13 +84,21 @@ function update_post_thumbnail_cache( $wp_query = null ) {
}
/**
* Retrieve Post Thumbnail.
* Retrieve the post thumbnail.
*
* When a theme adds 'post-thumbnail' support, a special 'post-thumbnail' image size
* is registered, which differs from the 'thumbnail' image size managed via the
* Settings > Media screen.
*
* When using the_post_thumbnail() or related functions, the 'post-thumbnail' image
* size is used by default, though a different size can be specified instead as needed.
*
* @since 2.9.0
*
* @param int $post_id Optional. Post ID.
* @param string $size Optional. Image size. Defaults to 'post-thumbnail'.
* @param string|array $attr Optional. Query string or array of attributes.
* @param int $post_id Post ID. Default is the ID of the `$post` global.
* @param string|array $size Optional. Registered image size to use, or flat array of height
* and width values. Default 'post-thumbnail'.
* @param string|array $attr Optional. Query string or array of attributes. Default empty.
*/
function get_the_post_thumbnail( $post_id = null, $size = 'post-thumbnail', $attr = '' ) {
$post_id = ( null === $post_id ) ? get_the_ID() : $post_id;