Changeset 40421

Timestamp:

04/13/2017 08:21:45 PM (7 years ago)

Author:

jnylen0

Message:

Media: Improve filters that allow overriding slow media queries.

As a follow-up to [40382], this commit makes the following improvements:

• Make the filter names more specific.
• Fix the inline documentation (use @param instead of `@return).
• Use null === instead of is_null to avoid extra function calls.
• Rename the $has_audio and $has_video variables now that they actually represent something slightly different.

See #31071.

File:

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

trunk/src/wp-includes/media.php

@@ -3334 +3334 @@
      * @link https://core.trac.wordpress.org/ticket/31071
      *
-     * @return bool|null Whether to show the button, or `null` for default behavior.
-     */
-    $has_audio = apply_filters( 'media_has_audio', null );
-    if ( is_null( $has_audio ) ) {
-        $has_audio = $wpdb->get_var( "
+     * @param bool|null Whether to show the button, or `null` for default behavior.
+     */
+    $show_audio_playlist = apply_filters( 'media_library_show_audio_playlist', null );
+    if ( null === $show_audio_playlist ) {
+        $show_audio_playlist = $wpdb->get_var( "
             SELECT ID
             FROM $wpdb->posts
@@ -3359 +3359 @@
      * @link https://core.trac.wordpress.org/ticket/31071
      *
-     * @return bool|null Whether to show the button, or `null` for default behavior.
-     */
-    $has_video = apply_filters( 'media_has_video', null );
-    if ( is_null( $has_video ) ) {
-        $has_video = $wpdb->get_var( "
+     * @param bool|null Whether to show the button, or `null` for default behavior.
+     */
+    $show_video_playlist = apply_filters( 'media_library_show_video_playlist', null );
+    if ( null === $show_video_playlist ) {
+        $show_video_playlist = $wpdb->get_var( "
             SELECT ID
             FROM $wpdb->posts
@@ -3384 +3384 @@
      * @link https://core.trac.wordpress.org/ticket/31071
      *
-     * @return array|null An array of objects with `month` and `year`
-     *                    properties, or `null` (or any other non-array value)
-     *                    for default behavior.
-     */
-    $months = apply_filters( 'media_months', null );
+     * @param array|null An array of objects with `month` and `year`
+     *                   properties, or `null` (or any other non-array value)
+     *                   for default behavior.
+     */
+    $months = apply_filters( 'media_library_months_with_files', null );
     if ( ! is_array( $months ) ) {
         $months = $wpdb->get_results( $wpdb->prepare( "
@@ -3415 +3415 @@
         'defaultProps' => $props,
         'attachmentCounts' => array(
-            'audio' => ( $has_audio ) ? 1 : 0,
-            'video' => ( $has_video ) ? 1 : 0
+            'audio' => ( $show_audio_playlist ) ? 1 : 0,
+            'video' => ( $show_video_playlist ) ? 1 : 0,
         ),
         'embedExts'    => $exts,
@@ -3422 +3422 @@
         'contentWidth' => $content_width,
         'months'       => $months,
-        'mediaTrash'   => MEDIA_TRASH ? 1 : 0
+        'mediaTrash'   => MEDIA_TRASH ? 1 : 0,
     );