3 * Holds Most of the WordPress classes.
5 * Some of the other classes are contained in other files. For example, the
6 * WordPress cache is in cache.php and the WordPress roles API is in
7 * capabilities.php. The third party libraries are contained in their own
14 * WordPress environment setup class.
21 * Public query variables.
23 * Long list of public query variables.
29 var $public_query_vars = array('m', 'p', 'posts', 'w', 'cat', 'withcomments', 'withoutcomments', 's', 'search', 'exact', 'sentence', 'debug', 'calendar', 'page', 'paged', 'more', 'tb', 'pb', 'author', 'order', 'orderby', 'year', 'monthnum', 'day', 'hour', 'minute', 'second', 'name', 'category_name', 'tag', 'feed', 'author_name', 'static', 'pagename', 'page_id', 'error', 'comments_popup', 'attachment', 'attachment_id', 'subpost', 'subpost_id', 'preview', 'robots', 'taxonomy', 'term', 'cpage', 'post_type');
32 * Private query variables.
34 * Long list of private query variables.
39 var $private_query_vars = array('offset', 'posts_per_page', 'posts_per_archive_page', 'showposts', 'nopaging', 'post_type', 'post_status', 'category__in', 'category__not_in', 'category__and', 'tag__in', 'tag__not_in', 'tag__and', 'tag_slug__in', 'tag_slug__and', 'tag_id', 'post_mime_type', 'perm', 'comments_per_page');
42 * Extra query variables set by the user.
47 var $extra_query_vars = array();
50 * Query variables for setting up the WordPress Query Loop.
58 * String parsed to set the query variables.
66 * Permalink or requested URI.
74 * Rewrite rule the request matched.
82 * Rewrite query the request matched.
90 * Whether already did the permalink.
95 var $did_permalink = false;
98 * Add name to list of public query variables.
102 * @param string $qv Query variable name.
104 function add_query_var($qv) {
105 if ( !in_array($qv, $this->public_query_vars) )
106 $this->public_query_vars[] = $qv;
110 * Set the value of a query variable.
114 * @param string $key Query variable name.
115 * @param mixed $value Query variable value.
117 function set_query_var($key, $value) {
118 $this->query_vars[$key] = $value;
122 * Parse request to find correct WordPress query.
124 * Sets up the query variables based on the request. There are also many
125 * filters and actions that can be used to further manipulate the result.
129 * @param array|string $extra_query_vars Set the extra query variables.
131 function parse_request($extra_query_vars = '') {
134 $this->query_vars = array();
135 $taxonomy_query_vars = array();
136 $post_type_query_vars = array();
138 if ( is_array($extra_query_vars) )
139 $this->extra_query_vars = & $extra_query_vars;
140 else if (! empty($extra_query_vars))
141 parse_str($extra_query_vars, $this->extra_query_vars);
143 // Process PATH_INFO, REQUEST_URI, and 404 for permalinks.
145 // Fetch the rewrite rules.
146 $rewrite = $wp_rewrite->wp_rewrite_rules();
148 if ( ! empty($rewrite) ) {
149 // If we match a rewrite rule, this will be cleared.
151 $this->did_permalink = true;
153 if ( isset($_SERVER['PATH_INFO']) )
154 $pathinfo = $_SERVER['PATH_INFO'];
157 $pathinfo_array = explode('?', $pathinfo);
158 $pathinfo = str_replace("%", "%25", $pathinfo_array[0]);
159 $req_uri = $_SERVER['REQUEST_URI'];
160 $req_uri_array = explode('?', $req_uri);
161 $req_uri = $req_uri_array[0];
162 $self = $_SERVER['PHP_SELF'];
163 $home_path = parse_url(home_url());
164 if ( isset($home_path['path']) )
165 $home_path = $home_path['path'];
168 $home_path = trim($home_path, '/');
170 // Trim path info from the end and the leading home path from the
171 // front. For path info requests, this leaves us with the requesting
172 // filename, if any. For 404 requests, this leaves us with the
173 // requested permalink.
174 $req_uri = str_replace($pathinfo, '', rawurldecode($req_uri));
175 $req_uri = trim($req_uri, '/');
176 $req_uri = preg_replace("|^$home_path|", '', $req_uri);
177 $req_uri = trim($req_uri, '/');
178 $pathinfo = trim($pathinfo, '/');
179 $pathinfo = preg_replace("|^$home_path|", '', $pathinfo);
180 $pathinfo = trim($pathinfo, '/');
181 $self = trim($self, '/');
182 $self = preg_replace("|^$home_path|", '', $self);
183 $self = trim($self, '/');
185 // The requested permalink is in $pathinfo for path info requests and
186 // $req_uri for other requests.
187 if ( ! empty($pathinfo) && !preg_match('|^.*' . $wp_rewrite->index . '$|', $pathinfo) ) {
188 $request = $pathinfo;
190 // If the request uri is the index, blank it out so that we don't try to match it against a rule.
191 if ( $req_uri == $wp_rewrite->index )
196 $this->request = $request;
199 $request_match = $request;
200 foreach ( (array) $rewrite as $match => $query) {
201 // Don't try to match against AtomPub calls
202 if ( $req_uri == 'wp-app.php' )
205 // If the requesting file is the anchor of the match, prepend it
207 if ( (! empty($req_uri)) && (strpos($match, $req_uri) === 0) && ($req_uri != $request) )
208 $request_match = $req_uri . '/' . $request;
210 if ( preg_match("#^$match#", $request_match, $matches) ||
211 preg_match("#^$match#", urldecode($request_match), $matches) ) {
213 $this->matched_rule = $match;
215 // Trim the query of everything up to the '?'.
216 $query = preg_replace("!^.+\?!", '', $query);
218 // Substitute the substring matches into the query.
219 $query = addslashes(WP_MatchesMapRegex::apply($query, $matches));
221 $this->matched_query = $query;
224 parse_str($query, $perma_query_vars);
226 // If we're processing a 404 request, clear the error var
227 // since we found something.
228 if ( isset($_GET['error']) )
229 unset($_GET['error']);
238 // If req_uri is empty or if it is a request for ourself, unset error.
239 if ( empty($request) || $req_uri == $self || strpos($_SERVER['PHP_SELF'], 'wp-admin/') !== false ) {
240 if ( isset($_GET['error']) )
241 unset($_GET['error']);
246 if ( isset($perma_query_vars) && strpos($_SERVER['PHP_SELF'], 'wp-admin/') !== false )
247 unset($perma_query_vars);
249 $this->did_permalink = false;
253 $this->public_query_vars = apply_filters('query_vars', $this->public_query_vars);
255 foreach ( $GLOBALS['wp_taxonomies'] as $taxonomy => $t )
257 $taxonomy_query_vars[$t->query_var] = $taxonomy;
259 foreach ( $GLOBALS['wp_post_types'] as $post_type => $t )
261 $post_type_query_vars[$t->query_var] = $post_type;
263 for ( $i = 0; $i < count($this->public_query_vars); $i += 1 ) {
264 $wpvar = $this->public_query_vars[$i];
265 if ( isset($this->extra_query_vars[$wpvar]) )
266 $this->query_vars[$wpvar] = $this->extra_query_vars[$wpvar];
267 elseif ( isset($GLOBALS[$wpvar]) )
268 $this->query_vars[$wpvar] = $GLOBALS[$wpvar];
269 elseif ( !empty($_POST[$wpvar]) )
270 $this->query_vars[$wpvar] = $_POST[$wpvar];
271 elseif ( !empty($_GET[$wpvar]) )
272 $this->query_vars[$wpvar] = $_GET[$wpvar];
273 elseif ( !empty($perma_query_vars[$wpvar]) )
274 $this->query_vars[$wpvar] = $perma_query_vars[$wpvar];
276 if ( !empty( $this->query_vars[$wpvar] ) ) {
277 $this->query_vars[$wpvar] = (string) $this->query_vars[$wpvar];
278 if ( isset( $taxonomy_query_vars[$wpvar] ) ) {
279 $this->query_vars['taxonomy'] = $taxonomy_query_vars[$wpvar];
280 $this->query_vars['term'] = $this->query_vars[$wpvar];
281 } elseif ( isset($post_type_query_vars[$wpvar] ) ) {
282 $this->query_vars['post_type'] = $post_type_query_vars[$wpvar];
283 $this->query_vars['name'] = $this->query_vars[$wpvar];
288 // Limit publicly queried post_types to those that are publicly_queryable
289 if ( isset( $this->query_vars['post_type']) ) {
290 $queryable_post_types = get_post_types( array('publicly_queryable' => true) );
291 if ( ! in_array( $this->query_vars['post_type'], $queryable_post_types ) )
292 unset( $this->query_vars['post_type'] );
295 foreach ( (array) $this->private_query_vars as $var) {
296 if ( isset($this->extra_query_vars[$var]) )
297 $this->query_vars[$var] = $this->extra_query_vars[$var];
298 elseif ( isset($GLOBALS[$var]) && '' != $GLOBALS[$var] )
299 $this->query_vars[$var] = $GLOBALS[$var];
303 $this->query_vars['error'] = $error;
305 $this->query_vars = apply_filters('request', $this->query_vars);
307 do_action_ref_array('parse_request', array(&$this));
311 * Send additional HTTP headers for caching, content type, etc.
313 * Sets the X-Pingback header, 404 status (if 404), Content-type. If showing
314 * a feed, it will also send last-modified, etag, and 304 status if needed.
318 function send_headers() {
319 $headers = array('X-Pingback' => get_bloginfo('pingback_url'));
321 $exit_required = false;
323 if ( is_user_logged_in() )
324 $headers = array_merge($headers, wp_get_nocache_headers());
325 if ( !empty($this->query_vars['error']) && '404' == $this->query_vars['error'] ) {
327 if ( !is_user_logged_in() )
328 $headers = array_merge($headers, wp_get_nocache_headers());
329 $headers['Content-Type'] = get_option('html_type') . '; charset=' . get_option('blog_charset');
330 } else if ( empty($this->query_vars['feed']) ) {
331 $headers['Content-Type'] = get_option('html_type') . '; charset=' . get_option('blog_charset');
333 // We're showing a feed, so WP is indeed the only thing that last changed
334 if ( !empty($this->query_vars['withcomments'])
335 || ( empty($this->query_vars['withoutcomments'])
336 && ( !empty($this->query_vars['p'])
337 || !empty($this->query_vars['name'])
338 || !empty($this->query_vars['page_id'])
339 || !empty($this->query_vars['pagename'])
340 || !empty($this->query_vars['attachment'])
341 || !empty($this->query_vars['attachment_id'])
345 $wp_last_modified = mysql2date('D, d M Y H:i:s', get_lastcommentmodified('GMT'), 0).' GMT';
347 $wp_last_modified = mysql2date('D, d M Y H:i:s', get_lastpostmodified('GMT'), 0).' GMT';
348 $wp_etag = '"' . md5($wp_last_modified) . '"';
349 $headers['Last-Modified'] = $wp_last_modified;
350 $headers['ETag'] = $wp_etag;
352 // Support for Conditional GET
353 if (isset($_SERVER['HTTP_IF_NONE_MATCH']))
354 $client_etag = stripslashes(stripslashes($_SERVER['HTTP_IF_NONE_MATCH']));
355 else $client_etag = false;
357 $client_last_modified = empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? '' : trim($_SERVER['HTTP_IF_MODIFIED_SINCE']);
358 // If string is empty, return 0. If not, attempt to parse into a timestamp
359 $client_modified_timestamp = $client_last_modified ? strtotime($client_last_modified) : 0;
361 // Make a timestamp for our most recent modification...
362 $wp_modified_timestamp = strtotime($wp_last_modified);
364 if ( ($client_last_modified && $client_etag) ?
365 (($client_modified_timestamp >= $wp_modified_timestamp) && ($client_etag == $wp_etag)) :
366 (($client_modified_timestamp >= $wp_modified_timestamp) || ($client_etag == $wp_etag)) ) {
368 $exit_required = true;
372 $headers = apply_filters('wp_headers', $headers, $this);
374 if ( ! empty( $status ) )
375 status_header( $status );
376 foreach( (array) $headers as $name => $field_value )
377 @header("{$name}: {$field_value}");
382 do_action_ref_array('send_headers', array(&$this));
386 * Sets the query string property based off of the query variable property.
388 * The 'query_string' filter is deprecated, but still works. Plugins should
389 * use the 'request' filter instead.
393 function build_query_string() {
394 $this->query_string = '';
395 foreach ( (array) array_keys($this->query_vars) as $wpvar) {
396 if ( '' != $this->query_vars[$wpvar] ) {
397 $this->query_string .= (strlen($this->query_string) < 1) ? '' : '&';
398 if ( !is_scalar($this->query_vars[$wpvar]) ) // Discard non-scalars.
400 $this->query_string .= $wpvar . '=' . rawurlencode($this->query_vars[$wpvar]);
404 // query_string filter deprecated. Use request filter instead.
405 if ( has_filter('query_string') ) { // Don't bother filtering and parsing if no plugins are hooked in.
406 $this->query_string = apply_filters('query_string', $this->query_string);
407 parse_str($this->query_string, $this->query_vars);
412 * Set up the WordPress Globals.
414 * The query_vars property will be extracted to the GLOBALS. So care should
415 * be taken when naming global variables that might interfere with the
416 * WordPress environment.
418 * @global string $query_string Query string for the loop.
419 * @global int $more Only set, if single page or post.
420 * @global int $single If single page or post. Only set, if single page or post.
424 function register_globals() {
426 // Extract updated query vars back into global namespace.
427 foreach ( (array) $wp_query->query_vars as $key => $value) {
428 $GLOBALS[$key] = $value;
431 $GLOBALS['query_string'] = $this->query_string;
432 $GLOBALS['posts'] = & $wp_query->posts;
433 $GLOBALS['post'] = $wp_query->post;
434 $GLOBALS['request'] = $wp_query->request;
436 if ( is_single() || is_page() ) {
437 $GLOBALS['more'] = 1;
438 $GLOBALS['single'] = 1;
443 * Set up the current user.
448 wp_get_current_user();
452 * Set up the Loop based on the query variables.
454 * @uses WP::$query_vars
457 function query_posts() {
458 global $wp_the_query;
459 $this->build_query_string();
460 $wp_the_query->query($this->query_vars);
464 * Set the Headers for 404, if nothing is found for requested URL.
466 * Issue a 404 if a request doesn't match any posts and doesn't match
467 * any object (e.g. an existing-but-empty category, tag, author) and a 404 was not already
468 * issued, and if the request was not a search or the homepage.
470 * Otherwise, issue a 200.
474 function handle_404() {
477 if ( !is_admin() && ( 0 == count( $wp_query->posts ) ) && !is_404() && !is_robots() && !is_search() && !is_home() ) {
478 // Don't 404 for these queries if they matched an object.
479 if ( ( is_tag() || is_category() || is_tax() || is_author() ) && $wp_query->get_queried_object() && !is_paged() ) {
481 status_header( 200 );
484 $wp_query->set_404();
485 status_header( 404 );
487 } elseif ( !is_404() ) {
488 status_header( 200 );
493 * Sets up all of the variables required by the WordPress environment.
495 * The action 'wp' has one parameter that references the WP object. It
496 * allows for accessing the properties and methods to further manipulate the
501 * @param string|array $query_args Passed to {@link parse_request()}
503 function main($query_args = '') {
505 $this->parse_request($query_args);
506 $this->send_headers();
507 $this->query_posts();
509 $this->register_globals();
510 do_action_ref_array('wp', array(&$this));
514 * PHP4 Constructor - Does nothing.
516 * Call main() method when ready to run setup.
528 * WordPress Error class.
530 * Container for checking for WordPress errors and error messages. Return
531 * WP_Error and use {@link is_wp_error()} to check if this class is returned.
532 * Many core WordPress functions pass this class in the event of an error and
533 * if not handled properly will result in code errors.
540 * Stores the list of errors.
546 var $errors = array();
549 * Stores the list of data for error codes.
555 var $error_data = array();
558 * PHP4 Constructor - Sets up error message.
560 * If code parameter is empty then nothing will be done. It is possible to
561 * add multiple messages to the same code, but with other methods in the
564 * All parameters are optional, but if the code parameter is set, then the
565 * data parameter is optional.
569 * @param string|int $code Error code
570 * @param string $message Error message
571 * @param mixed $data Optional. Error data.
574 function WP_Error($code = '', $message = '', $data = '') {
578 $this->errors[$code][] = $message;
580 if ( ! empty($data) )
581 $this->error_data[$code] = $data;
585 * Retrieve all error codes.
590 * @return array List of error codes, if avaiable.
592 function get_error_codes() {
593 if ( empty($this->errors) )
596 return array_keys($this->errors);
600 * Retrieve first error code available.
605 * @return string|int Empty string, if no error codes.
607 function get_error_code() {
608 $codes = $this->get_error_codes();
617 * Retrieve all error messages or error messages matching code.
621 * @param string|int $code Optional. Retrieve messages matching code, if exists.
622 * @return array Error strings on success, or empty array on failure (if using codee parameter).
624 function get_error_messages($code = '') {
625 // Return all messages if no code specified.
626 if ( empty($code) ) {
627 $all_messages = array();
628 foreach ( (array) $this->errors as $code => $messages )
629 $all_messages = array_merge($all_messages, $messages);
631 return $all_messages;
634 if ( isset($this->errors[$code]) )
635 return $this->errors[$code];
641 * Get single error message.
643 * This will get the first message available for the code. If no code is
644 * given then the first code available will be used.
648 * @param string|int $code Optional. Error code to retrieve message.
651 function get_error_message($code = '') {
653 $code = $this->get_error_code();
654 $messages = $this->get_error_messages($code);
655 if ( empty($messages) )
661 * Retrieve error data for error code.
665 * @param string|int $code Optional. Error code.
666 * @return mixed Null, if no errors.
668 function get_error_data($code = '') {
670 $code = $this->get_error_code();
672 if ( isset($this->error_data[$code]) )
673 return $this->error_data[$code];
678 * Append more error messages to list of error messages.
683 * @param string|int $code Error code.
684 * @param string $message Error message.
685 * @param mixed $data Optional. Error data.
687 function add($code, $message, $data = '') {
688 $this->errors[$code][] = $message;
689 if ( ! empty($data) )
690 $this->error_data[$code] = $data;
694 * Add data for error code.
696 * The error code can only contain one error data.
700 * @param mixed $data Error data.
701 * @param string|int $code Error code.
703 function add_data($data, $code = '') {
705 $code = $this->get_error_code();
707 $this->error_data[$code] = $data;
712 * Check whether variable is a WordPress Error.
714 * Looks at the object and if a WP_Error class. Does not check to see if the
715 * parent is also WP_Error, so can't inherit WP_Error and still use this
720 * @param mixed $thing Check if unknown variable is WordPress Error object.
721 * @return bool True, if WP_Error. False, if not WP_Error.
723 function is_wp_error($thing) {
724 if ( is_object($thing) && is_a($thing, 'WP_Error') )
730 * A class for displaying various tree-like structures.
732 * Extend the Walker class to use it, see examples at the below. Child classes
733 * do not need to implement all of the abstract methods in the class. The child
734 * only needs to implement the methods that are needed. Also, the methods are
735 * not strictly abstract in that the parameter definition needs to be followed.
736 * The child classes can have additional parameters.
744 * What the class handles.
762 * Max number of pages walked by the paged walker
771 * Starts the list before the elements are added.
773 * Additional parameters are used in child classes. The args parameter holds
774 * additional values that may be used with the child class methods. This
775 * method is called at the start of the output list.
780 * @param string $output Passed by reference. Used to append additional content.
782 function start_lvl(&$output) {}
785 * Ends the list of after the elements are added.
787 * Additional parameters are used in child classes. The args parameter holds
788 * additional values that may be used with the child class methods. This
789 * method finishes the list at the end of output of the elements.
794 * @param string $output Passed by reference. Used to append additional content.
796 function end_lvl(&$output) {}
799 * Start the element output.
801 * Additional parameters are used in child classes. The args parameter holds
802 * additional values that may be used with the child class methods. Includes
803 * the element output also.
808 * @param string $output Passed by reference. Used to append additional content.
810 function start_el(&$output) {}
813 * Ends the element output, if needed.
815 * Additional parameters are used in child classes. The args parameter holds
816 * additional values that may be used with the child class methods.
821 * @param string $output Passed by reference. Used to append additional content.
823 function end_el(&$output) {}
826 * Traverse elements to create list from elements.
828 * Display one element if the element doesn't have any children otherwise,
829 * display the element and its children. Will only traverse up to the max
830 * depth and no ignore elements under that depth. It is possible to set the
831 * max depth to include all depths, see walk() method.
833 * This method shouldn't be called directly, use the walk() method instead.
837 * @param object $element Data object
838 * @param array $children_elements List of elements to continue traversing.
839 * @param int $max_depth Max depth to traverse.
840 * @param int $depth Depth of current element.
842 * @param string $output Passed by reference. Used to append additional content.
843 * @return null Null on failure with no changes to parameters.
845 function display_element( $element, &$children_elements, $max_depth, $depth=0, $args, &$output ) {
850 $id_field = $this->db_fields['id'];
852 //display this element
853 if ( is_array( $args[0] ) )
854 $args[0]['has_children'] = ! empty( $children_elements[$element->$id_field] );
855 $cb_args = array_merge( array(&$output, $element, $depth), $args);
856 call_user_func_array(array(&$this, 'start_el'), $cb_args);
858 $id = $element->$id_field;
860 // descend only when the depth is right and there are childrens for this element
861 if ( ($max_depth == 0 || $max_depth > $depth+1 ) && isset( $children_elements[$id]) ) {
863 foreach( $children_elements[ $id ] as $child ){
865 if ( !isset($newlevel) ) {
867 //start the child delimiter
868 $cb_args = array_merge( array(&$output, $depth), $args);
869 call_user_func_array(array(&$this, 'start_lvl'), $cb_args);
871 $this->display_element( $child, $children_elements, $max_depth, $depth + 1, $args, $output );
873 unset( $children_elements[ $id ] );
876 if ( isset($newlevel) && $newlevel ){
877 //end the child delimiter
878 $cb_args = array_merge( array(&$output, $depth), $args);
879 call_user_func_array(array(&$this, 'end_lvl'), $cb_args);
883 $cb_args = array_merge( array(&$output, $element, $depth), $args);
884 call_user_func_array(array(&$this, 'end_el'), $cb_args);
888 * Display array of elements hierarchically.
890 * It is a generic function which does not assume any existing order of
891 * elements. max_depth = -1 means flatly display every element. max_depth =
892 * 0 means display all levels. max_depth > 0 specifies the number of
897 * @param array $elements
898 * @param int $max_depth
901 function walk( $elements, $max_depth) {
903 $args = array_slice(func_get_args(), 2);
906 if ($max_depth < -1) //invalid parameter
909 if (empty($elements)) //nothing to walk
912 $id_field = $this->db_fields['id'];
913 $parent_field = $this->db_fields['parent'];
916 if ( -1 == $max_depth ) {
917 $empty_array = array();
918 foreach ( $elements as $e )
919 $this->display_element( $e, $empty_array, 1, 0, $args, $output );
924 * need to display in hierarchical order
925 * separate elements into two buckets: top level and children elements
926 * children_elements is two dimensional array, eg.
927 * children_elements[10][] contains all sub-elements whose parent is 10.
929 $top_level_elements = array();
930 $children_elements = array();
931 foreach ( $elements as $e) {
932 if ( 0 == $e->$parent_field )
933 $top_level_elements[] = $e;
935 $children_elements[ $e->$parent_field ][] = $e;
939 * when none of the elements is top level
940 * assume the first one must be root of the sub elements
942 if ( empty($top_level_elements) ) {
944 $first = array_slice( $elements, 0, 1 );
947 $top_level_elements = array();
948 $children_elements = array();
949 foreach ( $elements as $e) {
950 if ( $root->$parent_field == $e->$parent_field )
951 $top_level_elements[] = $e;
953 $children_elements[ $e->$parent_field ][] = $e;
957 foreach ( $top_level_elements as $e )
958 $this->display_element( $e, $children_elements, $max_depth, 0, $args, $output );
961 * if we are displaying all levels, and remaining children_elements is not empty,
962 * then we got orphans, which should be displayed regardless
964 if ( ( $max_depth == 0 ) && count( $children_elements ) > 0 ) {
965 $empty_array = array();
966 foreach ( $children_elements as $orphans )
967 foreach( $orphans as $op )
968 $this->display_element( $op, $empty_array, 1, 0, $args, $output );
975 * paged_walk() - produce a page of nested elements
977 * Given an array of hierarchical elements, the maximum depth, a specific page number,
978 * and number of elements per page, this function first determines all top level root elements
979 * belonging to that page, then lists them and all of their children in hierarchical order.
983 * @param $max_depth = 0 means display all levels; $max_depth > 0 specifies the number of display levels.
984 * @param $page_num the specific page number, beginning with 1.
985 * @return XHTML of the specified page of elements
987 function paged_walk( $elements, $max_depth, $page_num, $per_page ) {
990 if ( empty($elements) || $max_depth < -1 )
993 $args = array_slice( func_get_args(), 4 );
996 $id_field = $this->db_fields['id'];
997 $parent_field = $this->db_fields['parent'];
1000 if ( -1 == $max_depth )
1001 $total_top = count( $elements );
1002 if ( $page_num < 1 || $per_page < 0 ) {
1006 if ( -1 == $max_depth )
1008 $this->max_pages = 1;
1011 $start = ( (int)$page_num - 1 ) * (int)$per_page;
1012 $end = $start + $per_page;
1013 if ( -1 == $max_depth )
1014 $this->max_pages = ceil($total_top / $per_page);
1018 if ( -1 == $max_depth ) {
1019 if ( !empty($args[0]['reverse_top_level']) ) {
1020 $elements = array_reverse( $elements );
1022 $start = $total_top - $end;
1023 $end = $total_top - $oldstart;
1026 $empty_array = array();
1027 foreach ( $elements as $e ) {
1029 if ( $count < $start )
1031 if ( $count >= $end )
1033 $this->display_element( $e, $empty_array, 1, 0, $args, $output );
1039 * separate elements into two buckets: top level and children elements
1040 * children_elements is two dimensional array, eg.
1041 * children_elements[10][] contains all sub-elements whose parent is 10.
1043 $top_level_elements = array();
1044 $children_elements = array();
1045 foreach ( $elements as $e) {
1046 if ( 0 == $e->$parent_field )
1047 $top_level_elements[] = $e;
1049 $children_elements[ $e->$parent_field ][] = $e;
1052 $total_top = count( $top_level_elements );
1054 $this->max_pages = ceil($total_top / $per_page);
1058 if ( !empty($args[0]['reverse_top_level']) ) {
1059 $top_level_elements = array_reverse( $top_level_elements );
1061 $start = $total_top - $end;
1062 $end = $total_top - $oldstart;
1064 if ( !empty($args[0]['reverse_children']) ) {
1065 foreach ( $children_elements as $parent => $children )
1066 $children_elements[$parent] = array_reverse( $children );
1069 foreach ( $top_level_elements as $e ) {
1072 //for the last page, need to unset earlier children in order to keep track of orphans
1073 if ( $end >= $total_top && $count < $start )
1074 $this->unset_children( $e, $children_elements );
1076 if ( $count < $start )
1079 if ( $count >= $end )
1082 $this->display_element( $e, $children_elements, $max_depth, 0, $args, $output );
1085 if ( $end >= $total_top && count( $children_elements ) > 0 ) {
1086 $empty_array = array();
1087 foreach ( $children_elements as $orphans )
1088 foreach( $orphans as $op )
1089 $this->display_element( $op, $empty_array, 1, 0, $args, $output );
1095 function get_number_of_root_elements( $elements ){
1098 $parent_field = $this->db_fields['parent'];
1100 foreach ( $elements as $e) {
1101 if ( 0 == $e->$parent_field )
1107 // unset all the children for a given top level element
1108 function unset_children( $e, &$children_elements ){
1110 if ( !$e || !$children_elements )
1113 $id_field = $this->db_fields['id'];
1114 $id = $e->$id_field;
1116 if ( !empty($children_elements[$id]) && is_array($children_elements[$id]) )
1117 foreach ( (array) $children_elements[$id] as $child )
1118 $this->unset_children( $child, $children_elements );
1120 if ( isset($children_elements[$id]) )
1121 unset( $children_elements[$id] );
1127 * Create HTML list of pages.
1129 * @package WordPress
1133 class Walker_Page extends Walker {
1135 * @see Walker::$tree_type
1139 var $tree_type = 'page';
1142 * @see Walker::$db_fields
1144 * @todo Decouple this.
1147 var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
1150 * @see Walker::start_lvl()
1153 * @param string $output Passed by reference. Used to append additional content.
1154 * @param int $depth Depth of page. Used for padding.
1156 function start_lvl(&$output, $depth) {
1157 $indent = str_repeat("\t", $depth);
1158 $output .= "\n$indent<ul class='children'>\n";
1162 * @see Walker::end_lvl()
1165 * @param string $output Passed by reference. Used to append additional content.
1166 * @param int $depth Depth of page. Used for padding.
1168 function end_lvl(&$output, $depth) {
1169 $indent = str_repeat("\t", $depth);
1170 $output .= "$indent</ul>\n";
1174 * @see Walker::start_el()
1177 * @param string $output Passed by reference. Used to append additional content.
1178 * @param object $page Page data object.
1179 * @param int $depth Depth of page. Used for padding.
1180 * @param int $current_page Page ID.
1181 * @param array $args
1183 function start_el(&$output, $page, $depth, $args, $current_page) {
1185 $indent = str_repeat("\t", $depth);
1189 extract($args, EXTR_SKIP);
1190 $css_class = array('page_item', 'page-item-'.$page->ID);
1191 if ( !empty($current_page) ) {
1192 $_current_page = get_page( $current_page );
1193 if ( isset($_current_page->ancestors) && in_array($page->ID, (array) $_current_page->ancestors) )
1194 $css_class[] = 'current_page_ancestor';
1195 if ( $page->ID == $current_page )
1196 $css_class[] = 'current_page_item';
1197 elseif ( $_current_page && $page->ID == $_current_page->post_parent )
1198 $css_class[] = 'current_page_parent';
1199 } elseif ( $page->ID == get_option('page_for_posts') ) {
1200 $css_class[] = 'current_page_parent';
1203 $css_class = implode(' ', apply_filters('page_css_class', $css_class, $page));
1205 $output .= $indent . '<li class="' . $css_class . '"><a href="' . get_page_link($page->ID) . '" title="' . esc_attr( wp_strip_all_tags( apply_filters( 'the_title', $page->post_title, $page->ID ) ) ) . '">' . $link_before . apply_filters( 'the_title', $page->post_title, $page->ID ) . $link_after . '</a>';
1207 if ( !empty($show_date) ) {
1208 if ( 'modified' == $show_date )
1209 $time = $page->post_modified;
1211 $time = $page->post_date;
1213 $output .= " " . mysql2date($date_format, $time);
1218 * @see Walker::end_el()
1221 * @param string $output Passed by reference. Used to append additional content.
1222 * @param object $page Page data object. Not used.
1223 * @param int $depth Depth of page. Not Used.
1225 function end_el(&$output, $page, $depth) {
1226 $output .= "</li>\n";
1232 * Create HTML dropdown list of pages.
1234 * @package WordPress
1238 class Walker_PageDropdown extends Walker {
1240 * @see Walker::$tree_type
1244 var $tree_type = 'page';
1247 * @see Walker::$db_fields
1249 * @todo Decouple this
1252 var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID');
1255 * @see Walker::start_el()
1258 * @param string $output Passed by reference. Used to append additional content.
1259 * @param object $page Page data object.
1260 * @param int $depth Depth of page in reference to parent pages. Used for padding.
1261 * @param array $args Uses 'selected' argument for selected page to set selected HTML attribute for option element.
1263 function start_el(&$output, $page, $depth, $args) {
1264 $pad = str_repeat(' ', $depth * 3);
1266 $output .= "\t<option class=\"level-$depth\" value=\"$page->ID\"";
1267 if ( $page->ID == $args['selected'] )
1268 $output .= ' selected="selected"';
1270 $title = esc_html($page->post_title);
1271 $output .= "$pad$title";
1272 $output .= "</option>\n";
1277 * Create HTML list of categories.
1279 * @package WordPress
1283 class Walker_Category extends Walker {
1285 * @see Walker::$tree_type
1289 var $tree_type = 'category';
1292 * @see Walker::$db_fields
1294 * @todo Decouple this
1297 var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
1300 * @see Walker::start_lvl()
1303 * @param string $output Passed by reference. Used to append additional content.
1304 * @param int $depth Depth of category. Used for tab indentation.
1305 * @param array $args Will only append content if style argument value is 'list'.
1307 function start_lvl(&$output, $depth, $args) {
1308 if ( 'list' != $args['style'] )
1311 $indent = str_repeat("\t", $depth);
1312 $output .= "$indent<ul class='children'>\n";
1316 * @see Walker::end_lvl()
1319 * @param string $output Passed by reference. Used to append additional content.
1320 * @param int $depth Depth of category. Used for tab indentation.
1321 * @param array $args Will only append content if style argument value is 'list'.
1323 function end_lvl(&$output, $depth, $args) {
1324 if ( 'list' != $args['style'] )
1327 $indent = str_repeat("\t", $depth);
1328 $output .= "$indent</ul>\n";
1332 * @see Walker::start_el()
1335 * @param string $output Passed by reference. Used to append additional content.
1336 * @param object $category Category data object.
1337 * @param int $depth Depth of category in reference to parents.
1338 * @param array $args
1340 function start_el(&$output, $category, $depth, $args) {
1343 $cat_name = esc_attr( $category->name);
1344 $cat_name = apply_filters( 'list_cats', $cat_name, $category );
1345 $link = '<a href="' . get_term_link( $category, $category->taxonomy ) . '" ';
1346 if ( $use_desc_for_title == 0 || empty($category->description) )
1347 $link .= 'title="' . sprintf(__( 'View all posts filed under %s' ), $cat_name) . '"';
1349 $link .= 'title="' . esc_attr( strip_tags( apply_filters( 'category_description', $category->description, $category ) ) ) . '"';
1351 $link .= $cat_name . '</a>';
1353 if ( (! empty($feed_image)) || (! empty($feed)) ) {
1356 if ( empty($feed_image) )
1359 $link .= '<a href="' . get_term_feed_link( $category->term_id, $category->taxonomy, $feed_type ) . '"';
1362 $alt = ' alt="' . sprintf(__( 'Feed for all posts filed under %s' ), $cat_name ) . '"';
1364 $title = ' title="' . $feed . '"';
1365 $alt = ' alt="' . $feed . '"';
1372 if ( empty($feed_image) )
1375 $link .= "<img src='$feed_image'$alt$title" . ' />';
1377 if ( empty($feed_image) )
1381 if ( isset($show_count) && $show_count )
1382 $link .= ' (' . intval($category->count) . ')';
1384 if ( isset($show_date) && $show_date ) {
1385 $link .= ' ' . gmdate('Y-m-d', $category->last_update_timestamp);
1388 if ( isset($current_category) && $current_category )
1389 $_current_category = get_category( $current_category );
1391 if ( 'list' == $args['style'] ) {
1393 $class = 'cat-item cat-item-'.$category->term_id;
1394 if ( isset($current_category) && $current_category && ($category->term_id == $current_category) )
1395 $class .= ' current-cat';
1396 elseif ( isset($_current_category) && $_current_category && ($category->term_id == $_current_category->parent) )
1397 $class .= ' current-cat-parent';
1398 $output .= ' class="'.$class.'"';
1399 $output .= ">$link\n";
1401 $output .= "\t$link<br />\n";
1406 * @see Walker::end_el()
1409 * @param string $output Passed by reference. Used to append additional content.
1410 * @param object $page Not used.
1411 * @param int $depth Depth of category. Not used.
1412 * @param array $args Only uses 'list' for whether should append to output.
1414 function end_el(&$output, $page, $depth, $args) {
1415 if ( 'list' != $args['style'] )
1418 $output .= "</li>\n";
1424 * Create HTML dropdown list of Categories.
1426 * @package WordPress
1430 class Walker_CategoryDropdown extends Walker {
1432 * @see Walker::$tree_type
1436 var $tree_type = 'category';
1439 * @see Walker::$db_fields
1441 * @todo Decouple this
1444 var $db_fields = array ('parent' => 'parent', 'id' => 'term_id');
1447 * @see Walker::start_el()
1450 * @param string $output Passed by reference. Used to append additional content.
1451 * @param object $category Category data object.
1452 * @param int $depth Depth of category. Used for padding.
1453 * @param array $args Uses 'selected', 'show_count', and 'show_last_update' keys, if they exist.
1455 function start_el(&$output, $category, $depth, $args) {
1456 $pad = str_repeat(' ', $depth * 3);
1458 $cat_name = apply_filters('list_cats', $category->name, $category);
1459 $output .= "\t<option class=\"level-$depth\" value=\"".$category->term_id."\"";
1460 if ( $category->term_id == $args['selected'] )
1461 $output .= ' selected="selected"';
1463 $output .= $pad.$cat_name;
1464 if ( $args['show_count'] )
1465 $output .= ' ('. $category->count .')';
1466 if ( $args['show_last_update'] ) {
1468 $output .= ' ' . gmdate($format, $category->last_update_timestamp);
1470 $output .= "</option>\n";
1475 * Send XML response back to AJAX request.
1477 * @package WordPress
1480 class WP_Ajax_Response {
1482 * Store XML responses to send.
1488 var $responses = array();
1491 * PHP4 Constructor - Passes args to {@link WP_Ajax_Response::add()}.
1494 * @see WP_Ajax_Response::add()
1496 * @param string|array $args Optional. Will be passed to add() method.
1497 * @return WP_Ajax_Response
1499 function WP_Ajax_Response( $args = '' ) {
1500 if ( !empty($args) )
1505 * Append to XML response based on given arguments.
1507 * The arguments that can be passed in the $args parameter are below. It is
1508 * also possible to pass a WP_Error object in either the 'id' or 'data'
1509 * argument. The parameter isn't actually optional, content should be given
1510 * in order to send the correct response.
1512 * 'what' argument is a string that is the XMLRPC response type.
1513 * 'action' argument is a boolean or string that acts like a nonce.
1514 * 'id' argument can be WP_Error or an integer.
1515 * 'old_id' argument is false by default or an integer of the previous ID.
1516 * 'position' argument is an integer or a string with -1 = top, 1 = bottom,
1517 * html ID = after, -html ID = before.
1518 * 'data' argument is a string with the content or message.
1519 * 'supplemental' argument is an array of strings that will be children of
1520 * the supplemental element.
1524 * @param string|array $args Override defaults.
1525 * @return string XML response.
1527 function add( $args = '' ) {
1529 'what' => 'object', 'action' => false,
1530 'id' => '0', 'old_id' => false,
1532 'data' => '', 'supplemental' => array()
1535 $r = wp_parse_args( $args, $defaults );
1536 extract( $r, EXTR_SKIP );
1537 $position = preg_replace( '/[^a-z0-9:_-]/i', '', $position );
1539 if ( is_wp_error($id) ) {
1545 if ( is_wp_error($data) ) {
1546 foreach ( (array) $data->get_error_codes() as $code ) {
1547 $response .= "<wp_error code='$code'><![CDATA[" . $data->get_error_message($code) . "]]></wp_error>";
1548 if ( !$error_data = $data->get_error_data($code) )
1551 if ( is_object($error_data) ) {
1552 $class = ' class="' . get_class($error_data) . '"';
1553 $error_data = get_object_vars($error_data);
1556 $response .= "<wp_error_data code='$code'$class>";
1558 if ( is_scalar($error_data) ) {
1559 $response .= "<![CDATA[$error_data]]>";
1560 } elseif ( is_array($error_data) ) {
1561 foreach ( $error_data as $k => $v )
1562 $response .= "<$k><![CDATA[$v]]></$k>";
1565 $response .= "</wp_error_data>";
1568 $response = "<response_data><![CDATA[$data]]></response_data>";
1572 if ( is_array($supplemental) ) {
1573 foreach ( $supplemental as $k => $v )
1574 $s .= "<$k><![CDATA[$v]]></$k>";
1575 $s = "<supplemental>$s</supplemental>";
1578 if ( false === $action )
1579 $action = $_POST['action'];
1582 $x .= "<response action='{$action}_$id'>"; // The action attribute in the xml output is formatted like a nonce action
1583 $x .= "<$what id='$id' " . ( false === $old_id ? '' : "old_id='$old_id' " ) . "position='$position'>";
1587 $x .= "</response>";
1589 $this->responses[] = $x;
1594 * Display XML formatted responses.
1596 * Sets the content type header to text/xml.
1601 header('Content-Type: text/xml');
1602 echo "<?xml version='1.0' standalone='yes'?><wp_ajax>";
1603 foreach ( (array) $this->responses as $response )
1611 * Helper class to remove the need to use eval to replace $matches[] in query strings.
1615 class WP_MatchesMapRegex {
1625 * store for mapping result
1633 * subject to perform mapping on (query string containing $matches[] references
1641 * regexp pattern to match $matches[] references
1645 var $_pattern = '(\$matches\[[1-9]+[0-9]*\])'; // magic number
1650 * @param string $subject subject if regex
1651 * @param array $matches data to use in map
1654 function WP_MatchesMapRegex($subject, $matches) {
1655 $this->_subject = $subject;
1656 $this->_matches = $matches;
1657 $this->output = $this->_map();
1661 * Substitute substring matches in subject.
1663 * static helper function to ease use
1666 * @param string $subject subject
1667 * @param array $matches data used for subsitution
1670 function apply($subject, $matches) {
1671 $oSelf =& new WP_MatchesMapRegex($subject, $matches);
1672 return $oSelf->output;
1676 * do the actual mapping
1682 $callback = array(&$this, 'callback');
1683 return preg_replace_callback($this->_pattern, $callback, $this->_subject);
1687 * preg_replace_callback hook
1690 * @param array $matches preg_replace regexp matches
1693 function callback($matches) {
1694 $index = intval(substr($matches[0], 9, -1));
1695 return ( isset( $this->_matches[$index] ) ? urlencode($this->_matches[$index]) : '' );