Changeset 53768

Timestamp:

07/23/2022 03:04:03 PM (3 years ago)

Author:

SergeyBiryukov

Message:

Docs: Document that the $file_format parameter of metadata filters can be null.

This affects the wp_read_video_metadata and wp_read_audio_metadata filters.

Follow-up to [41746], [53764].

See #55646, #55828.

File:

• trunk/src/wp-admin/includes/media.php (modified) (2 diffs)

trunk/src/wp-admin/includes/media.php

@@ -3631 +3631 @@
      * @since 4.9.0
      *
-     * @param array  $metadata    Filtered video metadata.
-     * @param string $file        Path to video file.
-     * @param string $file_format File format of video, as analyzed by getID3.
-     * @param array  $data        Raw metadata from getID3.
+     * @param array       $metadata    Filtered video metadata.
+     * @param string      $file        Path to video file.
+     * @param string|null $file_format File format of video, as analyzed by getID3.
+     *                                 Null if unknown.
+     * @param array       $data        Raw metadata from getID3.
      */
     return apply_filters( 'wp_read_video_metadata', $metadata, $file, $file_format, $data );
@@ -3713 +3714 @@
      * @since 6.1.0
      *
-     * @param array  $metadata    Filtered audio metadata.
-     * @param string $file        Path to audio file.
-     * @param string $file_format File format of audio, as analyzed by getID3.
-     * @param array  $data        Raw metadata from getID3.
+     * @param array       $metadata    Filtered audio metadata.
+     * @param string      $file        Path to audio file.
+     * @param string|null $file_format File format of audio, as analyzed by getID3.
+     *                                 Null if unknown.
+     * @param array       $data        Raw metadata from getID3.
      */
     return apply_filters( 'wp_read_audio_metadata', $metadata, $file, $file_format, $data );