From cd97be6df7e34690f0b4dc973f3800f46b5b2a82 Mon Sep 17 00:00:00 2001 From: SergeyBiryukov Date: Wed, 4 Jan 2017 13:43:40 +0000 Subject: [PATCH] Docs: Correct the DocBlock for `get_header_video_url()`. Props keesiemeijer. Fixes #39468. git-svn-id: https://develop.svn.wordpress.org/trunk@39676 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/theme.php | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/src/wp-includes/theme.php b/src/wp-includes/theme.php index da1cb12ce9..47194dfcc7 100644 --- a/src/wp-includes/theme.php +++ b/src/wp-includes/theme.php @@ -1325,13 +1325,14 @@ function has_header_video() { return (bool) get_header_video_url(); } -/* Retrieve header video URL for custom header. +/** + * Retrieve header video URL for custom header. * - * Uses a local video if present, or falls back to an external video. Returns false if there is no video. + * Uses a local video if present, or falls back to an external video. * * @since 4.7.0 * - * @return string|false + * @return string|false Header video URL or false if there is no video. */ function get_header_video_url() { $id = absint( get_theme_mod( 'header_video' ) );