wppaste
WordPress

WP_Customize_Manager::_validate_header_video( WP_Error $validity, mixed $value ): mixed

Since
4.7.0
Source
wp-includes/class-wp-customize-manager.php:6087
Callback for validating the header_video value.

Description

Ensures that the selected video is less than 8MB and provides an error message.

Compatibility

WordPress
since 4.7.0
PHP
7.4–8.6-dev
  • 6.7.7
  • 6.8.8
  • 6.9.7
  • 7.0.4
  • 7.1.0

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

Parameters

$validityWP_Error
$valuemixed

Return value

mixed

Performance profile

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

Reads or writes the filesystem via filesize().

Scaling
Constant

No loop in the body: the same number of instructions runs whatever you pass in.

Instructions
11–47

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

Plugin surface
None

Nothing here hands control to plugin code.

Called by
0

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

What it touches

  • filesystemfilesystem accessfilesize()called directly
  • hookthird-party callbacksapply_filters()one call below WP_Customize_Manager::_validate_header_video()

Further down the call graph this can also reach cache, serialize, option, query 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 · 7 distinct outcomes

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

WhenInstructionsCalls it makes
always11absint(), get_attached_file()
!$size && str_ends_with()23absint(), get_attached_file(), filesize(), str_ends_with()
!$size28absint(), get_attached_file(), filesize(), str_ends_with(), str_ends_with()
$size && str_ends_with()30absint(), get_attached_file(), filesize(), __(), ->add(), str_ends_with()
$size35absint(), get_attached_file(), filesize(), __(), ->add(), str_ends_with(), str_ends_with()
!$size && !str_ends_with()40absint(), get_attached_file(), filesize(), str_ends_with(), str_ends_with(), __(), sprintf(), ->add()
$size && !str_ends_with()47absint(), get_attached_file(), filesize(), __(), ->add(), str_ends_with(), str_ends_with(), __(), sprintf(), ->add()

Across PHP versions

Compiles the same on PHP 7.4, 8.1, 8.2, 8.3, 8.4, 8.5 and 8.6-dev: 47 instructions, 11–47 executed per call, 4 branches. The work does not change between versions.

An instruction is not a fixed amount of time, so a matching count is not necessarily the same speed; what it rules out is a difference in the work itself.

Uses · 4

  • get_attached_file()Retrieves attached file path based on attachment ID.
  • absint()Converts a value to non-negative integer.
  • __()Retrieves the translation of $text.
  • str_ends_with()Polyfill for `str_ends_with()` function added in PHP 8.0.

Source code

View on Trac View on GitHub 

	public function _validate_header_video( $validity, $value ) {		$video = get_attached_file( absint( $value ) );		if ( $video ) {			$size = filesize( $video );			if ( $size > 8 * MB_IN_BYTES ) {				$validity->add(					'size_too_large',					__( 'This video file is too large to use as a header video. Try a shorter video or optimize the compression settings and re-upload a file that is less than 8MB. Or, upload your video to YouTube and link it with the option below.' )				);			}			if ( ! str_ends_with( $video, '.mp4' ) && ! str_ends_with( $video, '.mov' ) ) { // Check for .mp4 or .mov format, which (assuming h.264 encoding) are the only cross-browser-supported formats.				$validity->add(					'invalid_file_type',					sprintf(						/* translators: 1: .mp4, 2: .mov */						__( 'Only %1$s or %2$s files may be used for header video. Please convert your video file and try again, or, upload your video to YouTube and link it with the option below.' ),						'<code>.mp4</code>',						'<code>.mov</code>'					)				);			}		}		return $validity;	}

Changelog

Introduced in 4.7.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.9.7 tag, from src/wp-includes/class-wp-customize-manager.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.