Changeset 53933

Timestamp:

08/23/2022 05:46:46 PM (2 years ago)

Author:

SergeyBiryukov

Message:

Themes: Add support for Update URI header.

This allows third-party themes to avoid accidentally being overwritten with an update of a theme of a similar name from the WordPress.org Theme Directory.

Additionally, introduce the update_themes_{$hostname} filter, which third-party themes can use to offer updates for a given hostname.

If set, the Update URI header field should be a URI and have a unique hostname.

Some examples include:

• https://wordpress.org/themes/example-theme/
• https://example.com/my-theme/
• my-custom-theme-name

Update URI: false also works, and unless there is code handling the false hostname, the theme will never get an update notification.

If the header is present, the WordPress.org API will currently only return updates for the theme if it matches the following format:

• https://wordpress.org/themes/{$slug}/
• w.org/theme/{$slug}

If the header has any other value, the API will not return a result and will ignore the theme for update purposes.

Follow-up to [50921].

Props dd32, meloniq, costdev, audrasjb, DavidAnderson, markjaquith, DrewAPicture, mweichert, design_dolphin, filosofo, sean212, nhuja, JeroenReumkens, infolu, dingdang, joyously, earnjam, williampatton, grapplerulrich, markparnell, apedog, afragen, miqrogroove, rmccue, crazycoders, jdgrimes, damonganto, joostdevalk, jorbin, georgestephanis, khromov, GeekStreetWP, jb510, Rarst, juliobox, Ipstenu, mikejolley, Otto42, gMagicScott, TJNowell, GaryJ, knutsp, mordauk, nvartolomei, aspexi, chriscct7, benoitchantre, ryno267, lev0, gregorlove, dougwollison, leemon, SergeyBiryukov.
See #14179, #23318, #32101.

Location:

trunk

Files:

• src/wp-includes/class-wp-theme.php (modified) (4 diffs)
• src/wp-includes/update.php (modified) (3 diffs)
• tests/phpunit/data/themedir1/update-uri-theme (added)
• tests/phpunit/data/themedir1/update-uri-theme/index.php (added)
• tests/phpunit/data/themedir1/update-uri-theme/style.css (added)
• tests/phpunit/tests/theme/themeDir.php (modified) (1 diff)
• tests/phpunit/tests/theme/wpTheme.php (modified) (1 diff)

trunk/src/wp-includes/class-wp-theme.php

@@ -24 +24 @@
      * @since 3.4.0
      * @since 5.4.0 Added `Requires at least` and `Requires PHP` headers.
+
      * @var string[]
      */
@@ -40 +41 @@
         'RequiresWP'  => 'Requires at least',
         'RequiresPHP' => 'Requires PHP',
+
     );
 
@@ -845 +847 @@
      * @since 3.4.0
      * @since 5.4.0 Added support for `Requires at least` and `Requires PHP` headers.
+
      *
      * @param string $header Theme header. Accepts 'Name', 'Description', 'Author', 'Version',
-     *                       'ThemeURI', 'AuthorURI', 'Status', 'Tags', 'RequiresWP', 'RequiresPHP'.
+     *                       'ThemeURI', 'AuthorURI', 'Status', 'Tags', 'RequiresWP', 'RequiresPHP',
+     *                       'UpdateURI'.
      * @param string $value  Value to sanitize.
      * @return string|array An array for Tags header, string otherwise.
@@ -897 +901 @@
             case 'RequiresWP':
             case 'RequiresPHP':
+
                 $value = strip_tags( $value );
                 break;

trunk/src/wp-includes/update.php

@@ -506 +506 @@
          * @param array       $plugin_data      Plugin headers.
          * @param string      $plugin_file      Plugin filename.
-         * @param array       $locales          Installed locales to look translations for.
+         * @param array       $locales          Installed locales to look translations for.
          */
         $update = apply_filters( "update_plugins_{$hostname}", false, $plugin_data, $plugin_file, $locales );
@@ -614 +614 @@
             'Author'     => $theme->get( 'Author' ),
             'Author URI' => $theme->get( 'AuthorURI' ),
+
             'Template'   => $theme->get_template(),
             'Stylesheet' => $theme->get_stylesheet(),
@@ -745 +746 @@
     }
 
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
     set_site_transient( 'update_themes', $new_update );
 }

trunk/tests/phpunit/tests/theme/themeDir.php

@@ -183 +183 @@
             'Webfonts theme',
             'Empty `fontFace` in theme.json - no webfonts defined',
+
         );
 

trunk/tests/phpunit/tests/theme/wpTheme.php

@@ -406 +406 @@
         );
     }
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
 }