From 6d8232b69d353466432d4996961ef6fba30a528c Mon Sep 17 00:00:00 2001 From: Rumperuu Date: Mon, 26 Apr 2021 23:06:10 +0100 Subject: [PATCH] docs: update documentation --- docs/classes/Footnotes-Activator.html | 244 ++++ docs/classes/Footnotes-Admin.html | 652 +++++++++++ docs/classes/Footnotes-Config.html | 33 +- docs/classes/Footnotes-Convert.html | 35 +- docs/classes/Footnotes-Deactivator.html | 244 ++++ docs/classes/Footnotes-Layout-Engine.html | 131 ++- docs/classes/Footnotes-Layout-Init.html | 51 +- docs/classes/Footnotes-Layout-Settings.html | 229 ++-- docs/classes/Footnotes-Loader.html | 823 ++++++++++++++ docs/classes/Footnotes-Public.html | 895 +++++++++++++++ docs/classes/Footnotes-Settings.html | 495 ++++---- docs/classes/Footnotes-Task.html | 223 ++-- docs/classes/Footnotes-Template.html | 59 +- docs/classes/Footnotes-WYSIWYG.html | 43 +- docs/classes/Footnotes-Widget-Base.html | 31 +- .../Footnotes-Widget-Reference-Container.html | 47 +- docs/classes/Footnotes-i18n.html | 264 +++++ docs/classes/Footnotes.html | 1002 ++++++++--------- .../src-admin-class-footnotes-admin.html | 131 +++ .../src-admin-class-footnotes-wysiwyg.html | 131 +++ docs/files/src-admin-index.html | 119 ++ ...-layout-class-footnotes-layout-engine.html | 130 +++ ...in-layout-class-footnotes-layout-init.html | 130 +++ ...ayout-class-footnotes-layout-settings.html | 130 +++ docs/files/src-footnotes.html | 141 ++- ...rc-includes-class-footnotes-activator.html | 131 +++ .../src-includes-class-footnotes-config.html | 130 +++ .../src-includes-class-footnotes-convert.html | 130 +++ ...-includes-class-footnotes-deactivator.html | 131 +++ .../src-includes-class-footnotes-i18n.html | 131 +++ .../src-includes-class-footnotes-loader.html | 131 +++ ...src-includes-class-footnotes-settings.html | 130 +++ ...src-includes-class-footnotes-template.html | 130 +++ docs/files/src-includes-class-footnotes.html | 131 +++ docs/files/src-includes-index.html | 119 ++ docs/files/src-index.html | 119 ++ .../src-public-class-footnotes-public.html | 131 +++ .../src-public-class-footnotes-task.html | 130 +++ docs/files/src-public-index.html | 119 ++ ...ic-widget-class-footnotes-widget-base.html | 130 +++ ...-footnotes-widget-reference-container.html | 130 +++ docs/files/src-uninstall.html | 119 ++ docs/graphs/classes.html | 13 +- docs/index.html | 172 ++- docs/indices/files.html | 77 +- docs/js/searchIndex.js | 715 +++++++----- docs/namespaces/default.html | 161 ++- docs/packages/Default.html | 117 ++ docs/packages/default.html | 14 +- docs/packages/footnotes-footnotesadmin.html | 129 +++ .../packages/footnotes-footnotesincludes.html | 137 +++ docs/packages/footnotes-footnotespublic.html | 129 +++ docs/packages/footnotes.html | 151 ++- docs/reports/deprecated.html | 13 +- docs/reports/errors.html | 43 +- docs/reports/markers.html | 13 +- 56 files changed, 8846 insertions(+), 1623 deletions(-) create mode 100644 docs/classes/Footnotes-Activator.html create mode 100644 docs/classes/Footnotes-Admin.html create mode 100644 docs/classes/Footnotes-Deactivator.html create mode 100644 docs/classes/Footnotes-Loader.html create mode 100644 docs/classes/Footnotes-Public.html create mode 100644 docs/classes/Footnotes-i18n.html create mode 100644 docs/files/src-admin-class-footnotes-admin.html create mode 100644 docs/files/src-admin-class-footnotes-wysiwyg.html create mode 100644 docs/files/src-admin-index.html create mode 100644 docs/files/src-admin-layout-class-footnotes-layout-engine.html create mode 100644 docs/files/src-admin-layout-class-footnotes-layout-init.html create mode 100644 docs/files/src-admin-layout-class-footnotes-layout-settings.html create mode 100644 docs/files/src-includes-class-footnotes-activator.html create mode 100644 docs/files/src-includes-class-footnotes-config.html create mode 100644 docs/files/src-includes-class-footnotes-convert.html create mode 100644 docs/files/src-includes-class-footnotes-deactivator.html create mode 100644 docs/files/src-includes-class-footnotes-i18n.html create mode 100644 docs/files/src-includes-class-footnotes-loader.html create mode 100644 docs/files/src-includes-class-footnotes-settings.html create mode 100644 docs/files/src-includes-class-footnotes-template.html create mode 100644 docs/files/src-includes-class-footnotes.html create mode 100644 docs/files/src-includes-index.html create mode 100644 docs/files/src-index.html create mode 100644 docs/files/src-public-class-footnotes-public.html create mode 100644 docs/files/src-public-class-footnotes-task.html create mode 100644 docs/files/src-public-index.html create mode 100644 docs/files/src-public-widget-class-footnotes-widget-base.html create mode 100644 docs/files/src-public-widget-class-footnotes-widget-reference-container.html create mode 100644 docs/files/src-uninstall.html create mode 100644 docs/packages/Default.html create mode 100644 docs/packages/footnotes-footnotesadmin.html create mode 100644 docs/packages/footnotes-footnotesincludes.html create mode 100644 docs/packages/footnotes-footnotespublic.html diff --git a/docs/classes/Footnotes-Activator.html b/docs/classes/Footnotes-Activator.html new file mode 100644 index 0000000..5dff791 --- /dev/null +++ b/docs/classes/Footnotes-Activator.html @@ -0,0 +1,244 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
+

Documentation

+ + +
+ +
+ + +
+ +
+
+ + + + +
+ + +
+

+ Footnotes_Activator + + +
+ in package + +
+ + +

+ + + +

Fired during plugin activation.

+ +

This class defines all code necessary to run during the plugin's activation.

+
+ + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ subpackage +
+
+ +

footnotes/includes

+
+ +
+
+ + + + + + +

+ Table of Contents + +

+ +
+
+ activate() + +  : mixed +
+
Runs when the Plugin is deactivated.
+ +
+ + + + + + + +
+

+ Methods + +

+
+

+ activate() + +

+ + +

Runs when the Plugin is deactivated.

+ + + public + static activate() : mixed + +

Currently NOP.

+
+ + + +
+ Tags + +
+
+
+ since +
+
+ 2.8.0 + +
+ +
+
+ +
Return values
+ mixed + — +
+ + +
+
+ +
+
+
+
+

Search results

