Changeset 45694

Timestamp:

07/28/2019 04:30:46 PM (7 years ago)

Author:

SergeyBiryukov

Message:

Rewrite Rules: Add a comment to # BEGIN/END .htaccess markers to clarify that the directives are dynamically generated, and should only be modified via WordPress filters.

Introduce insert_with_markers_inline_instructions filter to modify the default instructions text.

Props bradleyt, SergeyBiryukov.
Fixes #47466.

File:

• trunk/src/wp-admin/includes/misc.php (modified) (2 diffs)

trunk/src/wp-admin/includes/misc.php

@@ -80 +80 @@
                 }
                 if ( $state ) {
+                        if ( '#' === substr( $markerline, 0, 1 ) ) {
+                                continue;
+                        }
                         $result[] = $markerline;
                 }
@@ -119 +122 @@
                 $insertion = explode( "\n", $insertion );
         }
+
+        $switched_locale = switch_to_locale( get_locale() );
+
+        $instructions = sprintf(
+                /* translators: 1: marker */
+                __( 'The directives (lines) between `BEGIN %1$s` and `END %1$s` are
+dynamically generated, and should only be modified via WordPress filters.
+Any changes to the directives between these markers will be overwritten.' ),
+                $marker
+        );
+
+        $instructions = explode( "\n", $instructions );
+        foreach ( $instructions as $line => $text ) {
+                $instructions[ $line ] = '# ' . $text;
+        }
+
+        /**
+         * Filters the inline instructions inserted before the dynamically generated content.
+         *
+         * @since 5.3.0
+         *
+         * @param string[] $instructions Array of lines with inline instructions.
+         * @param string   $marker       The marker being inserted.
+         */
+        $instructions = apply_filters( 'insert_with_markers_inline_instructions', $instructions, $marker );
+
+        if ( $switched_locale ) {
+                restore_previous_locale();
+        }
+
+        $insertion = array_merge( $instructions, $insertion );
 
         $start_marker = "# BEGIN {$marker}";