Changeset 59700

Timestamp:

01/24/2025 01:30:27 PM (3 months ago)

Author:

swissspidy

Message:

Posts, Post Types: Embeds: Add new embeddable argument to post types.

This new argument, which defaults to the value of public, can be used to determine whether a post can be embedded using oEmbed. A new is_post_embeddable() function is added to easily check this.

Props pampfelimetten, swissspidy, bradleyt, DrewAPicture, gadelhas, mukesh27.
Fixes #35567.

Location:

trunk

Files:

• src/wp-includes/class-wp-post-type.php (modified) (3 diffs)
• src/wp-includes/embed.php (modified) (3 diffs)
• src/wp-includes/post.php (modified) (1 diff)
• tests/phpunit/tests/oembed/discovery.php (modified) (1 diff)
• tests/phpunit/tests/oembed/template.php (modified) (1 diff)
• tests/phpunit/tests/post/types.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-post-type.php

@@ -113 +113 @@
      */
     public $publicly_queryable = null;
+
+    /**
+     * Whether this post type is embeddable.
+     *
+     * Default is the value of $public.
+     *
+     * @since 6.8.0
+     * @var bool $embeddable
+     */
+    public $embeddable = null;
 
     /**
@@ -522 +532 @@
             'exclude_from_search'             => null,
             'publicly_queryable'              => null,
+            'embeddable'                      => null,
             'show_ui'                         => null,
             'show_in_menu'                    => null,
@@ -564 +575 @@
         if ( null === $args['show_ui'] ) {
             $args['show_ui'] = $args['public'];
+        }
+
+        // If not set, default to the setting for 'public'.
+        if ( null === $args['embeddable'] ) {
+            $args['embeddable'] = $args['public'];
         }
 

trunk/src/wp-includes/embed.php

@@ -332 +332 @@
  *
  * @since 4.4.0
+ * @since 6.8.0 Output was adjusted to only embed if the post supports it.
  */
 function wp_oembed_add_discovery_links() {
     $output = '';
 
-    if ( is_singular() ) {
+    if ( is_singular() && is_post_embeddable() ) {
         $output .= '<link rel="alternate" title="' . _x( 'oEmbed (JSON)', 'oEmbed resource link name' ) . '" type="application/json+oembed" href="' . esc_url( get_oembed_endpoint_url( get_permalink() ) ) . '" />' . "\n";
 
@@ -539 +540 @@
  *
  * @since 4.4.0
+ * @since 6.8.0 Output was adjusted to only embed if the post type supports it.
  *
  * @param WP_Post|int $post  Post ID or post object.
  * @param int         $width The requested width.
- * @return array|false Response data on success, false if post doesn't exist
- *                     or is not publicly viewable.
+ * @return array|false Response data on success, false if post doesn't exist,
+ *                     is not publicly viewable or post type is not embeddable.
  */
 function get_oembed_response_data( $post, $width ) {
@@ -554 +556 @@
 
     if ( ! is_post_publicly_viewable( $post ) ) {
+        return false;
+    }
+
+    if ( ! is_post_embeddable( $post ) ) {
         return false;
     }

trunk/src/wp-includes/post.php

@@ -2477 +2477 @@
 
 /**
+ * Determines whether a post is embeddable.
+ *
+ * @since 6.8.0
+ *
+ * @param int|WP_Post|null $post Optional. Post ID or `WP_Post` object. Defaults to global $post.
+ * @return bool Whether the post should be considered embeddable.
+ */
+function is_post_embeddable( $post = null ) {
+    $post = get_post( $post );
+
+    if ( ! $post ) {
+        return false;
+    }
+
+    $post_type = get_post_type_object( $post->post_type );
+
+    if ( ! $post_type ) {
+        return false;
+    }
+
+    $is_embeddable = $post_type->embeddable;
+
+    /**
+     * Filter whether a post is embeddable.
+     *
+     * @since 6.8.0
+     *
+     * @param bool    $is_embeddable Whether the post is embeddable.
+     * @param WP_Post $post          Post object.
+     */
+    return apply_filters( 'is_post_embeddable', $is_embeddable, $post );
+}
+
+/**
  * Retrieves an array of the latest posts, or posts matching the given criteria.
  *

trunk/tests/phpunit/tests/oembed/discovery.php

@@ -86 +86 @@
         $this->assertSame( $expected, get_echo( 'wp_oembed_add_discovery_links' ) );
     }
+
+    /**
+     * @ticket 35567
+     */
+    public function test_wp_oembed_add_discovery_links_non_embeddable_post_type_output_should_be_empty() {
+        register_post_type( 'not_embeddable', array( 'embeddable' => false ) );
+
+        $post = self::factory()->post->create_and_get(
+            array(
+                'post_type' => 'not_embeddable',
+            )
+        );
+
+        $this->assertFalse( get_oembed_response_data( $post, 100 ) );
+    }
 }

trunk/tests/phpunit/tests/oembed/template.php

@@ -344 +344 @@
         $this->assertFalse( $scripts->query( 'wp-embed', 'enqueued' ) );
     }
+
+    /**
+     * @ticket 35567
+     */
+    public function test_is_embeddable_post_non_existent_post() {
+        $this->assertFalse( is_post_embeddable( 99999 ) );
+    }
+
+    /**
+     * @ticket 35567
+     */
+    public function test_is_embeddable_post_should_return_false_for_non_embeddable_post_type() {
+        register_post_type( 'not_embeddable', array( 'embeddable' => false ) );
+
+        $post = self::factory()->post->create_and_get(
+            array(
+                'post_type' => 'not_embeddable',
+            )
+        );
+
+        $this->assertFalse( is_post_embeddable( $post ) );
+    }
+
+    /**
+     * @ticket 35567
+     */
+    public function test_is_embeddable_post_should_return_true_for_embeddable_post_type() {
+        register_post_type( 'embeddable', array( 'embeddable' => true ) );
+
+        $post = self::factory()->post->create_and_get(
+            array(
+                'post_type' => 'embeddable',
+            )
+        );
+
+        $this->assertTrue( is_post_embeddable( $post ) );
+    }
+
+    /**
+     * @ticket 35567
+     */
+    public function test_is_embeddable_post_filtered() {
+        register_post_type( 'not_embeddable', array( 'embeddable' => false ) );
+
+        $post = self::factory()->post->create_and_get(
+            array(
+                'post_type' => 'not_embeddable',
+            )
+        );
+
+        add_filter( 'is_post_embeddable', '__return_true' );
+        $embeddable = is_post_embeddable( $post );
+        remove_filter( 'is_post_embeddable', '__return_true' );
+
+        $this->assertTrue( $embeddable );
+    }
 }

trunk/tests/phpunit/tests/post/types.php

@@ -647 +647 @@
         $this->assertTrue( post_type_supports( 'foo', 'autosave' ), 'Post type should still support autosaves.' );
     }
+
+    /**
+     * @group oembed
+     * @ticket 35567
+     */
+    public function test_register_post_type_is_embeddable_should_default_to_value_of_public() {
+        $post_type = register_post_type( $this->post_type );
+        $this->assertFalse( $post_type->embeddable, 'Non-public post type should not be embeddable by default' );
+
+        $post_type = register_post_type( $this->post_type, array( 'public' => true ) );
+        $this->assertTrue( $post_type->embeddable, 'Public post type should be embeddable by default' );
+    }
+
+    /**
+     * @group oembed
+     * @ticket 35567
+     */
+    public function test_register_post_type_override_is_embeddable() {
+        $post_type = register_post_type( $this->post_type, array( 'embeddable' => true ) );
+        $this->assertTrue( $post_type->embeddable, 'Post type should be embeddable even though it is not public' );
+
+        $post_type = register_post_type(
+            $this->post_type,
+            array(
+                'public'     => true,
+                'embeddable' => false,
+            )
+        );
+        $this->assertFalse( $post_type->embeddable, 'Post type should not be embeddable even though it is public' );
+    }
 }