+ +
+
+
    +
    +
    +
    +
    +
    + + +
    + + + + diff --git a/docs/classes/Footnotes-Admin.html b/docs/classes/Footnotes-Admin.html new file mode 100644 index 0000000..85b55d7 --- /dev/null +++ b/docs/classes/Footnotes-Admin.html @@ -0,0 +1,652 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
    +

    Documentation

    + + +
    + +
    + + +
    + +
    +
    + + + + +
    + + +
    +

    + Footnotes_Admin + + +
    + in package + +
    + + +

    + + + +

    The admin-specific functionality of the plugin.

    + +

    Defines the plugin name, version, and enqueues all admin-specific stylesheets +and JavaScript.

    +
    + + +
    + Tags + +
    +
    +
    + subpackage +
    +
    + +

    footnotes/admin

    +
    + +
    +
    + + + + + + +

    + Table of Contents + +

    + +
    +
    + $plugin_name + +  : string +
    +
    The ID of this plugin.
    + +
    + $version + +  : string +
    +
    The version of this plugin.
    + +
    + __construct() + +  : mixed +
    +
    Initialize the class and set its properties.
    + +
    + enqueue_scripts() + +  : mixed +
    +
    Register the JavaScript for the admin area.
    + +
    + enqueue_styles() + +  : mixed +
    +
    Register the stylesheets for the admin area.
    + +
    + get_plugin_links() + +  : array<string|int, string> +
    +
    Appends the Plugin links for display in the dashboard Plugins page.
    + +
    + load_dependencies() + +  : mixed +
    +
    Load the required admin-specific dependencies.
    + +
    + + + + + + +
    +

    + Properties + +

    +
    +

    + $plugin_name + + + +

    + + +

    The ID of this plugin.

    + + + private + string + $plugin_name + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.8.0 + +
    + +
    +
    + access +
    +
    + +

    private

    +
    + +
    +
    + +
    +
    +

    + $version + + + +

    + + +

    The version of this plugin.

    + + + private + string + $version + + +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.8.0 + +
    + +
    +
    + access +
    +
    + +

    private

    +
    + +
    +
    + +
    +
    + +
    +

    + Methods + +

    +
    +

    + __construct() + +

    + + +

    Initialize the class and set its properties.

    + + + public + __construct(string $plugin_name, string $version) : mixed + +
    + +
    Parameters
    +
    +
    + $plugin_name + : string +
    +
    +

    The name of this plugin.

    +
    + +
    +
    + $version + : string +
    +
    +

    The version of this plugin.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.8.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + enqueue_scripts() + +

    + + +

    Register the JavaScript for the admin area.

    + + + public + enqueue_scripts() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.8.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + enqueue_styles() + +

    + + +

    Register the stylesheets for the admin area.

    + + + public + enqueue_styles() : mixed + +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.8.0 + +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    +

    + get_plugin_links() + +

    + + +

    Appends the Plugin links for display in the dashboard Plugins page.

    + + + public + static get_plugin_links(array<string|int, mixed> $plugin_links) : array<string|int, string> + +
    + +
    Parameters
    +
    +
    + $plugin_links + : array<string|int, mixed> +
    +
    +

    The WP-default set of links to display.

    +
    + +
    +
    + + +
    + Tags + +
    +
    +
    + since +
    +
    + 1.5.0 + +
    + +
    +
    + since +
    +
    + 2.8.0 + +

    Moved into Footnote_Admin class.

    +
    + +
    +
    + +
    Return values
    + array<string|int, string> + — +

    The full set of links to display.

    +
    + + +
    +
    +

    + load_dependencies() + +

    + + +

    Load the required admin-specific dependencies.

    + + + private + load_dependencies() : mixed + +

    Include the following files that provide the admin-specific functionality +of this plugin:

    +
      +
    • +Footnotes_WYSIWYG. TODO
      • +
    • +Footnotes_Layout_Settings. TODO
      • +
    +
    + + + +
    + Tags + +
    +
    +
    + since +
    +
    + 2.8.0 + +
    + +
    +
    + access +
    +
    + +

    private

    +
    + +
    +
    + +
    Return values
    + mixed + — +
    + + +
    +
    + +
    +
    +
    +
    +

    Search results

    + +
    +
    +
      +
      +
      +
      +
      +
      + + +
      + + + + diff --git a/docs/classes/Footnotes-Config.html b/docs/classes/Footnotes-Config.html index 50a827d..c96b051 100644 --- a/docs/classes/Footnotes-Config.html +++ b/docs/classes/Footnotes-Config.html @@ -51,9 +51,18 @@

      Namespaces

      -

      Global

      -
      + +
      +

      Packages

      +

      footnotes

      + +

      Default

      +

      Reports

      @@ -78,12 +87,18 @@ Footnotes_Config +
      + in package + +
      @@ -179,7 +194,7 @@ @@ -221,7 +236,7 @@ @@ -263,7 +278,7 @@ @@ -305,7 +320,7 @@ @@ -352,7 +367,7 @@ that isn’t translated, and dropping the logo in another, translatable heading. @@ -394,7 +409,7 @@ that isn’t translated, and dropping the logo in another, translatable heading. diff --git a/docs/classes/Footnotes-Convert.html b/docs/classes/Footnotes-Convert.html index 7cfd36b..70b4c6d 100644 --- a/docs/classes/Footnotes-Convert.html +++ b/docs/classes/Footnotes-Convert.html @@ -51,9 +51,18 @@

      Namespaces

      -

      Global

      -
      +
      +
      +

      Packages

      +

      footnotes

      + +

      Default

      +

      Reports

      @@ -78,12 +87,18 @@ Footnotes_Convert +
      + in package + +
      @@ -193,7 +208,7 @@ @@ -254,7 +269,7 @@ @@ -316,7 +331,7 @@ @@ -398,7 +413,7 @@ @@ -460,7 +475,7 @@ @@ -522,7 +537,7 @@ @@ -593,7 +608,7 @@ diff --git a/docs/classes/Footnotes-Deactivator.html b/docs/classes/Footnotes-Deactivator.html new file mode 100644 index 0000000..d25fc4e --- /dev/null +++ b/docs/classes/Footnotes-Deactivator.html @@ -0,0 +1,244 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
      +

      Documentation

      + + +
      + +
      + + +
      + +
      +
      + + + + +
      + + +
      +

      + Footnotes_Deactivator + + +
      + in package + +
      + + +

      + + + +

      Fired during plugin deactivation.

      + +

      This class defines all code necessary to run during the plugin's deactivation.

      +
      + + +
      + Tags + +
      +
      +
      + since +
      +
      + 2.8.0 + +
      + +
      +
      + subpackage +
      +
      + +

      footnotes/includes

      +
      + +
      +
      + + + + + + +

      + Table of Contents + +

      + +
      +
      + deactivate() + +  : mixed +
      +
      Runs when the Plugin is deactivated.
      + +
      + + + + + + + +
      +

      + Methods + +

      +
      +

      + deactivate() + +

      + + +

      Runs when the Plugin is deactivated.

      + + + public + static deactivate() : mixed + +

      Currently NOP.

      +
      + + + +
      + Tags + +
      +
      +
      + since +
      +
      + 2.8.0 + +
      + +
      +
      + +
      Return values
      + mixed + — +
      + + +
      +
      + +
      +
      +
      +
      +

      Search results

      + +
      +
      +
        +
        +
        +
        +
        +
        + + +
        + + + + diff --git a/docs/classes/Footnotes-Layout-Engine.html b/docs/classes/Footnotes-Layout-Engine.html index e632707..0f717e2 100644 --- a/docs/classes/Footnotes-Layout-Engine.html +++ b/docs/classes/Footnotes-Layout-Engine.html @@ -51,9 +51,18 @@

        Namespaces

        -

        Global

        -
        +
        +
        +

        Packages

        +

        footnotes

        + +

        Default

        +

        Reports

        @@ -78,14 +87,20 @@ Footnotes_Layout_Engine +
        + in package + +

        Layout Engine for the administration dashboard.

        @@ -335,9 +350,9 @@

        Stores all Sections for the child sub page.

        @@ -382,9 +397,9 @@

        Stores the Hook connection string for the child sub page.

        @@ -434,9 +449,9 @@ ull

        Output the Description of a section. May be overwritten in any section.

        @@ -483,9 +498,9 @@ ull

        Displays the content of specific sub page.

        @@ -532,9 +547,9 @@ ull

        Returns a Priority index. Lower numbers have a higher Priority.

        @@ -581,9 +596,9 @@ ull

        Registers all sections for a sub page.

        @@ -630,9 +645,9 @@ ull

        Registers a sub page.

        @@ -679,9 +694,9 @@ ull

        Returns the html tag for an input [type = checkbox].

        @@ -740,9 +755,9 @@ ull

        Returns the html tag for an input [type = text] with color selection class.

        @@ -801,9 +816,9 @@ ull

        Returns the html tag for an input/select label.

        @@ -871,9 +886,9 @@ ull

        Returns a line break to have a space between two lines.

        @@ -920,9 +935,9 @@ ull

        Returns an array describing a meta box.

        @@ -1009,9 +1024,9 @@ ull

        Returns a line break to start a new line.

        @@ -1058,9 +1073,9 @@ ull

        Returns the html tag for an input [type = num].

        @@ -1157,9 +1172,9 @@ ull

        Returns an array describing a sub page section.

        @@ -1246,9 +1261,9 @@ ull

        Returns the html tag for a select box.

        @@ -1357,9 +1372,9 @@ ull

        Returns a simple text inside html <span> text.

        @@ -1418,9 +1433,9 @@ ull

        Returns the html tag for an input [type = text].

        @@ -1506,9 +1521,9 @@ ull

        Returns the html tag for a text area.

        @@ -1567,9 +1582,9 @@ ull

        Returns an array of all registered meta boxes.

        @@ -1616,9 +1631,9 @@ ull

        Returns an array of all registered sections for a sub page.

        @@ -1665,9 +1680,9 @@ ull

        Returns the unique slug of the child sub page.

        @@ -1714,9 +1729,9 @@ ull

        Returns the title of the child sub page.

        @@ -1763,9 +1778,9 @@ ull

        Loads specific setting and returns an array with the keys [id, name, value].

        @@ -1891,9 +1906,9 @@ Removing this did not fix the quotation mark backslash escapement bug.

        Append javascript and css files for specific sub page.

        @@ -1940,9 +1955,9 @@ Removing this did not fix the quotation mark backslash escapement bug.

        Registers all Meta boxes for a sub page.

        @@ -2001,9 +2016,9 @@ Removing this did not fix the quotation mark backslash escapement bug.

        Save all Plugin settings.

        diff --git a/docs/classes/Footnotes-Layout-Init.html b/docs/classes/Footnotes-Layout-Init.html index ec5f7e4..75bcd0f 100644 --- a/docs/classes/Footnotes-Layout-Init.html +++ b/docs/classes/Footnotes-Layout-Init.html @@ -51,9 +51,18 @@

        Namespaces

        -

        Global

        -
        +
        +
        +

        Packages

        +

        footnotes

        + +

        Default

        +

        Reports

        @@ -78,14 +87,20 @@ Footnotes_Layout_Init +
        + in package + +

        Handles the Settings interface of the Plugin.

        @@ -186,9 +201,9 @@

        Slug for the Plugin main menu.

        @@ -228,9 +243,9 @@

        Plugin main menu name.

        @@ -285,9 +300,9 @@

        Contains the settings layoutEngine

        @@ -336,9 +351,9 @@

        Class Constructor. Initializes all WordPress hooks for the Plugin Settings.

        @@ -385,9 +400,9 @@

        AJAX call. returns a JSON string containing meta information about a specific WordPress Plugin.

        @@ -434,9 +449,9 @@

        Registers the settings and initialises the settings page.

        @@ -483,9 +498,9 @@

        Registers the footnotes submenu page.

        diff --git a/docs/classes/Footnotes-Layout-Settings.html b/docs/classes/Footnotes-Layout-Settings.html index ff4d841..67f34dc 100644 --- a/docs/classes/Footnotes-Layout-Settings.html +++ b/docs/classes/Footnotes-Layout-Settings.html @@ -51,9 +51,18 @@

        Namespaces

        -

        Global

        -
        +
        +
        +

        Packages

        +

        footnotes

        + +

        Default

        +

        Reports

        @@ -81,14 +90,20 @@ extends Footnotes_Layout_Engine +
        + in package + +

        Displays and handles all Settings of the Plugin.

        @@ -506,9 +521,9 @@

        Stores all Sections for the child sub page.

        @@ -553,9 +568,9 @@

        Stores the Hook connection string for the child sub page.

        @@ -605,9 +620,9 @@ ull

        Displays the AMP compatibility mode option.

        @@ -665,9 +680,9 @@ ull

        Displays the Custom CSS box.

        @@ -741,7 +756,7 @@ list directly in the template, as CSS is in English anyway

        -

        templates/dashboard/customize-css.html

        +

        admin/partials/customize-css.html

        @@ -765,9 +780,9 @@ list directly in the template, as CSS is in English anyway

        Displays transitional legacy Custom CSS box.

        @@ -814,9 +829,9 @@ list directly in the template, as CSS is in English anyway

        Displays the new Custom CSS box.

        @@ -863,9 +878,9 @@ list directly in the template, as CSS is in English anyway

        Output the Description of a section. May be overwritten in any section.

        @@ -912,9 +927,9 @@ list directly in the template, as CSS is in English anyway

        Displays the content of specific sub page.

        @@ -961,9 +976,9 @@ list directly in the template, as CSS is in English anyway

        Displays all Donate button to support the developers.

        @@ -1010,9 +1025,9 @@ list directly in the template, as CSS is in English anyway

        Displays the footnotes in excerpt setting.

        @@ -1094,9 +1109,9 @@ list directly in the template, as CSS is in English anyway

        Returns a Priority index. Lower numbers have a higher Priority.

        @@ -1143,9 +1158,9 @@ list directly in the template, as CSS is in English anyway

        Displays all options for the fragment identifier configuration.

        @@ -1203,9 +1218,9 @@ list directly in the template, as CSS is in English anyway

        Displays a short introduction to the Plugin.

        @@ -1269,9 +1284,9 @@ list directly in the template, as CSS is in English anyway

        Displays all settings for the backlink symbol.

        @@ -1391,9 +1406,9 @@ list directly in the template, as CSS is in English anyway

        Displays the setting for the input label issue solution.

        @@ -1440,9 +1455,9 @@ list directly in the template, as CSS is in English anyway

        Displays available Hooks to look for Footnote short codes.

        @@ -1535,9 +1550,9 @@ define -1 as PHP_INT_MAX instead

        Displays all settings for 'I love Footnotes'.

        @@ -1605,9 +1620,9 @@ define -1 as PHP_INT_MAX instead

        Displays enabled status for the footnotes mouse-over box.

        @@ -1675,9 +1690,9 @@ define -1 as PHP_INT_MAX instead

        Displays style settings for the footnotes mouse-over box.

        @@ -1724,9 +1739,9 @@ define -1 as PHP_INT_MAX instead

        Displays dimensions setting for the footnotes mouse-over box.

        @@ -1773,9 +1788,9 @@ define -1 as PHP_INT_MAX instead

        Displays position settings for the footnotes mouse-over box.

        @@ -1822,9 +1837,9 @@ define -1 as PHP_INT_MAX instead

        Displays dedicated tooltip text settings for the footnotes mouse-over box.

        @@ -1871,9 +1886,9 @@ define -1 as PHP_INT_MAX instead

        Displays timing settings for the footnotes mouse-over box.

        @@ -1920,9 +1935,9 @@ define -1 as PHP_INT_MAX instead

        Displays truncation settings for the footnotes mouse-over box.

        @@ -1969,9 +1984,9 @@ define -1 as PHP_INT_MAX instead

        Displays all options for the footnotes numbering.

        @@ -2018,9 +2033,9 @@ define -1 as PHP_INT_MAX instead

        Displays all settings for the reference container.

        @@ -2095,9 +2110,9 @@ define -1 as PHP_INT_MAX instead

        Registers all sections for a sub page.

        @@ -2144,9 +2159,9 @@ define -1 as PHP_INT_MAX instead

        Registers a sub page.

        @@ -2193,9 +2208,9 @@ define -1 as PHP_INT_MAX instead

        Displays all options for the scrolling behavior.

        @@ -2242,9 +2257,9 @@ define -1 as PHP_INT_MAX instead

        Displays all options for the footnotes start and end tag short codes.

        @@ -2373,9 +2388,9 @@ define -1 as PHP_INT_MAX instead

        Displays all settings for the footnote referrers.

        @@ -2443,9 +2458,9 @@ define -1 as PHP_INT_MAX instead

        Returns the html tag for an input [type = checkbox].

        @@ -2504,9 +2519,9 @@ define -1 as PHP_INT_MAX instead

        Returns the html tag for an input [type = text] with color selection class.

        @@ -2565,9 +2580,9 @@ define -1 as PHP_INT_MAX instead

        Returns the html tag for an input/select label.

        @@ -2635,9 +2650,9 @@ define -1 as PHP_INT_MAX instead

        Returns a line break to have a space between two lines.

        @@ -2684,9 +2699,9 @@ define -1 as PHP_INT_MAX instead

        Returns an array describing a meta box.

        @@ -2773,9 +2788,9 @@ define -1 as PHP_INT_MAX instead

        Returns a line break to start a new line.

        @@ -2822,9 +2837,9 @@ define -1 as PHP_INT_MAX instead

        Returns the html tag for an input [type = num].

        @@ -2921,9 +2936,9 @@ define -1 as PHP_INT_MAX instead

        Returns an array describing a sub page section.

        @@ -3010,9 +3025,9 @@ define -1 as PHP_INT_MAX instead

        Returns the html tag for a select box.

        @@ -3121,9 +3136,9 @@ define -1 as PHP_INT_MAX instead

        Returns a simple text inside html <span> text.

        @@ -3182,9 +3197,9 @@ define -1 as PHP_INT_MAX instead

        Returns the html tag for an input [type = text].

        @@ -3270,9 +3285,9 @@ define -1 as PHP_INT_MAX instead

        Returns the html tag for a text area.

        @@ -3331,9 +3346,9 @@ define -1 as PHP_INT_MAX instead

        Returns an array of all registered meta boxes for each section of the sub page.

        @@ -3445,9 +3460,9 @@ Change string "%s styling" to "Footnotes styling" to fix lay

        Returns an array of all registered sections for the sub page.

        @@ -3522,9 +3537,9 @@ Change string "%s styling" to "Footnotes styling" to fix lay

        Returns the unique slug of the sub page.

        @@ -3571,9 +3586,9 @@ Change string "%s styling" to "Footnotes styling" to fix lay

        Returns the title of the sub page.

        @@ -3620,9 +3635,9 @@ Change string "%s styling" to "Footnotes styling" to fix lay

        Loads specific setting and returns an array with the keys [id, name, value].

        @@ -3748,9 +3763,9 @@ Removing this did not fix the quotation mark backslash escapement bug.

        Append javascript and css files for specific sub page.

        @@ -3797,9 +3812,9 @@ Removing this did not fix the quotation mark backslash escapement bug.

        Registers all Meta boxes for a sub page.

        @@ -3858,9 +3873,9 @@ Removing this did not fix the quotation mark backslash escapement bug.

        Save all Plugin settings.

        diff --git a/docs/classes/Footnotes-Loader.html b/docs/classes/Footnotes-Loader.html new file mode 100644 index 0000000..8b2c87a --- /dev/null +++ b/docs/classes/Footnotes-Loader.html @@ -0,0 +1,823 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
        +

        Documentation

        + + +
        + +
        + + +
        + +
        +
        + + + + +
        + + +
        +

        + Footnotes_Loader + + +
        + in package + +
        + + +

        + + + +

        Register all actions and filters for the plugin.

        + +

        Maintain a list of all hooks that are registered throughout +the plugin, and register them with the WordPress API. Call the +run function to execute the list of actions and filters.

        +
        + + +
        + Tags + +
        +
        +
        + subpackage +
        +
        + +

        footnotes/includes

        +
        + +
        +
        + + + + + + +

        + Table of Contents + +

        + +
        +
        + $actions + +  : array<string|int, mixed> +
        +
        The array of actions registered with WordPress.
        + +
        + $filters + +  : array<string|int, mixed> +
        +
        The array of filters registered with WordPress.
        + +
        + __construct() + +  : mixed +
        +
        Initialize the collections used to maintain the actions and filters.
        + +
        + add_action() + +  : mixed +
        +
        Add a new action to the collection to be registered with WordPress.
        + +
        + add_filter() + +  : mixed +
        +
        Add a new filter to the collection to be registered with WordPress.
        + +
        + initialize_widgets() + +  : mixed +
        +
        Initializes all Widgets of the Plugin.
        + +
        + run() + +  : mixed +
        +
        Register the filters and actions with WordPress.
        + +
        + add() + +  : array<string|int, mixed> +
        +
        A utility function that is used to register the actions and hooks into a single +collection.
        + +
        + + + + + + +
        +

        + Properties + +

        +
        +

        + $actions + + + +

        + + +

        The array of actions registered with WordPress.

        + + + protected + array<string|int, mixed> + $actions + + +
        + + +
        + Tags + +
        +
        +
        + since +
        +
        + 2.8.0 + +
        + +
        +
        + access +
        +
        + +

        protected

        +
        + +
        +
        + +
        +
        +

        + $filters + + + +

        + + +

        The array of filters registered with WordPress.

        + + + protected + array<string|int, mixed> + $filters + + +
        + + +
        + Tags + +
        +
        +
        + since +
        +
        + 2.8.0 + +
        + +
        +
        + access +
        +
        + +

        protected

        +
        + +
        +
        + +
        +
        + +
        +

        + Methods + +

        +
        +

        + __construct() + +

        + + +

        Initialize the collections used to maintain the actions and filters.

        + + + public + __construct() : mixed + +
        + + + +
        + Tags + +
        +
        +
        + since +
        +
        + 2.8.0 + +
        + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + add_action() + +

        + + +

        Add a new action to the collection to be registered with WordPress.

        + + + public + add_action(string $hook, object $component, string $callback[, int $priority = 10 ][, int $accepted_args = 1 ]) : mixed + +
        + +
        Parameters
        +
        +
        + $hook + : string +
        +
        +

        The name of the WordPress action that is being registered.

        +
        + +
        +
        + $component + : object +
        +
        +

        A reference to the instance of the object on which the action is defined.

        +
        + +
        +
        + $callback + : string +
        +
        +

        The name of the function definition on the $component.

        +
        + +
        +
        + $priority + : int + = 10
        +
        +

        Optional. The priority at which the function should be fired. Default is 10.

        +
        + +
        +
        + $accepted_args + : int + = 1
        +
        +

        Optional. The number of arguments that should be passed to the $callback. Default is 1.

        +
        + +
        +
        + + +
        + Tags + +
        +
        +
        + since +
        +
        + 2.8.0 + +
        + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + add_filter() + +

        + + +

        Add a new filter to the collection to be registered with WordPress.

        + + + public + add_filter(string $hook, object $component, string $callback[, int $priority = 10 ][, int $accepted_args = 1 ]) : mixed + +
        + +
        Parameters
        +
        +
        + $hook + : string +
        +
        +

        The name of the WordPress filter that is being registered.

        +
        + +
        +
        + $component + : object +
        +
        +

        A reference to the instance of the object on which the filter is defined.

        +
        + +
        +
        + $callback + : string +
        +
        +

        The name of the function definition on the $component.

        +
        + +
        +
        + $priority + : int + = 10
        +
        +

        Optional. The priority at which the function should be fired. Default is 10.

        +
        + +
        +
        + $accepted_args + : int + = 1
        +
        +

        Optional. The number of arguments that should be passed to the $callback. Default is 1.

        +
        + +
        +
        + + +
        + Tags + +
        +
        +
        + since +
        +
        + 2.8.0 + +
        + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + initialize_widgets() + +

        + + +

        Initializes all Widgets of the Plugin.

        + + + public + initialize_widgets() : mixed + +
        + + + +
        + Tags + +
        +
        +
        + since +
        +
        + 1.5.0 + +
        + +
        +
        + since +
        +
        + 2.8.0 + +

        Moved to Footnotes_Loader class.

        +
        + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + run() + +

        + + +

        Register the filters and actions with WordPress.

        + + + public + run() : mixed + +
        + + + +
        + Tags + +
        +
        +
        + since +
        +
        + 2.8.0 + +
        + +
        +
        + +
        Return values
        + mixed + — +
        + + +
        +
        +

        + add() + +

        + + +

        A utility function that is used to register the actions and hooks into a single +collection.

        + + + private + add(array<string|int, mixed> $hooks, string $hook, object $component, string $callback, int $priority, int $accepted_args) : array<string|int, mixed> + +
        + +
        Parameters
        +
        +
        + $hooks + : array<string|int, mixed> +
        +
        +

        The collection of hooks that is being registered (that is, actions or filters).

        +
        + +
        +
        + $hook + : string +
        +
        +

        The name of the WordPress filter that is being registered.

        +
        + +
        +
        + $component + : object +
        +
        +

        A reference to the instance of the object on which the filter is defined.

        +
        + +
        +
        + $callback + : string +
        +
        +

        The name of the function definition on the $component.

        +
        + +
        +
        + $priority + : int +
        +
        +

        The priority at which the function should be fired.

        +
        + +
        +
        + $accepted_args + : int +
        +
        +

        The number of arguments that should be passed to the $callback.

        +
        + +
        +
        + + +
        + Tags + +
        +
        +
        + since +
        +
        + 2.8.0 + +
        + +
        +
        + access +
        +
        + +

        private

        +
        + +
        +
        + +
        Return values
        + array<string|int, mixed> + — +

        The collection of actions and filters registered with WordPress.

        +
        + + +
        +
        + +
        +
        +
        +
        +

        Search results

        + +
        +
        +
          +
          +
          +
          +
          +
          + + +
          + + + + diff --git a/docs/classes/Footnotes-Public.html b/docs/classes/Footnotes-Public.html new file mode 100644 index 0000000..3927580 --- /dev/null +++ b/docs/classes/Footnotes-Public.html @@ -0,0 +1,895 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
          +

          Documentation

          + + +
          + +
          + + +
          + +
          +
          + + + + +
          + + +
          +

          + Footnotes_Public + + +
          + in package + +
          + + +

          + + + +

          The public-facing functionality of the plugin.

          + +

          Defines the plugin name, version, and enqueues all public-facing stylesheets +and JavaScript.

          +
          + + +
          + Tags + +
          +
          +
          + subpackage +
          +
          + +

          footnotes/public

          +
          + +
          +
          + + + + + + +

          + Table of Contents + +

          + +
          +
          + $a_bool_alternative_tooltips_enabled + +  : bool +
          +
          Allows to determine whether alternative tooltips are enabled.
          + +
          + $a_bool_amp_enabled + +  : bool +
          +
          Allows to determine whether AMP compatibility mode is enabled.
          + +
          + $a_bool_tooltips_enabled + +  : bool +
          +
          Flag for using tooltips.
          + +
          + $a_obj_task + +  : Task +
          +
          The Plugin task.
          + +
          + $a_str_script_mode + +  : str +
          +
          Allows to determine the script mode among jQuery or plain JS.
          + +
          + $plugin_name + +  : string +
          +
          The ID of this plugin.
          + +
          + $version + +  : string +
          +
          The version of this plugin.
          + +
          + __construct() + +  : mixed +
          +
          Initialize the class and set its properties.
          + +
          + enqueue_scripts() + +  : mixed +
          +
          Register the JavaScript for the public-facing side of the site.
          + +
          + enqueue_styles() + +  : mixed +
          +
          Register the stylesheets for the public-facing side of the site.
          + +
          + load_dependencies() + +  : mixed +
          +
          Load the required public-facing dependencies.
          + +
          + + + + + + +
          +

          + Properties + +

          +
          +

          + $a_bool_alternative_tooltips_enabled + + + +

          + + +

          Allows to determine whether alternative tooltips are enabled.

          + + + public + static bool + $a_bool_alternative_tooltips_enabled + = alse + +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.1.1 + +
          + +
          +
          + since +
          +
          + 2.8.0 + +

          Moved to Footnotes_Public class.

          +
          + +
          +
          + +
          +
          +

          + $a_bool_amp_enabled + + + +

          + + +

          Allows to determine whether AMP compatibility mode is enabled.

          + + + public + static bool + $a_bool_amp_enabled + = alse + +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.6.0 + +

          (release)

          +
          + +
          +
          + since +
          +
          + 2.8.0 + +

          Moved to Footnotes_Public class.

          +
          + +
          +
          + +
          +
          +

          + $a_bool_tooltips_enabled + + + +

          + + +

          Flag for using tooltips.

          + + + public + static bool + $a_bool_tooltips_enabled + = alse + +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.4.0 + +
          + +
          +
          + since +
          +
          + 2.8.0 + +

          Moved to Footnotes_Public class.

          +
          + +
          +
          + +
          +
          +

          + $a_obj_task + + + +

          + + +

          The Plugin task.

          + + + public + Task + $a_obj_task + = +ull + +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 1.5.0 + +
          + +
          +
          + since +
          +
          + 2.8.0 + +

          Moved to Footnotes_Public class.

          +
          + +
          +
          + +
          +
          +

          + $a_str_script_mode + + + +

          + + +

          Allows to determine the script mode among jQuery or plain JS.

          + + + public + static str + $a_str_script_mode + = 'js' + +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.5.6 + +
          + +
          +
          + since +
          +
          + 2.8.0 + +

          Moved to Footnotes_Public class.

          +
          + +
          +
          + +
          +
          +

          + $plugin_name + + + +

          + + +

          The ID of this plugin.

          + + + private + string + $plugin_name + + +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.8.0 + +
          + +
          +
          + access +
          +
          + +

          private

          +
          + +
          +
          + +
          +
          +

          + $version + + + +

          + + +

          The version of this plugin.

          + + + private + string + $version + + +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.8.0 + +
          + +
          +
          + access +
          +
          + +

          private

          +
          + +
          +
          + +
          +
          + +
          +

          + Methods + +

          +
          +

          + __construct() + +

          + + +

          Initialize the class and set its properties.

          + + + public + __construct(string $plugin_name, string $version) : mixed + +
          + +
          Parameters
          +
          +
          + $plugin_name + : string +
          +
          +

          The name of this plugin.

          +
          + +
          +
          + $version + : string +
          +
          +

          The version of this plugin.

          +
          + +
          +
          + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.8.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + enqueue_scripts() + +

          + + +

          Register the JavaScript for the public-facing side of the site.

          + + + public + enqueue_scripts() : mixed + +
          + + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.8.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + enqueue_styles() + +

          + + +

          Register the stylesheets for the public-facing side of the site.

          + + + public + enqueue_styles() : mixed + +
          + + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.8.0 + +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          +

          + load_dependencies() + +

          + + +

          Load the required public-facing dependencies.

          + + + private + load_dependencies() : mixed + +

          Include the following files that provide the public-facing functionality +of this plugin:

          +
            +
          • +Footnotes_Task. TODO
            • +
          • +Footnotes_Widget_Reference_Container. TODO
            • +
          +
          + + + +
          + Tags + +
          +
          +
          + since +
          +
          + 2.8.0 + +
          + +
          +
          + access +
          +
          + +

          private

          +
          + +
          +
          + +
          Return values
          + mixed + — +
          + + +
          +
          + +
          +
          +
          +
          +

          Search results

          + +
          +
          +
            +
            +
            +
            +
            +
            + + +
            + + + + diff --git a/docs/classes/Footnotes-Settings.html b/docs/classes/Footnotes-Settings.html index 21d0a2f..86bf800 100644 --- a/docs/classes/Footnotes-Settings.html +++ b/docs/classes/Footnotes-Settings.html @@ -51,9 +51,18 @@

            Namespaces

            -

            Global

            -
            +
            +
            +

            Packages

            +

            footnotes

            + +

            Default

            +

            Reports

            @@ -78,14 +87,20 @@ Footnotes_Settings +
            + in package + +

            Loads the settings values, sets to default values if undefined.

            @@ -963,9 +978,9 @@

            Settings container key for the scalar value of the tooltip font size.

            @@ -1005,9 +1020,9 @@

            Settings container key for the backlinks column max width scalar.

            @@ -1047,9 +1062,9 @@

            Settings container key for the backlinks column width scalar.

            @@ -1089,9 +1104,9 @@

            Settings container key for 'the_content' hook priority level.

            @@ -1263,9 +1278,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for 'the_excerpt' hook priority level.

            @@ -1305,9 +1320,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for 'the_title' hook priority level.

            @@ -1366,9 +1381,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for 'widget_text' hook priority level.

            @@ -1408,9 +1423,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for 'widget_title' hook priority level.

            @@ -1450,9 +1465,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for alternative tooltip x offset.

            @@ -1492,9 +1507,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for alternative tooltip y offset.

            @@ -1534,9 +1549,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for alternative tooltip width.

            @@ -1576,9 +1591,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for the mouse-over box to define the border radius.

            @@ -1628,9 +1643,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for the mouse-over box to define the border width.

            @@ -1670,9 +1685,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for the mouse-over box to define the max. length of the enabled excerpt.

            @@ -1722,9 +1737,9 @@ priority needs to be at least 1200 (i.e. 0 =< $l_int_the_content_priority =&l

            Settings container key for the mouse-over box to define the max. width.

            @@ -1775,9 +1790,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for the mouse-over box to define the offset (x).

            @@ -1817,9 +1832,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for the mouse-over box to define the offset (y).

            @@ -1859,9 +1874,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for scroll down delay.

            @@ -1901,9 +1916,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for scroll down duration.

            @@ -1943,9 +1958,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for scroll duration.

            @@ -1988,9 +2003,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for scroll offset.

            @@ -2033,9 +2048,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for scroll up delay.

            @@ -2075,9 +2090,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for tooltip display fade-in delay.

            @@ -2117,9 +2132,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for tooltip display fade-in duration.

            @@ -2159,9 +2174,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for tooltip display fade-out delay.

            @@ -2201,9 +2216,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for tooltip display fade-out duration.

            @@ -2243,9 +2258,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for reference container bottom margin.

            @@ -2304,9 +2319,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for reference container top margin.

            @@ -2365,9 +2380,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key to enable a max width for the backlinks column.

            @@ -2407,9 +2422,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for the backlinks column max width unit.

            @@ -2449,9 +2464,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key to enable the backlinks column width.

            @@ -2491,9 +2506,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for the backlinks column width unit.

            @@ -2533,9 +2548,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key to enable line breaks between backlinks.

            @@ -2575,9 +2590,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for a custom backlink separator.

            @@ -2617,9 +2632,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key to enable the presence of a backlink separator.

            @@ -2678,9 +2693,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for the backlink separator options.

            @@ -2720,9 +2735,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for a custom backlink terminator.

            @@ -2762,9 +2777,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key to enable the presence of a backlink terminator.

            @@ -2804,9 +2819,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for the backlink terminator options.

            @@ -2846,9 +2861,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for combining identical footnotes.

            @@ -2888,9 +2903,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key for the Custom CSS.

            @@ -2940,9 +2955,9 @@ The width should be limited to start with, for the box to have shape.

            Settings container key to enable display of legacy Custom CSS metaboxes.

            @@ -2993,9 +3008,9 @@ because when saving, all missing constants are emptied, and to_bool() converts e

            Settings container key for the Custom CSS migrated to a dedicated tab.

            @@ -3038,9 +3053,9 @@ because when saving, all missing constants are emptied, and to_bool() converts e

            Settings container key to enable the 'the_content' hook.

            @@ -3080,9 +3095,9 @@ because when saving, all missing constants are emptied, and to_bool() converts e

            Settings container key to enable the 'the_excerpt' hook.

            @@ -3218,9 +3233,9 @@ because when saving, all missing constants are emptied, and to_bool() converts e

            Settings container key to enable the 'the_title' hook.

            @@ -3270,9 +3285,9 @@ Footnotes doesn’t delete footnotes therein.

            Settings container key to enable the 'widget_text' hook.

            @@ -3312,9 +3327,9 @@ Footnotes doesn’t delete footnotes therein.

            Settings container key to enable the 'widget_title' hook.

            @@ -3354,9 +3369,9 @@ Footnotes doesn’t delete footnotes therein.

            Settings container key for the fragment ID slug in footnotes.

            @@ -3396,9 +3411,9 @@ Footnotes doesn’t delete footnotes therein.

            Settings container key to enable superscript style normalization.

            @@ -3455,9 +3470,9 @@ Footnotes doesn’t delete footnotes therein.

            Settings container key for the footnote section shortcode.

            @@ -3516,9 +3531,9 @@ Footnotes doesn’t delete footnotes therein.

            Settings container key to enable shortcode syntax validation.

            @@ -3558,9 +3573,9 @@ Footnotes doesn’t delete footnotes therein.

            Settings container key for URL wrap option.

            @@ -3602,9 +3617,9 @@ Unicode-compliant browsers break URLs at slashes.

            Settings container key for alternative tooltip position.

            @@ -3644,9 +3659,9 @@ Unicode-compliant browsers break URLs at slashes.

            Settings container key to enable AMP compatibility mode.

            @@ -3748,9 +3763,9 @@ Unicode-compliant browsers break URLs at slashes.

            Settings container key to enable backlink tooltips.

            @@ -3816,9 +3831,9 @@ Unicode-compliant browsers break URLs at slashes.

            Settings container key to configure the backlink tooltip.

            @@ -3877,9 +3892,9 @@ Unicode-compliant browsers break URLs at slashes.

            Settings container key for the counter style of the footnotes.

            @@ -3919,9 +3934,9 @@ Unicode-compliant browsers break URLs at slashes.

            Settings container key to enable CSS smooth scrolling.

            @@ -3996,9 +4011,9 @@ Unicode-compliant browsers break URLs at slashes.

            Settings container key for the Expert mode.

            @@ -4050,9 +4065,9 @@ All users, not experts only, need to be able to control relative positioning.

            Settings container key to enable hard links.

            @@ -4127,9 +4142,9 @@ All users, not experts only, need to be able to control relative positioning.

            Settings container key to look for footnotes in post excerpts.

            @@ -4226,9 +4241,9 @@ All users, not experts only, need to be able to control relative positioning.

            Settings container key to set the solution of the input element label issue.

            @@ -4275,9 +4290,9 @@ All users, not experts only, need to be able to control relative positioning.

            Settings container key for the 'I love footnotes' text.

            @@ -4317,9 +4332,9 @@ All users, not experts only, need to be able to control relative positioning.

            Settings container key to enable the alternative tooltips.

            @@ -4378,9 +4393,9 @@ All users, not experts only, need to be able to control relative positioning.

            Settings container key for the mouse-over box to define the background color.

            @@ -4508,9 +4523,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the mouse-over box to define the border color.

            @@ -4550,9 +4565,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the mouse-over box to define the color.

            @@ -4629,9 +4644,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key to enable the mouse-over box.

            @@ -4671,9 +4686,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key to enable tooltip truncation.

            @@ -4713,9 +4728,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the mouse-over box to define the position.

            @@ -4755,9 +4770,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the mouse-over box to define the box-shadow color.

            @@ -4797,9 +4812,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for basic responsive page layout support options.

            @@ -4839,9 +4854,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key to select the script mode for the reference container.

            @@ -4900,9 +4915,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the referrer element.

            @@ -4961,9 +4976,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for scroll duration asymmetricity.

            @@ -5003,9 +5018,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the short code of the footnote’s end.

            @@ -5045,9 +5060,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the user-defined short code of the footnotes end.

            @@ -5087,9 +5102,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the short code of the footnote’s start.

            @@ -5129,9 +5144,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the user-defined short code of the footnotes start.

            @@ -5171,9 +5186,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the string after the footnote referrer.

            @@ -5213,9 +5228,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key for the string before the footnote referrer.

            @@ -5255,9 +5270,9 @@ But theme default background color doesn’t seem to exist.

            Settings container key to configure the tooltip excerpt delimiter.

            @@ -5318,9 +5333,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to enable mirroring the tooltip excerpt in the reference container.

            @@ -5375,9 +5390,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to configure the tooltip excerpt separator in the reference container.

            @@ -5417,9 +5432,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the label of the Read-on button in truncated tooltips.

            @@ -5478,9 +5493,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the ID separator in fragment IDs.

            @@ -5520,9 +5535,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the backlink symbol selection.

            @@ -5590,9 +5605,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the user-defined backlink symbol.

            @@ -5632,9 +5647,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the link element option.

            @@ -5693,9 +5708,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to enable setting the tooltip font size.

            @@ -5735,9 +5750,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the unit of the tooltip font size.

            @@ -5777,9 +5792,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to enable the legacy layout of the reference container.

            @@ -5822,9 +5837,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to enable the display of a backlink symbol.

            @@ -5883,9 +5898,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to get the backlink symbol switch side.

            @@ -5944,9 +5959,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to collapse the reference container by default.

            @@ -5995,9 +6010,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to enable the reference container label bottom border.

            @@ -6056,9 +6071,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the reference container label element.

            @@ -6117,9 +6132,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the label of the reference container.

            @@ -6159,9 +6174,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the position of the reference container.

            @@ -6201,9 +6216,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for reference container position shortcode.

            @@ -6262,9 +6277,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to enable reference container table row borders.

            @@ -6323,9 +6338,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key to not display the reference container on the homepage.

            @@ -6384,9 +6399,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Settings container key for the fragment ID slug in referrers.

            @@ -6441,9 +6456,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Contains all Settings Container names.

            @@ -6488,9 +6503,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Contains all Default Settings for each Settings Container.

            @@ -6674,9 +6689,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Contains all Settings from each Settings container as soon as this class is initialized.

            @@ -6721,9 +6736,9 @@ But Footnotes’ UI design policy is to make shortcodes freely configurable.

            Stores a singleton reference of this class.

            @@ -6773,9 +6788,9 @@ ull

            Deletes each Settings Container and loads the default values for each Settings Container.

            @@ -6835,9 +6850,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Returns the value of specified Settings name.

            @@ -6897,9 +6912,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Returns the name of a specified Settings Container.

            @@ -6959,9 +6974,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Returns the default values of a specific Settings Container.

            @@ -7020,9 +7035,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Returns a singleton of this class.

            @@ -7069,9 +7084,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Register all Settings Container for the Plugin Settings Page in the Dashboard.

            @@ -7119,9 +7134,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Updates a whole Settings container.

            @@ -7189,9 +7204,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Class Constructor. Loads all Settings from each WordPress Settings container.

            @@ -7238,9 +7253,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Loads all settings from specified settings container.

            @@ -7328,9 +7343,9 @@ done by deleting and reinstalling (see the warning about database backup).

            Loads all Settings from each Settings container.

            diff --git a/docs/classes/Footnotes-Task.html b/docs/classes/Footnotes-Task.html index 81f562b..a2daae5 100644 --- a/docs/classes/Footnotes-Task.html +++ b/docs/classes/Footnotes-Task.html @@ -51,9 +51,18 @@

            Namespaces

            -

            Global

            -
            +
            +
            +

            Packages

            +

            footnotes

            + +

            Default

            +

            Reports

            @@ -78,14 +87,20 @@ Footnotes_Task +
            + in package + +

            Searches and replaces the footnotes and generates the reference container.

            @@ -275,6 +290,13 @@
            The slug and identifier separator.
            + __construct() + +  : mixed +
            +
            Initialize the class and set its properties.
            + +
            exec()  : string @@ -398,9 +420,9 @@

            Contains all footnotes found in the searched content.

            @@ -445,9 +467,9 @@

            Flag if the display of 'LOVE FOOTNOTES' is allowed on the current public page.

            @@ -492,9 +514,9 @@

            Hard links for AMP compatibility.

            @@ -612,9 +634,9 @@

            Whether to mirror the tooltip text in the reference container.

            @@ -659,9 +681,9 @@

            Footnote delimiter syntax validation enabled.

            @@ -709,9 +731,9 @@

            Autoload a.k.a. infinite scroll, or archive view.

            @@ -791,9 +813,9 @@

            Multiple reference containers in content and widgets.

            @@ -864,9 +886,9 @@

            Scroll offset.

            @@ -942,9 +964,9 @@

            The tooltip delimiter shortcode length.

            @@ -989,9 +1011,9 @@

            Footnote delimiter end short code.

            @@ -1047,9 +1069,9 @@

            Footnote delimiter end short code in regex format.

            @@ -1105,9 +1127,9 @@

            The footnote slug.

            @@ -1152,9 +1174,9 @@

            The closing tag.

            @@ -1199,9 +1221,9 @@

            The opening tag.

            @@ -1246,9 +1268,9 @@

            The span element name.

            @@ -1293,9 +1315,9 @@

            Contains the concatenated fragment ID base.

            @@ -1340,9 +1362,9 @@

            Prefix for the Footnote html element ID.

            @@ -1387,9 +1409,9 @@

            The referrer slug.

            @@ -1434,9 +1456,9 @@

            Footnote delimiter start short code.

            @@ -1492,9 +1514,9 @@

            Footnote delimiter start short code in regex format.

            @@ -1550,9 +1572,9 @@

            The tooltip delimiter shortcode.

            @@ -1597,9 +1619,9 @@

            The slug and identifier separator.

            @@ -1642,15 +1664,64 @@ -method -public " +> +

            + __construct() + +

            + + +

            Initialize the class and set its properties.

            + + + public + __construct() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + since +
            +
            + 2.8.0 + +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + + +

            exec()

            Replaces all footnotes that occur in the given content.

            @@ -1727,9 +1798,9 @@

            Replaces footnotes in the content of the current page/post.

            @@ -1817,9 +1888,9 @@

            Processes existing excerpt or replaces it with a new one generated on the basis of the post.

            @@ -1930,9 +2001,9 @@ Default 'manual' is fallback and is backward compatible with the initial setup.<

            Replaces footnotes in the post/page title.

            @@ -1992,9 +2063,9 @@ Default 'manual' is fallback and is backward compatible with the initial setup.<

            Replaces footnotes in the content of the current widget.

            @@ -2054,9 +2125,9 @@ Default 'manual' is fallback and is backward compatible with the initial setup.<

            Replaces footnotes in the widget title.

            @@ -2116,9 +2187,9 @@ Default 'manual' is fallback and is backward compatible with the initial setup.<

            Displays the 'LOVE FOOTNOTES' slug if enabled.

            @@ -2175,9 +2246,9 @@ Default 'manual' is fallback and is backward compatible with the initial setup.<

            Outputs the custom css to the header of the public page.

            @@ -2314,9 +2385,9 @@ Default 'manual' is fallback and is backward compatible with the initial setup.<

            Generates excerpt on the basis of the post.

            @@ -2449,9 +2520,9 @@ Applies full WordPress excerpt processing.

            Generates excerpt with footnotes on the basis of the post.

            @@ -2631,9 +2702,9 @@ Does not apply full WordPress excerpt processing.

            Generates the reference container.

            @@ -2740,9 +2811,9 @@ Does not apply full WordPress excerpt processing.

            Register WordPress hooks to replace Footnotes in the content of a public page.

            @@ -2909,9 +2980,9 @@ Does not apply full WordPress excerpt processing.

            Replaces all footnotes in the given content and appends them to the static property.

            @@ -3073,9 +3144,9 @@ Does not apply full WordPress excerpt processing.

            Brings the delimiters and unifies their various HTML escapement schemas.

            diff --git a/docs/classes/Footnotes-Template.html b/docs/classes/Footnotes-Template.html index 2a7c5a3..b4bdfd1 100644 --- a/docs/classes/Footnotes-Template.html +++ b/docs/classes/Footnotes-Template.html @@ -51,9 +51,18 @@

            Namespaces

            -

            Global

            -
            +
            +
            +

            Packages

            +

            footnotes

            + +

            Default

            +

            Reports

            @@ -78,12 +87,18 @@ Footnotes_Template +
            + in package + +
            @@ -124,16 +139,16 @@
            C_STR_DASHBOARD -  = 'dashboard' +  = 'admin/partials'
            -
            Directory name for dashboard templates.
            +
            Directory name for dashboard partials.
            C_STR_PUBLIC -  = 'public' +  = 'public/partials'
            -
            Directory name for public templates.
            +
            Directory name for public partials.
            $plugin_directory @@ -215,18 +230,18 @@ -

            Directory name for dashboard templates.

            +

            Directory name for dashboard partials.

            public string C_STR_DASHBOARD - = 'dashboard' + = 'admin/partials' @@ -257,18 +272,18 @@ -

            Directory name for public templates.

            +

            Directory name for public partials.

            public string C_STR_PUBLIC - = 'public' + = 'public/partials' @@ -314,7 +329,7 @@ @@ -361,7 +376,7 @@ @@ -408,7 +423,7 @@ @@ -459,7 +474,7 @@ @@ -566,7 +581,7 @@ @@ -616,7 +631,7 @@ @@ -726,7 +741,7 @@ @@ -837,7 +852,7 @@ @@ -886,7 +901,7 @@ diff --git a/docs/classes/Footnotes-WYSIWYG.html b/docs/classes/Footnotes-WYSIWYG.html index 366618f..841207b 100644 --- a/docs/classes/Footnotes-WYSIWYG.html +++ b/docs/classes/Footnotes-WYSIWYG.html @@ -51,9 +51,18 @@

            Namespaces

            -

            Global

            -
            +
            +
            +

            Packages

            +

            footnotes

            + +

            Default

            +

            Reports

            @@ -78,14 +87,20 @@ Footnotes_WYSIWYG +
            + in package + +

            Handles the WSYIWYG-Buttons.

            @@ -179,9 +194,9 @@

            AJAX Callback function when the Footnotes Button is clicked. Either in the Plain text or Visual editor.

            @@ -229,9 +244,9 @@

            Includes the Plugins WYSIWYG editor script.

            @@ -290,9 +305,9 @@

            Add a new button to the plain text editor.

            @@ -339,9 +354,9 @@

            Append a new Button to the WYSIWYG editor of Posts and Pages.

            @@ -400,9 +415,9 @@

            Registers Button hooks.

            diff --git a/docs/classes/Footnotes-Widget-Base.html b/docs/classes/Footnotes-Widget-Base.html index da53be0..c31e2aa 100644 --- a/docs/classes/Footnotes-Widget-Base.html +++ b/docs/classes/Footnotes-Widget-Base.html @@ -51,9 +51,18 @@

            Namespaces

            -

            Global

            -
            +
            +
            +

            Packages

            +

            footnotes

            + +

            Default

            +

            Reports

            @@ -81,12 +90,18 @@ extends WP_Widget +
            + in package + +
            @@ -194,7 +209,7 @@ @@ -272,7 +287,7 @@ @@ -321,7 +336,7 @@ @@ -370,7 +385,7 @@ @@ -419,7 +434,7 @@ diff --git a/docs/classes/Footnotes-Widget-Reference-Container.html b/docs/classes/Footnotes-Widget-Reference-Container.html index c71ae8a..4a409a9 100644 --- a/docs/classes/Footnotes-Widget-Reference-Container.html +++ b/docs/classes/Footnotes-Widget-Reference-Container.html @@ -51,9 +51,18 @@

            Namespaces

            -

            Global

            -
            +
            +
            +

            Packages

            +

            footnotes

            + +

            Default

            +

            Reports

            @@ -81,14 +90,20 @@ extends Footnotes_Widget_Base +
            + in package + +

            Registers a Widget to put the Reference Container to the widget area.

            @@ -196,7 +211,7 @@ @@ -274,9 +289,9 @@

            Outputs the Settings of the Widget.

            @@ -336,9 +351,9 @@

            Outputs the Content of the Widget.

            @@ -406,9 +421,9 @@

            Returns the Description of the child widget.

            @@ -456,9 +471,9 @@

            Returns an unique ID as string used for the Widget Base ID.

            @@ -505,9 +520,9 @@

            Returns the Public name of the Widget to be displayed in the Configuration page.

            @@ -554,7 +569,7 @@ diff --git a/docs/classes/Footnotes-i18n.html b/docs/classes/Footnotes-i18n.html new file mode 100644 index 0000000..2ec15bd --- /dev/null +++ b/docs/classes/Footnotes-i18n.html @@ -0,0 +1,264 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
            +

            Documentation

            + + +
            + +
            + + +
            + +
            +
            + + + + +
            + + +
            +

            + Footnotes_i18n + + +
            + in package + +
            + + +

            + + + +

            Define the internationalization functionality.

            + +

            Loads and defines the internationalization files for this plugin +so that it is ready for translation.

            +
            + + +
            + Tags + +
            +
            +
            + since +
            +
            + 1.5.0 + +
            + +
            +
            + since +
            +
            + 2.8.0 + +

            Renamed class to Footnotes_i18n.

            +
            + +
            +
            + subpackage +
            +
            + +

            footnotes/includes

            +
            + +
            +
            + + + + + + +

            + Table of Contents + +

            + +
            +
            + load_plugin_textdomain() + +  : mixed +
            +
            Load the plugin text domain for translation.
            + +
            + + + + + + + +
            +

            + Methods + +

            +
            +

            + load_plugin_textdomain() + +

            + + +

            Load the plugin text domain for translation.

            + + + public + load_plugin_textdomain() : mixed + +
            + + + +
            + Tags + +
            +
            +
            + since +
            +
            + 1.5.1 + +
            + +
            +
            + since +
            +
            + 2.8.0 + +

            Rename from load() to load_plugin_textdomain(). Remove unused $p_str_language_code parameter.

            +
            + +
            +
            + +
            Return values
            + mixed + — +
            + + +
            +
            + +
            +
            +
            +
            +

            Search results

            + +
            +
            +
              +
              +
              +
              +
              +
              + + +
              + + + + diff --git a/docs/classes/Footnotes.html b/docs/classes/Footnotes.html index a03c538..9fc4fd8 100644 --- a/docs/classes/Footnotes.html +++ b/docs/classes/Footnotes.html @@ -51,9 +51,18 @@

              Namespaces

              -

              Global

              -
              +
              +
              +

              Packages

              +

              footnotes

              + +

              Default

              +

              Reports

              @@ -71,6 +80,7 @@
              @@ -78,19 +88,29 @@ Footnotes +
              + in package + +
              -

              Provides an entry point to the Plugin.

              +

              The core plugin class.

              -

              Loads the dashboard and executes the task.

              +

              This is used to define internationalization, admin-specific hooks, and +public-facing site hooks.

              +

              Also maintains the unique identifier of this plugin as well as the current +version of the plugin.

              @@ -107,6 +127,15 @@
              + +
              + subpackage +
              +
              + +

              footnotes/includes

              +
              +
              @@ -121,75 +150,93 @@
              -
              - $a_bool_alternative_tooltips_enabled +
              + $loader -  : bool +  : Footnotes_Loader
              -
              Allows to determine whether alternative tooltips are enabled.
              +
              The loader that's responsible for maintaining and registering all hooks that power +the plugin.
              -
              - $a_bool_amp_enabled +
              + $plugin_name -  : bool +  : string
              -
              Allows to determine whether AMP compatibility mode is enabled.
              +
              The unique identifier of this plugin.
              -
              - $a_bool_tooltips_enabled +
              + $version -  : bool +  : string
              -
              Flag for using tooltips.
              - -
              - $a_obj_task - -  : Task -
              -
              The Plugin task.
              - -
              - $a_str_script_mode - -  : str -
              -
              Allows to determine the script mode among jQuery or plain JS.
              +
              The current version of the plugin.
              - initialize_widgets() + __construct()  : mixed
              -
              Initializes all Widgets of the Plugin.
              +
              Define the core functionality of the plugin.
              - register_public() + get_loader() -  : mixed +  : Footnotes_Loader
              -
              Registers and enqueues scripts and stylesheets to the public pages.
              +
              The reference to the class that orchestrates the hooks with the plugin.
              + +
              + get_plugin_name() + +  : string +
              +
              The name of the plugin used to uniquely identify it within the context of +WordPress and to define internationalization functionality.
              + +
              + get_version() + +  : string +
              +
              Retrieve the version number of the plugin.
              run()  : mixed
              -
              Executes the Plugin.
              +
              Run the loader to execute all of the hooks with WordPress.
              - initialize_dashboard() + define_admin_hooks()  : mixed
              -
              Initializes the Dashboard of the Plugin and loads them.
              +
              Register all of the hooks related to the admin area functionality +of the plugin.
              - initialize_task() + define_public_hooks()  : mixed
              -
              Initializes the Plugin Task and registers the Task hooks.
              +
              Register all of the hooks related to the public-facing functionality +of the plugin.
              + +
              + load_dependencies() + +  : mixed +
              +
              Load the required dependencies for this plugin.
              + +
              + set_locale() + +  : mixed +
              +
              Define the locale for this plugin for internationalization.
              @@ -207,269 +254,29 @@ class=" phpdocumentor-element -property - -public - -static " -> -

              - $a_bool_alternative_tooltips_enabled - - - -

              - - -

              Allows to determine whether alternative tooltips are enabled.

              - - - public - static bool - $a_bool_alternative_tooltips_enabled - = alse - -
                -
              • Bugfix: Tooltips: optional alternative JS implementation with CSS transitions to fix configuration-related outage, thanks to @andreasra feedback.
                • -
              -
              - - -
              - Tags - -
              -
              -
              - since -
              -
              - 2.1.1 - -
              - -
              -
              - since -
              -
              - 2.4.0 - -
              - -
              -
              - reporter -
              -
              - -

              @andreasra

              -
              - -
              -
              - link -
              -
              - https://wordpress.org/support/topic/footnotes-appearing-in-header/page/2/#post-13632566 - -
              -
              - contributor -
              -
              - -

              Patrizia Lutz @misfist

              -
              - -
              -
              - -
              -
              -

              - $a_bool_amp_enabled - - - -

              - - -

              Allows to determine whether AMP compatibility mode is enabled.

              - - - public - static bool - $a_bool_amp_enabled - = alse - -
                -
              • Adding: Tooltips: make display work purely by style rules for AMP compatibility, thanks to @milindmore22 code contribution.
                • -
              • Bugfix: Tooltips: enable accessibility by keyboard navigation, thanks to @westonruter code contribution.
                • -
              • Adding: Reference container: get expanding and collapsing to work also in AMP compatibility mode, thanks to @westonruter code contribution.
                • -
              -
              - - -
              - Tags - -
              -
              -
              - since -
              -
              - 2.5.11 - -

              (draft)

              -
              - -
              -
              - since -
              -
              - 2.6.0 - -

              (release)

              -
              - -
              -
              - contributor -
              -
              - -

              @milindmore22

              -
              - -
              -
              - contributor -
              -
              - -

              @westonruter

              -
              - -
              -
              - link -
              -
              - https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785306933 - -
              -
              - link -
              -
              - https://github.com/ampproject/amp-wp/issues/5913#issuecomment-785419655 - -
              -
              - link -
              -
              - https://github.com/markcheret/footnotes/issues/48#issuecomment-799580854 - -
              -
              - link -
              -
              - https://github.com/markcheret/footnotes/issues/48#issuecomment-799582394 - -
              -
              - -
              -
              -

              - $a_bool_tooltips_enabled - - - -

              - - -

              Flag for using tooltips.

              - - - public - static bool - $a_bool_tooltips_enabled - = alse - -
              - - -
              - Tags - -
              -
              -
              - since -
              -
              - 2.4.0 - -
              - -
              -
              - -
              -
              -

              - $a_obj_task - +

              + $loader +

              -

              The Plugin task.

              +

              The loader that's responsible for maintaining and registering all hooks that power +the plugin.

              - public - Task - $a_obj_task - = -ull + protected + Footnotes_Loader + $loader +
              @@ -483,10 +290,19 @@ ull since
              - 1.5.0 + 2.8.0
              +
              +
              + access +
              +
              + +

              protected

              +
              +
              @@ -495,33 +311,30 @@ ull class=" phpdocumentor-element -property - -public - -static " + -protected + " > -

              - $a_str_script_mode - +

              + $plugin_name +

              -

              Allows to determine the script mode among jQuery or plain JS.

              +

              The unique identifier of this plugin.

              - public - static str - $a_str_script_mode - = 'js' + protected + string + $plugin_name + -
                -
              • Bugfix: Reference container: optional alternative expanding and collapsing without jQuery for use with hard links, thanks to @hopper87it @pkverma99 issue reports.
                • -
              -
              +
              @@ -533,42 +346,75 @@ ull since
              - 2.5.6 + 2.8.0
              - reporter + access
              -

              @hopper87it

              +

              protected

              -
              - reporter + + +
              +
              +

              + $version + + + +

              + + +

              The current version of the plugin.

              + + + protected + string + $version + + +
              + + +
              + Tags + +
              +
              +
              + since
              + 2.8.0 -

              @pkverma99

              -
              +
              - link + access
              - https://wordpress.org/support/topic/footnotes-wp-rocket/ - -
              -
              - link -
              -
              - https://wordpress.org/support/topic/footnotes-wp-rocket/#post-14076188 - + +

              protected

              +
              +
              @@ -586,23 +432,26 @@ ull -public " > -

              - initialize_widgets() - +

              + __construct() +

              -

              Initializes all Widgets of the Plugin.

              +

              Define the core functionality of the plugin.

              public - initialize_widgets() : mixed + __construct() : mixed -
              +

              Set the plugin name and the plugin version that can be used throughout the plugin. +Load the dependencies, define the locale, and set the hooks for the admin area and +the public-facing side of the site.

              +
              @@ -615,97 +464,10 @@ ull since
              - 1.5.0 - -
                -
              • Update: Fix for deprecated PHP function create_function(), thanks to @psykonevro @daliasued bug reports, thanks to @felipelavinz code contribution
                • -
              -
              - -
              -
              - since -
              -
              - 1.6.5 + 1.0.0
              -
              -
              - contributor -
              -
              - -

              @felipelavinz

              -
              - -
              -
              - link -
              -
              - https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 - -
              -
              - link -
              -
              - https://wordpress.org/support/topic/bug-function-create_function-is-deprecated/ - -
              -
              - link -
              -
              - https://wordpress.org/support/topic/deprecated-function-create_function-14/ - -
              -
              - link -
              -
              -

              create_function() was deprecated in PHP 7.2.0 and removed in PHP 8.0.0.

              -               - -
              -
              - link -
              -
              -

              The fix is to move add_action() above into run(), -and use the bare register_widget() here.

              -               - -
              -
              - reporter -
              -
              - -

              @psykonevro

              -
              - -
              -
              - reporter -
              -
              - -

              @daliasued

              -
              - -
              -
              - see -
              -
              - self::run() - -

              Also, the visibility of initialize_widgets() is not private any longer.

              -
              -
              @@ -722,21 +484,21 @@ and use the bare register_widget() here.

              -public " > -

              - register_public() - +

              + get_loader() +

              -

              Registers and enqueues scripts and stylesheets to the public pages.

              +

              The reference to the class that orchestrates the hooks with the plugin.

              public - register_public() : mixed + get_loader() : Footnotes_Loader
              @@ -751,67 +513,119 @@ and use the bare register_widget() here.

              since
              - 1.5.0 + 1.0.0
              -
              -
              - since -
              -
              - 2.0.0 - -

              Update: Tooltips: fix disabling bug by loading jQuery UI library, thanks to @rajinderverma @ericcorbett2 @honlapdavid @mmallett bug reports, thanks to @vonpiernik code contribution.

              -
              - -
              -
              - since -
              -
              - 2.0.3 - -

              add versioning of public.css for cache busting

              -
              - -
              -
              - since -
              -
              - 2.0.4 - -

              add jQuery UI from WordPress

              -
              - -
              -
              - since -
              -
              - 2.1.4 - -

              automate passing version number for cache busting

              -
              - -
              -
              - since -
              -
              - 2.1.4 - -

              optionally enqueue an extra stylesheet

              -
              -
              Return values
              - mixed + Footnotes_Loader — -
              +

              Orchestrates the hooks of the plugin.

              +
              + + +
              +
              +

              + get_plugin_name() + +

              + + +

              The name of the plugin used to uniquely identify it within the context of +WordPress and to define internationalization functionality.

              + + + public + get_plugin_name() : string + +
              + + + +
              + Tags + +
              +
              +
              + since +
              +
              + 1.0.0 + +
              + +
              +
              + +
              Return values
              + string + — +

              The name of the plugin.

              +
              + + +
              +
              +

              + get_version() + +

              + + +

              Retrieve the version number of the plugin.

              + + + public + get_version() : string + +
              + + + +
              + Tags + +
              +
              +
              + since +
              +
              + 1.0.0 + +
              + +
              +
              + +
              Return values
              + string + — +

              The version number of the plugin.

              +
              @@ -826,12 +640,12 @@ and use the bare register_widget() here.

              -

              Executes the Plugin.

              +

              Run the loader to execute all of the hooks with WordPress.

              public @@ -852,43 +666,8 @@ and use the bare register_widget() here.

              1.5.0 -
                -
              • Bugfix: Improve widgets registration, thanks to @felipelavinz code contribution.
                • -
              -
              - -
              -
              - since -
              -
              - 1.6.5 -
              -
              -
              - contributor -
              -
              - -

              @felipelavinz

              -
              - -
              -
              - link -
              -
              - https://github.com/benleyjyc/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 - -
              -
              - link -
              -
              - https://github.com/media-competence-institute/footnotes/commit/87173d2980c7ff90e12ffee94ca7153e11163793 -
              see @@ -914,21 +693,22 @@ and use the bare register_widget() here.

              -private " > -

              - initialize_dashboard() - +

              + define_admin_hooks() +

              -

              Initializes the Dashboard of the Plugin and loads them.

              +

              Register all of the hooks related to the admin area functionality +of the plugin.

              private - initialize_dashboard() : mixed + define_admin_hooks() : mixed
              @@ -943,10 +723,19 @@ and use the bare register_widget() here.

              since
              - 1.5.0 + 2.8.0
              +
              +
              + access +
              +
              + +

              private

              +
              +
              @@ -963,21 +752,22 @@ and use the bare register_widget() here.

              -private " > -

              - initialize_task() - +

              + define_public_hooks() +

              -

              Initializes the Plugin Task and registers the Task hooks.

              +

              Register all of the hooks related to the public-facing functionality +of the plugin.

              private - initialize_task() : mixed + define_public_hooks() : mixed
              @@ -992,10 +782,146 @@ and use the bare register_widget() here.

              since
              - 1.5.0 + 2.8.0
              +
              +
              + access +
              +
              + +

              private

              +
              + +
              + + +
              Return values
              + mixed + — +
              + + + +
              +

              + load_dependencies() + +

              + + +

              Load the required dependencies for this plugin.

              + + + private + load_dependencies() : mixed + +

              Include the following files that make up the plugin:

              +
                +
              • Footnotes_Loader. Orchestrates the hooks of the plugin.
                • +
              • Footnotes_i18n. Defines internationalization functionality.
                • +
              • Footnotes_Admin. Defines all hooks for the admin area.
                • +
              • Footnotes_Public. Defines all hooks for the public side of the site.
                • +
              +

              Create an instance of the loader which will be used to register the hooks +with WordPress.

              +
              + + + +
              + Tags + +
              +
              +
              + since +
              +
              + 2.8.0 + +
              + +
              +
              + access +
              +
              + +

              private

              +
              + +
              +
              + +
              Return values
              + mixed + — +
              + + +
              +
              +

              + set_locale() + +

              + + +

              Define the locale for this plugin for internationalization.

              + + + private + set_locale() : mixed + +

              Uses the Footnotes_i18n class in order to set the domain and to register the hook +with WordPress.

              +
              + + + +
              + Tags + +
              +
              +
              + since +
              +
              + 2.8.0 + +
              + +
              +
              + access +
              +
              + +

              private

              +
              +
              diff --git a/docs/files/src-admin-class-footnotes-admin.html b/docs/files/src-admin-class-footnotes-admin.html new file mode 100644 index 0000000..dc2146e --- /dev/null +++ b/docs/files/src-admin-class-footnotes-admin.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
              +

              Documentation

              + + +
              + +
              + + +
              + +
              +
              + + + + +
              + + +
              +

              class-footnotes-admin.php

              + + + +

              + Interfaces, Classes and Traits + +

              + +
              + +
              Footnotes_Admin
              +
              The admin-specific functionality of the plugin.
              + +
              + + + + + + + +
              +
              +
              +
              +

              Search results

              + +
              +
              +
                +
                +
                +
                +
                +
                + + +
                + + + + diff --git a/docs/files/src-admin-class-footnotes-wysiwyg.html b/docs/files/src-admin-class-footnotes-wysiwyg.html new file mode 100644 index 0000000..24cf02d --- /dev/null +++ b/docs/files/src-admin-class-footnotes-wysiwyg.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                +

                Documentation

                + + +
                + +
                + + +
                + +
                +
                + + + + +
                + + +
                +

                class-footnotes-wysiwyg.php

                + + + +

                + Interfaces, Classes and Traits + +

                + +
                + +
                Footnotes_WYSIWYG
                +
                Handles the WSYIWYG-Buttons.
                + +
                + + + + + + + +
                +
                +
                +
                +

                Search results

                + +
                +
                +
                  +
                  +
                  +
                  +
                  +
                  + + +
                  + + + + diff --git a/docs/files/src-admin-index.html b/docs/files/src-admin-index.html new file mode 100644 index 0000000..4827a6d --- /dev/null +++ b/docs/files/src-admin-index.html @@ -0,0 +1,119 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                  +

                  Documentation

                  + + +
                  + +
                  + + +
                  + +
                  +
                  + + + + +
                  + + +
                  +

                  index.php

                  + + + + + + + + + + +
                  +
                  +
                  +
                  +

                  Search results

                  + +
                  +
                  +
                    +
                    +
                    +
                    +
                    +
                    + + +
                    + + + + diff --git a/docs/files/src-admin-layout-class-footnotes-layout-engine.html b/docs/files/src-admin-layout-class-footnotes-layout-engine.html new file mode 100644 index 0000000..6cfd198 --- /dev/null +++ b/docs/files/src-admin-layout-class-footnotes-layout-engine.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                    +

                    Documentation

                    + + +
                    + +
                    + + +
                    + +
                    +
                    + + + + +
                    + + +
                    +

                    class-footnotes-layout-engine.php

                    + + + +

                    + Interfaces, Classes and Traits + +

                    + +
                    + +
                    Footnotes_Layout_Engine
                    +
                    Layout Engine for the administration dashboard.
                    + +
                    + + + + + + + +
                    +
                    +
                    +
                    +

                    Search results

                    + +
                    +
                    +
                      +
                      +
                      +
                      +
                      +
                      + + +
                      + + + + diff --git a/docs/files/src-admin-layout-class-footnotes-layout-init.html b/docs/files/src-admin-layout-class-footnotes-layout-init.html new file mode 100644 index 0000000..65a1547 --- /dev/null +++ b/docs/files/src-admin-layout-class-footnotes-layout-init.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                      +

                      Documentation

                      + + +
                      + +
                      + + +
                      + +
                      +
                      + + + + +
                      + + +
                      +

                      class-footnotes-layout-init.php

                      + + + +

                      + Interfaces, Classes and Traits + +

                      + +
                      + +
                      Footnotes_Layout_Init
                      +
                      Handles the Settings interface of the Plugin.
                      + +
                      + + + + + + + +
                      +
                      +
                      +
                      +

                      Search results

                      + +
                      +
                      +
                        +
                        +
                        +
                        +
                        +
                        + + +
                        + + + + diff --git a/docs/files/src-admin-layout-class-footnotes-layout-settings.html b/docs/files/src-admin-layout-class-footnotes-layout-settings.html new file mode 100644 index 0000000..95b4419 --- /dev/null +++ b/docs/files/src-admin-layout-class-footnotes-layout-settings.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                        +

                        Documentation

                        + + +
                        + +
                        + + +
                        + +
                        +
                        + + + + +
                        + + +
                        +

                        class-footnotes-layout-settings.php

                        + + + +

                        + Interfaces, Classes and Traits + +

                        + +
                        + +
                        Footnotes_Layout_Settings
                        +
                        Displays and handles all Settings of the Plugin.
                        + +
                        + + + + + + + +
                        +
                        +
                        +
                        +

                        Search results

                        + +
                        +
                        +
                          +
                          +
                          +
                          +
                          +
                          + + +
                          + + + + diff --git a/docs/files/src-footnotes.html b/docs/files/src-footnotes.html index 4362c2d..ee94d33 100644 --- a/docs/files/src-footnotes.html +++ b/docs/files/src-footnotes.html @@ -51,9 +51,18 @@

                          Namespaces

                          -

                          Global

                          -
                          +
                          +
                          +

                          Packages

                          +

                          footnotes

                          + +

                          Default

                          +

                          Reports

                          @@ -80,11 +89,137 @@ +

                          + Table of Contents + +

                          + +
                          +
                          + activate_footnotes() + +  : mixed +
                          +
                          The code that runs during plugin activation.
                          + +
                          + deactivate_plugin_name() + +  : mixed +
                          +
                          The code that runs during plugin deactivation.
                          + +
                          + run_footnotes() + +  : mixed +
                          +
                          Begins execution of the plugin.
                          + +
                          - +
                          +

                          + Functions + +

                          +
                          +

                          + activate_footnotes() + +

                          + + +

                          The code that runs during plugin activation.

                          + + + + activate_footnotes() : mixed + +

                          This action is documented in includes/class-plugin-name-activator.php

                          +
                          + + + + + +
                          +
                          +

                          + deactivate_plugin_name() + +

                          + + +

                          The code that runs during plugin deactivation.

                          + + + + deactivate_plugin_name() : mixed + +

                          This action is documented in includes/class-plugin-name-deactivator.php

                          +
                          + + + + + +
                          +
                          +

                          + run_footnotes() + +

                          + + +

                          Begins execution of the plugin.

                          + + + + run_footnotes() : mixed + +

                          Since everything within the plugin is registered via hooks, +then kicking off the plugin from this point in the file does +not affect the page life cycle.

                          +
                          + + + +
                          + Tags + +
                          +
                          +
                          + since +
                          +
                          + 2.8.0 + +
                          + +
                          +
                          + + +
                          +
                          +
                          diff --git a/docs/files/src-includes-class-footnotes-activator.html b/docs/files/src-includes-class-footnotes-activator.html new file mode 100644 index 0000000..23ebe44 --- /dev/null +++ b/docs/files/src-includes-class-footnotes-activator.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                          +

                          Documentation

                          + + +
                          + +
                          + + +
                          + +
                          +
                          + + + + +
                          + + +
                          +

                          class-footnotes-activator.php

                          + + + +

                          + Interfaces, Classes and Traits + +

                          + +
                          + +
                          Footnotes_Activator
                          +
                          Fired during plugin activation.
                          + +
                          + + + + + + + +
                          +
                          +
                          +
                          +

                          Search results

                          + +
                          +
                          +
                            +
                            +
                            +
                            +
                            +
                            + + +
                            + + + + diff --git a/docs/files/src-includes-class-footnotes-config.html b/docs/files/src-includes-class-footnotes-config.html new file mode 100644 index 0000000..7c1fac2 --- /dev/null +++ b/docs/files/src-includes-class-footnotes-config.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                            +

                            Documentation

                            + + +
                            + +
                            + + +
                            + +
                            +
                            + + + + +
                            + + +
                            +

                            class-footnotes-config.php

                            + + + +

                            + Interfaces, Classes and Traits + +

                            + +
                            + +
                            Footnotes_Config
                            +
                            Contains all Plugin Constants. Contains no Method or Property.
                            + +
                            + + + + + + + +
                            +
                            +
                            +
                            +

                            Search results

                            + +
                            +
                            +
                              +
                              +
                              +
                              +
                              +
                              + + +
                              + + + + diff --git a/docs/files/src-includes-class-footnotes-convert.html b/docs/files/src-includes-class-footnotes-convert.html new file mode 100644 index 0000000..876dff2 --- /dev/null +++ b/docs/files/src-includes-class-footnotes-convert.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                              +

                              Documentation

                              + + +
                              + +
                              + + +
                              + +
                              +
                              + + + + +
                              + + +
                              +

                              class-footnotes-convert.php

                              + + + +

                              + Interfaces, Classes and Traits + +

                              + +
                              + +
                              Footnotes_Convert
                              +
                              Converts data types and Footnotes specific values.
                              + +
                              + + + + + + + +
                              +
                              +
                              +
                              +

                              Search results

                              + +
                              +
                              +
                                +
                                +
                                +
                                +
                                +
                                + + +
                                + + + + diff --git a/docs/files/src-includes-class-footnotes-deactivator.html b/docs/files/src-includes-class-footnotes-deactivator.html new file mode 100644 index 0000000..5da7018 --- /dev/null +++ b/docs/files/src-includes-class-footnotes-deactivator.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                +

                                Documentation

                                + + +
                                + +
                                + + +
                                + +
                                +
                                + + + + +
                                + + +
                                +

                                class-footnotes-deactivator.php

                                + + + +

                                + Interfaces, Classes and Traits + +

                                + +
                                + +
                                Footnotes_Deactivator
                                +
                                Fired during plugin deactivation.
                                + +
                                + + + + + + + +
                                +
                                +
                                +
                                +

                                Search results

                                + +
                                +
                                +
                                  +
                                  +
                                  +
                                  +
                                  +
                                  + + +
                                  + + + + diff --git a/docs/files/src-includes-class-footnotes-i18n.html b/docs/files/src-includes-class-footnotes-i18n.html new file mode 100644 index 0000000..1c28315 --- /dev/null +++ b/docs/files/src-includes-class-footnotes-i18n.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                  +

                                  Documentation

                                  + + +
                                  + +
                                  + + +
                                  + +
                                  +
                                  + + + + +
                                  + + +
                                  +

                                  class-footnotes-i18n.php

                                  + + + +

                                  + Interfaces, Classes and Traits + +

                                  + +
                                  + +
                                  Footnotes_i18n
                                  +
                                  Define the internationalization functionality.
                                  + +
                                  + + + + + + + +
                                  +
                                  +
                                  +
                                  +

                                  Search results

                                  + +
                                  +
                                  +
                                    +
                                    +
                                    +
                                    +
                                    +
                                    + + +
                                    + + + + diff --git a/docs/files/src-includes-class-footnotes-loader.html b/docs/files/src-includes-class-footnotes-loader.html new file mode 100644 index 0000000..149e066 --- /dev/null +++ b/docs/files/src-includes-class-footnotes-loader.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                    +

                                    Documentation

                                    + + +
                                    + +
                                    + + +
                                    + +
                                    +
                                    + + + + +
                                    + + +
                                    +

                                    class-footnotes-loader.php

                                    + + + +

                                    + Interfaces, Classes and Traits + +

                                    + +
                                    + +
                                    Footnotes_Loader
                                    +
                                    Register all actions and filters for the plugin.
                                    + +
                                    + + + + + + + +
                                    +
                                    +
                                    +
                                    +

                                    Search results

                                    + +
                                    +
                                    +
                                      +
                                      +
                                      +
                                      +
                                      +
                                      + + +
                                      + + + + diff --git a/docs/files/src-includes-class-footnotes-settings.html b/docs/files/src-includes-class-footnotes-settings.html new file mode 100644 index 0000000..658d74e --- /dev/null +++ b/docs/files/src-includes-class-footnotes-settings.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                      +

                                      Documentation

                                      + + +
                                      + +
                                      + + +
                                      + +
                                      +
                                      + + + + +
                                      + + +
                                      +

                                      class-footnotes-settings.php

                                      + + + +

                                      + Interfaces, Classes and Traits + +

                                      + +
                                      + +
                                      Footnotes_Settings
                                      +
                                      Loads the settings values, sets to default values if undefined.
                                      + +
                                      + + + + + + + +
                                      +
                                      +
                                      +
                                      +

                                      Search results

                                      + +
                                      +
                                      +
                                        +
                                        +
                                        +
                                        +
                                        +
                                        + + +
                                        + + + + diff --git a/docs/files/src-includes-class-footnotes-template.html b/docs/files/src-includes-class-footnotes-template.html new file mode 100644 index 0000000..56d379d --- /dev/null +++ b/docs/files/src-includes-class-footnotes-template.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                        +

                                        Documentation

                                        + + +
                                        + +
                                        + + +
                                        + +
                                        +
                                        + + + + +
                                        + + +
                                        +

                                        class-footnotes-template.php

                                        + + + +

                                        + Interfaces, Classes and Traits + +

                                        + +
                                        + +
                                        Footnotes_Template
                                        +
                                        Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                        + +
                                        + + + + + + + +
                                        +
                                        +
                                        +
                                        +

                                        Search results

                                        + +
                                        +
                                        +
                                          +
                                          +
                                          +
                                          +
                                          +
                                          + + +
                                          + + + + diff --git a/docs/files/src-includes-class-footnotes.html b/docs/files/src-includes-class-footnotes.html new file mode 100644 index 0000000..1ece9e5 --- /dev/null +++ b/docs/files/src-includes-class-footnotes.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                          +

                                          Documentation

                                          + + +
                                          + +
                                          + + +
                                          + +
                                          +
                                          + + + + +
                                          + + +
                                          +

                                          class-footnotes.php

                                          + + + +

                                          + Interfaces, Classes and Traits + +

                                          + +
                                          + +
                                          Footnotes
                                          +
                                          The core plugin class.
                                          + +
                                          + + + + + + + +
                                          +
                                          +
                                          +
                                          +

                                          Search results

                                          + +
                                          +
                                          +
                                            +
                                            +
                                            +
                                            +
                                            +
                                            + + +
                                            + + + + diff --git a/docs/files/src-includes-index.html b/docs/files/src-includes-index.html new file mode 100644 index 0000000..2e12629 --- /dev/null +++ b/docs/files/src-includes-index.html @@ -0,0 +1,119 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                            +

                                            Documentation

                                            + + +
                                            + +
                                            + + +
                                            + +
                                            +
                                            + + + + +
                                            + + +
                                            +

                                            index.php

                                            + + + + + + + + + + +
                                            +
                                            +
                                            +
                                            +

                                            Search results

                                            + +
                                            +
                                            +
                                              +
                                              +
                                              +
                                              +
                                              +
                                              + + +
                                              + + + + diff --git a/docs/files/src-index.html b/docs/files/src-index.html new file mode 100644 index 0000000..5166573 --- /dev/null +++ b/docs/files/src-index.html @@ -0,0 +1,119 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                              +

                                              Documentation

                                              + + +
                                              + +
                                              + + +
                                              + +
                                              +
                                              + + + + +
                                              + + +
                                              +

                                              index.php

                                              + + + + + + + + + + +
                                              +
                                              +
                                              +
                                              +

                                              Search results

                                              + +
                                              +
                                              +
                                                +
                                                +
                                                +
                                                +
                                                +
                                                + + +
                                                + + + + diff --git a/docs/files/src-public-class-footnotes-public.html b/docs/files/src-public-class-footnotes-public.html new file mode 100644 index 0000000..a1f03bc --- /dev/null +++ b/docs/files/src-public-class-footnotes-public.html @@ -0,0 +1,131 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                +

                                                Documentation

                                                + + +
                                                + +
                                                + + +
                                                + +
                                                +
                                                + + + + +
                                                + + +
                                                +

                                                class-footnotes-public.php

                                                + + + +

                                                + Interfaces, Classes and Traits + +

                                                + +
                                                + +
                                                Footnotes_Public
                                                +
                                                The public-facing functionality of the plugin.
                                                + +
                                                + + + + + + + +
                                                +
                                                +
                                                +
                                                +

                                                Search results

                                                + +
                                                +
                                                +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  +
                                                  + + +
                                                  + + + + diff --git a/docs/files/src-public-class-footnotes-task.html b/docs/files/src-public-class-footnotes-task.html new file mode 100644 index 0000000..a47ce16 --- /dev/null +++ b/docs/files/src-public-class-footnotes-task.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                  +

                                                  Documentation

                                                  + + +
                                                  + +
                                                  + + +
                                                  + +
                                                  +
                                                  + + + + +
                                                  + + +
                                                  +

                                                  class-footnotes-task.php

                                                  + + + +

                                                  + Interfaces, Classes and Traits + +

                                                  + +
                                                  + +
                                                  Footnotes_Task
                                                  +
                                                  Searches and replaces the footnotes and generates the reference container.
                                                  + +
                                                  + + + + + + + +
                                                  +
                                                  +
                                                  +
                                                  +

                                                  Search results

                                                  + +
                                                  +
                                                  +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    +
                                                    + + +
                                                    + + + + diff --git a/docs/files/src-public-index.html b/docs/files/src-public-index.html new file mode 100644 index 0000000..b09f9b2 --- /dev/null +++ b/docs/files/src-public-index.html @@ -0,0 +1,119 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                    +

                                                    Documentation

                                                    + + +
                                                    + +
                                                    + + +
                                                    + +
                                                    +
                                                    + + + + +
                                                    + + +
                                                    +

                                                    index.php

                                                    + + + + + + + + + + +
                                                    +
                                                    +
                                                    +
                                                    +

                                                    Search results

                                                    + +
                                                    +
                                                    +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      +
                                                      + + +
                                                      + + + + diff --git a/docs/files/src-public-widget-class-footnotes-widget-base.html b/docs/files/src-public-widget-class-footnotes-widget-base.html new file mode 100644 index 0000000..069bbb2 --- /dev/null +++ b/docs/files/src-public-widget-class-footnotes-widget-base.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                      +

                                                      Documentation

                                                      + + +
                                                      + +
                                                      + + +
                                                      + +
                                                      +
                                                      + + + + +
                                                      + + +
                                                      +

                                                      class-footnotes-widget-base.php

                                                      + + + +

                                                      + Interfaces, Classes and Traits + +

                                                      + +
                                                      + +
                                                      Footnotes_Widget_Base
                                                      +
                                                      Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                      + +
                                                      + + + + + + + +
                                                      +
                                                      +
                                                      +
                                                      +

                                                      Search results

                                                      + +
                                                      +
                                                      +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        +
                                                        + + +
                                                        + + + + diff --git a/docs/files/src-public-widget-class-footnotes-widget-reference-container.html b/docs/files/src-public-widget-class-footnotes-widget-reference-container.html new file mode 100644 index 0000000..9c7f5ca --- /dev/null +++ b/docs/files/src-public-widget-class-footnotes-widget-reference-container.html @@ -0,0 +1,130 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                        +

                                                        Documentation

                                                        + + +
                                                        + +
                                                        + + +
                                                        + +
                                                        +
                                                        + + + + +
                                                        + + +
                                                        +

                                                        class-footnotes-widget-reference-container.php

                                                        + + + +

                                                        + Interfaces, Classes and Traits + +

                                                        + +
                                                        + +
                                                        Footnotes_Widget_Reference_Container
                                                        +
                                                        Registers a Widget to put the Reference Container to the widget area.
                                                        + +
                                                        + + + + + + + +
                                                        +
                                                        +
                                                        +
                                                        +

                                                        Search results

                                                        + +
                                                        +
                                                        +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          +
                                                          + + +
                                                          + + + + diff --git a/docs/files/src-uninstall.html b/docs/files/src-uninstall.html new file mode 100644 index 0000000..1e0e617 --- /dev/null +++ b/docs/files/src-uninstall.html @@ -0,0 +1,119 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                          +

                                                          Documentation

                                                          + + +
                                                          + +
                                                          + + +
                                                          + +
                                                          +
                                                          + + + + +
                                                          + + +
                                                          +

                                                          uninstall.php

                                                          + + + + + + + + + + +
                                                          +
                                                          +
                                                          +
                                                          +

                                                          Search results

                                                          + +
                                                          +
                                                          +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            +
                                                            + + +
                                                            + + + + diff --git a/docs/graphs/classes.html b/docs/graphs/classes.html index f77584f..8361330 100644 --- a/docs/graphs/classes.html +++ b/docs/graphs/classes.html @@ -44,9 +44,18 @@

                                                            Namespaces

                                                            -

                                                            Global

                                                            -
                                                            +
                                                            +
                                                            +

                                                            Packages

                                                            +

                                                            footnotes

                                                            + +

                                                            Default

                                                            +

                                                            Reports

                                                            diff --git a/docs/index.html b/docs/index.html index 3706b3f..5637e63 100644 --- a/docs/index.html +++ b/docs/index.html @@ -51,9 +51,18 @@

                                                            Namespaces

                                                            -

                                                            Global

                                                            -
                                                            +
                                                            +
                                                            +

                                                            Packages

                                                            +

                                                            footnotes

                                                            + +

                                                            Default

                                                            +

                                                            Reports

                                                            @@ -72,7 +81,16 @@

                                                            Documentation

                                                            - +

                                                            + Packages + +

                                                            + +
                                                            +
                                                            footnotes
                                                            +
                                                            Default
                                                            +
                                                            +

                                                            Interfaces, Classes and Traits @@ -81,34 +99,42 @@
                                                            +
                                                            Footnotes_Activator
                                                            +
                                                            Fired during plugin activation.
                                                            +
                                                            Footnotes_Deactivator
                                                            +
                                                            Fired during plugin deactivation.
                                                            +
                                                            Footnotes
                                                            +
                                                            The core plugin class.
                                                            +
                                                            Footnotes_Admin
                                                            +
                                                            The admin-specific functionality of the plugin.
                                                            +
                                                            Footnotes_WYSIWYG
                                                            +
                                                            Handles the WSYIWYG-Buttons.
                                                            +
                                                            Footnotes_Layout_Engine
                                                            +
                                                            Layout Engine for the administration dashboard.
                                                            +
                                                            Footnotes_Layout_Init
                                                            +
                                                            Handles the Settings interface of the Plugin.
                                                            +
                                                            Footnotes_Layout_Settings
                                                            +
                                                            Displays and handles all Settings of the Plugin.
                                                            Footnotes_Config
                                                            Contains all Plugin Constants. Contains no Method or Property.
                                                            Footnotes_Convert
                                                            Converts data types and Footnotes specific values.
                                                            -
                                                            Footnotes_Layout_Init
                                                            -
                                                            Handles the Settings interface of the Plugin.
                                                            -
                                                            Footnotes_Layout_Engine
                                                            -
                                                            Layout Engine for the administration dashboard.
                                                            -
                                                            Footnotes_Layout_Settings
                                                            -
                                                            Displays and handles all Settings of the Plugin.
                                                            -
                                                            Footnotes_Hooks
                                                            -
                                                            Registers all WordPress hooks and executes them on demand.
                                                            -
                                                            Footnotes
                                                            -
                                                            Provides an entry point to the Plugin.
                                                            -
                                                            Footnotes_Language
                                                            -
                                                            Loads text domain of current or default language for localization.
                                                            +
                                                            Footnotes_i18n
                                                            +
                                                            Define the internationalization functionality.
                                                            +
                                                            Footnotes_Loader
                                                            +
                                                            Register all actions and filters for the plugin.
                                                            Footnotes_Settings
                                                            Loads the settings values, sets to default values if undefined.
                                                            -
                                                            Footnotes_Task
                                                            -
                                                            Searches and replaces the footnotes and generates the reference container.
                                                            Footnotes_Template
                                                            Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                            +
                                                            Footnotes_Public
                                                            +
                                                            The public-facing functionality of the plugin.
                                                            +
                                                            Footnotes_Task
                                                            +
                                                            Searches and replaces the footnotes and generates the reference container.
                                                            Footnotes_Widget_Base
                                                            Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                            Footnotes_Widget_Reference_Container
                                                            Registers a Widget to put the Reference Container to the widget area.
                                                            -
                                                            Footnotes_WYSIWYG
                                                            -
                                                            Handles the WSYIWYG-Buttons.
                                                            @@ -120,11 +146,25 @@
                                                            - mci_footnotes_require_php_files() + activate_footnotes()  : mixed
                                                            -
                                                            Requires (`require_once`) all `*.php` files inside a specific Directory.
                                                            +
                                                            The code that runs during plugin activation.
                                                            + +
                                                            + deactivate_plugin_name() + +  : mixed +
                                                            +
                                                            The code that runs during plugin deactivation.
                                                            + +
                                                            + run_footnotes() + +  : mixed +
                                                            +
                                                            Begins execution of the plugin.
                                                            @@ -136,57 +176,89 @@

                                                            -

                                                            - mci_footnotes_require_php_files() - +

                                                            + activate_footnotes() +

                                                            -

                                                            Requires (`require_once`) all `*.php` files inside a specific Directory.

                                                            +

                                                            The code that runs during plugin activation.

                                                            - mci_footnotes_require_php_files(string $p_str_directory) : mixed + activate_footnotes() : mixed -
                                                            - -
                                                            Parameters
                                                            -
                                                            -
                                                            - $p_str_directory - : string -
                                                            -
                                                            -

                                                            Absolute Directory path to lookup for *.php files.

                                                            +

                                                            This action is documented in includes/class-plugin-name-activator.php

                                                            -
                                                            -
                                                            + + +
                                                            +
                                                            +

                                                            + deactivate_plugin_name() + +

                                                            + + +

                                                            The code that runs during plugin deactivation.

                                                            + + + + deactivate_plugin_name() : mixed + +

                                                            This action is documented in includes/class-plugin-name-deactivator.php

                                                            +
                                                            + + + + + +
                                                            +
                                                            +

                                                            + run_footnotes() + +

                                                            + + +

                                                            Begins execution of the plugin.

                                                            + + + + run_footnotes() : mixed + +

                                                            Since everything within the plugin is registered via hooks, +then kicking off the plugin from this point in the file does +not affect the page life cycle.

                                                            +
                                                            + + +
                                                            Tags
                                                            - author -
                                                            -
                                                            - -

                                                            Stefan Herndler

                                                            -
                                                            - -
                                                            -
                                                            since
                                                            - 1.5.0 + 2.8.0
                                                            diff --git a/docs/indices/files.html b/docs/indices/files.html index 3d651d0..c68514a 100644 --- a/docs/indices/files.html +++ b/docs/indices/files.html @@ -51,9 +51,18 @@

                                                            Namespaces

                                                            -

                                                            Global

                                                            -
                                                            +
                                                            +
                                                            +

                                                            Packages

                                                            +

                                                            footnotes

                                                            + +

                                                            Default

                                                            +

                                                            Reports

                                                            @@ -71,53 +80,43 @@

                                                            Files

                                                            -

                                                            B

                                                            +

                                                            C

                                                            -

                                                            C

                                                            -

                                                            F

                                                            -

                                                            H

                                                            +

                                                            I

                                                            -

                                                            I

                                                            +

                                                            U

                                                            -

                                                            L

                                                            - -

                                                            R

                                                            - -

                                                            S

                                                            - -

                                                            T

                                                            - -

                                                            W

                                                            - -
                                                            +

                                                            Search results

                                                            diff --git a/docs/js/searchIndex.js b/docs/js/searchIndex.js index 2c5b880..25edadf 100644 --- a/docs/js/searchIndex.js +++ b/docs/js/searchIndex.js @@ -1,120 +1,175 @@ Search.appendIndex( [ { - "fqsen": "\\Footnotes_Config", - "name": "Footnotes_Config", - "summary": "Contains\u0020all\u0020Plugin\u0020Constants.\u0020Contains\u0020no\u0020Method\u0020or\u0020Property.", - "url": "classes/Footnotes-Config.html" + "fqsen": "\\activate_footnotes\u0028\u0029", + "name": "activate_footnotes", + "summary": "The\u0020code\u0020that\u0020runs\u0020during\u0020plugin\u0020activation.", + "url": "namespaces/default.html#function_activate_footnotes" }, { - "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_PLUGIN_NAME", - "name": "C_STR_PLUGIN_NAME", - "summary": "Internal\u0020Plugin\u0020name.", - "url": "classes/Footnotes-Config.html#constant_C_STR_PLUGIN_NAME" + "fqsen": "\\deactivate_plugin_name\u0028\u0029", + "name": "deactivate_plugin_name", + "summary": "The\u0020code\u0020that\u0020runs\u0020during\u0020plugin\u0020deactivation.", + "url": "namespaces/default.html#function_deactivate_plugin_name" }, { - "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_PLUGIN_PUBLIC_NAME", - "name": "C_STR_PLUGIN_PUBLIC_NAME", - "summary": "Public\u0020Plugin\u0020name.", - "url": "classes/Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME" + "fqsen": "\\run_footnotes\u0028\u0029", + "name": "run_footnotes", + "summary": "Begins\u0020execution\u0020of\u0020the\u0020plugin.", + "url": "namespaces/default.html#function_run_footnotes" }, { - "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_PLUGIN_HEADING_NAME", - "name": "C_STR_PLUGIN_HEADING_NAME", - "summary": "Public\u0020Plugin\u0020name\u0020for\u0020dashboard\u0020heading", - "url": "classes/Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME" + "fqsen": "\\Footnotes_Activator", + "name": "Footnotes_Activator", + "summary": "Fired\u0020during\u0020plugin\u0020activation.", + "url": "classes/Footnotes-Activator.html" }, { - "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_LOVE_SYMBOL", - "name": "C_STR_LOVE_SYMBOL", - "summary": "Html\u0020tag\u0020for\u0020the\u0020LOVE\u0020symbol.", - "url": "classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL" + "fqsen": "\\Footnotes_Activator\u003A\u003Aactivate\u0028\u0029", + "name": "activate", + "summary": "Runs\u0020when\u0020the\u0020Plugin\u0020is\u0020deactivated.", + "url": "classes/Footnotes-Activator.html#method_activate" }, { - "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_LOVE_SYMBOL_HEADING", - "name": "C_STR_LOVE_SYMBOL_HEADING", - "summary": "HTML\u0020code\u0020for\u0020the\u0020\u0027love\u0027\u0020symbol\u0020used\u0020in\u0020dashboard\u0020heading", - "url": "classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING" + "fqsen": "\\Footnotes_Deactivator", + "name": "Footnotes_Deactivator", + "summary": "Fired\u0020during\u0020plugin\u0020deactivation.", + "url": "classes/Footnotes-Deactivator.html" }, { - "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_NO_LOVE_SLUG", - "name": "C_STR_NO_LOVE_SLUG", - "summary": "Short\u0020code\u0020to\u0020DON\u0027T\u0020display\u0020the\u0020\u0027LOVE\u0020ME\u0027\u0020slug\u0020on\u0020certain\u0020pages.", - "url": "classes/Footnotes-Config.html#constant_C_STR_NO_LOVE_SLUG" + "fqsen": "\\Footnotes_Deactivator\u003A\u003Adeactivate\u0028\u0029", + "name": "deactivate", + "summary": "Runs\u0020when\u0020the\u0020Plugin\u0020is\u0020deactivated.", + "url": "classes/Footnotes-Deactivator.html#method_deactivate" }, { - "fqsen": "\\Footnotes_Convert", - "name": "Footnotes_Convert", - "summary": "Converts\u0020data\u0020types\u0020and\u0020Footnotes\u0020specific\u0020values.", - "url": "classes/Footnotes-Convert.html" + "fqsen": "\\Footnotes", + "name": "Footnotes", + "summary": "The\u0020core\u0020plugin\u0020class.", + "url": "classes/Footnotes.html" }, { - "fqsen": "\\Footnotes_Convert\u003A\u003Aindex\u0028\u0029", - "name": "index", - "summary": "Converts\u0020a\u0020integer\u0020into\u0020the\u0020user\u002Ddefined\u0020counter\u0020style\u0020for\u0020the\u0020footnotes.", - "url": "classes/Footnotes-Convert.html#method_index" - }, { - "fqsen": "\\Footnotes_Convert\u003A\u003Ato_latin\u0028\u0029", - "name": "to_latin", - "summary": "Converts\u0020an\u0020integer\u0020into\u0020latin\u0020ascii\u0020characters,\u0020either\u0020lower\u0020or\u0020upper\u002Dcase.", - "url": "classes/Footnotes-Convert.html#method_to_latin" - }, { - "fqsen": "\\Footnotes_Convert\u003A\u003Ato_arabic_leading\u0028\u0029", - "name": "to_arabic_leading", - "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020leading\u002D0\u0020integer.", - "url": "classes/Footnotes-Convert.html#method_to_arabic_leading" - }, { - "fqsen": "\\Footnotes_Convert\u003A\u003Ato_romanic\u0028\u0029", - "name": "to_romanic", - "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020romanic\u0020letter.", - "url": "classes/Footnotes-Convert.html#method_to_romanic" - }, { - "fqsen": "\\Footnotes_Convert\u003A\u003Ato_bool\u0028\u0029", - "name": "to_bool", - "summary": "Converts\u0020a\u0020string\u0020depending\u0020on\u0020its\u0020value\u0020to\u0020a\u0020boolean.", - "url": "classes/Footnotes-Convert.html#method_to_bool" - }, { - "fqsen": "\\Footnotes_Convert\u003A\u003Aget_arrow\u0028\u0029", - "name": "get_arrow", - "summary": "Get\u0020a\u0020html\u0020Array\u0020short\u0020code\u0020depending\u0020on\u0020Arrow\u002DArray\u0020key\u0020index.", - "url": "classes/Footnotes-Convert.html#method_get_arrow" - }, { - "fqsen": "\\Footnotes_Convert\u003A\u003Adebug\u0028\u0029", - "name": "debug", - "summary": "Displays\u0020a\u0020Variable.", - "url": "classes/Footnotes-Convert.html#method_debug" - }, { - "fqsen": "\\Footnotes_Layout_Init", - "name": "Footnotes_Layout_Init", - "summary": "Handles\u0020the\u0020Settings\u0020interface\u0020of\u0020the\u0020Plugin.", - "url": "classes/Footnotes-Layout-Init.html" - }, { - "fqsen": "\\Footnotes_Layout_Init\u003A\u003A__construct\u0028\u0029", + "fqsen": "\\Footnotes\u003A\u003A__construct\u0028\u0029", "name": "__construct", - "summary": "Class\u0020Constructor.\u0020Initializes\u0020all\u0020WordPress\u0020hooks\u0020for\u0020the\u0020Plugin\u0020Settings.", - "url": "classes/Footnotes-Layout-Init.html#method___construct" + "summary": "Define\u0020the\u0020core\u0020functionality\u0020of\u0020the\u0020plugin.", + "url": "classes/Footnotes.html#method___construct" }, { - "fqsen": "\\Footnotes_Layout_Init\u003A\u003Ainitialize_settings\u0028\u0029", - "name": "initialize_settings", - "summary": "Registers\u0020the\u0020settings\u0020and\u0020initialises\u0020the\u0020settings\u0020page.", - "url": "classes/Footnotes-Layout-Init.html#method_initialize_settings" + "fqsen": "\\Footnotes\u003A\u003Aload_dependencies\u0028\u0029", + "name": "load_dependencies", + "summary": "Load\u0020the\u0020required\u0020dependencies\u0020for\u0020this\u0020plugin.", + "url": "classes/Footnotes.html#method_load_dependencies" }, { - "fqsen": "\\Footnotes_Layout_Init\u003A\u003Aregister_options_submenu\u0028\u0029", - "name": "register_options_submenu", - "summary": "Registers\u0020the\u0020footnotes\u0020submenu\u0020page.", - "url": "classes/Footnotes-Layout-Init.html#method_register_options_submenu" + "fqsen": "\\Footnotes\u003A\u003Aset_locale\u0028\u0029", + "name": "set_locale", + "summary": "Define\u0020the\u0020locale\u0020for\u0020this\u0020plugin\u0020for\u0020internationalization.", + "url": "classes/Footnotes.html#method_set_locale" }, { - "fqsen": "\\Footnotes_Layout_Init\u003A\u003Aget_plugin_meta_information\u0028\u0029", - "name": "get_plugin_meta_information", - "summary": "AJAX\u0020call.\u0020returns\u0020a\u0020JSON\u0020string\u0020containing\u0020meta\u0020information\u0020about\u0020a\u0020specific\u0020WordPress\u0020Plugin.", - "url": "classes/Footnotes-Layout-Init.html#method_get_plugin_meta_information" + "fqsen": "\\Footnotes\u003A\u003Adefine_admin_hooks\u0028\u0029", + "name": "define_admin_hooks", + "summary": "Register\u0020all\u0020of\u0020the\u0020hooks\u0020related\u0020to\u0020the\u0020admin\u0020area\u0020functionality\nof\u0020the\u0020plugin.", + "url": "classes/Footnotes.html#method_define_admin_hooks" }, { - "fqsen": "\\Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_SLUG", - "name": "C_STR_MAIN_MENU_SLUG", - "summary": "Slug\u0020for\u0020the\u0020Plugin\u0020main\u0020menu.", - "url": "classes/Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" + "fqsen": "\\Footnotes\u003A\u003Adefine_public_hooks\u0028\u0029", + "name": "define_public_hooks", + "summary": "Register\u0020all\u0020of\u0020the\u0020hooks\u0020related\u0020to\u0020the\u0020public\u002Dfacing\u0020functionality\nof\u0020the\u0020plugin.", + "url": "classes/Footnotes.html#method_define_public_hooks" }, { - "fqsen": "\\Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_TITLE", - "name": "C_STR_MAIN_MENU_TITLE", - "summary": "Plugin\u0020main\u0020menu\u0020name.", - "url": "classes/Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE" + "fqsen": "\\Footnotes\u003A\u003Arun\u0028\u0029", + "name": "run", + "summary": "Run\u0020the\u0020loader\u0020to\u0020execute\u0020all\u0020of\u0020the\u0020hooks\u0020with\u0020WordPress.", + "url": "classes/Footnotes.html#method_run" }, { - "fqsen": "\\Footnotes_Layout_Init\u003A\u003A\u0024settings_page", - "name": "settings_page", - "summary": "Contains\u0020the\u0020settings\u0020layoutEngine", - "url": "classes/Footnotes-Layout-Init.html#property_settings_page" + "fqsen": "\\Footnotes\u003A\u003Aget_plugin_name\u0028\u0029", + "name": "get_plugin_name", + "summary": "The\u0020name\u0020of\u0020the\u0020plugin\u0020used\u0020to\u0020uniquely\u0020identify\u0020it\u0020within\u0020the\u0020context\u0020of\nWordPress\u0020and\u0020to\u0020define\u0020internationalization\u0020functionality.", + "url": "classes/Footnotes.html#method_get_plugin_name" + }, { + "fqsen": "\\Footnotes\u003A\u003Aget_loader\u0028\u0029", + "name": "get_loader", + "summary": "The\u0020reference\u0020to\u0020the\u0020class\u0020that\u0020orchestrates\u0020the\u0020hooks\u0020with\u0020the\u0020plugin.", + "url": "classes/Footnotes.html#method_get_loader" + }, { + "fqsen": "\\Footnotes\u003A\u003Aget_version\u0028\u0029", + "name": "get_version", + "summary": "Retrieve\u0020the\u0020version\u0020number\u0020of\u0020the\u0020plugin.", + "url": "classes/Footnotes.html#method_get_version" + }, { + "fqsen": "\\Footnotes\u003A\u003A\u0024loader", + "name": "loader", + "summary": "The\u0020loader\u0020that\u0027s\u0020responsible\u0020for\u0020maintaining\u0020and\u0020registering\u0020all\u0020hooks\u0020that\u0020power\nthe\u0020plugin.", + "url": "classes/Footnotes.html#property_loader" + }, { + "fqsen": "\\Footnotes\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020unique\u0020identifier\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes.html#property_plugin_name" + }, { + "fqsen": "\\Footnotes\u003A\u003A\u0024version", + "name": "version", + "summary": "The\u0020current\u0020version\u0020of\u0020the\u0020plugin.", + "url": "classes/Footnotes.html#property_version" + }, { + "fqsen": "\\Footnotes_Admin", + "name": "Footnotes_Admin", + "summary": "The\u0020admin\u002Dspecific\u0020functionality\u0020of\u0020the\u0020plugin.", + "url": "classes/Footnotes-Admin.html" + }, { + "fqsen": "\\Footnotes_Admin\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/Footnotes-Admin.html#method___construct" + }, { + "fqsen": "\\Footnotes_Admin\u003A\u003Aload_dependencies\u0028\u0029", + "name": "load_dependencies", + "summary": "Load\u0020the\u0020required\u0020admin\u002Dspecific\u0020dependencies.", + "url": "classes/Footnotes-Admin.html#method_load_dependencies" + }, { + "fqsen": "\\Footnotes_Admin\u003A\u003Aenqueue_styles\u0028\u0029", + "name": "enqueue_styles", + "summary": "Register\u0020the\u0020stylesheets\u0020for\u0020the\u0020admin\u0020area.", + "url": "classes/Footnotes-Admin.html#method_enqueue_styles" + }, { + "fqsen": "\\Footnotes_Admin\u003A\u003Aenqueue_scripts\u0028\u0029", + "name": "enqueue_scripts", + "summary": "Register\u0020the\u0020JavaScript\u0020for\u0020the\u0020admin\u0020area.", + "url": "classes/Footnotes-Admin.html#method_enqueue_scripts" + }, { + "fqsen": "\\Footnotes_Admin\u003A\u003Aget_plugin_links\u0028\u0029", + "name": "get_plugin_links", + "summary": "Appends\u0020the\u0020Plugin\u0020links\u0020for\u0020display\u0020in\u0020the\u0020dashboard\u0020Plugins\u0020page.", + "url": "classes/Footnotes-Admin.html#method_get_plugin_links" + }, { + "fqsen": "\\Footnotes_Admin\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes-Admin.html#property_plugin_name" + }, { + "fqsen": "\\Footnotes_Admin\u003A\u003A\u0024version", + "name": "version", + "summary": "The\u0020version\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes-Admin.html#property_version" + }, { + "fqsen": "\\Footnotes_WYSIWYG", + "name": "Footnotes_WYSIWYG", + "summary": "Handles\u0020the\u0020WSYIWYG\u002DButtons.", + "url": "classes/Footnotes-WYSIWYG.html" + }, { + "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Aregister_hooks\u0028\u0029", + "name": "register_hooks", + "summary": "Registers\u0020Button\u0020hooks.", + "url": "classes/Footnotes-WYSIWYG.html#method_register_hooks" + }, { + "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Anew_visual_editor_button\u0028\u0029", + "name": "new_visual_editor_button", + "summary": "Append\u0020a\u0020new\u0020Button\u0020to\u0020the\u0020WYSIWYG\u0020editor\u0020of\u0020Posts\u0020and\u0020Pages.", + "url": "classes/Footnotes-WYSIWYG.html#method_new_visual_editor_button" + }, { + "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Anew_plain_text_editor_button\u0028\u0029", + "name": "new_plain_text_editor_button", + "summary": "Add\u0020a\u0020new\u0020button\u0020to\u0020the\u0020plain\u0020text\u0020editor.", + "url": "classes/Footnotes-WYSIWYG.html#method_new_plain_text_editor_button" + }, { + "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Ainclude_scripts\u0028\u0029", + "name": "include_scripts", + "summary": "Includes\u0020the\u0020Plugins\u0020WYSIWYG\u0020editor\u0020script.", + "url": "classes/Footnotes-WYSIWYG.html#method_include_scripts" + }, { + "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Aajax_callback\u0028\u0029", + "name": "ajax_callback", + "summary": "AJAX\u0020Callback\u0020function\u0020when\u0020the\u0020Footnotes\u0020Button\u0020is\u0020clicked.\u0020Either\u0020in\u0020the\u0020Plain\u0020text\u0020or\u0020Visual\u0020editor.", + "url": "classes/Footnotes-WYSIWYG.html#method_ajax_callback" }, { "fqsen": "\\Footnotes_Layout_Engine", "name": "Footnotes_Layout_Engine", @@ -255,6 +310,46 @@ Search.appendIndex( "name": "a_arr_sections", "summary": "Stores\u0020all\u0020Sections\u0020for\u0020the\u0020child\u0020sub\u0020page.", "url": "classes/Footnotes-Layout-Engine.html#property_a_arr_sections" + }, { + "fqsen": "\\Footnotes_Layout_Init", + "name": "Footnotes_Layout_Init", + "summary": "Handles\u0020the\u0020Settings\u0020interface\u0020of\u0020the\u0020Plugin.", + "url": "classes/Footnotes-Layout-Init.html" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Initializes\u0020all\u0020WordPress\u0020hooks\u0020for\u0020the\u0020Plugin\u0020Settings.", + "url": "classes/Footnotes-Layout-Init.html#method___construct" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003Ainitialize_settings\u0028\u0029", + "name": "initialize_settings", + "summary": "Registers\u0020the\u0020settings\u0020and\u0020initialises\u0020the\u0020settings\u0020page.", + "url": "classes/Footnotes-Layout-Init.html#method_initialize_settings" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003Aregister_options_submenu\u0028\u0029", + "name": "register_options_submenu", + "summary": "Registers\u0020the\u0020footnotes\u0020submenu\u0020page.", + "url": "classes/Footnotes-Layout-Init.html#method_register_options_submenu" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003Aget_plugin_meta_information\u0028\u0029", + "name": "get_plugin_meta_information", + "summary": "AJAX\u0020call.\u0020returns\u0020a\u0020JSON\u0020string\u0020containing\u0020meta\u0020information\u0020about\u0020a\u0020specific\u0020WordPress\u0020Plugin.", + "url": "classes/Footnotes-Layout-Init.html#method_get_plugin_meta_information" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_SLUG", + "name": "C_STR_MAIN_MENU_SLUG", + "summary": "Slug\u0020for\u0020the\u0020Plugin\u0020main\u0020menu.", + "url": "classes/Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_SLUG" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003AC_STR_MAIN_MENU_TITLE", + "name": "C_STR_MAIN_MENU_TITLE", + "summary": "Plugin\u0020main\u0020menu\u0020name.", + "url": "classes/Footnotes-Layout-Init.html#constant_C_STR_MAIN_MENU_TITLE" + }, { + "fqsen": "\\Footnotes_Layout_Init\u003A\u003A\u0024settings_page", + "name": "settings_page", + "summary": "Contains\u0020the\u0020settings\u0020layoutEngine", + "url": "classes/Footnotes-Layout-Init.html#property_settings_page" }, { "fqsen": "\\Footnotes_Layout_Settings", "name": "Footnotes_Layout_Settings", @@ -406,105 +501,135 @@ Search.appendIndex( "summary": "Displays\u0020all\u0020Donate\u0020button\u0020to\u0020support\u0020the\u0020developers.", "url": "classes/Footnotes-Layout-Settings.html#method_donate" }, { - "fqsen": "\\Footnotes_Hooks", - "name": "Footnotes_Hooks", - "summary": "Registers\u0020all\u0020WordPress\u0020hooks\u0020and\u0020executes\u0020them\u0020on\u0020demand.", - "url": "classes/Footnotes-Hooks.html" + "fqsen": "\\Footnotes_Config", + "name": "Footnotes_Config", + "summary": "Contains\u0020all\u0020Plugin\u0020Constants.\u0020Contains\u0020no\u0020Method\u0020or\u0020Property.", + "url": "classes/Footnotes-Config.html" }, { - "fqsen": "\\Footnotes_Hooks\u003A\u003Aregister_hooks\u0028\u0029", - "name": "register_hooks", - "summary": "Registers\u0020all\u0020WordPress\u0020hooks.", - "url": "classes/Footnotes-Hooks.html#method_register_hooks" + "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_PLUGIN_NAME", + "name": "C_STR_PLUGIN_NAME", + "summary": "Internal\u0020Plugin\u0020name.", + "url": "classes/Footnotes-Config.html#constant_C_STR_PLUGIN_NAME" }, { - "fqsen": "\\Footnotes_Hooks\u003A\u003Aactivate_plugin\u0028\u0029", - "name": "activate_plugin", - "summary": "Executes\u0020when\u0020the\u0020Plugin\u0020is\u0020activated.", - "url": "classes/Footnotes-Hooks.html#method_activate_plugin" + "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_PLUGIN_PUBLIC_NAME", + "name": "C_STR_PLUGIN_PUBLIC_NAME", + "summary": "Public\u0020Plugin\u0020name.", + "url": "classes/Footnotes-Config.html#constant_C_STR_PLUGIN_PUBLIC_NAME" }, { - "fqsen": "\\Footnotes_Hooks\u003A\u003Adeactivate_plugin\u0028\u0029", - "name": "deactivate_plugin", - "summary": "Executes\u0020when\u0020the\u0020Plugin\u0020is\u0020deactivated.", - "url": "classes/Footnotes-Hooks.html#method_deactivate_plugin" + "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_PLUGIN_HEADING_NAME", + "name": "C_STR_PLUGIN_HEADING_NAME", + "summary": "Public\u0020Plugin\u0020name\u0020for\u0020dashboard\u0020heading", + "url": "classes/Footnotes-Config.html#constant_C_STR_PLUGIN_HEADING_NAME" }, { - "fqsen": "\\Footnotes_Hooks\u003A\u003Aget_plugin_links\u0028\u0029", - "name": "get_plugin_links", - "summary": "Appends\u0020the\u0020Plugin\u0020links\u0020for\u0020display\u0020in\u0020the\u0020dashboard\u0020\u201CPlugins\u201D\u0020page.", - "url": "classes/Footnotes-Hooks.html#method_get_plugin_links" + "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_LOVE_SYMBOL", + "name": "C_STR_LOVE_SYMBOL", + "summary": "Html\u0020tag\u0020for\u0020the\u0020LOVE\u0020symbol.", + "url": "classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL" }, { - "fqsen": "\\Footnotes", - "name": "Footnotes", - "summary": "Provides\u0020an\u0020entry\u0020point\u0020to\u0020the\u0020Plugin.", - "url": "classes/Footnotes.html" + "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_LOVE_SYMBOL_HEADING", + "name": "C_STR_LOVE_SYMBOL_HEADING", + "summary": "HTML\u0020code\u0020for\u0020the\u0020\u0027love\u0027\u0020symbol\u0020used\u0020in\u0020dashboard\u0020heading", + "url": "classes/Footnotes-Config.html#constant_C_STR_LOVE_SYMBOL_HEADING" }, { - "fqsen": "\\Footnotes\u003A\u003Arun\u0028\u0029", - "name": "run", - "summary": "Executes\u0020the\u0020Plugin.", - "url": "classes/Footnotes.html#method_run" + "fqsen": "\\Footnotes_Config\u003A\u003AC_STR_NO_LOVE_SLUG", + "name": "C_STR_NO_LOVE_SLUG", + "summary": "Short\u0020code\u0020to\u0020DON\u0027T\u0020display\u0020the\u0020\u0027LOVE\u0020ME\u0027\u0020slug\u0020on\u0020certain\u0020pages.", + "url": "classes/Footnotes-Config.html#constant_C_STR_NO_LOVE_SLUG" }, { - "fqsen": "\\Footnotes\u003A\u003Ainitialize_widgets\u0028\u0029", + "fqsen": "\\Footnotes_Convert", + "name": "Footnotes_Convert", + "summary": "Converts\u0020data\u0020types\u0020and\u0020Footnotes\u0020specific\u0020values.", + "url": "classes/Footnotes-Convert.html" + }, { + "fqsen": "\\Footnotes_Convert\u003A\u003Aindex\u0028\u0029", + "name": "index", + "summary": "Converts\u0020a\u0020integer\u0020into\u0020the\u0020user\u002Ddefined\u0020counter\u0020style\u0020for\u0020the\u0020footnotes.", + "url": "classes/Footnotes-Convert.html#method_index" + }, { + "fqsen": "\\Footnotes_Convert\u003A\u003Ato_latin\u0028\u0029", + "name": "to_latin", + "summary": "Converts\u0020an\u0020integer\u0020into\u0020latin\u0020ascii\u0020characters,\u0020either\u0020lower\u0020or\u0020upper\u002Dcase.", + "url": "classes/Footnotes-Convert.html#method_to_latin" + }, { + "fqsen": "\\Footnotes_Convert\u003A\u003Ato_arabic_leading\u0028\u0029", + "name": "to_arabic_leading", + "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020leading\u002D0\u0020integer.", + "url": "classes/Footnotes-Convert.html#method_to_arabic_leading" + }, { + "fqsen": "\\Footnotes_Convert\u003A\u003Ato_romanic\u0028\u0029", + "name": "to_romanic", + "summary": "Converts\u0020an\u0020integer\u0020to\u0020a\u0020romanic\u0020letter.", + "url": "classes/Footnotes-Convert.html#method_to_romanic" + }, { + "fqsen": "\\Footnotes_Convert\u003A\u003Ato_bool\u0028\u0029", + "name": "to_bool", + "summary": "Converts\u0020a\u0020string\u0020depending\u0020on\u0020its\u0020value\u0020to\u0020a\u0020boolean.", + "url": "classes/Footnotes-Convert.html#method_to_bool" + }, { + "fqsen": "\\Footnotes_Convert\u003A\u003Aget_arrow\u0028\u0029", + "name": "get_arrow", + "summary": "Get\u0020a\u0020html\u0020Array\u0020short\u0020code\u0020depending\u0020on\u0020Arrow\u002DArray\u0020key\u0020index.", + "url": "classes/Footnotes-Convert.html#method_get_arrow" + }, { + "fqsen": "\\Footnotes_Convert\u003A\u003Adebug\u0028\u0029", + "name": "debug", + "summary": "Displays\u0020a\u0020Variable.", + "url": "classes/Footnotes-Convert.html#method_debug" + }, { + "fqsen": "\\Footnotes_i18n", + "name": "Footnotes_i18n", + "summary": "Define\u0020the\u0020internationalization\u0020functionality.", + "url": "classes/Footnotes-i18n.html" + }, { + "fqsen": "\\Footnotes_i18n\u003A\u003Aload_plugin_textdomain\u0028\u0029", + "name": "load_plugin_textdomain", + "summary": "Load\u0020the\u0020plugin\u0020text\u0020domain\u0020for\u0020translation.", + "url": "classes/Footnotes-i18n.html#method_load_plugin_textdomain" + }, { + "fqsen": "\\Footnotes_Loader", + "name": "Footnotes_Loader", + "summary": "Register\u0020all\u0020actions\u0020and\u0020filters\u0020for\u0020the\u0020plugin.", + "url": "classes/Footnotes-Loader.html" + }, { + "fqsen": "\\Footnotes_Loader\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020collections\u0020used\u0020to\u0020maintain\u0020the\u0020actions\u0020and\u0020filters.", + "url": "classes/Footnotes-Loader.html#method___construct" + }, { + "fqsen": "\\Footnotes_Loader\u003A\u003Aadd_action\u0028\u0029", + "name": "add_action", + "summary": "Add\u0020a\u0020new\u0020action\u0020to\u0020the\u0020collection\u0020to\u0020be\u0020registered\u0020with\u0020WordPress.", + "url": "classes/Footnotes-Loader.html#method_add_action" + }, { + "fqsen": "\\Footnotes_Loader\u003A\u003Aadd_filter\u0028\u0029", + "name": "add_filter", + "summary": "Add\u0020a\u0020new\u0020filter\u0020to\u0020the\u0020collection\u0020to\u0020be\u0020registered\u0020with\u0020WordPress.", + "url": "classes/Footnotes-Loader.html#method_add_filter" + }, { + "fqsen": "\\Footnotes_Loader\u003A\u003Ainitialize_widgets\u0028\u0029", "name": "initialize_widgets", "summary": "Initializes\u0020all\u0020Widgets\u0020of\u0020the\u0020Plugin.", - "url": "classes/Footnotes.html#method_initialize_widgets" + "url": "classes/Footnotes-Loader.html#method_initialize_widgets" }, { - "fqsen": "\\Footnotes\u003A\u003Ainitialize_dashboard\u0028\u0029", - "name": "initialize_dashboard", - "summary": "Initializes\u0020the\u0020Dashboard\u0020of\u0020the\u0020Plugin\u0020and\u0020loads\u0020them.", - "url": "classes/Footnotes.html#method_initialize_dashboard" + "fqsen": "\\Footnotes_Loader\u003A\u003Aadd\u0028\u0029", + "name": "add", + "summary": "A\u0020utility\u0020function\u0020that\u0020is\u0020used\u0020to\u0020register\u0020the\u0020actions\u0020and\u0020hooks\u0020into\u0020a\u0020single\ncollection.", + "url": "classes/Footnotes-Loader.html#method_add" }, { - "fqsen": "\\Footnotes\u003A\u003Ainitialize_task\u0028\u0029", - "name": "initialize_task", - "summary": "Initializes\u0020the\u0020Plugin\u0020Task\u0020and\u0020registers\u0020the\u0020Task\u0020hooks.", - "url": "classes/Footnotes.html#method_initialize_task" + "fqsen": "\\Footnotes_Loader\u003A\u003Arun\u0028\u0029", + "name": "run", + "summary": "Register\u0020the\u0020filters\u0020and\u0020actions\u0020with\u0020WordPress.", + "url": "classes/Footnotes-Loader.html#method_run" }, { - "fqsen": "\\Footnotes\u003A\u003Aregister_public\u0028\u0029", - "name": "register_public", - "summary": "Registers\u0020and\u0020enqueues\u0020scripts\u0020and\u0020stylesheets\u0020to\u0020the\u0020public\u0020pages.", - "url": "classes/Footnotes.html#method_register_public" + "fqsen": "\\Footnotes_Loader\u003A\u003A\u0024actions", + "name": "actions", + "summary": "The\u0020array\u0020of\u0020actions\u0020registered\u0020with\u0020WordPress.", + "url": "classes/Footnotes-Loader.html#property_actions" }, { - "fqsen": "\\Footnotes\u003A\u003A\u0024a_obj_task", - "name": "a_obj_task", - "summary": "The\u0020Plugin\u0020task.", - "url": "classes/Footnotes.html#property_a_obj_task" - }, { - "fqsen": "\\Footnotes\u003A\u003A\u0024a_bool_tooltips_enabled", - "name": "a_bool_tooltips_enabled", - "summary": "Flag\u0020for\u0020using\u0020tooltips.", - "url": "classes/Footnotes.html#property_a_bool_tooltips_enabled" - }, { - "fqsen": "\\Footnotes\u003A\u003A\u0024a_bool_alternative_tooltips_enabled", - "name": "a_bool_alternative_tooltips_enabled", - "summary": "Allows\u0020to\u0020determine\u0020whether\u0020alternative\u0020tooltips\u0020are\u0020enabled.", - "url": "classes/Footnotes.html#property_a_bool_alternative_tooltips_enabled" - }, { - "fqsen": "\\Footnotes\u003A\u003A\u0024a_bool_amp_enabled", - "name": "a_bool_amp_enabled", - "summary": "Allows\u0020to\u0020determine\u0020whether\u0020AMP\u0020compatibility\u0020mode\u0020is\u0020enabled.", - "url": "classes/Footnotes.html#property_a_bool_amp_enabled" - }, { - "fqsen": "\\Footnotes\u003A\u003A\u0024a_str_script_mode", - "name": "a_str_script_mode", - "summary": "Allows\u0020to\u0020determine\u0020the\u0020script\u0020mode\u0020among\u0020jQuery\u0020or\u0020plain\u0020JS.", - "url": "classes/Footnotes.html#property_a_str_script_mode" - }, { - "fqsen": "\\Footnotes_Language", - "name": "Footnotes_Language", - "summary": "Loads\u0020text\u0020domain\u0020of\u0020current\u0020or\u0020default\u0020language\u0020for\u0020localization.", - "url": "classes/Footnotes-Language.html" - }, { - "fqsen": "\\Footnotes_Language\u003A\u003Aregister_hooks\u0028\u0029", - "name": "register_hooks", - "summary": "Register\u0020WordPress\u0020Hook.", - "url": "classes/Footnotes-Language.html#method_register_hooks" - }, { - "fqsen": "\\Footnotes_Language\u003A\u003Aload_text_domain\u0028\u0029", - "name": "load_text_domain", - "summary": "Loads\u0020the\u0020text\u0020domain\u0020for\u0020current\u0020WordPress\u0020language\u0020if\u0020exists.", - "url": "classes/Footnotes-Language.html#method_load_text_domain" - }, { - "fqsen": "\\Footnotes_Language\u003A\u003Aload\u0028\u0029", - "name": "load", - "summary": "Loads\u0020a\u0020specific\u0020text\u0020domain.", - "url": "classes/Footnotes-Language.html#method_load" + "fqsen": "\\Footnotes_Loader\u003A\u003A\u0024filters", + "name": "filters", + "summary": "The\u0020array\u0020of\u0020filters\u0020registered\u0020with\u0020WordPress.", + "url": "classes/Footnotes-Loader.html#property_filters" }, { "fqsen": "\\Footnotes_Settings", "name": "Footnotes_Settings", @@ -1100,11 +1225,136 @@ Search.appendIndex( "name": "a_arr_settings", "summary": "Contains\u0020all\u0020Settings\u0020from\u0020each\u0020Settings\u0020container\u0020as\u0020soon\u0020as\u0020this\u0020class\u0020is\u0020initialized.", "url": "classes/Footnotes-Settings.html#property_a_arr_settings" + }, { + "fqsen": "\\Footnotes_Template", + "name": "Footnotes_Template", + "summary": "Handles\u0020each\u0020Template\u0020file\u0020for\u0020the\u0020Plugin\u0020Frontend\u0020\u0028e.g.\u0020Settings\u0020Dashboard,\u0020Public\u0020pages,\u0020...\u0029.", + "url": "classes/Footnotes-Template.html" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Class\u0020Constructor.\u0020Reads\u0020and\u0020loads\u0020the\u0020template\u0020file\u0020without\u0020replace\u0020any\u0020placeholder.", + "url": "classes/Footnotes-Template.html#method___construct" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003Areplace\u0028\u0029", + "name": "replace", + "summary": "Replace\u0020all\u0020placeholders\u0020specified\u0020in\u0020array.", + "url": "classes/Footnotes-Template.html#method_replace" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003Areload\u0028\u0029", + "name": "reload", + "summary": "Reloads\u0020the\u0020original\u0020content\u0020of\u0020the\u0020template\u0020file.", + "url": "classes/Footnotes-Template.html#method_reload" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003Aget_content\u0028\u0029", + "name": "get_content", + "summary": "Returns\u0020the\u0020content\u0020of\u0020the\u0020template\u0020file\u0020with\u0020replaced\u0020placeholders.", + "url": "classes/Footnotes-Template.html#method_get_content" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003Aprocess_template\u0028\u0029", + "name": "process_template", + "summary": "Process\u0020template\u0020file.", + "url": "classes/Footnotes-Template.html#method_process_template" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003Aget_template\u0028\u0029", + "name": "get_template", + "summary": "Get\u0020the\u0020template.", + "url": "classes/Footnotes-Template.html#method_get_template" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003AC_STR_DASHBOARD", + "name": "C_STR_DASHBOARD", + "summary": "Directory\u0020name\u0020for\u0020dashboard\u0020partials.", + "url": "classes/Footnotes-Template.html#constant_C_STR_DASHBOARD" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003AC_STR_PUBLIC", + "name": "C_STR_PUBLIC", + "summary": "Directory\u0020name\u0020for\u0020public\u0020partials.", + "url": "classes/Footnotes-Template.html#constant_C_STR_PUBLIC" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003A\u0024a_str_original_content", + "name": "a_str_original_content", + "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize.", + "url": "classes/Footnotes-Template.html#property_a_str_original_content" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003A\u0024a_str_replaced_content", + "name": "a_str_replaced_content", + "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize\u0020with\u0020replaced\u0020place\u0020holders.", + "url": "classes/Footnotes-Template.html#property_a_str_replaced_content" + }, { + "fqsen": "\\Footnotes_Template\u003A\u003A\u0024plugin_directory", + "name": "plugin_directory", + "summary": "Plugin\u0020Directory", + "url": "classes/Footnotes-Template.html#property_plugin_directory" + }, { + "fqsen": "\\Footnotes_Public", + "name": "Footnotes_Public", + "summary": "The\u0020public\u002Dfacing\u0020functionality\u0020of\u0020the\u0020plugin.", + "url": "classes/Footnotes-Public.html" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/Footnotes-Public.html#method___construct" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003Aload_dependencies\u0028\u0029", + "name": "load_dependencies", + "summary": "Load\u0020the\u0020required\u0020public\u002Dfacing\u0020dependencies.", + "url": "classes/Footnotes-Public.html#method_load_dependencies" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003Aenqueue_styles\u0028\u0029", + "name": "enqueue_styles", + "summary": "Register\u0020the\u0020stylesheets\u0020for\u0020the\u0020public\u002Dfacing\u0020side\u0020of\u0020the\u0020site.", + "url": "classes/Footnotes-Public.html#method_enqueue_styles" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003Aenqueue_scripts\u0028\u0029", + "name": "enqueue_scripts", + "summary": "Register\u0020the\u0020JavaScript\u0020for\u0020the\u0020public\u002Dfacing\u0020side\u0020of\u0020the\u0020site.", + "url": "classes/Footnotes-Public.html#method_enqueue_scripts" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A\u0024plugin_name", + "name": "plugin_name", + "summary": "The\u0020ID\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes-Public.html#property_plugin_name" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A\u0024version", + "name": "version", + "summary": "The\u0020version\u0020of\u0020this\u0020plugin.", + "url": "classes/Footnotes-Public.html#property_version" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A\u0024a_obj_task", + "name": "a_obj_task", + "summary": "The\u0020Plugin\u0020task.", + "url": "classes/Footnotes-Public.html#property_a_obj_task" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A\u0024a_bool_tooltips_enabled", + "name": "a_bool_tooltips_enabled", + "summary": "Flag\u0020for\u0020using\u0020tooltips.", + "url": "classes/Footnotes-Public.html#property_a_bool_tooltips_enabled" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A\u0024a_bool_alternative_tooltips_enabled", + "name": "a_bool_alternative_tooltips_enabled", + "summary": "Allows\u0020to\u0020determine\u0020whether\u0020alternative\u0020tooltips\u0020are\u0020enabled.", + "url": "classes/Footnotes-Public.html#property_a_bool_alternative_tooltips_enabled" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A\u0024a_bool_amp_enabled", + "name": "a_bool_amp_enabled", + "summary": "Allows\u0020to\u0020determine\u0020whether\u0020AMP\u0020compatibility\u0020mode\u0020is\u0020enabled.", + "url": "classes/Footnotes-Public.html#property_a_bool_amp_enabled" + }, { + "fqsen": "\\Footnotes_Public\u003A\u003A\u0024a_str_script_mode", + "name": "a_str_script_mode", + "summary": "Allows\u0020to\u0020determine\u0020the\u0020script\u0020mode\u0020among\u0020jQuery\u0020or\u0020plain\u0020JS.", + "url": "classes/Footnotes-Public.html#property_a_str_script_mode" }, { "fqsen": "\\Footnotes_Task", "name": "Footnotes_Task", "summary": "Searches\u0020and\u0020replaces\u0020the\u0020footnotes\u0020and\u0020generates\u0020the\u0020reference\u0020container.", "url": "classes/Footnotes-Task.html" + }, { + "fqsen": "\\Footnotes_Task\u003A\u003A__construct\u0028\u0029", + "name": "__construct", + "summary": "Initialize\u0020the\u0020class\u0020and\u0020set\u0020its\u0020properties.", + "url": "classes/Footnotes-Task.html#method___construct" }, { "fqsen": "\\Footnotes_Task\u003A\u003Aregister_hooks\u0028\u0029", "name": "register_hooks", @@ -1285,66 +1535,6 @@ Search.appendIndex( "name": "a_bool_syntax_error_flag", "summary": "Footnote\u0020delimiter\u0020syntax\u0020validation\u0020enabled.", "url": "classes/Footnotes-Task.html#property_a_bool_syntax_error_flag" - }, { - "fqsen": "\\Footnotes_Template", - "name": "Footnotes_Template", - "summary": "Handles\u0020each\u0020Template\u0020file\u0020for\u0020the\u0020Plugin\u0020Frontend\u0020\u0028e.g.\u0020Settings\u0020Dashboard,\u0020Public\u0020pages,\u0020...\u0029.", - "url": "classes/Footnotes-Template.html" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003A__construct\u0028\u0029", - "name": "__construct", - "summary": "Class\u0020Constructor.\u0020Reads\u0020and\u0020loads\u0020the\u0020template\u0020file\u0020without\u0020replace\u0020any\u0020placeholder.", - "url": "classes/Footnotes-Template.html#method___construct" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003Areplace\u0028\u0029", - "name": "replace", - "summary": "Replace\u0020all\u0020placeholders\u0020specified\u0020in\u0020array.", - "url": "classes/Footnotes-Template.html#method_replace" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003Areload\u0028\u0029", - "name": "reload", - "summary": "Reloads\u0020the\u0020original\u0020content\u0020of\u0020the\u0020template\u0020file.", - "url": "classes/Footnotes-Template.html#method_reload" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003Aget_content\u0028\u0029", - "name": "get_content", - "summary": "Returns\u0020the\u0020content\u0020of\u0020the\u0020template\u0020file\u0020with\u0020replaced\u0020placeholders.", - "url": "classes/Footnotes-Template.html#method_get_content" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003Aprocess_template\u0028\u0029", - "name": "process_template", - "summary": "Process\u0020template\u0020file.", - "url": "classes/Footnotes-Template.html#method_process_template" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003Aget_template\u0028\u0029", - "name": "get_template", - "summary": "Get\u0020the\u0020template.", - "url": "classes/Footnotes-Template.html#method_get_template" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003AC_STR_DASHBOARD", - "name": "C_STR_DASHBOARD", - "summary": "Directory\u0020name\u0020for\u0020dashboard\u0020templates.", - "url": "classes/Footnotes-Template.html#constant_C_STR_DASHBOARD" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003AC_STR_PUBLIC", - "name": "C_STR_PUBLIC", - "summary": "Directory\u0020name\u0020for\u0020public\u0020templates.", - "url": "classes/Footnotes-Template.html#constant_C_STR_PUBLIC" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003A\u0024a_str_original_content", - "name": "a_str_original_content", - "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize.", - "url": "classes/Footnotes-Template.html#property_a_str_original_content" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003A\u0024a_str_replaced_content", - "name": "a_str_replaced_content", - "summary": "Contains\u0020the\u0020content\u0020of\u0020the\u0020template\u0020after\u0020initialize\u0020with\u0020replaced\u0020place\u0020holders.", - "url": "classes/Footnotes-Template.html#property_a_str_replaced_content" - }, { - "fqsen": "\\Footnotes_Template\u003A\u003A\u0024plugin_directory", - "name": "plugin_directory", - "summary": "Plugin\u0020Directory", - "url": "classes/Footnotes-Template.html#property_plugin_directory" }, { "fqsen": "\\Footnotes_Widget_Base", "name": "Footnotes_Widget_Base", @@ -1405,41 +1595,6 @@ Search.appendIndex( "name": "widget", "summary": "Outputs\u0020the\u0020Content\u0020of\u0020the\u0020Widget.", "url": "classes/Footnotes-Widget-Reference-Container.html#method_widget" - }, { - "fqsen": "\\Footnotes_WYSIWYG", - "name": "Footnotes_WYSIWYG", - "summary": "Handles\u0020the\u0020WSYIWYG\u002DButtons.", - "url": "classes/Footnotes-WYSIWYG.html" - }, { - "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Aregister_hooks\u0028\u0029", - "name": "register_hooks", - "summary": "Registers\u0020Button\u0020hooks.", - "url": "classes/Footnotes-WYSIWYG.html#method_register_hooks" - }, { - "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Anew_visual_editor_button\u0028\u0029", - "name": "new_visual_editor_button", - "summary": "Append\u0020a\u0020new\u0020Button\u0020to\u0020the\u0020WYSIWYG\u0020editor\u0020of\u0020Posts\u0020and\u0020Pages.", - "url": "classes/Footnotes-WYSIWYG.html#method_new_visual_editor_button" - }, { - "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Anew_plain_text_editor_button\u0028\u0029", - "name": "new_plain_text_editor_button", - "summary": "Add\u0020a\u0020new\u0020button\u0020to\u0020the\u0020plain\u0020text\u0020editor.", - "url": "classes/Footnotes-WYSIWYG.html#method_new_plain_text_editor_button" - }, { - "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Ainclude_scripts\u0028\u0029", - "name": "include_scripts", - "summary": "Includes\u0020the\u0020Plugins\u0020WYSIWYG\u0020editor\u0020script.", - "url": "classes/Footnotes-WYSIWYG.html#method_include_scripts" - }, { - "fqsen": "\\Footnotes_WYSIWYG\u003A\u003Aajax_callback\u0028\u0029", - "name": "ajax_callback", - "summary": "AJAX\u0020Callback\u0020function\u0020when\u0020the\u0020Footnotes\u0020Button\u0020is\u0020clicked.\u0020Either\u0020in\u0020the\u0020Plain\u0020text\u0020or\u0020Visual\u0020editor.", - "url": "classes/Footnotes-WYSIWYG.html#method_ajax_callback" - }, { - "fqsen": "\\mci_footnotes_require_php_files\u0028\u0029", - "name": "mci_footnotes_require_php_files", - "summary": "Requires\u0020\u0028\u0060require_once\u0060\u0029\u0020all\u0020\u0060\u002A.php\u0060\u0020files\u0020inside\u0020a\u0020specific\u0020Directory.", - "url": "namespaces/default.html#function_mci_footnotes_require_php_files" }, { "fqsen": "\\", "name": "\\", diff --git a/docs/namespaces/default.html b/docs/namespaces/default.html index 5a99626..00764db 100644 --- a/docs/namespaces/default.html +++ b/docs/namespaces/default.html @@ -51,9 +51,18 @@

                                                            Namespaces

                                                            -

                                                            Global

                                                            -
                                                            +
                                                            +
                                                            +

                                                            Packages

                                                            +

                                                            footnotes

                                                            + +

                                                            Default

                                                            +

                                                            Reports

                                                            @@ -84,34 +93,42 @@
                                                            +
                                                            Footnotes_Activator
                                                            +
                                                            Fired during plugin activation.
                                                            +
                                                            Footnotes_Deactivator
                                                            +
                                                            Fired during plugin deactivation.
                                                            +
                                                            Footnotes
                                                            +
                                                            The core plugin class.
                                                            +
                                                            Footnotes_Admin
                                                            +
                                                            The admin-specific functionality of the plugin.
                                                            +
                                                            Footnotes_WYSIWYG
                                                            +
                                                            Handles the WSYIWYG-Buttons.
                                                            +
                                                            Footnotes_Layout_Engine
                                                            +
                                                            Layout Engine for the administration dashboard.
                                                            +
                                                            Footnotes_Layout_Init
                                                            +
                                                            Handles the Settings interface of the Plugin.
                                                            +
                                                            Footnotes_Layout_Settings
                                                            +
                                                            Displays and handles all Settings of the Plugin.
                                                            Footnotes_Config
                                                            Contains all Plugin Constants. Contains no Method or Property.
                                                            Footnotes_Convert
                                                            Converts data types and Footnotes specific values.
                                                            -
                                                            Footnotes_Layout_Init
                                                            -
                                                            Handles the Settings interface of the Plugin.
                                                            -
                                                            Footnotes_Layout_Engine
                                                            -
                                                            Layout Engine for the administration dashboard.
                                                            -
                                                            Footnotes_Layout_Settings
                                                            -
                                                            Displays and handles all Settings of the Plugin.
                                                            -
                                                            Footnotes_Hooks
                                                            -
                                                            Registers all WordPress hooks and executes them on demand.
                                                            -
                                                            Footnotes
                                                            -
                                                            Provides an entry point to the Plugin.
                                                            -
                                                            Footnotes_Language
                                                            -
                                                            Loads text domain of current or default language for localization.
                                                            +
                                                            Footnotes_i18n
                                                            +
                                                            Define the internationalization functionality.
                                                            +
                                                            Footnotes_Loader
                                                            +
                                                            Register all actions and filters for the plugin.
                                                            Footnotes_Settings
                                                            Loads the settings values, sets to default values if undefined.
                                                            -
                                                            Footnotes_Task
                                                            -
                                                            Searches and replaces the footnotes and generates the reference container.
                                                            Footnotes_Template
                                                            Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                            +
                                                            Footnotes_Public
                                                            +
                                                            The public-facing functionality of the plugin.
                                                            +
                                                            Footnotes_Task
                                                            +
                                                            Searches and replaces the footnotes and generates the reference container.
                                                            Footnotes_Widget_Base
                                                            Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                            Footnotes_Widget_Reference_Container
                                                            Registers a Widget to put the Reference Container to the widget area.
                                                            -
                                                            Footnotes_WYSIWYG
                                                            -
                                                            Handles the WSYIWYG-Buttons.
                                                            @@ -123,11 +140,25 @@
                                                            - mci_footnotes_require_php_files() + activate_footnotes()  : mixed
                                                            -
                                                            Requires (`require_once`) all `*.php` files inside a specific Directory.
                                                            +
                                                            The code that runs during plugin activation.
                                                            + +
                                                            + deactivate_plugin_name() + +  : mixed +
                                                            +
                                                            The code that runs during plugin deactivation.
                                                            + +
                                                            + run_footnotes() + +  : mixed +
                                                            +
                                                            Begins execution of the plugin.
                                                            @@ -139,57 +170,89 @@
                                                            -

                                                            - mci_footnotes_require_php_files() - +

                                                            + activate_footnotes() +

                                                            -

                                                            Requires (`require_once`) all `*.php` files inside a specific Directory.

                                                            +

                                                            The code that runs during plugin activation.

                                                            - mci_footnotes_require_php_files(string $p_str_directory) : mixed + activate_footnotes() : mixed -
                                                            - -
                                                            Parameters
                                                            -
                                                            -
                                                            - $p_str_directory - : string -
                                                            -
                                                            -

                                                            Absolute Directory path to lookup for *.php files.

                                                            +

                                                            This action is documented in includes/class-plugin-name-activator.php

                                                            -
                                                            -
                                                            + + +
                                                            +
                                                            +

                                                            + deactivate_plugin_name() + +

                                                            + + +

                                                            The code that runs during plugin deactivation.

                                                            + + + + deactivate_plugin_name() : mixed + +

                                                            This action is documented in includes/class-plugin-name-deactivator.php

                                                            +
                                                            + + + + + +
                                                            +
                                                            +

                                                            + run_footnotes() + +

                                                            + + +

                                                            Begins execution of the plugin.

                                                            + + + + run_footnotes() : mixed + +

                                                            Since everything within the plugin is registered via hooks, +then kicking off the plugin from this point in the file does +not affect the page life cycle.

                                                            +
                                                            + + +
                                                            Tags
                                                            - author -
                                                            -
                                                            - -

                                                            Stefan Herndler

                                                            -
                                                            - -
                                                            -
                                                            since
                                                            - 1.5.0 + 2.8.0
                                                            diff --git a/docs/packages/Default.html b/docs/packages/Default.html new file mode 100644 index 0000000..d3d3168 --- /dev/null +++ b/docs/packages/Default.html @@ -0,0 +1,117 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                            +

                                                            Documentation

                                                            + + +
                                                            + +
                                                            + + +
                                                            + +
                                                            +
                                                            + + + + +
                                                            +
                                                              +
                                                            + +
                                                            +

                                                            Default

                                                            + + + + + + + + + +
                                                            +
                                                            +
                                                            +
                                                            +

                                                            Search results

                                                            + +
                                                            +
                                                            +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              +
                                                              + + +
                                                              + + + + diff --git a/docs/packages/default.html b/docs/packages/default.html index 7d8bcbd..1b1ea46 100644 --- a/docs/packages/default.html +++ b/docs/packages/default.html @@ -51,9 +51,18 @@

                                                              Namespaces

                                                              -

                                                              Global

                                                              -
                                                              +
                                                              +
                                                              +

                                                              Packages

                                                              +

                                                              footnotes

                                                              + +

                                                              Default

                                                              +

                                                              Reports

                                                              @@ -82,6 +91,7 @@
                                                              footnotes
                                                              +
                                                              Default
                                                              diff --git a/docs/packages/footnotes-footnotesadmin.html b/docs/packages/footnotes-footnotesadmin.html new file mode 100644 index 0000000..cdf4e42 --- /dev/null +++ b/docs/packages/footnotes-footnotesadmin.html @@ -0,0 +1,129 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                              +

                                                              Documentation

                                                              + + +
                                                              + +
                                                              + + +
                                                              + +
                                                              +
                                                              + + + + +
                                                              + + +
                                                              +

                                                              footnotesadmin

                                                              + + + +

                                                              + Interfaces, Classes and Traits + +

                                                              + +
                                                              + +
                                                              Footnotes_Admin
                                                              +
                                                              The admin-specific functionality of the plugin.
                                                              + +
                                                              + + + + + + +
                                                              +
                                                              +
                                                              +
                                                              +

                                                              Search results

                                                              + +
                                                              +
                                                              +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                +
                                                                + + +
                                                                + + + + diff --git a/docs/packages/footnotes-footnotesincludes.html b/docs/packages/footnotes-footnotesincludes.html new file mode 100644 index 0000000..5550b48 --- /dev/null +++ b/docs/packages/footnotes-footnotesincludes.html @@ -0,0 +1,137 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                +

                                                                Documentation

                                                                + + +
                                                                + +
                                                                + + +
                                                                + +
                                                                +
                                                                + + + + +
                                                                + + + +
                                                                +
                                                                +
                                                                +

                                                                Search results

                                                                + +
                                                                +
                                                                +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  +
                                                                  + + +
                                                                  + + + + diff --git a/docs/packages/footnotes-footnotespublic.html b/docs/packages/footnotes-footnotespublic.html new file mode 100644 index 0000000..4ecfc5a --- /dev/null +++ b/docs/packages/footnotes-footnotespublic.html @@ -0,0 +1,129 @@ + + + + + Documentation + + + + + + + + + + + + + + + +
                                                                  +

                                                                  Documentation

                                                                  + + +
                                                                  + +
                                                                  + + +
                                                                  + +
                                                                  +
                                                                  + + + + +
                                                                  + + +
                                                                  +

                                                                  footnotespublic

                                                                  + + + +

                                                                  + Interfaces, Classes and Traits + +

                                                                  + +
                                                                  + +
                                                                  Footnotes_Public
                                                                  +
                                                                  The public-facing functionality of the plugin.
                                                                  + +
                                                                  + + + + + + +
                                                                  +
                                                                  +
                                                                  +
                                                                  +

                                                                  Search results

                                                                  + +
                                                                  +
                                                                  +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    +
                                                                    + + +
                                                                    + + + + diff --git a/docs/packages/footnotes.html b/docs/packages/footnotes.html index fcac0e8..eba3109 100644 --- a/docs/packages/footnotes.html +++ b/docs/packages/footnotes.html @@ -51,9 +51,18 @@

                                                                    Namespaces

                                                                    -

                                                                    Global

                                                                    -
                                                                    +
                                                                    +
                                                                    +

                                                                    Packages

                                                                    +

                                                                    footnotes

                                                                    + +

                                                                    Default

                                                                    +

                                                                    Reports

                                                                    @@ -81,7 +90,9 @@
                                                                    -
                                                                    WPDashboard
                                                                    +
                                                                    footnotesincludes
                                                                    +
                                                                    footnotesadmin
                                                                    +
                                                                    footnotespublic
                                                                    @@ -92,34 +103,28 @@
                                                                    +
                                                                    Footnotes_WYSIWYG
                                                                    +
                                                                    Handles the WSYIWYG-Buttons.
                                                                    +
                                                                    Footnotes_Layout_Engine
                                                                    +
                                                                    Layout Engine for the administration dashboard.
                                                                    +
                                                                    Footnotes_Layout_Init
                                                                    +
                                                                    Handles the Settings interface of the Plugin.
                                                                    +
                                                                    Footnotes_Layout_Settings
                                                                    +
                                                                    Displays and handles all Settings of the Plugin.
                                                                    Footnotes_Config
                                                                    Contains all Plugin Constants. Contains no Method or Property.
                                                                    Footnotes_Convert
                                                                    Converts data types and Footnotes specific values.
                                                                    -
                                                                    Footnotes_Layout_Init
                                                                    -
                                                                    Handles the Settings interface of the Plugin.
                                                                    -
                                                                    Footnotes_Layout_Engine
                                                                    -
                                                                    Layout Engine for the administration dashboard.
                                                                    -
                                                                    Footnotes_Layout_Settings
                                                                    -
                                                                    Displays and handles all Settings of the Plugin.
                                                                    -
                                                                    Footnotes_Hooks
                                                                    -
                                                                    Registers all WordPress hooks and executes them on demand.
                                                                    -
                                                                    Footnotes
                                                                    -
                                                                    Provides an entry point to the Plugin.
                                                                    -
                                                                    Footnotes_Language
                                                                    -
                                                                    Loads text domain of current or default language for localization.
                                                                    Footnotes_Settings
                                                                    Loads the settings values, sets to default values if undefined.
                                                                    -
                                                                    Footnotes_Task
                                                                    -
                                                                    Searches and replaces the footnotes and generates the reference container.
                                                                    Footnotes_Template
                                                                    Handles each Template file for the Plugin Frontend (e.g. Settings Dashboard, Public pages, ...).
                                                                    +
                                                                    Footnotes_Task
                                                                    +
                                                                    Searches and replaces the footnotes and generates the reference container.
                                                                    Footnotes_Widget_Base
                                                                    Base Class for all Plugin Widgets. Registers each Widget to WordPress.
                                                                    Footnotes_Widget_Reference_Container
                                                                    Registers a Widget to put the Reference Container to the widget area.
                                                                    -
                                                                    Footnotes_WYSIWYG
                                                                    -
                                                                    Handles the WSYIWYG-Buttons.
                                                                    @@ -131,11 +136,25 @@
                                                                    - mci_footnotes_require_php_files() + activate_footnotes()  : mixed
                                                                    -
                                                                    Requires (`require_once`) all `*.php` files inside a specific Directory.
                                                                    +
                                                                    The code that runs during plugin activation.
                                                                    + +
                                                                    + deactivate_plugin_name() + +  : mixed +
                                                                    +
                                                                    The code that runs during plugin deactivation.
                                                                    + +
                                                                    + run_footnotes() + +  : mixed +
                                                                    +
                                                                    Begins execution of the plugin.
                                                                    @@ -147,57 +166,89 @@
                                                                    -

                                                                    - mci_footnotes_require_php_files() - +

                                                                    + activate_footnotes() +

                                                                    -

                                                                    Requires (`require_once`) all `*.php` files inside a specific Directory.

                                                                    +

                                                                    The code that runs during plugin activation.

                                                                    - mci_footnotes_require_php_files(string $p_str_directory) : mixed + activate_footnotes() : mixed -
                                                                    - -
                                                                    Parameters
                                                                    -
                                                                    -
                                                                    - $p_str_directory - : string -
                                                                    -
                                                                    -

                                                                    Absolute Directory path to lookup for *.php files.

                                                                    +

                                                                    This action is documented in includes/class-plugin-name-activator.php

                                                                    -
                                                                    -
                                                                    + + +
                                                                    +
                                                                    +

                                                                    + deactivate_plugin_name() + +

                                                                    + + +

                                                                    The code that runs during plugin deactivation.

                                                                    + + + + deactivate_plugin_name() : mixed + +

                                                                    This action is documented in includes/class-plugin-name-deactivator.php

                                                                    +
                                                                    + + + + + +
                                                                    +
                                                                    +

                                                                    + run_footnotes() + +

                                                                    + + +

                                                                    Begins execution of the plugin.

                                                                    + + + + run_footnotes() : mixed + +

                                                                    Since everything within the plugin is registered via hooks, +then kicking off the plugin from this point in the file does +not affect the page life cycle.

                                                                    +
                                                                    + + +
                                                                    Tags
                                                                    - author -
                                                                    -
                                                                    - -

                                                                    Stefan Herndler

                                                                    -
                                                                    - -
                                                                    -
                                                                    since
                                                                    - 1.5.0 + 2.8.0
                                                                    diff --git a/docs/reports/deprecated.html b/docs/reports/deprecated.html index 31e5420..a499816 100644 --- a/docs/reports/deprecated.html +++ b/docs/reports/deprecated.html @@ -52,9 +52,18 @@

                                                                    Namespaces

                                                                    -

                                                                    Global

                                                                    -
                                                                    +
                                                                    +
                                                                    +

                                                                    Packages

                                                                    +

                                                                    footnotes

                                                                    + +

                                                                    Default

                                                                    +

                                                                    Reports

                                                                    diff --git a/docs/reports/errors.html b/docs/reports/errors.html index 3260cda..82b1d2a 100644 --- a/docs/reports/errors.html +++ b/docs/reports/errors.html @@ -52,9 +52,18 @@

                                                                    Namespaces

                                                                    -

                                                                    Global

                                                                    -
                                                                    +
                                                                    +
                                                                    +

                                                                    Packages

                                                                    +

                                                                    footnotes

                                                                    + +

                                                                    Default

                                                                    +

                                                                    Reports

                                                                    @@ -80,18 +89,14 @@

                                                                    Table of Contents

                                                                    - - - - - +
                                                                    src/class/dashboard/subpage-main.php1
                                                                    src/class/language.phpsrc/admin/layout/class-footnotes-layout-settings.php 1
                                                                    - -

                                                                    subpage-main.php

                                                                    + +

                                                                    class-footnotes-layout-settings.php

                                                                    @@ -104,25 +109,7 @@ - - - -
                                                                    ERROR 0Tag "see" with body "@see templates/dashboard/customize-css.html" has error "\templates/dashboard/customize-css.html" is not a valid Fqsen.
                                                                    - -

                                                                    language.php

                                                                    - - - - - - - - - - - - - +
                                                                    TypeLineDescription
                                                                    ERROR0Tag "see" with body "@see wp-includes/l10n.php:857" has error "\wp-includes/l10n.php:857" is not a valid Fqsen.Tag "see" with body "@see admin/partials/customize-css.html" has error "\admin/partials/customize-css.html" is not a valid Fqsen.
                                                                    diff --git a/docs/reports/markers.html b/docs/reports/markers.html index fffdf71..aa69429 100644 --- a/docs/reports/markers.html +++ b/docs/reports/markers.html @@ -52,9 +52,18 @@

                                                                    Namespaces

                                                                    -

                                                                    Global

                                                                    -
                                                                    +
                                                                    +
                                                                    +

                                                                    Packages

                                                                    +

                                                                    footnotes

                                                                    + +

                                                                    Default

                                                                    +

                                                                    Reports