| [ Index ] |
PHP Cross Reference of Wordpress 2.7.1 |
[Summary view] [Print] [Text view]
1 <?php 2 /** 3 * Holds Most of the WordPress classes. 4 * 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 8 * separate files. 9 * 10 * @package WordPress 11 */ 12 13 /** 14 * WordPress environment setup class. 15 * 16 * @package WordPress 17 * @since 2.0.0 18 */ 19 class WP { 20 /** 21 * Public query variables. 22 * 23 * Long list of public query variables. 24 * 25 * @since 2.0.0 26 * @access public 27 * @var array 28 */ 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'); 30 31 /** 32 * Private query variables. 33 * 34 * Long list of private query variables. 35 * 36 * @since 2.0.0 37 * @var array 38 */ 39 var $private_query_vars = array('offset', 'posts_per_page', 'posts_per_archive_page', 'what_to_show', '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'); 40 41 /** 42 * Extra query variables set by the user. 43 * 44 * @since 2.1.0 45 * @var array 46 */ 47 var $extra_query_vars = array(); 48 49 /** 50 * Query variables for setting up the WordPress Query Loop. 51 * 52 * @since 2.0.0 53 * @var array 54 */ 55 var $query_vars; 56 57 /** 58 * String parsed to set the query variables. 59 * 60 * @since 2.0.0 61 * @var string 62 */ 63 var $query_string; 64 65 /** 66 * Permalink or requested URI. 67 * 68 * @since 2.0.0 69 * @var string 70 */ 71 var $request; 72 73 /** 74 * Rewrite rule the request matched. 75 * 76 * @since 2.0.0 77 * @var string 78 */ 79 var $matched_rule; 80 81 /** 82 * Rewrite query the request matched. 83 * 84 * @since 2.0.0 85 * @var string 86 */ 87 var $matched_query; 88 89 /** 90 * Whether already did the permalink. 91 * 92 * @since 2.0.0 93 * @var bool 94 */ 95 var $did_permalink = false; 96 97 /** 98 * Add name to list of public query variables. 99 * 100 * @since 2.1.0 101 * 102 * @param string $qv Query variable name. 103 */ 104 function add_query_var($qv) { 105 if ( !in_array($qv, $this->public_query_vars) ) 106 $this->public_query_vars[] = $qv; 107 } 108 109 /** 110 * Set the value of a query variable. 111 * 112 * @since 2.3.0 113 * 114 * @param string $key Query variable name. 115 * @param mixed $value Query variable value. 116 */ 117 function set_query_var($key, $value) { 118 $this->query_vars[$key] = $value; 119 } 120 121 /** 122 * Parse request to find correct WordPress query. 123 * 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. 126 * 127 * @since 2.0.0 128 * 129 * @param array|string $extra_query_vars Set the extra query variables. 130 */ 131 function parse_request($extra_query_vars = '') { 132 global $wp_rewrite; 133 134 $this->query_vars = array(); 135 $taxonomy_query_vars = array(); 136 137 if ( is_array($extra_query_vars) ) 138 $this->extra_query_vars = & $extra_query_vars; 139 else if (! empty($extra_query_vars)) 140 parse_str($extra_query_vars, $this->extra_query_vars); 141 142 // Process PATH_INFO, REQUEST_URI, and 404 for permalinks. 143 144 // Fetch the rewrite rules. 145 $rewrite = $wp_rewrite->wp_rewrite_rules(); 146 147 if (! empty($rewrite)) { 148 // If we match a rewrite rule, this will be cleared. 149 $error = '404'; 150 $this->did_permalink = true; 151 152 if ( isset($_SERVER['PATH_INFO']) ) 153 $pathinfo = $_SERVER['PATH_INFO']; 154 else 155 $pathinfo = ''; 156 $pathinfo_array = explode('?', $pathinfo); 157 $pathinfo = str_replace("%", "%25", $pathinfo_array[0]); 158 $req_uri = $_SERVER['REQUEST_URI']; 159 $req_uri_array = explode('?', $req_uri); 160 $req_uri = $req_uri_array[0]; 161 $self = $_SERVER['PHP_SELF']; 162 $home_path = parse_url(get_option('home')); 163 if ( isset($home_path['path']) ) 164 $home_path = $home_path['path']; 165 else 166 $home_path = ''; 167 $home_path = trim($home_path, '/'); 168 169 // Trim path info from the end and the leading home path from the 170 // front. For path info requests, this leaves us with the requesting 171 // filename, if any. For 404 requests, this leaves us with the 172 // requested permalink. 173 $req_uri = str_replace($pathinfo, '', rawurldecode($req_uri)); 174 $req_uri = trim($req_uri, '/'); 175 $req_uri = preg_replace("|^$home_path|", '', $req_uri); 176 $req_uri = trim($req_uri, '/'); 177 $pathinfo = trim($pathinfo, '/'); 178 $pathinfo = preg_replace("|^$home_path|", '', $pathinfo); 179 $pathinfo = trim($pathinfo, '/'); 180 $self = trim($self, '/'); 181 $self = preg_replace("|^$home_path|", '', $self); 182 $self = trim($self, '/'); 183 184 // The requested permalink is in $pathinfo for path info requests and 185 // $req_uri for other requests. 186 if ( ! empty($pathinfo) && !preg_match('|^.*' . $wp_rewrite->index . '$|', $pathinfo) ) { 187 $request = $pathinfo; 188 } else { 189 // If the request uri is the index, blank it out so that we don't try to match it against a rule. 190 if ( $req_uri == $wp_rewrite->index ) 191 $req_uri = ''; 192 $request = $req_uri; 193 } 194 195 $this->request = $request; 196 197 // Look for matches. 198 $request_match = $request; 199 foreach ( (array) $rewrite as $match => $query) { 200 // Don't try to match against AtomPub calls 201 if ( $req_uri == 'wp-app.php' ) 202 break; 203 204 // If the requesting file is the anchor of the match, prepend it 205 // to the path info. 206 if ((! empty($req_uri)) && (strpos($match, $req_uri) === 0) && ($req_uri != $request)) { 207 $request_match = $req_uri . '/' . $request; 208 } 209 210 if (preg_match("!^$match!", $request_match, $matches) || 211 preg_match("!^$match!", urldecode($request_match), $matches)) { 212 // Got a match. 213 $this->matched_rule = $match; 214 215 // Trim the query of everything up to the '?'. 216 $query = preg_replace("!^.+\?!", '', $query); 217 218 // Substitute the substring matches into the query. 219 eval("@\$query = \"" . addslashes($query) . "\";"); 220 221 $this->matched_query = $query; 222 223 // Parse the query. 224 parse_str($query, $perma_query_vars); 225 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']); 230 231 if (isset($error)) 232 unset($error); 233 234 break; 235 } 236 } 237 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']); 242 243 if (isset($error)) 244 unset($error); 245 246 if (isset($perma_query_vars) && strpos($_SERVER['PHP_SELF'], 'wp-admin/') !== false) 247 unset($perma_query_vars); 248 249 $this->did_permalink = false; 250 } 251 } 252 253 $this->public_query_vars = apply_filters('query_vars', $this->public_query_vars); 254 255 foreach ( $GLOBALS['wp_taxonomies'] as $taxonomy => $t ) 256 if ( isset($t->query_var) ) 257 $taxonomy_query_vars[$t->query_var] = $taxonomy; 258 259 for ($i=0; $i<count($this->public_query_vars); $i += 1) { 260 $wpvar = $this->public_query_vars[$i]; 261 if (isset($this->extra_query_vars[$wpvar])) 262 $this->query_vars[$wpvar] = $this->extra_query_vars[$wpvar]; 263 elseif (isset($GLOBALS[$wpvar])) 264 $this->query_vars[$wpvar] = $GLOBALS[$wpvar]; 265 elseif (!empty($_POST[$wpvar])) 266 $this->query_vars[$wpvar] = $_POST[$wpvar]; 267 elseif (!empty($_GET[$wpvar])) 268 $this->query_vars[$wpvar] = $_GET[$wpvar]; 269 elseif (!empty($perma_query_vars[$wpvar])) 270 $this->query_vars[$wpvar] = $perma_query_vars[$wpvar]; 271 272 if ( !empty( $this->query_vars[$wpvar] ) ) { 273 $this->query_vars[$wpvar] = (string) $this->query_vars[$wpvar]; 274 if ( in_array( $wpvar, $taxonomy_query_vars ) ) { 275 $this->query_vars['taxonomy'] = $taxonomy_query_vars[$wpvar]; 276 $this->query_vars['term'] = $this->query_vars[$wpvar]; 277 } 278 } 279 } 280 281 foreach ( (array) $this->private_query_vars as $var) { 282 if (isset($this->extra_query_vars[$var])) 283 $this->query_vars[$var] = $this->extra_query_vars[$var]; 284 elseif (isset($GLOBALS[$var]) && '' != $GLOBALS[$var]) 285 $this->query_vars[$var] = $GLOBALS[$var]; 286 } 287 288 if ( isset($error) ) 289 $this->query_vars['error'] = $error; 290 291 $this->query_vars = apply_filters('request', $this->query_vars); 292 293 do_action_ref_array('parse_request', array(&$this)); 294 } 295 296 /** 297 * Send additional HTTP headers for caching, content type, etc. 298 * 299 * Sets the X-Pingback header, 404 status (if 404), Content-type. If showing 300 * a feed, it will also send last-modified, etag, and 304 status if needed. 301 * 302 * @since 2.0.0 303 */ 304 function send_headers() { 305 @header('X-Pingback: '. get_bloginfo('pingback_url')); 306 if ( is_user_logged_in() ) 307 nocache_headers(); 308 if ( !empty($this->query_vars['error']) && '404' == $this->query_vars['error'] ) { 309 status_header( 404 ); 310 if ( !is_user_logged_in() ) 311 nocache_headers(); 312 @header('Content-Type: ' . get_option('html_type') . '; charset=' . get_option('blog_charset')); 313 } else if ( empty($this->query_vars['feed']) ) { 314 @header('Content-Type: ' . get_option('html_type') . '; charset=' . get_option('blog_charset')); 315 } else { 316 // We're showing a feed, so WP is indeed the only thing that last changed 317 if ( !empty($this->query_vars['withcomments']) 318 || ( empty($this->query_vars['withoutcomments']) 319 && ( !empty($this->query_vars['p']) 320 || !empty($this->query_vars['name']) 321 || !empty($this->query_vars['page_id']) 322 || !empty($this->query_vars['pagename']) 323 || !empty($this->query_vars['attachment']) 324 || !empty($this->query_vars['attachment_id']) 325 ) 326 ) 327 ) 328 $wp_last_modified = mysql2date('D, d M Y H:i:s', get_lastcommentmodified('GMT'), 0).' GMT'; 329 else 330 $wp_last_modified = mysql2date('D, d M Y H:i:s', get_lastpostmodified('GMT'), 0).' GMT'; 331 $wp_etag = '"' . md5($wp_last_modified) . '"'; 332 @header("Last-Modified: $wp_last_modified"); 333 @header("ETag: $wp_etag"); 334 335 // Support for Conditional GET 336 if (isset($_SERVER['HTTP_IF_NONE_MATCH'])) 337 $client_etag = stripslashes(stripslashes($_SERVER['HTTP_IF_NONE_MATCH'])); 338 else $client_etag = false; 339 340 $client_last_modified = empty($_SERVER['HTTP_IF_MODIFIED_SINCE']) ? '' : trim($_SERVER['HTTP_IF_MODIFIED_SINCE']); 341 // If string is empty, return 0. If not, attempt to parse into a timestamp 342 $client_modified_timestamp = $client_last_modified ? strtotime($client_last_modified) : 0; 343 344 // Make a timestamp for our most recent modification... 345 $wp_modified_timestamp = strtotime($wp_last_modified); 346 347 if ( ($client_last_modified && $client_etag) ? 348 (($client_modified_timestamp >= $wp_modified_timestamp) && ($client_etag == $wp_etag)) : 349 (($client_modified_timestamp >= $wp_modified_timestamp) || ($client_etag == $wp_etag)) ) { 350 status_header( 304 ); 351 exit; 352 } 353 } 354 355 do_action_ref_array('send_headers', array(&$this)); 356 } 357 358 /** 359 * Sets the query string property based off of the query variable property. 360 * 361 * The 'query_string' filter is deprecated, but still works. Plugins should 362 * use the 'request' filter instead. 363 * 364 * @since 2.0.0 365 */ 366 function build_query_string() { 367 $this->query_string = ''; 368 foreach ( (array) array_keys($this->query_vars) as $wpvar) { 369 if ( '' != $this->query_vars[$wpvar] ) { 370 $this->query_string .= (strlen($this->query_string) < 1) ? '' : '&'; 371 if ( !is_scalar($this->query_vars[$wpvar]) ) // Discard non-scalars. 372 continue; 373 $this->query_string .= $wpvar . '=' . rawurlencode($this->query_vars[$wpvar]); 374 } 375 } 376 377 // query_string filter deprecated. Use request filter instead. 378 if ( has_filter('query_string') ) { // Don't bother filtering and parsing if no plugins are hooked in. 379 $this->query_string = apply_filters('query_string', $this->query_string); 380 parse_str($this->query_string, $this->query_vars); 381 } 382 } 383 384 /** 385 * Setup the WordPress Globals. 386 * 387 * The query_vars property will be extracted to the GLOBALS. So care should 388 * be taken when naming global variables that might interfere with the 389 * WordPress environment. 390 * 391 * @global string $query_string Query string for the loop. 392 * @global int $more Only set, if single page or post. 393 * @global int $single If single page or post. Only set, if single page or post. 394 * 395 * @since 2.0.0 396 */ 397 function register_globals() { 398 global $wp_query; 399 // Extract updated query vars back into global namespace. 400 foreach ( (array) $wp_query->query_vars as $key => $value) { 401 $GLOBALS[$key] = $value; 402 } 403 404 $GLOBALS['query_string'] = & $this->query_string; 405 $GLOBALS['posts'] = & $wp_query->posts; 406 $GLOBALS['post'] = & $wp_query->post; 407 $GLOBALS['request'] = & $wp_query->request; 408 409 if ( is_single() || is_page() ) { 410 $GLOBALS['more'] = 1; 411 $GLOBALS['single'] = 1; 412 } 413 } 414 415 /** 416 * Setup the current user. 417 * 418 * @since 2.0.0 419 */ 420 function init() { 421 wp_get_current_user(); 422 } 423 424 /** 425 * Setup the Loop based on the query variables. 426 * 427 * @uses WP::$query_vars 428 * @since 2.0.0 429 */ 430 function query_posts() { 431 global $wp_the_query; 432 $this->build_query_string(); 433 $wp_the_query->query($this->query_vars); 434 } 435 436 /** 437 * Set the Headers for 404, if permalink is not found. 438 * 439 * Issue a 404 if a permalink request doesn't match any posts. Don't issue 440 * a 404 if one was already issued, if the request was a search, or if the 441 * request was a regular query string request rather than a permalink 442 * request. Issues a 200, if not 404. 443 * 444 * @since 2.0.0 445 */ 446 function handle_404() { 447 global $wp_query; 448 449 if ( (0 == count($wp_query->posts)) && !is_404() && !is_search() && ( $this->did_permalink || (!empty($_SERVER['QUERY_STRING']) && (false === strpos($_SERVER['REQUEST_URI'], '?'))) ) ) { 450 // Don't 404 for these queries if they matched an object. 451 if ( ( is_tag() || is_category() || is_author() ) && $wp_query->get_queried_object() ) { 452 if ( !is_404() ) 453 status_header( 200 ); 454 return; 455 } 456 $wp_query->set_404(); 457 status_header( 404 ); 458 nocache_headers(); 459 } elseif ( !is_404() ) { 460 status_header( 200 ); 461 } 462 } 463 464 /** 465 * Sets up all of the variables required by the WordPress environment. 466 * 467 * The action 'wp' has one parameter that references the WP object. It 468 * allows for accessing the properties and methods to further manipulate the 469 * object. 470 * 471 * @since 2.0.0 472 * 473 * @param string|array $query_args Passed to {@link parse_request()} 474 */ 475 function main($query_args = '') { 476 $this->init(); 477 $this->parse_request($query_args); 478 $this->send_headers(); 479 $this->query_posts(); 480 $this->handle_404(); 481 $this->register_globals(); 482 do_action_ref_array('wp', array(&$this)); 483 } 484 485 /** 486 * PHP4 Constructor - Does nothing. 487 * 488 * Call main() method when ready to run setup. 489 * 490 * @since 2.0.0 491 * 492 * @return WP 493 */ 494 function WP() { 495 // Empty. 496 } 497 } 498 499 /** 500 * WordPress Error class. 501 * 502 * Container for checking for WordPress errors and error messages. Return 503 * WP_Error and use {@link is_wp_error()} to check if this class is returned. 504 * Many core WordPress functions pass this class in the event of an error and 505 * if not handled properly will result in code errors. 506 * 507 * @package WordPress 508 * @since 2.1.0 509 */ 510 class WP_Error { 511 /** 512 * Stores the list of errors. 513 * 514 * @since 2.1.0 515 * @var array 516 * @access private 517 */ 518 var $errors = array(); 519 520 /** 521 * Stores the list of data for error codes. 522 * 523 * @since 2.1.0 524 * @var array 525 * @access private 526 */ 527 var $error_data = array(); 528 529 /** 530 * PHP4 Constructor - Sets up error message. 531 * 532 * If code parameter is empty then nothing will be done. It is possible to 533 * add multiple messages to the same code, but with other methods in the 534 * class. 535 * 536 * All parameters are optional, but if the code parameter is set, then the 537 * data parameter is optional. 538 * 539 * @since 2.1.0 540 * 541 * @param string|int $code Error code 542 * @param string $message Error message 543 * @param mixed $data Optional. Error data. 544 * @return WP_Error 545 */ 546 function WP_Error($code = '', $message = '', $data = '') { 547 if ( empty($code) ) 548 return; 549 550 $this->errors[$code][] = $message; 551 552 if ( ! empty($data) ) 553 $this->error_data[$code] = $data; 554 } 555 556 /** 557 * Retrieve all error codes. 558 * 559 * @since 2.1.0 560 * @access public 561 * 562 * @return array List of error codes, if avaiable. 563 */ 564 function get_error_codes() { 565 if ( empty($this->errors) ) 566 return array(); 567 568 return array_keys($this->errors); 569 } 570 571 /** 572 * Retrieve first error code available. 573 * 574 * @since 2.1.0 575 * @access public 576 * 577 * @return string|int Empty string, if no error codes. 578 */ 579 function get_error_code() { 580 $codes = $this->get_error_codes(); 581 582 if ( empty($codes) ) 583 return ''; 584 585 return $codes[0]; 586 } 587 588 /** 589 * Retrieve all error messages or error messages matching code. 590 * 591 * @since 2.1.0 592 * 593 * @param string|int $code Optional. Retrieve messages matching code, if exists. 594 * @return array Error strings on success, or empty array on failure (if using codee parameter). 595 */ 596 function get_error_messages($code = '') { 597 // Return all messages if no code specified. 598 if ( empty($code) ) { 599 $all_messages = array(); 600 foreach ( (array) $this->errors as $code => $messages ) 601 $all_messages = array_merge($all_messages, $messages); 602 603 return $all_messages; 604 } 605 606 if ( isset($this->errors[$code]) ) 607 return $this->errors[$code]; 608 else 609 return array(); 610 } 611 612 /** 613 * Get single error message. 614 * 615 * This will get the first message available for the code. If no code is 616 * given then the first code available will be used. 617 * 618 * @since 2.1.0 619 * 620 * @param string|int $code Optional. Error code to retrieve message. 621 * @return string 622 */ 623 function get_error_message($code = '') { 624 if ( empty($code) ) 625 $code = $this->get_error_code(); 626 $messages = $this->get_error_messages($code); 627 if ( empty($messages) ) 628 return ''; 629 return $messages[0]; 630 } 631 632 /** 633 * Retrieve error data for error code. 634 * 635 * @since 2.1.0 636 * 637 * @param string|int $code Optional. Error code. 638 * @return mixed Null, if no errors. 639 */ 640 function get_error_data($code = '') { 641 if ( empty($code) ) 642 $code = $this->get_error_code(); 643 644 if ( isset($this->error_data[$code]) ) 645 return $this->error_data[$code]; 646 return null; 647 } 648 649 /** 650 * Append more error messages to list of error messages. 651 * 652 * @since 2.1.0 653 * @access public 654 * 655 * @param string|int $code Error code. 656 * @param string $message Error message. 657 * @param mixed $data Optional. Error data. 658 */ 659 function add($code, $message, $data = '') { 660 $this->errors[$code][] = $message; 661 if ( ! empty($data) ) 662 $this->error_data[$code] = $data; 663 } 664 665 /** 666 * Add data for error code. 667 * 668 * The error code can only contain one error data. 669 * 670 * @since 2.1.0 671 * 672 * @param mixed $data Error data. 673 * @param string|int $code Error code. 674 */ 675 function add_data($data, $code = '') { 676 if ( empty($code) ) 677 $code = $this->get_error_code(); 678 679 $this->error_data[$code] = $data; 680 } 681 } 682 683 /** 684 * Check whether variable is a WordPress Error. 685 * 686 * Looks at the object and if a WP_Error class. Does not check to see if the 687 * parent is also WP_Error, so can't inherit WP_Error and still use this 688 * function. 689 * 690 * @since 2.1.0 691 * 692 * @param mixed $thing Check if unknown variable is WordPress Error object. 693 * @return bool True, if WP_Error. False, if not WP_Error. 694 */ 695 function is_wp_error($thing) { 696 if ( is_object($thing) && is_a($thing, 'WP_Error') ) 697 return true; 698 return false; 699 } 700 701 /** 702 * A class for displaying various tree-like structures. 703 * 704 * Extend the Walker class to use it, see examples at the below. Child classes 705 * do not need to implement all of the abstract methods in the class. The child 706 * only needs to implement the methods that are needed. Also, the methods are 707 * not strictly abstract in that the parameter definition needs to be followed. 708 * The child classes can have additional parameters. 709 * 710 * @package WordPress 711 * @since 2.1.0 712 * @abstract 713 */ 714 class Walker { 715 /** 716 * What the class handles. 717 * 718 * @since 2.1.0 719 * @var string 720 * @access public 721 */ 722 var $tree_type; 723 724 /** 725 * DB fields to use. 726 * 727 * @since 2.1.0 728 * @var array 729 * @access protected 730 */ 731 var $db_fields; 732 733 /** 734 * Max number of pages walked by the paged walker 735 * 736 * @since 2.7.0 737 * @var int 738 * @access protected 739 */ 740 var $max_pages = 1; 741 742 /** 743 * Starts the list before the elements are added. 744 * 745 * Additional parameters are used in child classes. The args parameter holds 746 * additional values that may be used with the child class methods. This 747 * method is called at the start of the output list. 748 * 749 * @since 2.1.0 750 * @abstract 751 * 752 * @param string $output Passed by reference. Used to append additional content. 753 */ 754 function start_lvl(&$output) {} 755 756 /** 757 * Ends the list of after the elements are added. 758 * 759 * Additional parameters are used in child classes. The args parameter holds 760 * additional values that may be used with the child class methods. This 761 * method finishes the list at the end of output of the elements. 762 * 763 * @since 2.1.0 764 * @abstract 765 * 766 * @param string $output Passed by reference. Used to append additional content. 767 */ 768 function end_lvl(&$output) {} 769 770 /** 771 * Start the element output. 772 * 773 * Additional parameters are used in child classes. The args parameter holds 774 * additional values that may be used with the child class methods. Includes 775 * the element output also. 776 * 777 * @since 2.1.0 778 * @abstract 779 * 780 * @param string $output Passed by reference. Used to append additional content. 781 */ 782 function start_el(&$output) {} 783 784 /** 785 * Ends the element output, if needed. 786 * 787 * Additional parameters are used in child classes. The args parameter holds 788 * additional values that may be used with the child class methods. 789 * 790 * @since 2.1.0 791 * @abstract 792 * 793 * @param string $output Passed by reference. Used to append additional content. 794 */ 795 function end_el(&$output) {} 796 797 /** 798 * Traverse elements to create list from elements. 799 * 800 * Display one element if the element doesn't have any children otherwise, 801 * display the element and its children. Will only traverse up to the max 802 * depth and no ignore elements under that depth. It is possible to set the 803 * max depth to include all depths, see walk() method. 804 * 805 * This method shouldn't be called directly, use the walk() method instead. 806 * 807 * @since 2.5.0 808 * 809 * @param object $element Data object 810 * @param array $children_elements List of elements to continue traversing. 811 * @param int $max_depth Max depth to traverse. 812 * @param int $depth Depth of current element. 813 * @param array $args 814 * @param string $output Passed by reference. Used to append additional content. 815 * @return null Null on failure with no changes to parameters. 816 */ 817 function display_element( $element, &$children_elements, $max_depth, $depth=0, $args, &$output ) { 818 819 if ( !$element ) 820 return; 821 822 $id_field = $this->db_fields['id']; 823 824 //display this element 825 if ( is_array( $args[0] ) ) 826 $args[0]['has_children'] = ! empty( $children_elements[$element->$id_field] ); 827 $cb_args = array_merge( array(&$output, $element, $depth), $args); 828 call_user_func_array(array(&$this, 'start_el'), $cb_args); 829 830 $id = $element->$id_field; 831 832 // descend only when the depth is right and there are childrens for this element 833 if ( ($max_depth == 0 || $max_depth > $depth+1 ) && isset( $children_elements[$id]) ) { 834 835 foreach( $children_elements[ $id ] as $child ){ 836 837 if ( !isset($newlevel) ) { 838 $newlevel = true; 839 //start the child delimiter 840 $cb_args = array_merge( array(&$output, $depth), $args); 841 call_user_func_array(array(&$this, 'start_lvl'), $cb_args); 842 } 843 $this->display_element( $child, $children_elements, $max_depth, $depth + 1, $args, $output ); 844 } 845 unset( $children_elements[ $id ] ); 846 } 847 848 if ( isset($newlevel) && $newlevel ){ 849 //end the child delimiter 850 $cb_args = array_merge( array(&$output, $depth), $args); 851 call_user_func_array(array(&$this, 'end_lvl'), $cb_args); 852 } 853 854 //end this element 855 $cb_args = array_merge( array(&$output, $element, $depth), $args); 856 call_user_func_array(array(&$this, 'end_el'), $cb_args); 857 } 858 859 /** 860 * Display array of elements hierarchically. 861 * 862 * It is a generic function which does not assume any existing order of 863 * elements. max_depth = -1 means flatly display every element. max_depth = 864 * 0 means display all levels. max_depth > 0 specifies the number of 865 * display levels. 866 * 867 * @since 2.1.0 868 * 869 * @param array $elements 870 * @param int $max_depth 871 * @return string 872 */ 873 function walk( $elements, $max_depth) { 874 875 $args = array_slice(func_get_args(), 2); 876 $output = ''; 877 878 if ($max_depth < -1) //invalid parameter 879 return $output; 880 881 if (empty($elements)) //nothing to walk 882 return $output; 883 884 $id_field = $this->db_fields['id']; 885 $parent_field = $this->db_fields['parent']; 886 887 // flat display 888 if ( -1 == $max_depth ) { 889 $empty_array = array(); 890 foreach ( $elements as $e ) 891 $this->display_element( $e, $empty_array, 1, 0, $args, $output ); 892 return $output; 893 } 894 895 /* 896 * need to display in hierarchical order 897 * seperate elements into two buckets: top level and children elements 898 * children_elements is two dimensional array, eg. 899 * children_elements[10][] contains all sub-elements whose parent is 10. 900 */ 901 $top_level_elements = array(); 902 $children_elements = array(); 903 foreach ( $elements as $e) { 904 if ( 0 == $e->$parent_field ) 905 $top_level_elements[] = $e; 906 else 907 $children_elements[ $e->$parent_field ][] = $e; 908 } 909 910 /* 911 * when none of the elements is top level 912 * assume the first one must be root of the sub elements 913 */ 914 if ( empty($top_level_elements) ) { 915 916 $first = array_slice( $elements, 0, 1 ); 917 $root = $first[0]; 918 919 $top_level_elements = array(); 920 $children_elements = array(); 921 foreach ( $elements as $e) { 922 if ( $root->$parent_field == $e->$parent_field ) 923 $top_level_elements[] = $e; 924 else 925 $children_elements[ $e->$parent_field ][] = $e; 926 } 927 } 928 929 foreach ( $top_level_elements as $e ) 930 $this->display_element( $e, $children_elements, $max_depth, 0, $args, $output ); 931 932 /* 933 * if we are displaying all levels, and remaining children_elements is not empty, 934 * then we got orphans, which should be displayed regardless 935 */ 936 if ( ( $max_depth == 0 ) && count( $children_elements ) > 0 ) { 937 $empty_array = array(); 938 foreach ( $children_elements as $orphans ) 939 foreach( $orphans as $op ) 940 $this->display_element( $op, $empty_array, 1, 0, $args, $output ); 941 } 942 943 return $output; 944 } 945 946 /** 947 * paged_walk() - produce a page of nested elements 948 * 949 * Given an array of hierarchical elements, the maximum depth, a specific page number, 950 * and number of elements per page, this function first determines all top level root elements 951 * belonging to that page, then lists them and all of their children in hierarchical order. 952 * 953 * @package WordPress 954 * @since 2.7 955 * @param $max_depth = 0 means display all levels; $max_depth > 0 specifies the number of display levels. 956 * @param $page_num the specific page number, beginning with 1. 957 * @return XHTML of the specified page of elements 958 */ 959 function paged_walk( $elements, $max_depth, $page_num, $per_page ) { 960 961 /* sanity check */ 962 if ( empty($elements) || $max_depth < -1 ) 963 return ''; 964 965 $args = array_slice( func_get_args(), 4 ); 966 $output = ''; 967 968 $id_field = $this->db_fields['id']; 969 $parent_field = $this->db_fields['parent']; 970 971 $count = -1; 972 if ( -1 == $max_depth ) 973 $total_top = count( $elements ); 974 if ( $page_num < 1 || $per_page < 0 ) { 975 // No paging 976 $paging = false; 977 $start = 0; 978 if ( -1 == $max_depth ) 979 $end = $total_top; 980 $this->max_pages = 1; 981 } else { 982 $paging = true; 983 $start = ( (int)$page_num - 1 ) * (int)$per_page; 984 $end = $start + $per_page; 985 if ( -1 == $max_depth ) 986 $this->max_pages = ceil($total_top / $per_page); 987 } 988 989 // flat display 990 if ( -1 == $max_depth ) { 991 if ( !empty($args[0]['reverse_top_level']) ) { 992 $elements = array_reverse( $elements ); 993 $oldstart = $start; 994 $start = $total_top - $end; 995 $end = $total_top - $oldstart; 996 } 997 998 $empty_array = array(); 999 foreach ( $elements as $e ) { 1000 $count++; 1001 if ( $count < $start ) 1002 continue; 1003 if ( $count >= $end ) 1004 break; 1005 $this->display_element( $e, $empty_array, 1, 0, $args, $output ); 1006 } 1007 return $output; 1008 } 1009 1010 /* 1011 * seperate elements into two buckets: top level and children elements 1012 * children_elements is two dimensional array, eg. 1013 * children_elements[10][] contains all sub-elements whose parent is 10. 1014 */ 1015 $top_level_elements = array(); 1016 $children_elements = array(); 1017 foreach ( $elements as $e) { 1018 if ( 0 == $e->$parent_field ) 1019 $top_level_elements[] = $e; 1020 else 1021 $children_elements[ $e->$parent_field ][] = $e; 1022 } 1023 1024 $total_top = count( $top_level_elements ); 1025 if ( $paging ) 1026 $this->max_pages = ceil($total_top / $per_page); 1027 else 1028 $end = $total_top; 1029 1030 if ( !empty($args[0]['reverse_top_level']) ) { 1031 $top_level_elements = array_reverse( $top_level_elements ); 1032 $oldstart = $start; 1033 $start = $total_top - $end; 1034 $end = $total_top - $oldstart; 1035 } 1036 if ( !empty($args[0]['reverse_children']) ) { 1037 foreach ( $children_elements as $parent => $children ) 1038 $children_elements[$parent] = array_reverse( $children ); 1039 } 1040 1041 foreach ( $top_level_elements as $e ) { 1042 $count++; 1043 1044 //for the last page, need to unset earlier children in order to keep track of orphans 1045 if ( $end >= $total_top && $count < $start ) 1046 $this->unset_children( $e, $children_elements ); 1047 1048 if ( $count < $start ) 1049 continue; 1050 1051 if ( $count >= $end ) 1052 break; 1053 1054 $this->display_element( $e, $children_elements, $max_depth, 0, $args, $output ); 1055 } 1056 1057 if ( $end >= $total_top && count( $children_elements ) > 0 ) { 1058 $empty_array = array(); 1059 foreach ( $children_elements as $orphans ) 1060 foreach( $orphans as $op ) 1061 $this->display_element( $op, $empty_array, 1, 0, $args, $output ); 1062 } 1063 1064 return $output; 1065 } 1066 1067 function get_number_of_root_elements( $elements ){ 1068 1069 $num = 0; 1070 $parent_field = $this->db_fields['parent']; 1071 1072 foreach ( $elements as $e) { 1073 if ( 0 == $e->$parent_field ) 1074 $num++; 1075 } 1076 return $num; 1077 } 1078 1079 // unset all the children for a given top level element 1080 function unset_children( $e, &$children_elements ){ 1081 1082 if ( !$e || !$children_elements ) 1083 return; 1084 1085 $id_field = $this->db_fields['id']; 1086 $id = $e->$id_field; 1087 1088 if ( !empty($children_elements[$id]) && is_array($children_elements[$id]) ) 1089 foreach ( (array) $children_elements[$id] as $child ) 1090 $this->unset_children( $child, $children_elements ); 1091 1092 if ( isset($children_elements[$id]) ) 1093 unset( $children_elements[$id] ); 1094 1095 } 1096 } 1097 1098 /** 1099 * Create HTML list of pages. 1100 * 1101 * @package WordPress 1102 * @since 2.1.0 1103 * @uses Walker 1104 */ 1105 class Walker_Page extends Walker { 1106 /** 1107 * @see Walker::$tree_type 1108 * @since 2.1.0 1109 * @var string 1110 */ 1111 var $tree_type = 'page'; 1112 1113 /** 1114 * @see Walker::$db_fields 1115 * @since 2.1.0 1116 * @todo Decouple this. 1117 * @var array 1118 */ 1119 var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID'); 1120 1121 /** 1122 * @see Walker::start_lvl() 1123 * @since 2.1.0 1124 * 1125 * @param string $output Passed by reference. Used to append additional content. 1126 * @param int $depth Depth of page. Used for padding. 1127 */ 1128 function start_lvl(&$output, $depth) { 1129 $indent = str_repeat("\t", $depth); 1130 $output .= "\n$indent<ul>\n"; 1131 } 1132 1133 /** 1134 * @see Walker::end_lvl() 1135 * @since 2.1.0 1136 * 1137 * @param string $output Passed by reference. Used to append additional content. 1138 * @param int $depth Depth of page. Used for padding. 1139 */ 1140 function end_lvl(&$output, $depth) { 1141 $indent = str_repeat("\t", $depth); 1142 $output .= "$indent</ul>\n"; 1143 } 1144 1145 /** 1146 * @see Walker::start_el() 1147 * @since 2.1.0 1148 * 1149 * @param string $output Passed by reference. Used to append additional content. 1150 * @param object $page Page data object. 1151 * @param int $depth Depth of page. Used for padding. 1152 * @param int $current_page Page ID. 1153 * @param array $args 1154 */ 1155 function start_el(&$output, $page, $depth, $args, $current_page) { 1156 if ( $depth ) 1157 $indent = str_repeat("\t", $depth); 1158 else 1159 $indent = ''; 1160 1161 extract($args, EXTR_SKIP); 1162 $css_class = 'page_item page-item-'.$page->ID; 1163 if ( !empty($current_page) ) { 1164 $_current_page = get_page( $current_page ); 1165 if ( isset($_current_page->ancestors) && in_array($page->ID, (array) $_current_page->ancestors) ) 1166 $css_class .= ' current_page_ancestor'; 1167 if ( $page->ID == $current_page ) 1168 $css_class .= ' current_page_item'; 1169 elseif ( $_current_page && $page->ID == $_current_page->post_parent ) 1170 $css_class .= ' current_page_parent'; 1171 } elseif ( $page->ID == get_option('page_for_posts') ) { 1172 $css_class .= ' current_page_parent'; 1173 } 1174 1175 $output .= $indent . '<li class="' . $css_class . '"><a href="' . get_page_link($page->ID) . '" title="' . attribute_escape(apply_filters('the_title', $page->post_title)) . '">' . $link_before . apply_filters('the_title', $page->post_title) . $link_after . '</a>'; 1176 1177 if ( !empty($show_date) ) { 1178 if ( 'modified' == $show_date ) 1179 $time = $page->post_modified; 1180 else 1181 $time = $page->post_date; 1182 1183 $output .= " " . mysql2date($date_format, $time); 1184 } 1185 } 1186 1187 /** 1188 * @see Walker::end_el() 1189 * @since 2.1.0 1190 * 1191 * @param string $output Passed by reference. Used to append additional content. 1192 * @param object $page Page data object. Not used. 1193 * @param int $depth Depth of page. Not Used. 1194 */ 1195 function end_el(&$output, $page, $depth) { 1196 $output .= "</li>\n"; 1197 } 1198 1199 } 1200 1201 /** 1202 * Create HTML dropdown list of pages. 1203 * 1204 * @package WordPress 1205 * @since 2.1.0 1206 * @uses Walker 1207 */ 1208 class Walker_PageDropdown extends Walker { 1209 /** 1210 * @see Walker::$tree_type 1211 * @since 2.1.0 1212 * @var string 1213 */ 1214 var $tree_type = 'page'; 1215 1216 /** 1217 * @see Walker::$db_fields 1218 * @since 2.1.0 1219 * @todo Decouple this 1220 * @var array 1221 */ 1222 var $db_fields = array ('parent' => 'post_parent', 'id' => 'ID'); 1223 1224 /** 1225 * @see Walker::start_el() 1226 * @since 2.1.0 1227 * 1228 * @param string $output Passed by reference. Used to append additional content. 1229 * @param object $page Page data object. 1230 * @param int $depth Depth of page in reference to parent pages. Used for padding. 1231 * @param array $args Uses 'selected' argument for selected page to set selected HTML attribute for option element. 1232 */ 1233 function start_el(&$output, $page, $depth, $args) { 1234 $pad = str_repeat(' ', $depth * 3); 1235 1236 $output .= "\t<option class=\"level-$depth\" value=\"$page->ID\""; 1237 if ( $page->ID == $args['selected'] ) 1238 $output .= ' selected="selected"'; 1239 $output .= '>'; 1240 $title = wp_specialchars($page->post_title); 1241 $output .= "$pad$title"; 1242 $output .= "</option>\n"; 1243 } 1244 } 1245 1246 /** 1247 * Create HTML list of categories. 1248 * 1249 * @package WordPress 1250 * @since 2.1.0 1251 * @uses Walker 1252 */ 1253 class Walker_Category extends Walker { 1254 /** 1255 * @see Walker::$tree_type 1256 * @since 2.1.0 1257 * @var string 1258 */ 1259 var $tree_type = 'category'; 1260 1261 /** 1262 * @see Walker::$db_fields 1263 * @since 2.1.0 1264 * @todo Decouple this 1265 * @var array 1266 */ 1267 var $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); 1268 1269 /** 1270 * @see Walker::start_lvl() 1271 * @since 2.1.0 1272 * 1273 * @param string $output Passed by reference. Used to append additional content. 1274 * @param int $depth Depth of category. Used for tab indentation. 1275 * @param array $args Will only append content if style argument value is 'list'. 1276 */ 1277 function start_lvl(&$output, $depth, $args) { 1278 if ( 'list' != $args['style'] ) 1279 return; 1280 1281 $indent = str_repeat("\t", $depth); 1282 $output .= "$indent<ul class='children'>\n"; 1283 } 1284 1285 /** 1286 * @see Walker::end_lvl() 1287 * @since 2.1.0 1288 * 1289 * @param string $output Passed by reference. Used to append additional content. 1290 * @param int $depth Depth of category. Used for tab indentation. 1291 * @param array $args Will only append content if style argument value is 'list'. 1292 */ 1293 function end_lvl(&$output, $depth, $args) { 1294 if ( 'list' != $args['style'] ) 1295 return; 1296 1297 $indent = str_repeat("\t", $depth); 1298 $output .= "$indent</ul>\n"; 1299 } 1300 1301 /** 1302 * @see Walker::start_el() 1303 * @since 2.1.0 1304 * 1305 * @param string $output Passed by reference. Used to append additional content. 1306 * @param object $category Category data object. 1307 * @param int $depth Depth of category in reference to parents. 1308 * @param array $args 1309 */ 1310 function start_el(&$output, $category, $depth, $args) { 1311 extract($args); 1312 1313 $cat_name = attribute_escape( $category->name); 1314 $cat_name = apply_filters( 'list_cats', $cat_name, $category ); 1315 $link = '<a href="' . get_category_link( $category->term_id ) . '" '; 1316 if ( $use_desc_for_title == 0 || empty($category->description) ) 1317 $link .= 'title="' . sprintf(__( 'View all posts filed under %s' ), $cat_name) . '"'; 1318 else 1319 $link .= 'title="' . attribute_escape( apply_filters( 'category_description', $category->description, $category )) . '"'; 1320 $link .= '>'; 1321 $link .= $cat_name . '</a>'; 1322 1323 if ( (! empty($feed_image)) || (! empty($feed)) ) { 1324 $link .= ' '; 1325 1326 if ( empty($feed_image) ) 1327 $link .= '('; 1328 1329 $link .= '<a href="' . get_category_feed_link($category->term_id, $feed_type) . '"'; 1330 1331 if ( empty($feed) ) 1332 $alt = ' alt="' . sprintf(__( 'Feed for all posts filed under %s' ), $cat_name ) . '"'; 1333 else { 1334 $title = ' title="' . $feed . '"'; 1335 $alt = ' alt="' . $feed . '"'; 1336 $name = $feed; 1337 $link .= $title; 1338 } 1339 1340 $link .= '>'; 1341 1342 if ( empty($feed_image) ) 1343 $link .= $name; 1344 else 1345 $link .= "<img src='$feed_image'$alt$title" . ' />'; 1346 $link .= '</a>'; 1347 if ( empty($feed_image) ) 1348 $link .= ')'; 1349 } 1350 1351 if ( isset($show_count) && $show_count ) 1352 $link .= ' (' . intval($category->count) . ')'; 1353 1354 if ( isset($show_date) && $show_date ) { 1355 $link .= ' ' . gmdate('Y-m-d', $category->last_update_timestamp); 1356 } 1357 1358 if ( isset($current_category) && $current_category ) 1359 $_current_category = get_category( $current_category ); 1360 1361 if ( 'list' == $args['style'] ) { 1362 $output .= "\t<li"; 1363 $class = 'cat-item cat-item-'.$category->term_id; 1364 if ( isset($current_category) && $current_category && ($category->term_id == $current_category) ) 1365 $class .= ' current-cat'; 1366 elseif ( isset($_current_category) && $_current_category && ($category->term_id == $_current_category->parent) ) 1367 $class .= ' current-cat-parent'; 1368 $output .= ' class="'.$class.'"'; 1369 $output .= ">$link\n"; 1370 } else { 1371 $output .= "\t$link<br />\n"; 1372 } 1373 } 1374 1375 /** 1376 * @see Walker::end_el() 1377 * @since 2.1.0 1378 * 1379 * @param string $output Passed by reference. Used to append additional content. 1380 * @param object $page Not used. 1381 * @param int $depth Depth of category. Not used. 1382 * @param array $args Only uses 'list' for whether should append to output. 1383 */ 1384 function end_el(&$output, $page, $depth, $args) { 1385 if ( 'list' != $args['style'] ) 1386 return; 1387 1388 $output .= "</li>\n"; 1389 } 1390 1391 } 1392 1393 /** 1394 * Create HTML dropdown list of Categories. 1395 * 1396 * @package WordPress 1397 * @since 2.1.0 1398 * @uses Walker 1399 */ 1400 class Walker_CategoryDropdown extends Walker { 1401 /** 1402 * @see Walker::$tree_type 1403 * @since 2.1.0 1404 * @var string 1405 */ 1406 var $tree_type = 'category'; 1407 1408 /** 1409 * @see Walker::$db_fields 1410 * @since 2.1.0 1411 * @todo Decouple this 1412 * @var array 1413 */ 1414 var $db_fields = array ('parent' => 'parent', 'id' => 'term_id'); 1415 1416 /** 1417 * @see Walker::start_el() 1418 * @since 2.1.0 1419 * 1420 * @param string $output Passed by reference. Used to append additional content. 1421 * @param object $category Category data object. 1422 * @param int $depth Depth of category. Used for padding. 1423 * @param array $args Uses 'selected', 'show_count', and 'show_last_update' keys, if they exist. 1424 */ 1425 function start_el(&$output, $category, $depth, $args) { 1426 $pad = str_repeat(' ', $depth * 3); 1427 1428 $cat_name = apply_filters('list_cats', $category->name, $category); 1429 $output .= "\t<option class=\"level-$depth\" value=\"".$category->term_id."\""; 1430 if ( $category->term_id == $args['selected'] ) 1431 $output .= ' selected="selected"'; 1432 $output .= '>'; 1433 $output .= $pad.$cat_name; 1434 if ( $args['show_count'] ) 1435 $output .= ' ('. $category->count .')'; 1436 if ( $args['show_last_update'] ) { 1437 $format = 'Y-m-d'; 1438 $output .= ' ' . gmdate($format, $category->last_update_timestamp); 1439 } 1440 $output .= "</option>\n"; 1441 } 1442 } 1443 1444 /** 1445 * Send XML response back to AJAX request. 1446 * 1447 * @package WordPress 1448 * @since 2.1.0 1449 */ 1450 class WP_Ajax_Response { 1451 /** 1452 * Store XML responses to send. 1453 * 1454 * @since 2.1.0 1455 * @var array 1456 * @access private 1457 */ 1458 var $responses = array(); 1459 1460 /** 1461 * PHP4 Constructor - Passes args to {@link WP_Ajax_Response::add()}. 1462 * 1463 * @since 2.1.0 1464 * @see WP_Ajax_Response::add() 1465 * 1466 * @param string|array $args Optional. Will be passed to add() method. 1467 * @return WP_Ajax_Response 1468 */ 1469 function WP_Ajax_Response( $args = '' ) { 1470 if ( !empty($args) ) 1471 $this->add($args); 1472 } 1473 1474 /** 1475 * Append to XML response based on given arguments. 1476 * 1477 * The arguments that can be passed in the $args parameter are below. It is 1478 * also possible to pass a WP_Error object in either the 'id' or 'data' 1479 * argument. The parameter isn't actually optional, content should be given 1480 * in order to send the correct response. 1481 * 1482 * 'what' argument is a string that is the XMLRPC response type. 1483 * 'action' argument is a boolean or string that acts like a nonce. 1484 * 'id' argument can be WP_Error or an integer. 1485 * 'old_id' argument is false by default or an integer of the previous ID. 1486 * 'position' argument is an integer or a string with -1 = top, 1 = bottom, 1487 * html ID = after, -html ID = before. 1488 * 'data' argument is a string with the content or message. 1489 * 'supplemental' argument is an array of strings that will be children of 1490 * the supplemental element. 1491 * 1492 * @since 2.1.0 1493 * 1494 * @param string|array $args Override defaults. 1495 * @return string XML response. 1496 */ 1497 function add( $args = '' ) { 1498 $defaults = array( 1499 'what' => 'object', 'action' => false, 1500 'id' => '0', 'old_id' => false, 1501 'position' => 1, 1502 'data' => '', 'supplemental' => array() 1503 ); 1504 1505 $r = wp_parse_args( $args, $defaults ); 1506 extract( $r, EXTR_SKIP ); 1507 $position = preg_replace( '/[^a-z0-9:_-]/i', '', $position ); 1508 1509 if ( is_wp_error($id) ) { 1510 $data = $id; 1511 $id = 0; 1512 } 1513 1514 $response = ''; 1515 if ( is_wp_error($data) ) { 1516 foreach ( (array) $data->get_error_codes() as $code ) { 1517 $response .= "<wp_error code='$code'><![CDATA[" . $data->get_error_message($code) . "]]></wp_error>"; 1518 if ( !$error_data = $data->get_error_data($code) ) 1519 continue; 1520 $class = ''; 1521 if ( is_object($error_data) ) { 1522 $class = ' class="' . get_class($error_data) . '"'; 1523 $error_data = get_object_vars($error_data); 1524 } 1525 1526 $response .= "<wp_error_data code='$code'$class>"; 1527 1528 if ( is_scalar($error_data) ) { 1529 $response .= "<![CDATA[$error_data]]>"; 1530 } elseif ( is_array($error_data) ) { 1531 foreach ( $error_data as $k => $v ) 1532 $response .= "<$k><![CDATA[$v]]></$k>"; 1533 } 1534 1535 $response .= "</wp_error_data>"; 1536 } 1537 } else { 1538 $response = "<response_data><![CDATA[$data]]></response_data>"; 1539 } 1540 1541 $s = ''; 1542 if ( is_array($supplemental) ) { 1543 foreach ( $supplemental as $k => $v ) 1544 $s .= "<$k><![CDATA[$v]]></$k>"; 1545 $s = "<supplemental>$s</supplemental>"; 1546 } 1547 1548 if ( false === $action ) 1549 $action = $_POST['action']; 1550 1551 $x = ''; 1552 $x .= "<response action='{$action}_$id'>"; // The action attribute in the xml output is formatted like a nonce action 1553 $x .= "<$what id='$id' " . ( false === $old_id ? '' : "old_id='$old_id' " ) . "position='$position'>"; 1554 $x .= $response; 1555 $x .= $s; 1556 $x .= "</$what>"; 1557 $x .= "</response>"; 1558 1559 $this->responses[] = $x; 1560 return $x; 1561 } 1562 1563 /** 1564 * Display XML formatted responses. 1565 * 1566 * Sets the content type header to text/xml. 1567 * 1568 * @since 2.1.0 1569 */ 1570 function send() { 1571 header('Content-Type: text/xml'); 1572 echo "<?xml version='1.0' standalone='yes'?><wp_ajax>"; 1573 foreach ( (array) $this->responses as $response ) 1574 echo $response; 1575 echo '</wp_ajax>'; 1576 die(); 1577 } 1578 } 1579 1580 ?>
title
Description
Body
title
Description
Body
title
Description
Body
title
Body
| Generated: Mon Mar 23 16:23:02 2009 | Cross-referenced by PHPXref 0.7 |