Ticket #36300: walker-docs.patch
| File walker-docs.patch, 7.1 KB (added by , 8 years ago) |
|---|
-
wp-includes/class-walker-category-dropdown.php
10 10 /** 11 11 * Core class used to create an HTML dropdown list of Categories. 12 12 * 13 * @package WordPress 14 * @subpackage Template 13 15 * @since 2.1.0 14 16 * 15 17 * @see Walker 16 18 */ 17 19 class Walker_CategoryDropdown extends Walker { 20 18 21 /** 22 * What the class handles. 23 * 19 24 * @see Walker::$tree_type 25 * 20 26 * @since 2.1.0 27 * @access private 21 28 * @var string 22 29 */ 23 30 public $tree_type = 'category'; 24 31 25 32 /** 33 * Database fields to use. 34 * 26 35 * @see Walker::$db_fields 36 * 27 37 * @since 2.1.0 38 * @access private 28 39 * @todo Decouple this 29 40 * @var array 30 41 */ … … 34 45 * Start the element output. 35 46 * 36 47 * @see Walker::start_el() 48 * 37 49 * @since 2.1.0 50 * @access public 38 51 * 39 52 * @param string $output Passed by reference. Used to append additional content. 40 53 * @param object $category Category data object. -
wp-includes/class-walker-category.php
10 10 /** 11 11 * Core class used to create an HTML list of categories. 12 12 * 13 * @package WordPress 14 * @subpackage Template 13 15 * @since 2.1.0 14 16 * 15 17 * @see Walker 16 18 */ 17 19 class Walker_Category extends Walker { 20 18 21 /** 19 22 * What the class handles. 20 23 * 21 24 * @see Walker::$tree_type 25 * 22 26 * @since 2.1.0 27 * @access private 23 28 * @var string 24 29 */ 25 30 public $tree_type = 'category'; … … 28 33 * Database fields to use. 29 34 * 30 35 * @see Walker::$db_fields 36 * 31 37 * @since 2.1.0 38 * @access private 32 39 * @todo Decouple this 33 40 * @var array 34 41 */ … … 40 47 * @see Walker::start_lvl() 41 48 * 42 49 * @since 2.1.0 50 * @access public 43 51 * 44 52 * @param string $output Passed by reference. Used to append additional content. 45 53 * @param int $depth Depth of category. Used for tab indentation. … … 60 68 * @see Walker::end_lvl() 61 69 * 62 70 * @since 2.1.0 71 * @access public 63 72 * 64 73 * @param string $output Passed by reference. Used to append additional content. 65 74 * @param int $depth Depth of category. Used for tab indentation. … … 80 89 * @see Walker::start_el() 81 90 * 82 91 * @since 2.1.0 92 * @access public 83 93 * 84 94 * @param string $output Passed by reference. Used to append additional content. 85 95 * @param object $category Category data object. … … 209 219 * @see Walker::end_el() 210 220 * 211 221 * @since 2.1.0 222 * @access public 212 223 * 213 224 * @param string $output Passed by reference. Used to append additional content. 214 225 * @param object $page Not used. -
wp-includes/class-walker-comment.php
10 10 /** 11 11 * HTML comment list class. 12 12 * 13 * @package WordPress 14 * @subpackage Comments 15 * @since 2.7.0 16 * 13 17 * @uses Walker 14 * @since 2.7.015 18 */ 16 19 class Walker_Comment extends Walker { 20 17 21 /** 18 22 * What the class handles. 19 23 * … … 20 24 * @see Walker::$tree_type 21 25 * 22 26 * @since 2.7.0 27 * @access private 23 28 * @var string 24 29 */ 25 30 public $tree_type = 'comment'; 26 31 27 32 /** 28 * D Bfields to use.33 * Database fields to use. 29 34 * 30 35 * @see Walker::$db_fields 31 36 * 32 37 * @since 2.7.0 38 * @access private 39 * @todo Decouple this 33 40 * @var array 34 41 */ 35 42 public $db_fields = array ('parent' => 'comment_parent', 'id' => 'comment_ID'); … … 40 47 * @see Walker::start_lvl() 41 48 * 42 49 * @since 2.7.0 50 * @access public 43 51 * 44 52 * @global int $comment_depth 45 53 * … … 69 77 * @see Walker::end_lvl() 70 78 * 71 79 * @since 2.7.0 80 * @access public 72 81 * 73 82 * @global int $comment_depth 74 83 * … … 115 124 * @see wp_list_comments() 116 125 * 117 126 * @since 2.7.0 127 * @access public 118 128 * 119 129 * @param object $element Data object. 120 130 * @param array $children_elements List of elements to continue traversing. … … 150 160 * Start the element output. 151 161 * 152 162 * @since 2.7.0 163 * @access public 153 164 * 154 165 * @see Walker::start_el() 155 166 * @see wp_list_comments() … … 194 205 * Ends the element output, if needed. 195 206 * 196 207 * @since 2.7.0 208 * @access public 197 209 * 198 210 * @see Walker::end_el() 199 211 * @see wp_list_comments() -
wp-includes/class-walker-page-dropdown.php
10 10 /** 11 11 * Core class used to create an HTML drop-down list of pages. 12 12 * 13 * @package WordPress 14 * @subpackage Post 13 15 * @since 2.1.0 14 16 * 15 17 * @see Walker 16 18 */ 17 19 class Walker_PageDropdown extends Walker { 20 18 21 /** 19 * W alker tree type.22 * What the class handles. 20 23 * 24 * @see Walker::$tree_type 25 * 21 26 * @since 2.1.0 22 * @ see Walker::$tree_type27 * @access private 23 28 * @var string 24 29 */ 25 30 public $tree_type = 'page'; 26 31 27 32 /** 28 * Database fields .33 * Database fields to use. 29 34 * 35 * @see Walker::$db_fields 36 * 30 37 * @since 2.1.0 31 * @ see Walker::$db_fields38 * @access private 32 39 * @todo Decouple this 33 40 * @var array 34 41 */ … … 38 45 * Starts the element output. 39 46 * 40 47 * @since 2.1.0 48 * @access public 41 49 * 42 50 * @see Walker::start_el() 43 51 * -
wp-includes/class-walker-page.php
10 10 /** 11 11 * Core walker class used to create an HTML list of pages. 12 12 * 13 * @package WordPress 14 * @subpackage Template 13 15 * @since 2.1.0 14 16 * 15 17 * @see Walker 16 18 */ 17 19 class Walker_Page extends Walker { 20 18 21 /** 19 * W alker tree type.22 * What the class handles. 20 23 * 24 * @see Walker::$tree_type 25 * 21 26 * @since 2.1.0 22 * @ see Walker::$tree_type27 * @access private 23 28 * @var string 24 29 */ 25 30 public $tree_type = 'page'; 26 31 27 32 /** 28 * Database fields .33 * Database fields to use. 29 34 * 35 * @see Walker::$db_fields 36 * 30 37 * @since 2.1.0 31 * @ see Walker::$db_fields38 * @access private 32 39 * @todo Decouple this. 33 40 * @var array 34 41 */ … … 38 45 * Outputs the beginning of the current level in the tree before elements are output. 39 46 * 40 47 * @since 2.1.0 48 * @access public 41 49 * 42 50 * @see Walker::start_lvl() 43 51 * … … 55 63 * Outputs the end of the current level in the tree after elements are output. 56 64 * 57 65 * @since 2.1.0 66 * @access public 58 67 * 59 68 * @see Walker::end_lvl() 60 69 * … … 73 82 * 74 83 * @see Walker::start_el() 75 84 * @since 2.1.0 85 * @access public 76 86 * 77 87 * @param string $output Passed by reference. Used to append additional content. 78 88 * @param object $page Page data object. … … 157 167 * Outputs the end of the current element in the tree. 158 168 * 159 169 * @since 2.1.0 170 * @access public 160 171 * 161 172 * @see Walker::end_el() 162 173 *