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.


git-svn-id: https://develop.svn.wordpress.org/trunk@30224 602fd350-edb4-49c9-b593-d223f7449a82
This commit is contained in:
Drew Jaynes (DrewAPicture) 2014-11-04 06:51:06 +00:00
parent 2599e32a67
commit 73a79a8160
1 changed files with 10 additions and 4 deletions

View File

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