Upstream/WordPress
1
0
Fork 0
mirror of https://github.com/WordPress/WordPress.git synced 2024-09-28 07:07:38 +02:00
Code Issues Projects Releases Wiki Activity

Docs: Improve inline documentation syntax for Walker_Comment.

Browse Source 
* Marks optional parameters as such
* Improves existing parameter descriptions for clarity
* Syntax improvements

See #36300.

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


git-svn-id: http://core.svn.wordpress.org/trunk@37017 1a063a9b-81f0-0310-95a4-ce76da25c4cd
This commit is contained in:
Drew Jaynes 2016-03-22 17:41:27 +00:00
parent c4c26e4766
commit 7e65fe4f5b
2 changed files with 22 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

41
wp-includes/class-walker-comment.php
View File

@ -49,8 +49,8 @@ class Walker_Comment extends Walker {
* @global int $comment_depth * @global int $comment_depth
* *
* @param string $output Passed by reference. Used to append additional content. * @param string $output Passed by reference. Used to append additional content.
* @param int $depth Depth of comment. * @param int $depth Optional. Depth of the current comment. Default 0.
* @param array $args Uses 'style' argument for type of HTML list. * @param array $args Optional. Uses 'style' argument for type of HTML list. Default empty array.
*/ */
public function start_lvl( &$output, $depth = 0, $args = array() ) { public function start_lvl( &$output, $depth = 0, $args = array() ) {
$GLOBALS['comment_depth'] = $depth + 1; $GLOBALS['comment_depth'] = $depth + 1;
@ -78,8 +78,9 @@ class Walker_Comment extends Walker {
* @global int $comment_depth * @global int $comment_depth
* *
* @param string $output Passed by reference. Used to append additional content. * @param string $output Passed by reference. Used to append additional content.
* @param int $depth Depth of comment. * @param int $depth Optional. Depth of the current comment. Default 0.
* @param array $args Will only append content if style argument value is 'ol' or 'ul'. * @param array $args Optional. Will only append content if style argument value is 'ol' or 'ul'.
* Default empty array.
*/ */
public function end_lvl( &$output, $depth = 0, $args = array() ) { public function end_lvl( &$output, $depth = 0, $args = array() ) {
$GLOBALS['comment_depth'] = $depth + 1; $GLOBALS['comment_depth'] = $depth + 1;
@ -123,11 +124,11 @@ class Walker_Comment extends Walker {
* @see wp_list_comments() * @see wp_list_comments()
* *
* @param object $element Data object. * @param object $element Data object.
* @param array $children_elements List of elements to continue traversing. * @param array $children_elements List of elements to continue traversing. Passed by reference.
* @param int $max_depth Max depth to traverse. * @param int $max_depth Max depth to traverse.
* @param int $depth Depth of current element. * @param int $depth Depth of the current element.
* @param array $args An array of arguments. * @param array $args An array of arguments.
* @param string $output Passed by reference. Used to append additional content. * @param string $output Used to append additional content. Passed by reference.
*/ */
public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) { public function display_element( $element, &$children_elements, $max_depth, $depth, $args, &$output ) {
if ( !$element ) if ( !$element )
@ -139,9 +140,9 @@ class Walker_Comment extends Walker {
parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output ); parent::display_element( $element, $children_elements, $max_depth, $depth, $args, $output );
/* /*
* If we're at the max depth, and the current element still has children, * If at the max depth, and the current element still has children, loop over those
* loop over those and display them at this level. This is to prevent them * and display them at this level. This is to prevent them being orphaned to the end
* being orphaned to the end of the list. * of the list.
*/ */
if ( $max_depth <= $depth + 1 && isset( $children_elements[$id]) ) { if ( $max_depth <= $depth + 1 && isset( $children_elements[$id]) ) {
foreach ( $children_elements[ $id ] as $child ) foreach ( $children_elements[ $id ] as $child )
@ -163,10 +164,10 @@ class Walker_Comment extends Walker {
* @global int $comment_depth * @global int $comment_depth
* @global WP_Comment $comment * @global WP_Comment $comment
* *
* @param string $output Passed by reference. Used to append additional content. * @param string $output Used to append additional content. Passed by reference.
* @param object $comment Comment data object. * @param object $comment Comment data object.
* @param int $depth Depth of comment in reference to parents. * @param int $depth Optional. Depth of the current comment in reference to parents. Default 0.
* @param array $args An array of arguments. * @param array $args Optional. An array of arguments. Default empty array.
* @param int $id Optional. ID of the current comment. Default 0 (unused). * @param int $id Optional. ID of the current comment. Default 0 (unused).
*/ */
public function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) { public function start_el( &$output, $comment, $depth = 0, $args = array(), $id = 0 ) {
@ -205,10 +206,10 @@ class Walker_Comment extends Walker {
* @see Walker::end_el() * @see Walker::end_el()
* @see wp_list_comments() * @see wp_list_comments()
* *
* @param string $output Passed by reference. Used to append additional content. * @param string $output Used to append additional content. Passed by reference.
* @param WP_Comment $comment The comment object. Default current comment. * @param WP_Comment $comment The current comment object. Default current comment.
* @param int $depth Depth of comment. * @param int $depth Optional. Depth of the current comment. Default 0.
* @param array $args An array of arguments. * @param array $args Optional. An array of arguments. Default empty array.
*/ */
public function end_el( &$output, $comment, $depth = 0, $args = array() ) { public function end_el( &$output, $comment, $depth = 0, $args = array() ) {
if ( !empty( $args['end-callback'] ) ) { if ( !empty( $args['end-callback'] ) ) {
@ -232,7 +233,7 @@ class Walker_Comment extends Walker {
* @see wp_list_comments() * @see wp_list_comments()
* *
* @param WP_Comment $comment The comment object. * @param WP_Comment $comment The comment object.
* @param int $depth Depth of comment. * @param int $depth Depth of the current comment.
* @param array $args An array of arguments. * @param array $args An array of arguments.
*/ */
protected function ping( $comment, $depth, $args ) { protected function ping( $comment, $depth, $args ) {
@ -254,7 +255,7 @@ class Walker_Comment extends Walker {
* @see wp_list_comments() * @see wp_list_comments()
* *
* @param object $comment Comment to display. * @param object $comment Comment to display.
* @param int $depth Depth of comment. * @param int $depth Depth of the current comment.
* @param array $args An array of arguments. * @param array $args An array of arguments.
*/ */
protected function comment( $comment, $depth, $args ) { protected function comment( $comment, $depth, $args ) {
@ -313,7 +314,7 @@ class Walker_Comment extends Walker {
* @see wp_list_comments() * @see wp_list_comments()
* *
* @param object $comment Comment to display. * @param object $comment Comment to display.
* @param int $depth Depth of comment. * @param int $depth Depth of the current comment.
* @param array $args An array of arguments. * @param array $args An array of arguments.
*/ */
protected function html5_comment( $comment, $depth, $args ) { protected function html5_comment( $comment, $depth, $args ) {

2
wp-includes/version.php
View File

@ -4,7 +4,7 @@
* *
* @global string $wp_version * @global string $wp_version
*/ */
$wp_version = '4.5-beta4-37049'; $wp_version = '4.5-beta4-37050';
/** /**
* 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.