Changeset 30224

Timestamp:

11/04/2014 06:51:06 AM (10 years ago)

Author:

DrewAPicture

Message:

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.

File:

• trunk/src/wp-includes/general-template.php (modified) (3 diffs)

trunk/src/wp-includes/general-template.php

@@ -1116 +1116 @@
  * @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 = '' ) {
@@ -1190 +1192 @@
  * @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 = '' ) {
@@ -1214 +1218 @@
      *
      * @since 4.1.0
+     *
+     * @see term_description()
      *
      * @param string $description Archive description to be displayed.