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
This commit is contained in:
SergeyBiryukov 2017-01-04 13:43:40 +00:00
parent e2e43dade9
commit cd97be6df7
1 changed files with 4 additions and 3 deletions

View File

@ -1325,13 +1325,14 @@ function has_header_video() {
return (bool) get_header_video_url(); 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 * @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() { function get_header_video_url() {
$id = absint( get_theme_mod( 'header_video' ) ); $id = absint( get_theme_mod( 'header_video' ) );