Cross reference `get_the_archive_title()` and `get_the_archive_description()` in the inline documentation for their corresponding template tags.

Also define the default values for `$before` and `$after` in the template tag documentation.

See [30223]. See #21995.

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


git-svn-id: http://core.svn.wordpress.org/trunk@30224 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2014-11-04 06:52:23 +00:00
parent 6a45f46937
commit 784e162177
2 changed files with 11 additions and 5 deletions

View File

@ -1115,8 +1115,10 @@ function single_month_title($prefix = '', $display = true ) {
* *
* @since 4.1.0 * @since 4.1.0
* *
* @param string $before Optional. Content to prepend to the title. * @see get_the_archive_title()
* @param string $after Optional. Content to append to the title. *
* @param string $before Optional. Content to prepend to the title. Default empty.
* @param string $after Optional. Content to append to the title. Default empty.
*/ */
function the_archive_title( $before = '', $after = '' ) { function the_archive_title( $before = '', $after = '' ) {
$title = get_the_archive_title(); $title = get_the_archive_title();
@ -1189,8 +1191,10 @@ function get_the_archive_title() {
* *
* @since 4.1.0 * @since 4.1.0
* *
* @param string $before Optional. Content to prepend to the description. * @see get_the_archive_description()
* @param string $after Optional. Content to append to the description. *
* @param string $before Optional. Content to prepend to the description. Default empty.
* @param string $after Optional. Content to append to the description. Default empty.
*/ */
function the_archive_description( $before = '', $after = '' ) { function the_archive_description( $before = '', $after = '' ) {
$description = get_the_archive_description(); $description = get_the_archive_description();
@ -1214,6 +1218,8 @@ function get_the_archive_description() {
* *
* @since 4.1.0 * @since 4.1.0
* *
* @see term_description()
*
* @param string $description Archive description to be displayed. * @param string $description Archive description to be displayed.
*/ */
return apply_filters( 'get_the_archive_description', term_description() ); return apply_filters( 'get_the_archive_description', term_description() );

View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.1-alpha-30223'; $wp_version = '4.1-alpha-30224';
/** /**
* 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.