Skip to content

Commit

Permalink
Docs: Update parameter type hints to include null for post thumbnai…
Browse files Browse the repository at this point in the history
…l functions.

Follow-up to [12320], [12351], [20646], [32618], [34167], [34373], [37915].

Props apermo, jasonsa19.
Fixes #62720.

git-svn-id: https://develop.svn.wordpress.org/trunk@59548 602fd350-edb4-49c9-b593-d223f7449a82
  • Loading branch information
SergeyBiryukov committed Dec 20, 2024
1 parent b8ecfbf commit a64ad57
Showing 1 changed file with 12 additions and 12 deletions.
24 changes: 12 additions & 12 deletions src/wp-includes/post-thumbnail-template.php
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@
* @since 2.9.0
* @since 4.4.0 `$post` can be a post ID or WP_Post object.
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @return bool Whether the post has an image attached.
*/
function has_post_thumbnail( $post = null ) {
Expand All @@ -46,7 +46,7 @@ function has_post_thumbnail( $post = null ) {
* @since 5.5.0 The return value for a non-existing post
* was changed to false instead of an empty string.
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @return int|false Post thumbnail ID (which can be 0 if the thumbnail is not set),
* or false if the post does not exist.
*/
Expand Down Expand Up @@ -99,7 +99,7 @@ function the_post_thumbnail( $size = 'post-thumbnail', $attr = '' ) {
*
* @global WP_Query $wp_query WordPress Query object.
*
* @param WP_Query $wp_query Optional. A WP_Query instance. Defaults to the $wp_query global.
* @param WP_Query|null $wp_query Optional. A WP_Query instance. Defaults to the $wp_query global.
*/
function update_post_thumbnail_cache( $wp_query = null ) {
if ( ! $wp_query ) {
Expand Down Expand Up @@ -156,10 +156,10 @@ function update_post_thumbnail_cache( $wp_query = null ) {
* @since 2.9.0
* @since 4.4.0 `$post` can be a post ID or WP_Post object.
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of
* width and height values in pixels (in that order). Default 'post-thumbnail'.
* @param string|array $attr Optional. Query string or array of attributes. Default empty.
* @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param string|int[] $size Optional. Image size. Accepts any registered image size name, or an array of
* width and height values in pixels (in that order). Default 'post-thumbnail'.
* @param string|array $attr Optional. Query string or array of attributes. Default empty.
* @return string The post thumbnail image tag.
*/
function get_the_post_thumbnail( $post = null, $size = 'post-thumbnail', $attr = '' ) {
Expand Down Expand Up @@ -241,9 +241,9 @@ function get_the_post_thumbnail( $post = null, $size = 'post-thumbnail', $attr =
*
* @since 4.4.0
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param string|int[] $size Optional. Registered image size to retrieve the source for or a flat array
* of height and width dimensions. Default 'post-thumbnail'.
* @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param string|int[] $size Optional. Registered image size to retrieve the source for or a flat array
* of height and width dimensions. Default 'post-thumbnail'.
* @return string|false Post thumbnail URL or false if no image is available. If `$size` does not match
* any registered image size, the original image URL will be returned.
*/
Expand Down Expand Up @@ -291,7 +291,7 @@ function the_post_thumbnail_url( $size = 'post-thumbnail' ) {
*
* @since 4.6.0
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @return string Post thumbnail caption.
*/
function get_the_post_thumbnail_caption( $post = null ) {
Expand All @@ -315,7 +315,7 @@ function get_the_post_thumbnail_caption( $post = null ) {
*
* @since 4.6.0
*
* @param int|WP_Post $post Optional. Post ID or WP_Post object. Default is global `$post`.
* @param int|WP_Post|null $post Optional. Post ID or WP_Post object. Default is global `$post`.
*/
function the_post_thumbnail_caption( $post = null ) {
/**
Expand Down

0 comments on commit a64ad57

Please sign in to comment.