From 0be11d0ecc442194884286e3876afd4ef4425c0b Mon Sep 17 00:00:00 2001 From: Pascal Birchler Date: Fri, 7 Oct 2016 16:59:54 +0000 Subject: [PATCH] Docs: Document global variables used by `get_the_content()`. Props goranseric, morganestes. Fixes #37173. git-svn-id: https://develop.svn.wordpress.org/trunk@38746 602fd350-edb4-49c9-b593-d223f7449a82 --- src/wp-includes/post-template.php | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/src/wp-includes/post-template.php b/src/wp-includes/post-template.php index 0c1d1e4bf7..1214129588 100644 --- a/src/wp-includes/post-template.php +++ b/src/wp-includes/post-template.php @@ -247,11 +247,11 @@ function the_content( $more_link_text = null, $strip_teaser = false) { * * @since 0.71 * - * @global int $page - * @global int $more - * @global bool $preview - * @global array $pages - * @global int $multipage + * @global int $page Page number of a single post/page. + * @global int $more Boolean indicator for whether single post/page is being viewed. + * @global bool $preview Whether post/page is in preview mode. + * @global array $pages Array of all pages in post/page. Each array element contains part of the content separated by the tag. + * @global int $multipage Boolean indicator for whether multiple pages are in play. * * @param string $more_link_text Optional. Content for when there is more text. * @param bool $strip_teaser Optional. Strip teaser content before the more text. Default is false.