Changeset 57120 for trunk/src/wp-includes/blocks.php

Timestamp:

11/17/2023 01:27:23 PM (19 months ago)

Author:

SergeyBiryukov

Message:

Docs: Improve some DocBlocks and inline comments per the documentation standards.

Follow-up to [56834], [56836], [56837], [56838].

Props kebbet, costdev, mukesh27, SergeyBiryukov.
See #59651.

File:

• trunk/src/wp-includes/blocks.php (modified) (7 diffs)

trunk/src/wp-includes/blocks.php

@@ -1972 +1972 @@
 /**
  * Strips all HTML from the content of footnotes, and sanitizes the ID.
+ *
  * This function expects slashed data on the footnotes content.
  *
@@ -1977 +1978 @@
  * @since 6.3.2
  *
- * @param string $footnotes JSON encoded string of an array containing the content and ID of each footnote.
- * @return string Filtered content without any HTML on the footnote content and with the sanitized id.
+ * @param string $footnotes JSON-encoded string of an array containing the content and ID of each footnote.
+ * @return string Filtered content without any HTML on the footnote content and with the sanitized ID.
  */
 function _wp_filter_post_meta_footnotes( $footnotes ) {
@@ -1998 +1999 @@
 
 /**
- * Adds the filters to filter footnotes meta field.
+ * Adds the filters for footnotes meta field.
  *
  * @access private
@@ -2008 +2009 @@
 
 /**
- * Removes the filters that filter footnotes meta field.
+ * Removes the filters for footnotes meta field.
  *
  * @access private
@@ -2018 +2019 @@
 
 /**
- * Registers the filter of footnotes meta field if the user does not have unfiltered_html capability.
+ * Registers the filter of footnotes meta field if the user does not have `unfiltered_html` capability.
  *
  * @access private
@@ -2031 +2032 @@
 
 /**
- * Initializes footnotes meta field filters when imported data should be filtered.
- *
- * This filter is the last being executed on force_filtered_html_on_import.
- * If the input of the filter is true it means we are in an import situation and should
- * enable kses, independently of the user capabilities.
- * So in that case we call _wp_footnotes_kses_init_filters;
+ * Initializes the filters for footnotes meta field when imported data should be filtered.
+ *
+ * This filter is the last one being executed on {@see 'force_filtered_html_on_import'}.
+ * If the input of the filter is true, it means we are in an import situation and should
+ * enable kses, independently of the user capabilities. So in that case we call
+ * _wp_footnotes_kses_init_filters().
  *
  * @access private
@@ -2045 +2046 @@
  */
 function _wp_footnotes_force_filtered_html_on_import_filter( $arg ) {
-    // force_filtered_html_on_import is true we need to init the global styles kses filters.
+    // If `force_filtered_html_on_import` is true, we need to init the global styles kses filters.
     if ( $arg ) {
         _wp_footnotes_kses_init_filters();