Changeset 51024

Timestamp:

05/26/2021 01:46:10 AM (2 years ago)

Author:

desrosj

Message:

General: Pass the scheme to the *_url filters.

This adds an additional $scheme parameter to the following URL related filters:

• admin_url.
• includes_url.
• network_admin_url.
• user_admin_url.

Props johnbillion, SergeyBiryukov, desrosj.
Fixes #52813.

File:

• trunk/src/wp-includes/link-template.php (modified) (4 diffs)

trunk/src/wp-includes/link-template.php

@@ -3430 +3430 @@
      *
      * @since 2.8.0
-     *
-     * @param string   $url     The complete admin area URL including scheme and path.
-     * @param string   $path    Path relative to the admin area URL. Blank string if no path is specified.
-     * @param int|null $blog_id Site ID, or null for the current site.
-     */
-    return apply_filters( 'admin_url', $url, $path, $blog_id );
+     * @since 5.8.0 The `$scheme` parameter was added.
+     *
+     * @param string      $url     The complete admin area URL including scheme and path.
+     * @param string      $path    Path relative to the admin area URL. Blank string if no path is specified.
+     * @param int|null    $blog_id Site ID, or null for the current site.
+     * @param string|null $scheme  The scheme to use. Accepts 'http', 'https',
+     *                             'admin', or null. Default 'admin', which obeys force_ssl_admin() and is_ssl().
+     */
+    return apply_filters( 'admin_url', $url, $path, $blog_id, $scheme );
 }
 
@@ -3459 +3462 @@
      *
      * @since 2.8.0
-     *
-     * @param string $url  The complete URL to the includes directory including scheme and path.
-     * @param string $path Path relative to the URL to the wp-includes directory. Blank string
-     *                     if no path is specified.
-     */
-    return apply_filters( 'includes_url', $url, $path );
+     * @since 5.8.0 The `$scheme` parameter was added.
+     *
+     * @param string      $url    The complete URL to the includes directory including scheme and path.
+     * @param string      $path   Path relative to the URL to the wp-includes directory. Blank string
+     *                            if no path is specified.
+     * @param string|null $scheme Scheme to give the includes URL context. Accepts
+     *                            'http', 'https', 'relative', or null. Default null.
+     */
+    return apply_filters( 'includes_url', $url, $path, $scheme );
 }
 
@@ -3669 +3675 @@
      *
      * @since 3.0.0
-     *
-     * @param string $url  The complete network admin URL including scheme and path.
-     * @param string $path Path relative to the network admin URL. Blank string if
-     *                     no path is specified.
-     */
-    return apply_filters( 'network_admin_url', $url, $path );
+     * @since 5.8.0 The `$scheme` parameter was added.
+     *
+     * @param string      $url    The complete network admin URL including scheme and path.
+     * @param string      $path   Path relative to the network admin URL. Blank string if
+     *                            no path is specified.
+     * @param string|null $scheme The scheme to use. Accepts 'http', 'https',
+     *                            'admin', or null. Default is 'admin', which obeys force_ssl_admin() and is_ssl().
+     */
+    return apply_filters( 'network_admin_url', $url, $path, $scheme );
 }
 
@@ -3698 +3707 @@
      *
      * @since 3.1.0
-     *
-     * @param string $url  The complete URL including scheme and path.
-     * @param string $path Path relative to the URL. Blank string if
-     *                     no path is specified.
-     */
-    return apply_filters( 'user_admin_url', $url, $path );
+     * @since 5.8.0 The `$scheme` parameter was added.
+     *
+     * @param string      $url    The complete URL including scheme and path.
+     * @param string      $path   Path relative to the URL. Blank string if
+     *                            no path is specified.
+     * @param string|null $scheme The scheme to use. Accepts 'http', 'https',
+     *                            'admin', or null. Default is 'admin', which obeys force_ssl_admin() and is_ssl().
+     */
+    return apply_filters( 'user_admin_url', $url, $path, $scheme );
 }