class-wp-ajax-response.php 5.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165
  1. <?php
  2. /**
  3. * Send XML response back to Ajax request.
  4. *
  5. * @package WordPress
  6. * @since 2.1.0
  7. */
  8. #[AllowDynamicProperties]
  9. class WP_Ajax_Response {
  10. /**
  11. * Store XML responses to send.
  12. *
  13. * @since 2.1.0
  14. * @var array
  15. */
  16. public $responses = array();
  17. /**
  18. * Constructor - Passes args to WP_Ajax_Response::add().
  19. *
  20. * @since 2.1.0
  21. *
  22. * @see WP_Ajax_Response::add()
  23. *
  24. * @param string|array $args Optional. Will be passed to add() method.
  25. */
  26. public function __construct( $args = '' ) {
  27. if ( ! empty( $args ) ) {
  28. $this->add( $args );
  29. }
  30. }
  31. /**
  32. * Appends data to an XML response based on given arguments.
  33. *
  34. * With `$args` defaults, extra data output would be:
  35. *
  36. * <response action='{$action}_$id'>
  37. * <$what id='$id' position='$position'>
  38. * <response_data><![CDATA[$data]]></response_data>
  39. * </$what>
  40. * </response>
  41. *
  42. * @since 2.1.0
  43. *
  44. * @param string|array $args {
  45. * Optional. An array or string of XML response arguments.
  46. *
  47. * @type string $what XML-RPC response type. Used as a child element of `<response>`.
  48. * Default 'object' (`<object>`).
  49. * @type string|false $action Value to use for the `action` attribute in `<response>`. Will be
  50. * appended with `_$id` on output. If false, `$action` will default to
  51. * the value of `$_POST['action']`. Default false.
  52. * @type int|WP_Error $id The response ID, used as the response type `id` attribute. Also
  53. * accepts a `WP_Error` object if the ID does not exist. Default 0.
  54. * @type int|false $old_id The previous response ID. Used as the value for the response type
  55. * `old_id` attribute. False hides the attribute. Default false.
  56. * @type string $position Value of the response type `position` attribute. Accepts 1 (bottom),
  57. * -1 (top), HTML ID (after), or -HTML ID (before). Default 1 (bottom).
  58. * @type string|WP_Error $data The response content/message. Also accepts a WP_Error object if the
  59. * ID does not exist. Default empty.
  60. * @type array $supplemental An array of extra strings that will be output within a `<supplemental>`
  61. * element as CDATA. Default empty array.
  62. * }
  63. * @return string XML response.
  64. */
  65. public function add( $args = '' ) {
  66. $defaults = array(
  67. 'what' => 'object',
  68. 'action' => false,
  69. 'id' => '0',
  70. 'old_id' => false,
  71. 'position' => 1,
  72. 'data' => '',
  73. 'supplemental' => array(),
  74. );
  75. $parsed_args = wp_parse_args( $args, $defaults );
  76. $position = preg_replace( '/[^a-z0-9:_-]/i', '', $parsed_args['position'] );
  77. $id = $parsed_args['id'];
  78. $what = $parsed_args['what'];
  79. $action = $parsed_args['action'];
  80. $old_id = $parsed_args['old_id'];
  81. $data = $parsed_args['data'];
  82. if ( is_wp_error( $id ) ) {
  83. $data = $id;
  84. $id = 0;
  85. }
  86. $response = '';
  87. if ( is_wp_error( $data ) ) {
  88. foreach ( (array) $data->get_error_codes() as $code ) {
  89. $response .= "<wp_error code='$code'><![CDATA[" . $data->get_error_message( $code ) . ']]></wp_error>';
  90. $error_data = $data->get_error_data( $code );
  91. if ( ! $error_data ) {
  92. continue;
  93. }
  94. $class = '';
  95. if ( is_object( $error_data ) ) {
  96. $class = ' class="' . get_class( $error_data ) . '"';
  97. $error_data = get_object_vars( $error_data );
  98. }
  99. $response .= "<wp_error_data code='$code'$class>";
  100. if ( is_scalar( $error_data ) ) {
  101. $response .= "<![CDATA[$error_data]]>";
  102. } elseif ( is_array( $error_data ) ) {
  103. foreach ( $error_data as $k => $v ) {
  104. $response .= "<$k><![CDATA[$v]]></$k>";
  105. }
  106. }
  107. $response .= '</wp_error_data>';
  108. }
  109. } else {
  110. $response = "<response_data><![CDATA[$data]]></response_data>";
  111. }
  112. $s = '';
  113. if ( is_array( $parsed_args['supplemental'] ) ) {
  114. foreach ( $parsed_args['supplemental'] as $k => $v ) {
  115. $s .= "<$k><![CDATA[$v]]></$k>";
  116. }
  117. $s = "<supplemental>$s</supplemental>";
  118. }
  119. if ( false === $action ) {
  120. $action = $_POST['action'];
  121. }
  122. $x = '';
  123. $x .= "<response action='{$action}_$id'>"; // The action attribute in the xml output is formatted like a nonce action.
  124. $x .= "<$what id='$id' " . ( false === $old_id ? '' : "old_id='$old_id' " ) . "position='$position'>";
  125. $x .= $response;
  126. $x .= $s;
  127. $x .= "</$what>";
  128. $x .= '</response>';
  129. $this->responses[] = $x;
  130. return $x;
  131. }
  132. /**
  133. * Display XML formatted responses.
  134. *
  135. * Sets the content type header to text/xml.
  136. *
  137. * @since 2.1.0
  138. */
  139. public function send() {
  140. header( 'Content-Type: text/xml; charset=' . get_option( 'blog_charset' ) );
  141. echo "<?xml version='1.0' encoding='" . get_option( 'blog_charset' ) . "' standalone='yes'?><wp_ajax>";
  142. foreach ( (array) $this->responses as $response ) {
  143. echo $response;
  144. }
  145. echo '</wp_ajax>';
  146. if ( wp_doing_ajax() ) {
  147. wp_die();
  148. } else {
  149. die();
  150. }
  151. }
  152. }