Changeset 21799 for trunk/wp-includes/post-template.php

Timestamp:

09/10/2012 08:04:33 PM (12 years ago)

Author:

ryan

Message:

phpdoc fixes and additions for post-template.php. Props c3mdigital. fixes #21220

File:

• trunk/wp-includes/post-template.php (modified) (8 diffs)

trunk/wp-includes/post-template.php

@@ -234 +234 @@
  * @access private
  * @param array $match Match array from preg_replace_callback
- * @returns string
+ * @return string
  */
 function _convert_urlencoded_to_entities( $match ) {
@@ -870 +870 @@
  *
  * @param array|string $args
+ * @return string html menu
  */
 function wp_page_menu( $args = array() ) {
@@ -983 +984 @@
      * @param string $output Passed by reference. Used to append additional content.
      * @param int $depth Depth of page. Used for padding.
+     * @param array $args
      */
     function start_lvl( &$output, $depth = 0, $args = array() ) {
@@ -995 +997 @@
      * @param string $output Passed by reference. Used to append additional content.
      * @param int $depth Depth of page. Used for padding.
+     * @param array $args
      */
     function end_lvl( &$output, $depth = 0, $args = array() ) {
@@ -1052 +1055 @@
      * @param object $page Page data object. Not used.
      * @param int $depth Depth of page. Not Used.
+     * @param array $args
      */
     function end_el( &$output, $page, $depth = 0, $args = array() ) {
@@ -1090 +1094 @@
      * @param int $depth Depth of page in reference to parent pages. Used for padding.
      * @param array $args Uses 'selected' argument for selected page to set selected HTML attribute for option element.
+     * @param int $id
      */
     function start_el(&$output, $page, $depth, $args, $id = 0) {
@@ -1138 +1143 @@
  * @param bool $permalink Optional, default is false. Whether to add permalink to image.
  * @param bool $icon Optional, default is false. Whether to include icon.
- * @param string $text Optional, default is false. If string, then will be link text.
+ * @param string|bool $text Optional, default is false. If string, then will be link text.
  * @return string HTML content.
  */
@@ -1249 +1254 @@
  * @since 3.4.0
  *
- * @param int $id The page ID to check. Defaults to the current post, when used in the loop.
+ * @param int $post_id The page ID to check. Defaults to the current post, when used in the loop.
  * @return string|bool Page template filename. Returns an empty string when the default page template
  *  is in use. Returns false if the post is not a page.