Walker_Page WordPress Class

Welcome to the Walker Page Wordpress class! In this class, you will learn how to create and manage a Wordpress website. You will learn how to install Wordpress, create pages and posts, add plugins and themes, and customize your site. This class is perfect for those who want to create a Wordpress site for their business or personal use.

Walker_Page #

Core walker class used to create an HTML list of pages.

Contents

Description

Top ↑

See also

Top ↑

More Information

The Walker_Page class was implemented to help create HTML list of pages. It extends the Walker class. You can also extend this class to add your own logic.

Top ↑

Source

File: wp-includes/class-walker-page.php

17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
class Walker_Page extends Walker {
 
    /**
     * What the class handles.
     *
     * @since 2.1.0
     * @var string
     *
     * @see Walker::$tree_type
     */
    public $tree_type = 'page';
 
    /**
     * Database fields to use.
     *
     * @since 2.1.0
     * @var string[]
     *
     * @see Walker::$db_fields
     * @todo Decouple this.
     */
    public $db_fields = array(
        'parent' => 'post_parent',
        'id'     => 'ID',
    );
 
    /**
     * Outputs the beginning of the current level in the tree before elements are output.
     *
     * @since 2.1.0
     *
     * @see Walker::start_lvl()
     *
     * @param string $output Used to append additional content (passed by reference).
     * @param int    $depth  Optional. Depth of page. Used for padding. Default 0.
     * @param array  $args   Optional. Arguments for outputting the next level.
     *                       Default empty array.
     */
    public function start_lvl( &$output, $depth = 0, $args = array() ) {
        if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
            $t = "\t";
            $n = "\n";
        } else {
            $t = '';
            $n = '';
        }
        $indent  = str_repeat( $t, $depth );
        $output .= "{$n}{$indent}<ul class='children'>{$n}";
    }
 
    /**
     * Outputs the end of the current level in the tree after elements are output.
     *
     * @since 2.1.0
     *
     * @see Walker::end_lvl()
     *
     * @param string $output Used to append additional content (passed by reference).
     * @param int    $depth  Optional. Depth of page. Used for padding. Default 0.
     * @param array  $args   Optional. Arguments for outputting the end of the current level.
     *                       Default empty array.
     */
    public function end_lvl( &$output, $depth = 0, $args = array() ) {
        if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
            $t = "\t";
            $n = "\n";
        } else {
            $t = '';
            $n = '';
        }
        $indent  = str_repeat( $t, $depth );
        $output .= "{$indent}</ul>{$n}";
    }
 
    /**
     * Outputs the beginning of the current element in the tree.
     *
     * @see Walker::start_el()
     * @since 2.1.0
     * @since 5.9.0 Renamed `$page` to `$data_object` and `$current_page` to `$current_object_id`
     *              to match parent class for PHP 8 named parameter support.
     *
     * @param string  $output            Used to append additional content. Passed by reference.
     * @param WP_Post $data_object       Page data object.
     * @param int     $depth             Optional. Depth of page. Used for padding. Default 0.
     * @param array   $args              Optional. Array of arguments. Default empty array.
     * @param int     $current_object_id Optional. ID of the current page. Default 0.
     */
    public function start_el( &$output, $data_object, $depth = 0, $args = array(), $current_object_id = 0 ) {
        // Restores the more descriptive, specific name for use within this method.
        $page            = $data_object;
        $current_page_id = $current_object_id;
 
        if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
            $t = "\t";
            $n = "\n";
        } else {
            $t = '';
            $n = '';
        }
        if ( $depth ) {
            $indent = str_repeat( $t, $depth );
        } else {
            $indent = '';
        }
 
        $css_class = array( 'page_item', 'page-item-' . $page->ID );
 
        if ( isset( $args['pages_with_children'][ $page->ID ] ) ) {
            $css_class[] = 'page_item_has_children';
        }
 
        if ( ! empty( $current_page_id ) ) {
            $_current_page = get_post( $current_page_id );
 
            if ( $_current_page && in_array( $page->ID, $_current_page->ancestors, true ) ) {
                $css_class[] = 'current_page_ancestor';
            }
 
            if ( $page->ID == $current_page_id ) {
                $css_class[] = 'current_page_item';
            } elseif ( $_current_page && $page->ID === $_current_page->post_parent ) {
                $css_class[] = 'current_page_parent';
            }
        } elseif ( get_option( 'page_for_posts' ) == $page->ID ) {
            $css_class[] = 'current_page_parent';
        }
 
        /**
         * Filters the list of CSS classes to include with each page item in the list.
         *
         * @since 2.8.0
         *
         * @see wp_list_pages()
         *
         * @param string[] $css_class       An array of CSS classes to be applied to each list item.
         * @param WP_Post  $page            Page data object.
         * @param int      $depth           Depth of page, used for padding.
         * @param array    $args            An array of arguments.
         * @param int      $current_page_id ID of the current page.
         */
        $css_classes = implode( ' ', apply_filters( 'page_css_class', $css_class, $page, $depth, $args, $current_page_id ) );
        $css_classes = $css_classes ? ' class="' . esc_attr( $css_classes ) . '"' : '';
 
        if ( '' === $page->post_title ) {
            /* translators: %d: ID of a post. */
            $page->post_title = sprintf( __( '#%d (no title)' ), $page->ID );
        }
 
        $args['link_before'] = empty( $args['link_before'] ) ? '' : $args['link_before'];
        $args['link_after']  = empty( $args['link_after'] ) ? '' : $args['link_after'];
 
        $atts                 = array();
        $atts['href']         = get_permalink( $page->ID );
        $atts['aria-current'] = ( $page->ID == $current_page_id ) ? 'page' : '';
 
        /**
         * Filters the HTML attributes applied to a page menu item's anchor element.
         *
         * @since 4.8.0
         *
         * @param array $atts {
         *     The HTML attributes applied to the menu item's `<a>` element, empty strings are ignored.
         *
         *     @type string $href         The href attribute.
         *     @type string $aria-current The aria-current attribute.
         * }
         * @param WP_Post $page            Page data object.
         * @param int     $depth           Depth of page, used for padding.
         * @param array   $args            An array of arguments.
         * @param int     $current_page_id ID of the current page.
         */
        $atts = apply_filters( 'page_menu_link_attributes', $atts, $page, $depth, $args, $current_page_id );
 
        $attributes = '';
        foreach ( $atts as $attr => $value ) {
            if ( is_scalar( $value ) && '' !== $value && false !== $value ) {
                $value       = ( 'href' === $attr ) ? esc_url( $value ) : esc_attr( $value );
                $attributes .= ' ' . $attr . '="' . $value . '"';
            }
        }
 
        $output .= $indent . sprintf(
            '<li%s><a%s>%s%s%s</a>',
            $css_classes,
            $attributes,
            $args['link_before'],
            /** This filter is documented in wp-includes/post-template.php */
            apply_filters( 'the_title', $page->post_title, $page->ID ),
            $args['link_after']
        );
 
        if ( ! empty( $args['show_date'] ) ) {
            if ( 'modified' === $args['show_date'] ) {
                $time = $page->post_modified;
            } else {
                $time = $page->post_date;
            }
 
            $date_format = empty( $args['date_format'] ) ? '' : $args['date_format'];
            $output     .= ' ' . mysql2date( $date_format, $time );
        }
    }
 
    /**
     * Outputs the end of the current element in the tree.
     *
     * @since 2.1.0
     * @since 5.9.0 Renamed `$page` to `$data_object` to match parent class for PHP 8 named parameter support.
     *
     * @see Walker::end_el()
     *
     * @param string  $output      Used to append additional content. Passed by reference.
     * @param WP_Post $data_object Page data object. Not used.
     * @param int     $depth       Optional. Depth of page. Default 0 (unused).
     * @param array   $args        Optional. Array of arguments. Default empty array.
     */
    public function end_el( &$output, $data_object, $depth = 0, $args = array() ) {
        if ( isset( $args['item_spacing'] ) && 'preserve' === $args['item_spacing'] ) {
            $t = "\t";
            $n = "\n";
        } else {
            $t = '';
            $n = '';
        }
        $output .= "</li>{$n}";
    }
 
}

Expand full source codeCollapse full source codeView on TracView on GitHub

Top ↑

Top ↑

Uses

Uses
UsesDescription
wp-includes/class-wp-walker.php:Walker

A class for displaying various tree-like structures.

Top ↑

Methods

  • end_el— Outputs the end of the current element in the tree.
  • end_lvl— Outputs the end of the current level in the tree after elements are output.
  • start_el— Outputs the beginning of the current element in the tree.
  • start_lvl— Outputs the beginning of the current level in the tree before elements are output.

Top ↑

Changelog

Changelog
VersionDescription
2.1.0Introduced.
Download the latest version of WordPress from https://wordpress.org/

The content displayed on this page has been created in part by processing WordPress source code files which are made available under the GPLv2 (or a later version) license by the Free Software Foundation. In addition to this, the content includes user-written examples and information. All material is subject to review and curation by the WPPaste.com community.