WordPress.org
Get WordPress

Make WordPress Core


Ignore:
Timestamp:
07/13/2014 11:40:14 PM (12 years ago)
Author:
DrewAPicture
Message:

Fill out inline documentation for magic methods added to the Walker class in [28514].

See #27881, #22234 and #28885.

File:
1 edited

Legend:

Unmodified
Added
Removed

  • trunk/src/wp-includes/class-wp-walker.php

    r28824 r29143  
    1717         *
    1818         * @since 2.1.0
     19         * @access public
    1920         * @var string
     21         */
     22        public $tree_type;
     23
     24        /**
     25         * DB fields to use.
     26         *
     27         * @since 2.1.0
     28         * @access protected
     29         * @var array
     30         */
     31        protected $db_fields;
     32
     33        /**
     34         * Max number of pages walked by the paged walker
     35         *
     36         * @since 2.7.0
     37         * @access protected
     38         * @var int
     39         */
     40        protected $max_pages = 1;
     41
     42        /**
     43         * Wether the current element has children or not. To be used in start_el()
     44         *
     45         * @since 4.0.0
     46         * @access protected
     47         * @var bool
     48         */
     49        protected $has_children;
     50
     51        /**
     52         * Make private properties readable for backwards compatibility
     53         *
     54         * @since 4.0.0
    2055         * @access public
    21          */
    22         public $tree_type;
    23 
    24         /**
    25          * DB fields to use.
    26          *
    27          * @since 2.1.0
    28          * @var array
    29          * @access protected
    30          */
    31         protected $db_fields;
    32 
    33         /**
    34          * Max number of pages walked by the paged walker
    35          *
    36          * @since 2.7.0
    37          * @var int
    38          * @access protected
    39          */
    40         protected $max_pages = 1;
    41 
    42         /**
    43          * Wether the current element has children or not. To be used in start_el()
    44          *
    45          * @since 4.0.0
    46          * @var bool
    47          * @access protected
    48          */
    49         protected $has_children;
    50 
    51         /**
    52          * Make private properties readable for backwards compatibility
    53          *
    54          * @since 4.0.0
    55          * @param string $name
    56          * @return mixed
     56         *
     57         * @param string $name Property to get.
     58         * @return mixed Property.
    5759         */
    5860        public function __get( $name ) {
    … …  
    6466         *
    6567         * @since 4.0.0
    66          * @param string $name
    67          * @param string $value
    68          * @return mixed
     68         * @access public
     69         *
     70         * @param string $name  Property to set.
     71         * @param mixed  $value Property value.
     72         * @return mixed Newly-set property.
    6973         */
    7074        public function __set( $name, $value ) {
    … …  
    7680         *
    7781         * @since 4.0.0
    78          * @param string $name
    79          * @return mixed
     82         * @access public
     83         *
     84         * @param string $name Property to check if set.
     85         * @return bool Whether the property is set.
    8086         */
    8187        public function __isset( $name ) {
    … …  
    8793         *
    8894         * @since 4.0.0
    89          * @param string $name
    90          * @return mixed
     95         * @access public
     96         *
     97         * @param string $name Property to unset.
    9198         */
    9299        public function __unset( $name ) {
Note: See TracChangeset for help on using the changeset viewer.