do_enclose( string|null $content, int|WP_Post $post ): void|false

Description

Compatibility

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

Parameters

$contentstring|null

Post content. If null, the post_content field from $post is used.

$postint|WP_Post

Post ID or post object.

Return value

void|false

Void on success, false if the post is not found.

Performance profile

How much work a call to do_enclose() 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_head().

Scaling

Scales with input

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

Instructions

14–48

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

Plugin surface

1 hook

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

Called by

1

1 place in core call this, so the cost is paid more often than your own code shows.

What it touches

• querycontent queryget_post()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_delete()one call below do_enclose()
• httpoutbound HTTP requestwp_safe_remote_head()one call below do_enclose()

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

What one call costs · 2 distinct outcomes

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

Hooks and filters fired · 1

One hook fires while do_enclose() runs, in this order:

1. 1
   apply_filters( enclosure_links )filterline 938 (+57 into the body)

   Filters the list of enclosure links before querying the database.

Uses · 9

• get_post()Retrieves post data given a post ID or post object.
• get_enclosed()Retrieves enclosures already enclosed for a post.
• wp_extract_urls()Uses RegEx to extract URLs from arbitrary content.
• delete_metadata_by_mid()Deletes metadata by meta ID.
• apply_filters()Calls the callback functions that have been added to a filter hook.
• strip_fragment_from_url()Strips the #fragment from a URL, if one is present.
• wp_get_http_headers()Retrieves HTTP Headers from URL.
• wp_get_mime_types()Retrieves the list of mime types and file extensions.
• add_post_meta()Adds a meta field to the given post.

Used by · 1

• do_all_enclosures()Performs all enclosures.

Source code

View on Trac ↗View on GitHub ↗

881function do_enclose( $content, $post ) {882	global $wpdb;883 884	// @todo Tidy this code and make the debug code optional.885	require_once ABSPATH . WPINC . '/class-IXR.php';886 887	$post = get_post( $post );888	if ( ! $post ) {889		return false;890	}891 892	if ( null === $content ) {893		$content = $post->post_content;894	}895 896	$post_links = array();897 898	$pung = get_enclosed( $post->ID );899 900	$post_links_temp = wp_extract_urls( $content );901 902	foreach ( $pung as $link_test ) {903		// Link is no longer in post.904		if ( ! in_array( $link_test, $post_links_temp, true ) ) {905			$mids = $wpdb->get_col( $wpdb->prepare( "SELECT meta_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE %s", $post->ID, $wpdb->esc_like( $link_test ) . '%' ) );906			foreach ( $mids as $mid ) {907				delete_metadata_by_mid( 'post', $mid );908			}909		}910	}911 912	foreach ( (array) $post_links_temp as $link_test ) {913		// If we haven't pung it already.914		if ( ! in_array( $link_test, $pung, true ) ) {915			$test = parse_url( $link_test );916			if ( false === $test ) {917				continue;918			}919			if ( isset( $test['query'] ) ) {920				$post_links[] = $link_test;921			} elseif ( isset( $test['path'] ) && ( '/' !== $test['path'] ) && ( '' !== $test['path'] ) ) {922				$post_links[] = $link_test;923			}924		}925	}926 927	/**928	 * Filters the list of enclosure links before querying the database.929	 *930	 * Allows for the addition and/or removal of potential enclosures to save931	 * to postmeta before checking the database for existing enclosures.932	 *933	 * @since 4.4.0934	 *935	 * @param string[] $post_links An array of enclosure links.936	 * @param int      $post_id    Post ID.937	 */938	$post_links = apply_filters( 'enclosure_links', $post_links, $post->ID );939 940	foreach ( (array) $post_links as $url ) {941		$url = strip_fragment_from_url( $url );942 943		if ( '' !== $url && ! $wpdb->get_var( $wpdb->prepare( "SELECT post_id FROM $wpdb->postmeta WHERE post_id = %d AND meta_key = 'enclosure' AND meta_value LIKE %s", $post->ID, $wpdb->esc_like( $url ) . '%' ) ) ) {944 945			$headers = wp_get_http_headers( $url );946			if ( $headers ) {947				$len           = isset( $headers['Content-Length'] ) ? (int) $headers['Content-Length'] : 0;948				$type          = isset( $headers['Content-Type'] ) ? $headers['Content-Type'] : '';949				$allowed_types = array( 'video', 'audio' );950 951				// Check to see if we can figure out the mime type from the extension.952				$url_parts = parse_url( $url );953				if ( false !== $url_parts && ! empty( $url_parts['path'] ) ) {954					$extension = pathinfo( $url_parts['path'], PATHINFO_EXTENSION );955					if ( ! empty( $extension ) ) {956						foreach ( wp_get_mime_types() as $exts => $mime ) {957							if ( preg_match( '!^(' . $exts . ')$!i', $extension ) ) {958								$type = $mime;959								break;960							}

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/functions.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.