added page Filters & Actions

fixes #10

README.md

@@ -7,12 +7,4 @@ from the desire to empower developers to build outstanding WordPress themes fast
 
 ## Build
 
-To be able to build the documentation, install [Sphinx](http://sphinx-doc.org/install.html).
-
-Run the build script:
-
-```
-$ ./build.sh
-```
-
-All the html will be generated in the `build/` directory *(open in browser the `build/index.html` file)*.
+Execute `build.bash` then open in browser `build/index.html`

build.bash

@@ -0,0 +1,12 @@
+#!/bin/bash
+
+# requirements
+command -v sphinx-build >/dev/null 2>&1 || { echo >&2 "Please install Sphinx http://sphinx-doc.org/install.html"; exit 1; }
+
+cd "$( cd "$( dirname "${BASH_SOURCE[0]}" )" && pwd )"
+
+if [ -d "build" ]; then
+    rm -r build/
+fi
+
+sphinx-build . build/

hooks/index.rst

@@ -0,0 +1,221 @@
+Filters & Actions
+=================
+
+.. contents::
+    :local:
+    :backlinks: top
+
+Actions
+-------
+
+General
+#######
+
+.. _fw_init:
+
+* ``fw_init`` - The framework is fully loaded and you can safely access any of its components.
+  Useful when you need to init some theme components only when the framework is installed.
+
+    .. code-block:: php
+
+        add_action('fw_init', '_action_theme_fw_init');
+        function _action_theme_fw_init() {
+            $value = fw_get_db_customizer_option('hello');
+            // fw()->...
+        }
+
+.. _fw_backend_add_custom_settings_menu:
+
+* ``fw_backend_add_custom_settings_menu`` - Change **Theme Settings** menu.
+  You can register the menu yourself as a top or sub menu,
+  then the script will detect if it was registered (by slug) and will skip the default internal register.
+
+    .. code-block:: php
+
+        add_action('fw_backend_add_custom_settings_menu', '_action_theme_custom_fw_settings_menu');
+        function _action_theme_custom_fw_settings_menu($data) {
+            add_menu_page(
+                __( 'Awesome Settings', 'fw' ),
+                __( 'Awesome Settings', 'fw' ),
+                $data['capability'],
+                $data['slug'],
+                $data['content_callback']
+            );
+        }
+
+.. _fw_backend_add_custom_extensions_menu:
+
+* ``fw_backend_add_custom_extensions_menu`` - Change **Unyson** menu. Works the same as :ref:`previous action <fw_backend_add_custom_settings_menu>`.
+
+Assets Enqueue
+##############
+
+.. _fw_admin_enqueue_scripts_settings:
+
+* ``fw_admin_enqueue_scripts:settings`` - Enqueue assets only in **Theme Settings** page.
+
+    .. code-block:: php
+
+        add_action('fw_admin_enqueue_scripts:settings', '_action_theme_enqueue_scripts_theme_settings');
+        function _action_theme_enqueue_scripts_theme_settings() {
+            wp_enqueue_script(
+                'theme-settings-scripts',
+                get_template_directory_uri() .'/js/admin-theme-settings.js',
+                array('fw'),
+                fw()->theme->manifest->get_version(),
+                true
+            );
+        }
+
+.. _fw_admin_enqueue_scripts_customizer:
+
+* ``fw_admin_enqueue_scripts:customizer`` - Enqueue assets only in **Customizer** page.
+
+.. _fw_admin_enqueue_scripts_post:
+
+* ``fw_admin_enqueue_scripts:post`` - Enqueue assets only in **Post Edit** page.
+
+    .. code-block:: php
+
+        add_action('fw_admin_enqueue_scripts:post', '_action_theme_enqueue_scripts_post_edit');
+        function _action_theme_enqueue_scripts_post_edit(WP_Post $post) {
+            if ($post->post_type == 'page') {
+                wp_enqueue_script(
+                    'page-edit-scripts',
+                    get_template_directory_uri() .'/js/admin-page-edit.js',
+                    array('fw'),
+                    fw()->theme->manifest->get_version(),
+                    true
+                );
+            }
+        }
+
+.. _fw_admin_enqueue_scripts_term:
+
+* ``fw_admin_enqueue_scripts:term`` - Enqueue assets only in **Taxonomy Term Edit** page.
+
+    .. code-block:: php
+
+        add_action('fw_admin_enqueue_scripts:term', '_action_theme_enqueue_scripts_term_edit');
+        function _action_theme_enqueue_scripts_term_edit($taxonomy) {
+            if ($taxonomy == 'category') {
+                wp_enqueue_script(
+                    'category-edit-scripts',
+                    get_template_directory_uri() .'/js/admin-category-edit.js',
+                    array('fw'),
+                    fw()->theme->manifest->get_version(),
+                    true
+                );
+            }
+        }
+
+Database
+########
+
+* ``fw_post_options_update`` - After database post option or all options were updated.
+  The description of parameters can be found `here <https://github.com/ThemeFuse/Unyson/blob/v2.4.17/framework/helpers/database.php#L147-L179>`__.
+
+    .. code-block:: php
+
+        add_action('fw_post_options_update', '_action_theme_fw_post_options_update', 10, 4);
+        function _action_theme_fw_post_options_update($post_id, $option_id, $sub_keys, $old_value) {
+            if ($option_id === 'hello' && empty($sub_keys)) {
+                // do something ...
+            }
+        }
+
+Filters
+-------
+
+General
+#######
+
+.. _fw_framework_customizations_dir_rel_path:
+
+* ``fw_framework_customizations_dir_rel_path`` - Relative path of the customizations directory located in theme.
+  By default it is ``/framework-customizations``.
+
+    .. code-block:: php
+
+        add_filter(
+            'fw_framework_customizations_dir_rel_path',
+            '_filter_theme_fw_customizations_dir_rel_path'
+        );
+        function _filter_theme_fw_customizations_dir_rel_path($rel_path) {
+            /**
+             * Make the directory name shorter. Instead of
+             * {theme}/framework-customizations/theme/options/post.php
+             * will be
+             * {theme}/fw/theme/options/post.php
+             */
+            return '/fw';
+        }
+
+Options
+#######
+
+.. _fw_settings_options:
+
+* ``fw_settings_options`` - Theme **Settings Options**, which are loaded from
+  ``{theme}/framework-customizations/theme/options/settings.php``
+
+    .. code-block:: php
+
+        add_filter('fw_settings_options', '_filter_theme_fw_settings_options');
+        function _filter_theme_fw_settings_options($options) {
+            $options['extra-tab'] = array(
+                'type' => 'tab',
+                'title' => __('Extra Tab', 'domain'),
+                'options' => array(
+                    'test' => array('type' => 'text'),
+                ),
+            );
+
+            return $options;
+        }
+
+.. _fw_customizer_options:
+
+* ``fw_customizer_options`` - Theme **Customizer Options**, which are loaded from
+  ``{theme}/framework-customizations/theme/options/customizer.php``
+
+    .. code-block:: php
+
+        add_filter('fw_customizer_options', '_filter_theme_fw_customizer_options');
+        function _filter_theme_fw_customizer_options($options) {
+            $options['extra-option'] = array('type' => 'text');
+
+            return $options;
+        }
+
+.. _fw_post_options:
+
+* ``fw_post_options`` - **Post Options**, which are loaded from
+  ``{theme}/framework-customizations/theme/options/posts/{post-type}.php``
+
+    .. code-block:: php
+
+        add_filter('fw_post_options', '_filter_theme_fw_post_options', 10, 2);
+        function _filter_theme_fw_post_options($options, $post_type) {
+            if ($post_type == 'page') {
+                $options['extra-option'] = array('type' => 'text');
+            }
+
+            return $options;
+        }
+
+.. _fw_taxonomy_options:
+
+* ``fw_taxonomy_options`` - **Taxonomy Term Options**, which are loaded from
+  ``{theme}/framework-customizations/theme/options/taxonomies/{taxonomy}.php``
+
+    .. code-block:: php
+
+        add_filter('fw_taxonomy_options', '_filter_theme_fw_taxonomy_options', 10, 2);
+        function _filter_theme_fw_taxonomy_options($options, $taxonomy) {
+            if ($taxonomy == 'category') {
+                $options['extra-option'] = array('type' => 'text');
+            }
+
+            return $options;
+        }

index.rst

@@ -83,3 +83,4 @@ The licenses for most software are designed to take away your freedom to share a
     helpers/index
     manifest/index
     extension/index
+    hooks/index