wp_xmlrpc_server::pingback_ping( array $args ): string|IXR_Error

Compatibility

Present in every tracked release (6.7.7 to 7.1.0), and compiles on PHP 7.4 through 8.6-dev.

Parameters

$argsarray

Method arguments. Note: arguments must be ordered as documented.

• $0string

  URL of page linked from.

• $1string

  URL of page linked to.

Return value

string|IXR_Error

Performance profile

How much work a call to wp_xmlrpc_server::pingback_ping() does, and what it touches: the algorithmic scaling, the Zend instruction count per call across PHP versions, the hooks it hands control to, and the core code that calls it. Measured from the compiled opcodes, not a stopwatch, so every number is identical on any machine running the same PHP version, and every function in core is ranked by cost.

Cost class

Expensive

Reaches an outbound HTTP request via wp_safe_remote_get().

Scaling

Scales with input

The body loops, so the work grows with what you pass in.

Instructions

61–330

Executed per call on PHP 8.5, depending on the branch taken. The body compiles to 452.

Plugin surface

5 hooks

Third-party callbacks on 'xmlrpc_call', 'pingback_ping_source_uri', 'http_headers_useragent' run inside this call, and their cost is not bounded by anything here.

Called by

0

Nothing in core calls this; the cost is only what you spend yourself.

What it touches

• hookthird-party callbacksdo_action()called directly
• optionoption read or writeget_option()called directly
• querycontent queryget_post()called directly
• httpoutbound HTTP requestwp_safe_remote_get()called directly
• sqldatabase query->get_results()called directly
• cacheobject cachewp_cache_get()one call below wp_xmlrpc_server::pingback_ping()
• serializeserialisationmaybe_unserialize()one call below wp_xmlrpc_server::pingback_ping()

Further down the call graph this can also reach transient. That is the worst case, several calls deep and usually down an error path, not what a normal call pays.

What one call costs · 86 distinct outcomes

One number would be a lie: the work depends on which branch runs. These are every distinct cost wp_xmlrpc_server::pingback_ping() can have, taken from its control-flow graph on PHP 8.5.

This body has more branch combinations than are worth enumerating, so the table covers the outcomes found first rather than every one that exists.

Hooks and filters fired · 5

5 hooks fire while wp_xmlrpc_server::pingback_ping() runs, in this order:

1. 1
   do_action( xmlrpc_call )actionline 6853 (+4 into the body)

   Fires after the XML-RPC user has been authenticated but before the rest of the method logic begins.

2. 2
   apply_filters( pingback_ping_source_uri )filterline 6869 (+20 into the body)

   Filters the pingback source URI.

3. 3
   apply_filters( http_headers_useragent )filterline 6960 (+111 into the body)

   Filters the user agent value sent with an HTTP request.

4. 4
   apply_filters( pre_remote_source )filterline 6989 (+140 into the body)

   Filters the pingback remote source.

5. 5
   do_action( pingback_post )actionline 7087 (+238 into the body)

   Fires after a post pingback has been sent.

Uses · 16

• do_action()Calls the callback functions that have been added to an action hook.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• __()Retrieves the translation of $text.
• get_option()Retrieves an option value based on an option name.
• url_to_postid()Examines a URL and try to determine the post ID it represents.
• get_post()Retrieves post data given a post ID or post object.
• pings_open()Determines whether the current post is open for pings.
• get_bloginfo()Retrieves information about the current site.
• wp_safe_remote_get()Retrieves the raw response from a safe HTTP request using the GET method.
• wp_remote_retrieve_body()Retrieves only the body from the raw response.
• str_contains()Polyfill for `str_contains()` function added in PHP 8.0.
• esc_html()Escaping for HTML blocks.

Source code

View on Trac ↗View on GitHub ↗

