Documentation

    Function generateHeader

    • Generates a POT header for a given set of arguments. https://developer.wordpress.org/cli/commands/i18n/make-pot/ String that should be added as a comment to the top of the resulting POT file. By default, a copyright comment is added for WordPress plugins and themes in the following manner: Copyright (C) 2018 Example Plugin Author This file is distributed under the same license as the Example Plugin package. If a plugin or theme specifies a license in their main plugin file or stylesheet, the comment looks like this: Copyright (C) 2018 Example Plugin Author This file is distributed under the GPLv2.

      Parameters

      • args: Args

        The argument object containing the headers and their values.

      Returns Promise<
          | null
          | {
              "Content-Transfer-Encoding": string;
              "content-type": string;
              Language: string;
              "Language-Team": string;
              "Last-Translator": string;
              "MIME-Version": string;
              "plural-forms": string;
              "PO-Revision-Date": string;
              "POT-Creation-Date": string;
              "Project-Id-Version": string;
              "Report-Msgid-Bugs-To": string;
              "X-Generator": string;
          },
      >

      The generated POT header.

    MMNEPVFCICPMFPCPTTAAATR