Changeset 47101

Timestamp:

01/22/2020 12:23:09 AM (5 years ago)

Author:

SergeyBiryukov

Message:

Docs: Adjust documentation for some pre_* filters for consistency.

See #48303.

Location:

trunk/src/wp-includes

Files:

• class-wp-network.php (modified) (1 diff)
• class-wp-oembed.php (modified) (1 diff)
• ms-load.php (modified) (1 diff)
• ms-site.php (modified) (1 diff)
• user.php (modified) (1 diff)

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

@@ -408 +408 @@
          * @since 3.9.0
          *
-         * @param null|bool|WP_Network $network  Network value to return by path.
+         * @param null|bool|WP_Network $network  Network value to return by path. Default null
+         *                                       to continue retrieving the network.
          * @param string               $domain   The requested domain.
          * @param string               $path     The requested path, in full.

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

@@ -385 +385 @@
          * @since 4.5.3
          *
-         * @param null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed. Default null.
+         * @param null|string $result The UNSANITIZED (and potentially unsafe) HTML that should be used to embed.
+         *                            Default null to continue retrieving the result.
          * @param string      $url    The URL to the content that should be attempted to be embedded.
          * @param array       $args   Optional. Arguments, usually passed from a shortcode. Default empty.

trunk/src/wp-includes/ms-load.php

@@ -204 +204 @@
      * @since 3.9.0
      *
-     * @param null|false|WP_Site $site     Site value to return by path.
+     * @param null|false|WP_Site $site     Site value to return by path. Default null
+     *                                     to continue retrieving the site.
      * @param string             $domain   The requested domain.
      * @param string             $path     The requested path, in full.

trunk/src/wp-includes/ms-site.php

@@ -933 +933 @@
      * @since 5.1.0
      *
-     * @param bool|null $pre     The value to return, if not null.
+     * @param bool|null $pre     The value to return instead. Default null
+     *                           to continue with the check.
      * @param int       $site_id The site ID that is being checked.
      */

trunk/src/wp-includes/user.php

@@ -887 +887 @@
      * @since 5.1.0
      *
-     * @param null|string $result   Default null.
+     * @param null|string $result   The value to return instead. Default null to continue with the query.
      * @param string      $strategy Optional. The computational strategy to use when counting the users.
      *                              Accepts either 'time' or 'memory'. Default 'time'.