6849	public function pingback_ping( $args ) {6850		global $wpdb;6851 6852		/** This action is documented in wp-includes/class-wp-xmlrpc-server.php */6853		do_action( 'xmlrpc_call', 'pingback.ping', $args, $this );6854 6855		$this->escape( $args );6856 6857		$pagelinkedfrom = str_replace( '&', '&', $args[0] );6858		$pagelinkedto   = str_replace( '&', '&', $args[1] );6859		$pagelinkedto   = str_replace( '&', '&', $pagelinkedto );6860 6861		/**6862		 * Filters the pingback source URI.6863		 *6864		 * @since 3.6.06865		 *6866		 * @param string $pagelinkedfrom URI of the page linked from.6867		 * @param string $pagelinkedto   URI of the page linked to.6868		 */6869		$pagelinkedfrom = apply_filters( 'pingback_ping_source_uri', $pagelinkedfrom, $pagelinkedto );6870 6871		if ( ! $pagelinkedfrom ) {6872			return $this->pingback_error( 0, __( 'A valid URL was not provided.' ) );6873		}6874 6875		// Check if the page linked to is on our site.6876		$pos1 = strpos( $pagelinkedto, str_replace( array( 'http://www.', 'http://', 'https://www.', 'https://' ), '', get_option( 'home' ) ) );6877		if ( ! $pos1 ) {6878			return $this->pingback_error( 0, __( 'Is there no link to us?' ) );6879		}6880 6881		/*6882		 * Let's find which post is linked to.6883		 * FIXME: Does url_to_postid() cover all these cases already?6884		 * If so, then let's use it and drop the old code.6885		 */6886		$urltest = parse_url( $pagelinkedto );6887		$post_id = url_to_postid( $pagelinkedto );6888		if ( $post_id ) {6889			// $way6890		} elseif ( isset( $urltest['path'] ) && preg_match( '#p/[0-9]{1,}#', $urltest['path'], $match ) ) {6891			// The path defines the post_ID (archives/p/XXXX).6892			$blah    = explode( '/', $match[0] );6893			$post_id = (int) $blah[1];6894		} elseif ( isset( $urltest['query'] ) && preg_match( '#p=[0-9]{1,}#', $urltest['query'], $match ) ) {6895			// The query string defines the post_ID (?p=XXXX).6896			$blah    = explode( '=', $match[0] );6897			$post_id = (int) $blah[1];6898		} elseif ( isset( $urltest['fragment'] ) ) {6899			// An #anchor is there, it's either...6900			if ( (int) $urltest['fragment'] ) {6901				// ...an integer #XXXX (simplest case),6902				$post_id = (int) $urltest['fragment'];6903			} elseif ( preg_match( '/post-[0-9]+/', $urltest['fragment'] ) ) {6904				// ...a post ID in the form 'post-###',6905				$post_id = preg_replace( '/[^0-9]+/', '', $urltest['fragment'] );6906			} elseif ( is_string( $urltest['fragment'] ) ) {6907				// ...or a string #title, a little more complicated.6908				$title   = preg_replace( '/[^a-z0-9]/i', '.', $urltest['fragment'] );6909				$sql     = $wpdb->prepare( "SELECT ID FROM $wpdb->posts WHERE post_title RLIKE %s", $title );6910				$post_id = $wpdb->get_var( $sql );6911				if ( ! $post_id ) {6912					// Returning unknown error '0' is better than die()'ing.6913					return $this->pingback_error( 0, '' );6914				}6915			}6916		} else {6917			// TODO: Attempt to extract a post ID from the given URL.6918			return $this->pingback_error( 33, __( 'The specified target URL cannot be used as a target. It either does not exist, or it is not a pingback-enabled resource.' ) );6919		}6920		$post_id = (int) $post_id;6921 6922		$post = get_post( $post_id );6923 6924		if ( ! $post ) { // Post not found.6925			return $this->pingback_error( 33, __( 'The specified target URL cannot be used as a target. It either does not exist, or it is not a pingback-enabled resource.' ) );6926		}6927 6928		if ( url_to_postid( $pagelinkedfrom ) == $post_id ) {

Changelog

Introduced in 1.5.0. Unchanged from 6.7.7 through 7.1.0.

1. 6.7.7
2. 6.8.8
3. 6.9.7
4. 7.0.4
5. 7.1.0

Signature, return type and hooks compared across 5 parsed releases.

About this page

Parsed data

Generated from the wordpress-develop 6.7.7 tag, from src/wp-includes/class-wp-xmlrpc-server.php, and regenerated for each WordPress release so it tracks the code rather than a snapshot of it.

Corrections

Something wrong on this page? Report it and it gets fixed in the next regeneration.