Code style and documentation for HTML import

Author: rask

README.md

@@ -215,20 +215,21 @@ Sometimes a project might require static forms which are not supposed to
 be editable in the admin panel.
 
 This plugin allows you to define HTML forms in your project source code
-and import them into the form admin.
+and import them into the form admin for specific forms.
 
 ### Creating a static HTML template
 
 Importable forms are defined using standard HTML5 templates, meaning
-files ending in `.html`.
+files ending in `.html`. The template can contain anything the regular
+WPLF form edit view can.
 
 You can create your templates in a theme, a plugin, or anywhere where
 the plugin can read files.
 
-### Importing a template into wp-libre-form
+### Importing a template into WPLF
 
 Once you're done creating a form template, you need to inform
-wp-libre-form about it. You can use the `wplf_register_html_template`
+WPLF about it. You can use the `wplf_import_html_template`
 filter hook for this:
 
 ```php
@@ -237,7 +238,7 @@ filter hook for this:
 add_filter( 'wplf_import_html_template', function ($template, $form_id) {
     $some_form_id = 123;
 
-    if ($form_id = $some_form_id) {
+    if ($form_id === $some_form_id) {
         return '/path/to/template/file.html';
     }
 

classes/class-cpt-wplf-form.php

@@ -488,15 +488,15 @@ function maybe_load_imported_template( $post_type, $post ) {
      */
     $template_path = apply_filters( 'wplf_import_html_template', null, $form_id );
 
-    if ($template_path === null) {
+    if ( $template_path === null ) {
       return;
     }
 
     $this->override_form_template( $template_path, $form_id );
   }
 
   /**
-   * Override a forms template with an imported template file.
+   * Override a form's template with an imported template file.
    *
    * @param string $template_path Absolute path to template HTML file.
    * @param int $form_id ID of form we're overriding the template for.
@@ -513,44 +513,52 @@ protected function override_form_template( $template_path, $form_id ) {
      * @param string $contents The form HTML.
      * @param int $form_id ID of form we are importing a template for.
      */
-    $contents = apply_filters( 'wplf_imported_html_template_contents', $contents, $form_id );
+    $template_contents = apply_filters( 'wplf_imported_html_template_contents', $contents, $form_id );
 
     // Make the editor textarea uneditable. Also remove TinyMCE.
     add_filter( 'the_editor', function ( $editor ) {
-        if (!preg_match('%id="wp-content-editor-container"%', $editor)) {
+        if ( ! preg_match( '%id="wp-content-editor-container"%', $editor ) ) {
             return $editor;
         }
 
         $editor = preg_replace( '%\<textarea %', '<textarea readonly="readonly" ', $editor );
 
-        $editor = preg_replace( '%<div [^<>]*? class="quicktags-toolbar">.*?</div><textarea%imux', '<textarea', $editor );
+        $editor = preg_replace(
+          '%<div [^<>]*? class="quicktags-toolbar">.*?</div><textarea%imux',
+          '<textarea',
+          $editor
+        );
 
         return $editor;
     } );
 
     // Replace all editor content with template content.
-    add_filter( 'the_editor_content', function ( $content ) use ( $contents ) {
-        return $contents;
+    add_filter( 'the_editor_content', function ( $content ) use ( $template_contents ) {
+        return $template_contents;
     } );
 
     // Add a notice about the override.
     add_action( 'edit_form_after_title', function () use ( $template_path ) {
-        $printable_path = explode(DIRECTORY_SEPARATOR, $template_path);
-
-        if (count($printable_path) < 4) {
-            $printable_path = implode(DIRECTORY_SEPARATOR, $template_path);
-        } else {
-            $printable_path = array_reverse(array_slice(array_reverse($printable_path), 0, 4));
+      $printable_path = explode( DIRECTORY_SEPARATOR, $template_path );
 
-            $printable_path = '..' . DIRECTORY_SEPARATOR . implode(DIRECTORY_SEPARATOR, $printable_path);
-        }
+      // We may not want the full system path to be shown, 4 parent directories oughta suffice.
+      if ( count( $printable_path ) < 4 ) {
+        $printable_path = implode( DIRECTORY_SEPARATOR, $printable_path );
+      } else {
+        $printable_path = array_reverse( array_slice( array_reverse( $printable_path ), 0, 4 ) );
+        $printable_path = '..' . DIRECTORY_SEPARATOR . implode( DIRECTORY_SEPARATOR, $printable_path );
+      }
 
-        $notice = sprintf(
-            __( 'This form template is being overridden by code, the template being used is<br> <code>%s</code>', 'wplf' ),
-            $printable_path
-        );
+      $notice = sprintf(
+        _x(
+          'This form template is being overridden by code, the template being used is<br> <code>%s</code>',
+          'Template override notice in form edit admin view',
+          'wp-libre-form'
+        ),
+        $printable_path
+      );
 
-        printf('<p>%s</p>', $notice);
+      printf( '<p>%s</p>', $notice );
     } );
   }