Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-24 21:32:51 +02:00
Code Issues Projects Releases Wiki Activity

In author-template.php, clarify/add some return docs.

Browse Source 
See #32444.

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


git-svn-id: http://core.svn.wordpress.org/trunk@32496 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Scott Taylor 2015-05-21 20:10:26 +00:00
parent c92608aebd
commit 04554bc30d
2 changed files with 11 additions and 6 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

15
wp-includes/author-template.php
View File

@ -18,7 +18,7 @@
* @uses $authordata The current author's DB object. * @uses $authordata The current author's DB object.
* *
* @param string $deprecated Deprecated. * @param string $deprecated Deprecated.
* @return string The author's display name. * @return string|null The author's display name.
*/ */
function get_the_author($deprecated = '') { function get_the_author($deprecated = '') {
global $authordata; global $authordata;
@ -53,7 +53,7 @@ function get_the_author($deprecated = '') {
* *
* @param string $deprecated Deprecated. * @param string $deprecated Deprecated.
* @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it. * @param string $deprecated_echo Deprecated. Use get_the_author(). Echo the string or return it.
* @return string The author's display name, from get_the_author(). * @return string|null The author's display name, from get_the_author().
*/ */
function the_author( $deprecated = '', $deprecated_echo = true ) { function the_author( $deprecated = '', $deprecated_echo = true ) {
if ( !empty( $deprecated ) ) if ( !empty( $deprecated ) )
@ -70,7 +70,7 @@ function the_author( $deprecated = '', $deprecated_echo = true ) {
* *
* @since 2.8.0 * @since 2.8.0
* *
* @return string The author's display name. * @return string|null The author's display name.
*/ */
function get_the_modified_author() { function get_the_modified_author() {
if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) { if ( $last_id = get_post_meta( get_post()->ID, '_edit_last', true) ) {
@ -88,12 +88,12 @@ function get_the_modified_author() {
} }
/** /**
* Display the name of the author who last edited the current post. * Display the name of the author who last edited the current post,
* if the author's ID is available.
* *
* @since 2.8.0 * @since 2.8.0
* *
* @see get_the_author() * @see get_the_author()
* @return string The author's display name, from get_the_modified_author().
*/ */
function the_modified_author() { function the_modified_author() {
echo get_the_modified_author(); echo get_the_modified_author();
@ -162,6 +162,9 @@ function the_author_meta( $field = '', $user_id = false ) {
* *
* If the author has a home page set, return an HTML link, otherwise just return the * If the author has a home page set, return an HTML link, otherwise just return the
* author's name. * author's name.
*
* @return string|null An HTML link if the author's url exist in user meta,
* else the result of get_the_author().
*/ */
function get_the_author_link() { function get_the_author_link() {
if ( get_the_author_meta('url') ) { if ( get_the_author_meta('url') ) {
@ -220,6 +223,8 @@ function the_author_posts() {
* @link https://codex.wordpress.org/Template_Tags/the_author_posts_link * @link https://codex.wordpress.org/Template_Tags/the_author_posts_link
* @since 1.2.0 * @since 1.2.0
* @param string $deprecated Deprecated. * @param string $deprecated Deprecated.
*
* @return false|null
*/ */
function the_author_posts_link($deprecated = '') { function the_author_posts_link($deprecated = '') {
if ( !empty( $deprecated ) ) if ( !empty( $deprecated ) )

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.3-alpha-32525'; $wp_version = '4.3-alpha-32526';
/** /**
* Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema. * Holds the WordPress DB revision, increments when changes are made to the WordPress DB schema.