get_attachment_fields_to_edit( WP_Post $post, array $errors = null ): array<string,

Compatibility

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

Parameters

$postWP_Post

$errorsarrayoptional

Default: null

Return value

array<string,

array<string, mixed>> The attachment fields.

Performance profile

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

Heavy

Reaches the database via get_post().

Scaling

Scales with input

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

Instructions

117–177

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

Plugin surface

1 hook

Third-party callbacks on 'attachment_fields_to_edit' 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
• optionoption read or writeget_option()called directly
• hookthird-party callbacksapply_filters()called directly
• cacheobject cachewp_cache_get()one call below get_attachment_fields_to_edit()
• serializeserialisationmaybe_unserialize()one call below get_attachment_fields_to_edit()

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 · 4 distinct outcomes

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

Hooks and filters fired · 1

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

1. 1
   apply_filters( attachment_fields_to_edit )filterline 1526 (+124 into the body)

   Filters the attachment fields to edit.

Uses · 18

• get_post()Retrieves post data given a post ID or post object.
• wp_get_attachment_url()Retrieves the URL for an attachment.
• sanitize_post()Sanitizes every post field.
• __()Retrieves the translation of $text.
• wp_caption_input_textarea()Outputs a textarea element for inputting an attachment caption.
• image_link_input_fields()Retrieves HTML for the Link URL buttons with the default link type as specified.
• get_option()Retrieves an option value based on an option name.
• esc_attr()Escaping for HTML attributes.
• get_attachment_taxonomies()Retrieves taxonomies attached to given the attachment.
• get_taxonomy()Retrieves the taxonomy object of $taxonomy.
• get_object_term_cache()Retrieves the cached term objects for the given object ID.
• wp_get_object_terms()Retrieves the terms associated with the given object(s), in the supplied taxonomies.

Used by · 1

• get_media_item()Retrieves HTML form for modifying the image attachment.

Source code

View on Trac ↗View on GitHub ↗

1402function get_attachment_fields_to_edit( $post, $errors = null ) {1403	if ( is_int( $post ) ) {1404		$post = get_post( $post );1405	}1406 1407	if ( is_array( $post ) ) {1408		$post = new WP_Post( (object) $post );1409	}1410 1411	$image_url = wp_get_attachment_url( $post->ID );1412 1413	$edit_post = sanitize_post( $post, 'edit' );1414 1415	$form_fields = array(1416		'post_title'   => array(1417			'label' => __( 'Title' ),1418			'value' => $edit_post->post_title,1419		),1420		'image_alt'    => array(),1421		'post_excerpt' => array(1422			'label' => __( 'Caption' ),1423			'input' => 'html',1424			'html'  => wp_caption_input_textarea( $edit_post ),1425		),1426		'post_content' => array(1427			'label' => __( 'Description' ),1428			'value' => $edit_post->post_content,1429			'input' => 'textarea',1430		),1431		'url'          => array(1432			'label' => __( 'Link URL' ),1433			'input' => 'html',1434			'html'  => image_link_input_fields( $post, get_option( 'image_default_link_type' ) ),1435			'helps' => __( 'Enter a link URL or click above for presets.' ),1436		),1437		'menu_order'   => array(1438			'label' => __( 'Order' ),1439			'value' => $edit_post->menu_order,1440		),1441		'image_url'    => array(1442			'label' => __( 'File URL' ),1443			'input' => 'html',1444			'html'  => "<input type='text' class='text urlfield' readonly='readonly' name='attachments[$post->ID][url]' value='" . esc_attr( $image_url ) . "' /><br />",1445			'value' => wp_get_attachment_url( $post->ID ),1446			'helps' => __( 'Location of the uploaded file.' ),1447		),1448	);1449 1450	foreach ( get_attachment_taxonomies( $post ) as $taxonomy ) {1451		$t = (array) get_taxonomy( $taxonomy );1452 1453		if ( ! $t['public'] || ! $t['show_ui'] ) {1454			continue;1455		}1456 1457		if ( empty( $t['label'] ) ) {1458			$t['label'] = $taxonomy;1459		}1460 1461		if ( empty( $t['args'] ) ) {1462			$t['args'] = array();1463		}1464 1465		$terms = get_object_term_cache( $post->ID, $taxonomy );1466 1467		if ( false === $terms ) {1468			$terms = wp_get_object_terms( $post->ID, $taxonomy, $t['args'] );1469		}1470 1471		$values = array();1472 1473		foreach ( $terms as $term ) {1474			$values[] = $term->slug;1475		}1476 1477		$t['value'] = implode( ', ', $values );1478 1479		$form_fields[ $taxonomy ] = $t;1480	}1481

Changelog

Introduced in 2.5.0. One change between 6.7.7 and 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 7.0.4 tag, from src/wp-admin/includes/media.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.