From 43c4ff55d12fe258320b611b181d9f441b58d12a Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Wed, 11 Dec 2024 10:22:33 -0500 Subject: [PATCH 1/6] Setup search scraper action --- .github/workflows/build.yml | 93 ++++++++++++++++++ .github/workflows/search.yml | 48 +++++++++ README.md | 18 ++++ config.yml | 2 + search.config.json | 183 +++++++++++++++++++++++++++++++++++ 5 files changed, 344 insertions(+) create mode 100644 .github/workflows/build.yml create mode 100644 .github/workflows/search.yml create mode 100644 search.config.json diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml new file mode 100644 index 000000000..8fbb73855 --- /dev/null +++ b/.github/workflows/build.yml @@ -0,0 +1,93 @@ +name: Build Docs + +on: + push: + branches: + - feature/docsearch + - 7.x + - 7.dev + +jobs: + build: + name: Build Documentation HTML + runs-on: ubuntu-latest + outputs: + DOCSEARCH_INDEX: ${{ steps.setup_vars.outputs.DOCSEARCH_INDEX }} + DOCS_URL: ${{ steps.setup_vars.outputs.DOCS_URL }} + steps: + - name: Checkout code + uses: actions/checkout@v2 + + - name: Setup Variables + id: setup_vars + run: | + if [[ "${{github.base_ref}}" == "7.x" || "${{github.ref}}" == "refs/heads/7.x" ]]; then + echo "DOCSEARCH_INDEX=expressionengine7" >> "$GITHUB_OUTPUT" + else + echo "DOCSEARCH_INDEX=expressionengine7_staging" >> "$GITHUB_OUTPUT" + fi + + - name: Update Docsearch Index + uses: richardrigutins/replace-in-files@v2 + with: + search-text: "docsearch_index: 'expressionengine'" + replacement-text: "docsearch_index: '${{steps.setup_vars.outputs.DOCSEARCH_INDEX}}'" + files: ./config.yml + + - name: Install NPM and build + run: | + npm install + npm run build + + - name: Archive Build files + uses: actions/upload-artifact@v4 + with: + name: EEDocs7.latest + path: build + + - name: Zip the docs + uses: montudor/action-zip@v1 + with: + args: zip -qq -r EEDocs7.latest.zip build + +# search: +# name: Build Search Index +# needs: build +# runs-on: ubuntu-latest +# steps: +# - name: Checkout code +# uses: actions/checkout@v2 + +# - name: Setup Variables +# run: | +# if [[ "${{github.base_ref}}" == "7.x" || "${{github.ref}}" == "refs/heads/7.x" ]]; then +# echo "DOCS_URL=https://docs.expressionengine.com/latest" >> "$GITHUB_ENV" +# else +# echo "::add-mask::${{secrets.STAGING_DOCS_DOMAIN}}" +# echo "DOCS_URL=${{secrets.STAGING_DOCS_URL}}" >> "$GITHUB_ENV" +# fi + +# - name: Configure Docsearch Index +# uses: richardrigutins/replace-in-files@v2 +# with: +# search-text: "\"index_uid\": \"expressionengine\"" +# replacement-text: "\"index_uid\": \"${{ needs.build.outputs.DOCSEARCH_INDEX }}\"" +# files: ./search.config.json + +# - name: Configure Docs Url +# uses: richardrigutins/replace-in-files@v2 +# with: +# search-text: "https://docs.expressionengine.com/latest" +# replacement-text: ${{ env.DOCS_URL }} +# files: ./search.config.json + +# - name: Scrape Docs +# env: +# HOST_URL: ${{ secrets.MEILISEARCH_HOST_URL }} +# API_KEY: ${{ secrets.MEILISEARCH_API_KEY }} +# run: | +# docker run -t --rm \ +# -e MEILISEARCH_HOST_URL=$HOST_URL \ +# -e MEILISEARCH_API_KEY=$API_KEY \ +# -v ./search.config.json:/docs-scraper/search.config.json \ +# getmeili/docs-scraper:latest pipenv run ./docs_scraper search.config.json diff --git a/.github/workflows/search.yml b/.github/workflows/search.yml new file mode 100644 index 000000000..c11de52a9 --- /dev/null +++ b/.github/workflows/search.yml @@ -0,0 +1,48 @@ +name: search + +on: + workflow_dispatch: + +jobs: + search: + name: Build Search Index + runs-on: ubuntu-latest + steps: + - name: Checkout code + uses: actions/checkout@v4 + + - name: Setup Variables + run: | + if [[ "${{github.base_ref}}" == "7.x" || "${{github.ref}}" == "refs/heads/7.x" ]]; then + echo "DOCSEARCH_INDEX=expressionengine7" >> "$GITHUB_ENV" + echo "DOCS_URL=https://docs.expressionengine.com/latest" >> "$GITHUB_ENV" + else + echo "DOCSEARCH_INDEX=expressionengine7_staging" >> "$GITHUB_ENV" + echo "::add-mask::${{secrets.STAGING_DOCS_DOMAIN}}" + echo "DOCS_URL=${{secrets.STAGING_DOCS_URL}}" >> "$GITHUB_ENV" + fi + + - name: Configure Docsearch Index + uses: richardrigutins/replace-in-files@v2 + with: + search-text: "\"index_uid\": \"expressionengine\"" + replacement-text: "\"index_uid\": \"${{ env.DOCSEARCH_INDEX }}\"" + files: ./search.config.json + + - name: Configure Docs Url + uses: richardrigutins/replace-in-files@v2 + with: + search-text: "https://docs.expressionengine.com/latest" + replacement-text: ${{ env.DOCS_URL }} + files: ./search.config.json + + - name: Scrape Docs + env: + HOST_URL: ${{ secrets.MEILISEARCH_HOST_URL }} + API_KEY: ${{ secrets.MEILISEARCH_API_KEY }} + run: | + docker run -t --rm \ + -e MEILISEARCH_HOST_URL=$HOST_URL \ + -e MEILISEARCH_API_KEY=$API_KEY \ + -v ./search.config.json:/docs-scraper/search.config.json \ + getmeili/docs-scraper:latest pipenv run ./docs_scraper search.config.json diff --git a/README.md b/README.md index 59f70c42c..aeed75ea5 100755 --- a/README.md +++ b/README.md @@ -34,6 +34,24 @@ To build the theme assets, run `npm run buildAssets`. You can also dynamically r Manually load `/build/index.html` in your browser to view your local build. For example, `file:///Users//Documents/ExpressionEngine-User-Guide/build/index.html`. You can use the side navigation to navigate to different local files, but the search functionality always takes you to the live version at docs.expressionengine.com. +## Using DocSearch Locally + +First you will need to choose a docsearch index name to use for your local testing and set that in `config.yml` + +Then you will need to build the docs and serve a local copy. For simplicity's sake we recommend using the node http-server like this `npx http-server -o ./build` + +Next you will need to update all the urls in `search.config.json` to point at your local copy of the documentation. Do a find/replace on `https://docs.expressionengine.com/latest` => `http://localhost:8080`. You will also need to update the `allowed_domains` array to include this new url. (If you are on a mac you may need to use `http://host.docker.internal:8080` instead so that the scraper container can connect to the docs on your local http-server.) + +Finally you can scrape your local docs with the following docker command + +``` +docker run -t --rm --network=host + -e MEILISEARCH_HOST_URL=https://docsearch.expressionengine.com \ + -e MEILISEARCH_API_KEY={{ SECRET_KEY }} \ + -v ./search.config.json:/docs-scraper/search.config.json \ + getmeili/docs-scraper:latest pipenv run ./docs_scraper search.config.json +``` + ## Contributing See something that needs fixing? Want to improve the user guide or make it more helpful? Great! Check out [CONTRIBUTING.md](CONTRIBUTING.md) for details. diff --git a/config.yml b/config.yml index 0e1bf101e..5b1d8b778 100644 --- a/config.yml +++ b/config.yml @@ -8,3 +8,5 @@ themeDir: theme customVariables: current_version: '7' current_year: 2024 + docsearch_index: 'expressionengine' + docsearch_public_key: '7d283b55c1d7c0e5f340c71b5dfc751d8dc625708f29e582134f7643bc95dbd7' diff --git a/search.config.json b/search.config.json new file mode 100644 index 000000000..eff5cfacf --- /dev/null +++ b/search.config.json @@ -0,0 +1,183 @@ +{ + "index_uid": "expressionengine", + "allowed_domains": [], + "start_urls": [ + { + "url": "https://docs.expressionengine.com/latest/general", + "page_rank": 50 + }, + { + "url": "https://docs.expressionengine.com/latest/getting-started", + "page_rank": 45 + }, + { + "url": "https://docs.expressionengine.com/latest/installation", + "page_rank": 40 + }, + { + "url": "https://docs.expressionengine.com/latest/control-panel", + "page_rank": 5 + }, + { + "url": "https://docs.expressionengine.com/latest/channels", + "page_rank": 65 + }, + { + "url": "https://docs.expressionengine.com/latest/config", + "page_rank": 55 + }, + { + "url": "https://docs.expressionengine.com/latest/templates", + "page_rank": 60 + }, + { + "url": "https://docs.expressionengine.com/latest/troubleshooting", + "page_rank": 50 + }, + { + "url": "https://docs.expressionengine.com/latest/fieldtypes", + "page_rank": 55 + }, + { + "url": "https://docs.expressionengine.com/latest/comment", + "page_rank": 30 + }, + { + "url": "https://docs.expressionengine.com/latest/cli", + "page_rank": 35 + }, + { + "url": "https://docs.expressionengine.com/latest/member", + "page_rank": 30 + }, + { + "url": "https://docs.expressionengine.com/latest/optimization", + "page_rank": 35 + }, + { + "url": "https://docs.expressionengine.com/latest/security", + "page_rank": 35 + }, + { + "url": "https://docs.expressionengine.com/latest/localization", + "page_rank": 35 + }, + { + "url": "https://docs.expressionengine.com/latest/msm", + "page_rank": 30 + }, + { + "url": "https://docs.expressionengine.com/latest/advanced-usage", + "page_rank": 25 + }, + { + "url": "https://docs.expressionengine.com/latest/add-ons", + "page_rank": 25 + }, + { + "url": "https://docs.expressionengine.com/latest/development", + "page_rank": 30 + } + ], + "sitemap_urls": [], + "stop_urls": [], + "min_indexed_level": 2, + "selectors_exclude": [ + ".table-of-contents", + ".docs-footer" + ], + "selectors": { + "lvl0": { + "selector": "#docsearch-content h1", + "global": false + }, + "lvl1": { + "selector": "#docsearch-content h2" + }, + "lvl2": "#docsearch-content h3", + "lvl3": "#docsearch-content h4", + "lvl4": "#docsearch-content h5", + "lvl5": "#docsearch-content h6", + "text": "#docsearch-content > article > *:not(section), #docsearch-content > article > section > *:not(pre)" + }, + "custom_settings": { + "displayedAttributes": [ + "*" + ], + "searchableAttributes": [ + "hierarchy_radio_lvl0", + "hierarchy_radio_lvl1", + "hierarchy_radio_lvl2", + "hierarchy_radio_lvl3", + "hierarchy_radio_lvl4", + "hierarchy_radio_lvl5", + "hierarchy_lvl0", + "hierarchy_lvl1", + "hierarchy_lvl2", + "hierarchy_lvl3", + "hierarchy_lvl4", + "hierarchy_lvl5", + "hierarchy_lvl6", + "content", + "anchor", + "url", + "objectID" + ], + "filterableAttributes": [ + "hierarchy_lvl0", + "hierarchy_lvl1", + "hierarchy_lvl2", + "hierarchy_lvl3" + ], + "sortableAttributes": [], + "rankingRules": + [ + "words", + "typo", + "proximity", + "attribute", + "page_rank:desc", + "exactness", + "sort" + ], + "stopWords": [ + "a", "and", "as", "at", "be", "but", "by", + "do", "does", "doesn't", "for", "from", + "in", "is", "it", "no", "nor", "not", + "of", "off", "on", "or", + "so", "should", "than", "that", "that's", "the", + "then", "there", "there's", "these", + "this", "those", "to", "too", + "up", "was", "wasn't", "what", "what's", "when", "when's", + "where", "where's", "which", "while", "who", "who's", + "with", "won't", "would", "wouldn't", "example", "option" + ], + "nonSeparatorTokens": [], + "separatorTokens": [], + "dictionary": [], + "synonyms": { + "add-on": ["addon"], + "addon": ["add-on"], + "fieldtype": ["field type"], + "field type": ["fieldtype"] + }, + "distinctAttribute": null, + "typoTolerance": { + "enabled": true, + "minWordSizeForTypos": { + "oneTypo": 5, + "twoTypos": 9 + }, + "disableOnWords": [], + "disableOnAttributes": [] + }, + "faceting": { + "maxValuesPerFacet": 100 + }, + "pagination": { + "maxTotalHits": 50 + }, + "proximityPrecision": "byWord", + "searchCutoffMs": null + } + } \ No newline at end of file From 2b7057a919789dde6ae91a30ead1920de90192bf Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Mon, 16 Dec 2024 14:36:28 -0500 Subject: [PATCH 2/6] Update to meilisearch, improve markdown rendering for search --- package-lock.json | 32 +++++++----------------- package.json | 2 +- scripts/md-render.js | 46 ++++++++++++++++++++++++++++++++++- scripts/page-toc-generator.js | 2 +- theme/doc-page-template.html | 32 ++++++++++++------------ theme/site-template.html | 33 ++++++++++--------------- 6 files changed, 85 insertions(+), 62 deletions(-) diff --git a/package-lock.json b/package-lock.json index 1e8fcc360..edc23fa5a 100644 --- a/package-lock.json +++ b/package-lock.json @@ -32,7 +32,7 @@ "js-yaml": "^3.13.1", "list-item": "^2.0.0", "markdown-slug": "^0.1.1", - "marked": "^0.7.0", + "marked": "^7.0.5", "postcss": "^8.4.18", "replace-ext": "^1.0.0", "tailwindcss": "^3.2.1", @@ -5034,12 +5034,6 @@ "node": ">=6" } }, - "node_modules/json5/node_modules/minimist": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz", - "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", - "dev": true - }, "node_modules/jsprim": { "version": "1.4.1", "resolved": "https://registry.npmjs.org/jsprim/-/jsprim-1.4.1.tgz", @@ -5421,15 +5415,15 @@ } }, "node_modules/marked": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz", - "integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==", + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/marked/-/marked-7.0.5.tgz", + "integrity": "sha512-lwNAFTfXgqpt/XvK17a/8wY9/q6fcSPZT1aP6QW0u74VwaJF/Z9KbRcX23sWE4tODM+AolJNcUtErTkgOeFP/Q==", "dev": true, "bin": { - "marked": "bin/marked" + "marked": "bin/marked.js" }, "engines": { - "node": ">=0.10.0" + "node": ">= 16" } }, "node_modules/matchdep": { @@ -12684,14 +12678,6 @@ "dev": true, "requires": { "minimist": "^1.2.0" - }, - "dependencies": { - "minimist": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz", - "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", - "dev": true - } } }, "jsprim": { @@ -13001,9 +12987,9 @@ } }, "marked": { - "version": "0.7.0", - "resolved": "https://registry.npmjs.org/marked/-/marked-0.7.0.tgz", - "integrity": "sha512-c+yYdCZJQrsRjTPhUx7VKkApw9bwDkNbHUKo1ovgcfDjb2kc8rLuRbIFyXL5WOEUwzSSKo3IXpph2K6DqB/KZg==", + "version": "7.0.5", + "resolved": "https://registry.npmjs.org/marked/-/marked-7.0.5.tgz", + "integrity": "sha512-lwNAFTfXgqpt/XvK17a/8wY9/q6fcSPZT1aP6QW0u74VwaJF/Z9KbRcX23sWE4tODM+AolJNcUtErTkgOeFP/Q==", "dev": true }, "matchdep": { diff --git a/package.json b/package.json index cdf1ee43a..00c0d2142 100644 --- a/package.json +++ b/package.json @@ -37,7 +37,7 @@ "js-yaml": "^3.13.1", "list-item": "^2.0.0", "markdown-slug": "^0.1.1", - "marked": "^0.7.0", + "marked": "^7.0.5", "postcss": "^8.4.18", "replace-ext": "^1.0.0", "tailwindcss": "^3.2.1", diff --git a/scripts/md-render.js b/scripts/md-render.js index 32001a915..03b388326 100644 --- a/scripts/md-render.js +++ b/scripts/md-render.js @@ -11,6 +11,7 @@ const Fs = require('fs') const Path = require('path') const MarkedJs = require('marked') + const isUrl = require('is-url') const { bsToFs } = require('./utility.js') const Logger = require('./logger.js') @@ -185,13 +186,56 @@ renderer.table = function(header, body) { return `
${header}${body}
` } + +// The sectionLevel will help us prevent matching the same header multiple times. +let sectionLevel = 0; + +// Creating regular expressions is expensive so we create them once. +// Create 7 sections since that is the maximum heading level. +const sectionRegexps = new Array(7).fill().map((e, i) => new RegExp(`^(#{${i + 1}} )[^]*?(?:\\n(?=\\1)|$)`)); + +const sectionExtension = { + name: 'sectionBlock', + level: 'block', + start(src) { + // Match when # is at the beginning of a line. + return src.match(/^#/m)?.index; + }, + tokenizer(src) { + const match = src.match(sectionRegexps[sectionLevel]); + if (!match) { + return; + } + + + sectionLevel++; + // Tokenize text inside the section. + // Only add sectionBlock token for headers one level up from current level. + const tokens = this.lexer.blockTokens(match[0]); + sectionLevel--; + + return { + type: 'sectionBlock', + raw: match[0], + level: sectionLevel + 1, + tokens + }; + }, + renderer(token) { + const tag = token.level === 1 ? 'article' : 'section'; + return `<${tag}>\n${this.parser.parse(token.tokens)}\n`; + } +}; + // ------------------------------------------------------------------- module.exports = function (text, info) { currentPageInfo = info tocGenerator = new PageTocGenerator() - let renderedContent = MarkedJs(text, { renderer: renderer }) + MarkedJs.marked.use({ renderer: renderer, extensions: [sectionExtension] }) + let renderedContent = MarkedJs.marked.parse(text) + renderedContent = tocGenerator.renderTocs(renderedContent, currentPageInfo) diff --git a/scripts/page-toc-generator.js b/scripts/page-toc-generator.js index ce430b6d5..c5dfb9e77 100644 --- a/scripts/page-toc-generator.js +++ b/scripts/page-toc-generator.js @@ -102,7 +102,7 @@ class PageTocGenerator { let start = toc.hide ? '
Show List
' : '
' // Render the list as html - let tocContent = start + Marked(list) + '
' + let tocContent = start + Marked.marked.parse(list) + '
' // Replace the temporary id with the new html pageContent = pageContent.replace(key, tocContent) } diff --git a/theme/doc-page-template.html b/theme/doc-page-template.html index 16367c645..732a99ec5 100755 --- a/theme/doc-page-template.html +++ b/theme/doc-page-template.html @@ -14,7 +14,7 @@ {{page_title}} — ExpressionEngine {{current_version}} Documentation - + @@ -93,7 +93,7 @@
@@ -127,20 +127,20 @@

Community

- - + + diff --git a/theme/site-template.html b/theme/site-template.html index cdb9ef009..9bc2957a8 100644 --- a/theme/site-template.html +++ b/theme/site-template.html @@ -81,24 +81,17 @@

Community

From a929a703cbb59c72ac51f398c4fb81d45adfc64f Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Mon, 16 Dec 2024 14:38:39 -0500 Subject: [PATCH 3/6] Update documentation structure for better search results --- README.md | 4 +- docs/development/control-panel-js/globals.md | 24 +- .../extension-hooks/api/channel-fields.md | 2 +- .../extension-hooks/api/template-structure.md | 2 +- .../extension-hooks/cp/admin-content.md | 8 +- docs/development/extension-hooks/cp/css.md | 2 +- docs/development/extension-hooks/cp/design.md | 2 +- .../extension-hooks/cp/javascript.md | 2 +- docs/development/extension-hooks/cp/login.md | 10 +- .../development/extension-hooks/cp/members.md | 10 +- docs/development/extension-hooks/cp/menu.md | 2 +- .../extension-hooks/cp/myaccount.md | 2 +- .../development/extension-hooks/cp/publish.md | 4 +- .../development/extension-hooks/global/cli.md | 4 +- .../extension-hooks/global/core.md | 4 +- .../extension-hooks/global/email.md | 2 +- .../extension-hooks/global/filemanager.md | 4 +- .../extension-hooks/global/functions.md | 8 +- .../extension-hooks/global/grid.md | 4 +- .../extension-hooks/global/input.md | 2 +- .../extension-hooks/global/member-ft.md | 6 +- .../extension-hooks/global/member-model.md | 12 +- .../extension-hooks/global/output.md | 2 +- .../extension-hooks/global/pagination.md | 6 +- .../extension-hooks/global/relationships.md | 16 +- .../development/extension-hooks/global/rte.md | 12 +- .../extension-hooks/global/session.md | 4 +- .../extension-hooks/global/template.md | 6 +- .../extension-hooks/global/text-helper.md | 2 +- .../extension-hooks/global/typography.md | 4 +- .../extension-hooks/model/category-field.md | 22 +- .../extension-hooks/model/category-group.md | 22 +- .../extension-hooks/model/category.md | 22 +- .../extension-hooks/model/channel-entry.md | 22 +- .../model/channel-field-group.md | 22 +- .../extension-hooks/model/channel-field.md | 22 +- .../model/channel-form-settings.md | 18 +- .../extension-hooks/model/channel-layout.md | 18 +- .../extension-hooks/model/channel.md | 18 +- .../extension-hooks/model/comment.md | 22 +- .../development/extension-hooks/model/file.md | 22 +- .../extension-hooks/model/fluid-field.md | 10 +- .../extension-hooks/model/member-field.md | 22 +- .../extension-hooks/model/member.md | 24 +- .../development/extension-hooks/model/role.md | 22 +- .../development/extension-hooks/model/site.md | 18 +- .../extension-hooks/model/status.md | 18 +- .../model/template-global-variable.md | 18 +- .../extension-hooks/model/template-group.md | 22 +- .../extension-hooks/model/template-route.md | 22 +- .../extension-hooks/model/template-snippet.md | 18 +- .../model/template-specialty-template.md | 18 +- .../extension-hooks/model/template.md | 22 +- .../extension-hooks/module/channel-form.md | 12 +- .../extension-hooks/module/channel.md | 16 +- .../extension-hooks/module/comment.md | 30 +- .../extension-hooks/module/email.md | 6 +- .../extension-hooks/module/forum.md | 36 +- .../extension-hooks/module/member-auth.md | 12 +- .../extension-hooks/module/member-register.md | 10 +- .../extension-hooks/module/member-settings.md | 4 +- .../extension-hooks/module/member.md | 2 +- .../extension-hooks/module/search.md | 4 +- .../extension-hooks/module/simple-commerce.md | 8 +- .../extension-hooks/module/wiki.md | 16 +- .../general/system-configuration-overrides.md | 468 +++++++++--------- docs/installation/changelog.md | 46 +- search.config.json | 10 +- theme/doc-page-template.html | 1 - 69 files changed, 648 insertions(+), 669 deletions(-) diff --git a/README.md b/README.md index aeed75ea5..fae2b7c9d 100755 --- a/README.md +++ b/README.md @@ -38,14 +38,14 @@ Manually load `/build/index.html` in your browser to view your local build. For First you will need to choose a docsearch index name to use for your local testing and set that in `config.yml` -Then you will need to build the docs and serve a local copy. For simplicity's sake we recommend using the node http-server like this `npx http-server -o ./build` +Then you will need to build the docs and serve a local copy. For simplicity's sake we recommend using the node http-server like this `npx http-server -o` Next you will need to update all the urls in `search.config.json` to point at your local copy of the documentation. Do a find/replace on `https://docs.expressionengine.com/latest` => `http://localhost:8080`. You will also need to update the `allowed_domains` array to include this new url. (If you are on a mac you may need to use `http://host.docker.internal:8080` instead so that the scraper container can connect to the docs on your local http-server.) Finally you can scrape your local docs with the following docker command ``` -docker run -t --rm --network=host +docker run -t --rm --network=host \ -e MEILISEARCH_HOST_URL=https://docsearch.expressionengine.com \ -e MEILISEARCH_API_KEY={{ SECRET_KEY }} \ -v ./search.config.json:/docs-scraper/search.config.json \ diff --git a/docs/development/control-panel-js/globals.md b/docs/development/control-panel-js/globals.md index af9f24cb7..594edaca8 100644 --- a/docs/development/control-panel-js/globals.md +++ b/docs/development/control-panel-js/globals.md @@ -20,56 +20,56 @@ The elements of global `EE` JavaScript objects could vary depending on the Contr To add the element to global object, call [`ee()->javascript->set_global()`](development/legacy/libraries/javascript.md#set_globalvar-val--) function. -### `BASE` +## `BASE` Control Panel base URL. $.get(EE.BASE + '&C=login&M=lock_cp'); -### `CSRF_TOKEN` +## `CSRF_TOKEN` The current [Cross Site Request Forgery](development/guidelines/security.md#cross-site-request-forgery) token headers: { 'X-CSRF-TOKEN': EE.CSRF_TOKEN }, -### `PATH_CP_GBL_IMG` +## `PATH_CP_GBL_IMG` Path to `themes/ee/asset/img` directory -### `THEME_URL` +## `THEME_URL` URL to `themes/ee/cp` folder -### `username` +## `username` Username of currently logged in member -### `lang` +## `lang` Object of language strings available for JavaScript function in member's preferred language text: EE.lang.loading -### `hasRememberMe` +## `hasRememberMe` Indicates whether the "remember me" checkbox was toggled on when member logged in. -### `cp.appVer` +## `cp.appVer` The version number of ExpressionEngine release. data: { appVer: EE.cp.appVer, } -### `site_id` +## `site_id` ID of MSM site that is currently active in Control Panel -### `site_name` +## `site_name` The configured site name -### `site_url` +## `site_url` The URL to the site's front-end @@ -81,7 +81,7 @@ The URL to the site's front-end } ] -### `fileManagerCompatibilityMode` +## `fileManagerCompatibilityMode` Indicates whether File Manager is running in [Compatibility Mode](control-panel/file-manager/file-manager.md#compatibility-mode). diff --git a/docs/development/extension-hooks/api/channel-fields.md b/docs/development/extension-hooks/api/channel-fields.md index 493809391..18380e3f3 100755 --- a/docs/development/extension-hooks/api/channel-fields.md +++ b/docs/development/extension-hooks/api/channel-fields.md @@ -13,7 +13,7 @@ lang: php # Channel Fields API Extension Hooks -### `custom_field_modify_data(EE_Fieldtype $ft, $method, $data)` +## `custom_field_modify_data(EE_Fieldtype $ft, $method, $data)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------- | diff --git a/docs/development/extension-hooks/api/template-structure.md b/docs/development/extension-hooks/api/template-structure.md index 2d6a72f6e..c788c0860 100755 --- a/docs/development/extension-hooks/api/template-structure.md +++ b/docs/development/extension-hooks/api/template-structure.md @@ -9,6 +9,6 @@ # Template Structure API Extension Hooks -### `template_types` +## `template_types` See the Output library's [template_types](development/extension-hooks/cp/design.md#template_types). diff --git a/docs/development/extension-hooks/cp/admin-content.md b/docs/development/extension-hooks/cp/admin-content.md index a0a2f08d2..0c89bce1b 100755 --- a/docs/development/extension-hooks/cp/admin-content.md +++ b/docs/development/extension-hooks/cp/admin-content.md @@ -13,9 +13,9 @@ lang: php # Admin Content Controller Extension Hooks -[TOC=3] +[TOC=2] -### `category_delete($cat_ids)` +## `category_delete($cat_ids)` | Parameter | Type | Description | | --------- | ------- | ----------------------------------- | @@ -28,7 +28,7 @@ How it's called: ee()->extensions->call('category_delete', $cat_ids); -### `category_save($cat_id, $data)` +## `category_save($cat_id, $data)` | Parameter | Type | Description | | --------------- | ------- | -------------------- | @@ -42,6 +42,6 @@ How it's called: ee()->extensions->call('category_save', $cat_id, $category_data); -### `foreign_character_conversion_array` +## `foreign_character_conversion_array` See Content_publish's `foreign_character_conversion_array`. diff --git a/docs/development/extension-hooks/cp/css.md b/docs/development/extension-hooks/cp/css.md index 64c967864..d83d80329 100755 --- a/docs/development/extension-hooks/cp/css.md +++ b/docs/development/extension-hooks/cp/css.md @@ -13,7 +13,7 @@ lang: php # CSS Controller Extension Hooks -### `cp_css_end()` +## `cp_css_end()` | Parameter | Type | Description | | --------- | -------- | -------------------------------------- | diff --git a/docs/development/extension-hooks/cp/design.md b/docs/development/extension-hooks/cp/design.md index fa8f71159..91c658758 100755 --- a/docs/development/extension-hooks/cp/design.md +++ b/docs/development/extension-hooks/cp/design.md @@ -13,7 +13,7 @@ lang: php # Design Controller Extension Hooks -### `template_types()` +## `template_types()` | Parameter | Type | Description | | --------- | ------- | -------------------------------------- | diff --git a/docs/development/extension-hooks/cp/javascript.md b/docs/development/extension-hooks/cp/javascript.md index 5b9024dfe..1aae330ef 100755 --- a/docs/development/extension-hooks/cp/javascript.md +++ b/docs/development/extension-hooks/cp/javascript.md @@ -13,7 +13,7 @@ lang: php # Javascript Controller Extension Hooks -### `cp_js_end()` +## `cp_js_end()` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------- | diff --git a/docs/development/extension-hooks/cp/login.md b/docs/development/extension-hooks/cp/login.md index a732988b8..a5a275ebb 100755 --- a/docs/development/extension-hooks/cp/login.md +++ b/docs/development/extension-hooks/cp/login.md @@ -13,9 +13,9 @@ lang: php # Login Controller Extension Hooks -[TOC=3] +[TOC=2] -### `login_authenticate_start()` +## `login_authenticate_start()` | Parameter | Type | | --------- | ------ | @@ -28,7 +28,7 @@ How it's called: $this->extensions->call('login_authenticate_start'); if ($this->extensions->end_script === TRUE) return; -### `cp_member_login($hook_data)` +## `cp_member_login($hook_data)` | Parameter | Type | Description | | ----------- | -------- | ---------------------------------------------------------------------------------------------------------------- | @@ -42,7 +42,7 @@ How it's called: ee()->extensions->call('cp_member_login', $this->_hook_data()); if (ee()->extensions->end_script === TRUE) return; -### `cp_member_logout()` +## `cp_member_logout()` | Parameter | Type | | --------- | ------ | @@ -55,7 +55,7 @@ How it's called: $this->extensions->call('cp_member_logout'); if ($this->extensions->end_script === TRUE) return; -### `cp_member_reset_password()` +## `cp_member_reset_password()` | Parameter | Type | | --------- | ------ | diff --git a/docs/development/extension-hooks/cp/members.md b/docs/development/extension-hooks/cp/members.md index 5edbd57b0..a5e3ea9cb 100755 --- a/docs/development/extension-hooks/cp/members.md +++ b/docs/development/extension-hooks/cp/members.md @@ -13,9 +13,9 @@ lang: php # Members Controller Extension Hooks -[TOC=3] +[TOC=2] -### `cp_members_member_create_start()` +## `cp_members_member_create_start()` | Parameter | Type | | --------- | ------ | @@ -28,7 +28,7 @@ How it's called: $this->extensions->call('cp_members_member_create_start'); if ($this->extensions->end_script === TRUE) return; -### `cp_members_member_create($member_id, $data)` +## `cp_members_member_create($member_id, $data)` | Parameter | Type | Description | | ----------- | ------- | ----------------- | @@ -43,7 +43,7 @@ How it's called: $this->extensions->call('cp_members_member_create', $member_id, $data); if ($this->extensions->end_script === TRUE) return; -### `cp_members_member_delete_end($member_ids)` +## `cp_members_member_delete_end($member_ids)` | Parameter | Type | Description | | ------------ | ------- | ---------------------- | @@ -57,7 +57,7 @@ How it's called: $this->extensions->call('cp_members_member_delete_end', $member_ids); if ($this->extensions->end_script === TRUE) return; -### `cp_members_validate_members()` +## `cp_members_validate_members()` | Parameter | Type | Description | | --------- | ------- | ------------------------------ | diff --git a/docs/development/extension-hooks/cp/menu.md b/docs/development/extension-hooks/cp/menu.md index 51e90b2a3..3e441dd91 100755 --- a/docs/development/extension-hooks/cp/menu.md +++ b/docs/development/extension-hooks/cp/menu.md @@ -13,7 +13,7 @@ lang: php # Control Panel Menu Extension Hooks -### `cp_custom_menu($menu)` +## `cp_custom_menu($menu)` Add menu items to the secondary navigation area specifically reserved for custom links. diff --git a/docs/development/extension-hooks/cp/myaccount.md b/docs/development/extension-hooks/cp/myaccount.md index 1729f3d8b..1700f1a6b 100755 --- a/docs/development/extension-hooks/cp/myaccount.md +++ b/docs/development/extension-hooks/cp/myaccount.md @@ -13,7 +13,7 @@ lang: php # My Account Controller Extension Hooks -### `myaccount_nav_setup()` +## `myaccount_nav_setup()` | Parameter | Type | Description | | --------- | ------- | -------------------------------------- | diff --git a/docs/development/extension-hooks/cp/publish.md b/docs/development/extension-hooks/cp/publish.md index 7c925aa90..921b232ab 100755 --- a/docs/development/extension-hooks/cp/publish.md +++ b/docs/development/extension-hooks/cp/publish.md @@ -13,7 +13,7 @@ lang: php # Publish Controller Extension Hooks -### `entry_save_and_close_redirect($entry)` +## `entry_save_and_close_redirect($entry)` | Parameter | Type | Description | | --------- | ---------------------------------- | --------------------------------------------- | @@ -26,7 +26,7 @@ How it's called: $redirect_url = ee()->extensions->call('entry_save_and_close_redirect', $entry); -### `publish_live_preview_route($entry_data, $uri, $template_id)` +## `publish_live_preview_route($entry_data, $uri, $template_id)` | Parameter | Type | Description | | ------------- | -------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/global/cli.md b/docs/development/extension-hooks/global/cli.md index f29d3ed25..425edfe13 100644 --- a/docs/development/extension-hooks/global/cli.md +++ b/docs/development/extension-hooks/global/cli.md @@ -13,7 +13,7 @@ lang: php # CLI Extension Hooks -### `cli_boot($cli)` +## `cli_boot($cli)` | Parameter | Type | Description | | ------------------ | -------- | ------------------------------------------------------------------------ | @@ -29,7 +29,7 @@ How it's called: $this->complete(''); } -### `cli_before_handle($cli, $commandClass, $command)` +## `cli_before_handle($cli, $commandClass, $command)` | Parameter | Type | Description | | -------------- | -------- | ------------------------------------------------------------------------ | diff --git a/docs/development/extension-hooks/global/core.md b/docs/development/extension-hooks/global/core.md index cb30901c2..836419606 100755 --- a/docs/development/extension-hooks/global/core.md +++ b/docs/development/extension-hooks/global/core.md @@ -13,7 +13,7 @@ lang: php # Core Library Extension Hooks -### `core_boot()` +## `core_boot()` | Parameter | Type | | --------- | ------ | @@ -34,7 +34,7 @@ NOTE: **Note:** This hook fires on every ExpressionEngine request, so be mindful return; } -### `core_template_route($uri_string)` +## `core_template_route($uri_string)` | Parameter | Type | Description | | ------------ | -------- | ------------------------------------------------------------------------ | diff --git a/docs/development/extension-hooks/global/email.md b/docs/development/extension-hooks/global/email.md index 90f5f8739..6efd70ff6 100755 --- a/docs/development/extension-hooks/global/email.md +++ b/docs/development/extension-hooks/global/email.md @@ -13,7 +13,7 @@ lang: php # Email Library Extension Hooks -### `email_send(&$data)` +## `email_send(&$data)` | Parameter | Type | Description | | --------- | --------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/global/filemanager.md b/docs/development/extension-hooks/global/filemanager.md index 41297180b..20ce8e9fd 100755 --- a/docs/development/extension-hooks/global/filemanager.md +++ b/docs/development/extension-hooks/global/filemanager.md @@ -13,7 +13,7 @@ lang: php # Filemanager Library Extension Hooks -### `file_after_save($file_id, $data)` +## `file_after_save($file_id, $data)` | Parameter | Type | Description | | --------- | ------- | -------------------------------------------- | @@ -28,7 +28,7 @@ How it's called: $this->extensions->call('file_after_save', $file_id, $data); if ($this->extensions->end_script === TRUE) return; -### `files_after_delete($deleted)` +## `files_after_delete($deleted)` | Parameter | Type | Description | | --------- | ------- | ------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/global/functions.md b/docs/development/extension-hooks/global/functions.md index 09622678e..ee5729b1e 100755 --- a/docs/development/extension-hooks/global/functions.md +++ b/docs/development/extension-hooks/global/functions.md @@ -13,7 +13,7 @@ lang: php # Functions Library Extension Hooks -### `cache_clearing_end($which)` +## `cache_clearing_end($which)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------------------------ | @@ -26,7 +26,7 @@ How it's called: $result = ee()->extensions->call('cache_clearing_end', $which); -### `create_captcha_start($old_word)` +## `create_captcha_start($old_word)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------------------------ | @@ -40,7 +40,7 @@ How it's called: $edata = ee()->extensions->call('create_captcha_start', $old_word); if (ee()->extensions->end_script === TRUE) return $edata; -### `form_declaration_modify_data($data)` +## `form_declaration_modify_data($data)` | Parameter | Type | Description | | --------- | ------- | ---------------------------------------------------------- | @@ -53,7 +53,7 @@ How it's called: $data = $this->extensions->call('form_declaration_modify_data', $data); -### `form_declaration_return($data)` +## `form_declaration_return($data)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------------------------------ | diff --git a/docs/development/extension-hooks/global/grid.md b/docs/development/extension-hooks/global/grid.md index 688037065..8f7b3c7bd 100755 --- a/docs/development/extension-hooks/global/grid.md +++ b/docs/development/extension-hooks/global/grid.md @@ -13,7 +13,7 @@ lang: php # Grid Fieldtype Extension Hooks -### `grid_query($entry_ids, $field_id, $content_type, $data_table, $sql)` +## `grid_query($entry_ids, $field_id, $content_type, $data_table, $sql)` | Parameter | Type | Description | | -------------- | -------- | -------------------------------------------------------------- | @@ -46,7 +46,7 @@ How it's called: )->result_array(); } -### `grid_save($entry_id, $field_id, $content_type, $data_table, $data)` +## `grid_save($entry_id, $field_id, $content_type, $data_table, $data)` | Parameter | Type | Description | | -------------- | -------- | -------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/global/input.md b/docs/development/extension-hooks/global/input.md index 741480866..7f8239e83 100755 --- a/docs/development/extension-hooks/global/input.md +++ b/docs/development/extension-hooks/global/input.md @@ -13,7 +13,7 @@ lang: php # Input Library Extension Hooks -### `set_cookie_end($data)` +## `set_cookie_end($data)` | Parameter | Type | Description | | --------- | ------- | -------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/global/member-ft.md b/docs/development/extension-hooks/global/member-ft.md index 85422f098..6e7148b00 100644 --- a/docs/development/extension-hooks/global/member-ft.md +++ b/docs/development/extension-hooks/global/member-ft.md @@ -13,9 +13,9 @@ lang: php # Members Fieldtype Extension Hooks -[TOC=3] +[TOC=2] -### `member_relationships_display_field($entry_id, $field_id, $sql)` +## `member_relationships_display_field($entry_id, $field_id, $sql)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------------- | @@ -44,7 +44,7 @@ How it's called: NOTE: **Note:** To use this hook, you can either add to the existing Active Record call, or call `ee()->db->_reset_select()` to cancel the Active Record call and start your own, or modify the passed compiled SQL. -### `member_relationships_post_save($ships, $entry_id, $field_id)` +## `member_relationships_post_save($ships, $entry_id, $field_id)` | Parameter | Type | Description | | ---------- | ------- | ---------------------------------------------- | diff --git a/docs/development/extension-hooks/global/member-model.md b/docs/development/extension-hooks/global/member-model.md index 3168e1e3a..e051cebd9 100755 --- a/docs/development/extension-hooks/global/member-model.md +++ b/docs/development/extension-hooks/global/member-model.md @@ -13,9 +13,9 @@ lang: php # Legacy Member Model Extension Hooks -[TOC=3] +[TOC=2] -### `member_create_start($data, $cdata)` +## `member_create_start($data, $cdata)` | Parameter | Type | Description | | --------- | ------- | ----------------------------------------------------------------- | @@ -33,7 +33,7 @@ Example of array to return: array($data, $cdata) -### `member_create_end($member_id, $data, $cdata)` +## `member_create_end($member_id, $data, $cdata)` | Parameter | Type | Description | | ----------- | ------- | -------------------------------------------- | @@ -48,7 +48,7 @@ How it's called: $this->extensions->call('member_create_end', $member_id, $data, $cdata); -### `member_update_start($member_id, $data)` +## `member_update_start($member_id, $data)` | Parameter | Type | Description | | ----------- | ------- | ----------------------------- | @@ -62,7 +62,7 @@ How it's called: $data = $this->extensions->call('member_update_start', $member_id, $data); -### `member_update_end($member_id, $data)` +## `member_update_end($member_id, $data)` | Parameter | Type | Description | | ----------- | ------- | ----------------------------- | @@ -76,7 +76,7 @@ How it's called: $this->extensions->call('member_update_end', $member_id, $data); -### `member_delete($member_ids)` +## `member_delete($member_ids)` | Parameter | Type | Description | | ------------ | ------- | ---------------------------------------------------------- | diff --git a/docs/development/extension-hooks/global/output.md b/docs/development/extension-hooks/global/output.md index fe2166790..452b8e516 100755 --- a/docs/development/extension-hooks/global/output.md +++ b/docs/development/extension-hooks/global/output.md @@ -13,7 +13,7 @@ lang: php # Output Library Extension Hooks -### `output_show_message($data, $output)` +## `output_show_message($data, $output)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/global/pagination.md b/docs/development/extension-hooks/global/pagination.md index 136b46a7a..8e89acfcf 100755 --- a/docs/development/extension-hooks/global/pagination.md +++ b/docs/development/extension-hooks/global/pagination.md @@ -13,9 +13,9 @@ lang: php # Pagination Library Extension Hooks -[TOC=3] +[TOC=2] -### `pagination_create($this, $count)` +## `pagination_create($this, $count)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------------------------------------------------------------------------------------- | @@ -30,7 +30,7 @@ How it's called: $this->extensions->call('pagination_create', $this, $count); if ($this->extensions->end_script === TRUE) return; -### `pagination_fetch_data($this)` +## `pagination_fetch_data($this)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/global/relationships.md b/docs/development/extension-hooks/global/relationships.md index 5e271d6c5..0614780ad 100755 --- a/docs/development/extension-hooks/global/relationships.md +++ b/docs/development/extension-hooks/global/relationships.md @@ -13,9 +13,9 @@ lang: php # Relationships Fieldtype Extension Hooks -[TOC=3] +[TOC=2] -### `relationships_display_field($entry_id, $field_id, $sql)` +## `relationships_display_field($entry_id, $field_id, $sql)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------------- | @@ -44,7 +44,7 @@ How it's called: NOTE: **Note:** To use this hook, you can either add to the existing Active Record call, or call `ee()->db->_reset_select()` to cancel the Active Record call and start your own, or modify the passed compiled SQL. -### `relationships_display_field_options($entry_id, $field_id, $sql)` +## `relationships_display_field_options($entry_id, $field_id, $sql)` | Parameter | Type | Description | | ---------- | -------- | ---------------------------------------------- | @@ -67,7 +67,7 @@ How it's called: ); } -### `relationships_post_save($ships, $entry_id, $field_id)` +## `relationships_post_save($ships, $entry_id, $field_id)` | Parameter | Type | Description | | ---------- | ------- | ---------------------------------------------- | @@ -82,7 +82,7 @@ How it's called: $ships = ee()->extensions->call('relationships_post_save', $ships, $entry_id, $field_id); -### `relationships_query($field_name, $entry_ids, $depths, $sql)` +## `relationships_query($field_name, $entry_ids, $depths, $sql)` | Parameter | Type | Description | | ------------ | -------- | ------------------------------------------------------- | @@ -113,7 +113,7 @@ How it's called: NOTE: **Note:** To use this hook, you can either add to the existing Active Record call, or call `ee()->db->_reset_select()` to cancel the Active Record call and start your own, or modify the passed compiled SQL. -### `relationships_query_result($entry_lookup)` +## `relationships_query_result($entry_lookup)` | Parameter | Type | Description | | -------------- | ------- | ----------------------------------------------------- | @@ -126,7 +126,7 @@ How it's called: $entry_lookup = ee()->extensions->call('relationships_query_result', $entry_lookup); -### `relationships_modify_rows($rows, $node)` +## `relationships_modify_rows($rows, $node)` | Parameter | Type | Description | | --------- | ----------- | --------------------------------------------- | @@ -140,7 +140,7 @@ How it's called: $rows = ee()->extensions->call('relationships_modify_rows', $rows, $node); -### `relationship_entries_tagdata($tagdata, $row)` +## `relationship_entries_tagdata($tagdata, $row)` | Parameter | Type | Description | | --------- | -------- | ---------------------------- | diff --git a/docs/development/extension-hooks/global/rte.md b/docs/development/extension-hooks/global/rte.md index 8a7b84adb..b2e0fde97 100644 --- a/docs/development/extension-hooks/global/rte.md +++ b/docs/development/extension-hooks/global/rte.md @@ -13,7 +13,7 @@ lang: php # RTE Fieldtype Extension Hooks -### `rte_before_display($field, $data)` +## `rte_before_display($field, $data)` | Parameter | Type | Description | | -------------- | -------- | -------------------------------------------------------------- | @@ -26,7 +26,7 @@ How it's called: $data = ee()->extensions->call('rte_before_display', $this, $data); -### `rte_before_save($field, $data)` +## `rte_before_save($field, $data)` | Parameter | Type | Description | | -------------- | -------- | -------------------------------------------------------------- | @@ -39,7 +39,7 @@ How it's called: $data = ee()->extensions->call('rte_before_save', $this, $data); -### `rte_before_replace($field, $data)` +## `rte_before_replace($field, $data)` | Parameter | Type | Description | | -------------- | -------- | -------------------------------------------------------------- | @@ -50,9 +50,9 @@ Allows modification of field data before it is being displayed using template ta How it's called: - $data = ee()->extensions->call('rte_before_replace', $this, $data); + $data = ee()->extensions->call('rte_before_replace', $this, $data); -### `rte_before_replace_end($field, $data)` +## `rte_before_replace_end($field, $data)` | Parameter | Type | Description | | -------------- | -------- | -------------------------------------------------------------- | @@ -63,4 +63,4 @@ Allows modification of field data before it is being displayed using template ta How it's called: - $data = ee()->extensions->call('rte_before_replace_end', $this, $data); + $data = ee()->extensions->call('rte_before_replace_end', $this, $data); diff --git a/docs/development/extension-hooks/global/session.md b/docs/development/extension-hooks/global/session.md index 188a6025b..95884dfa3 100755 --- a/docs/development/extension-hooks/global/session.md +++ b/docs/development/extension-hooks/global/session.md @@ -13,7 +13,7 @@ lang: php # Session Library Extension Hooks -### `sessions_end($this)` +## `sessions_end($this)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------------------------------------------------------------------------------- | @@ -27,7 +27,7 @@ How it's called: $this->extensions->call('sessions_end', $this); if ($this->extensions->end_script === TRUE) return; -### `sessions_start($this)` +## `sessions_start($this)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/global/template.md b/docs/development/extension-hooks/global/template.md index b0863ade0..94117e137 100755 --- a/docs/development/extension-hooks/global/template.md +++ b/docs/development/extension-hooks/global/template.md @@ -13,7 +13,7 @@ lang: php # Template Library Extension Hooks -### `template_fetch_template($row)` +## `template_fetch_template($row)` | Parameter | Type | Description | | --------- | ------- | ----------------------------- | @@ -26,7 +26,7 @@ How it's called: ee()->extensions->call('template_fetch_template', $row); -### `template_post_parse($final_template, $is_partial, $site_id, $currentTemplateInfo)` +## `template_post_parse($final_template, $is_partial, $site_id, $currentTemplateInfo)` | Parameter | Type | Description | | ---------------- | --------- | -------------------------------------------------------- | @@ -49,7 +49,7 @@ How it's called: ); NOTE: If `$is_partial` is true: -- $final_template contains the interim $template at that point in parsing; +- $final_template contains the interim $template at that point in parsing; - the identity of the partial template most recently processed is stored in $currentTemplateInfo; - returning a modified version of $final_template updates the interim parsed template. diff --git a/docs/development/extension-hooks/global/text-helper.md b/docs/development/extension-hooks/global/text-helper.md index 869445be3..534791dae 100755 --- a/docs/development/extension-hooks/global/text-helper.md +++ b/docs/development/extension-hooks/global/text-helper.md @@ -9,6 +9,6 @@ # Text Helper Extension Hooks -### `foreign_character_conversion_array` +## `foreign_character_conversion_array` See Content_publish's `foreign_character_conversion_array`. diff --git a/docs/development/extension-hooks/global/typography.md b/docs/development/extension-hooks/global/typography.md index 060d28218..2279f1279 100755 --- a/docs/development/extension-hooks/global/typography.md +++ b/docs/development/extension-hooks/global/typography.md @@ -13,7 +13,7 @@ lang: php # Typography Library Extension Hooks -### `typography_parse_type_start($str, $this, $prefs)` +## `typography_parse_type_start($str, $this, $prefs)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------------- | @@ -28,7 +28,7 @@ How it's called: $str = $this->extensions->call('typography_parse_type_start', $str, $this, $prefs); -### `typography_parse_type_end($str, $this, $prefs)` +## `typography_parse_type_end($str, $this, $prefs)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------------- | diff --git a/docs/development/extension-hooks/model/category-field.md b/docs/development/extension-hooks/model/category-field.md index 75fa9c488..11c2280a2 100755 --- a/docs/development/extension-hooks/model/category-field.md +++ b/docs/development/extension-hooks/model/category-field.md @@ -13,9 +13,9 @@ lang: php # CategoryField Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_category_field_insert($category_field, $values)` +## `before_category_field_insert($category_field, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_category_field_insert', $this, $this->getValues()); -### `after_category_field_insert($category_field, $values)` +## `after_category_field_insert($category_field, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_category_field_insert', $this, $this->getValues()); -### `before_category_field_update($category_field, $values, $modified)` +## `before_category_field_update($category_field, $values, $modified)` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_category_field_update', $this, $this->getValues(), $modified); -### `after_category_field_update($category_field, $values, $modified)` +## `after_category_field_update($category_field, $values, $modified)` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_category_field_update', $this, $this->getValues(), $modified); -### `before_category_field_save($category_field, $values)` +## `before_category_field_save($category_field, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_category_field_save', $this, $this->getValues()); -### `after_category_field_save($category_field, $values)` +## `after_category_field_save($category_field, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_category_field_save', $this, $this->getValues()); -### `before_category_field_delete($category_field, $values)` +## `before_category_field_delete($category_field, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_category_field_delete', $this, $this->getValues()); -### `after_category_field_delete($category_field, $values)` +## `after_category_field_delete($category_field, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_category_field_delete', $this, $this->getValues()); -### `before_category_field_bulk_delete($delete_ids)` +## `before_category_field_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -142,7 +142,7 @@ How it's called: ee()->extensions->call('before_category_field_bulk_delete', $delete_ids); -### `after_category_field_bulk_delete($delete_ids)` +## `after_category_field_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/category-group.md b/docs/development/extension-hooks/model/category-group.md index 61ec9a4ec..955687c48 100755 --- a/docs/development/extension-hooks/model/category-group.md +++ b/docs/development/extension-hooks/model/category-group.md @@ -13,9 +13,9 @@ lang: php # CategoryGroup Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_category_group_insert($category_group, $values)` +## `before_category_group_insert($category_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_category_group_insert', $this, $this->getValues()); -### `after_category_group_insert($category_group, $values)` +## `after_category_group_insert($category_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_category_group_insert', $this, $this->getValues()); -### `before_category_group_update($category_group, $values, $modified)` +## `before_category_group_update($category_group, $values, $modified)` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_category_group_update', $this, $this->getValues(), $modified); -### `after_category_group_update($category_group, $values, $modified)` +## `after_category_group_update($category_group, $values, $modified)` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_category_group_update', $this, $this->getValues(), $modified); -### `before_category_group_save($category_group, $values)` +## `before_category_group_save($category_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_category_group_save', $this, $this->getValues()); -### `after_category_group_save($category_group, $values)` +## `after_category_group_save($category_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_category_group_save', $this, $this->getValues()); -### `before_category_group_delete($category_group, $values)` +## `before_category_group_delete($category_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_category_group_delete', $this, $this->getValues()); -### `after_category_group_delete($category_group, $values)` +## `after_category_group_delete($category_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_category_group_delete', $this, $this->getValues()); -### `before_category_group_bulk_delete($delete_ids)` +## `before_category_group_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0** -### `after_category_group_bulk_delete($delete_ids)` +## `after_category_group_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/category.md b/docs/development/extension-hooks/model/category.md index d116a34c3..bee43c1ec 100755 --- a/docs/development/extension-hooks/model/category.md +++ b/docs/development/extension-hooks/model/category.md @@ -13,9 +13,9 @@ lang: php # Category Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_category_insert($category, $values)` +## `before_category_insert($category, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_category_insert', $this, $this->getValues()); -### `after_category_insert($category, $values)` +## `after_category_insert($category, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_category_insert', $this, $this->getValues()); -### `before_category_update($category, $values, $modified)` +## `before_category_update($category, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_category_update', $this, $this->getValues(), $modified); -### `after_category_update($category, $values, $modified)` +## `after_category_update($category, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_category_update', $this, $this->getValues(), $modified); -### `before_category_save($category, $values)` +## `before_category_save($category, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_category_save', $this, $this->getValues()); -### `after_category_save($category, $values)` +## `after_category_save($category, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_category_save', $this, $this->getValues()); -### `before_category_delete($category, $values)` +## `before_category_delete($category, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_category_delete', $this, $this->getValues()); -### `after_category_delete($category, $values)` +## `after_category_delete($category, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_category_delete', $this, $this->getValues()); -### `before_category_bulk_delete($delete_ids)` +## `before_category_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_category_bulk_delete($delete_ids)` +## `after_category_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/channel-entry.md b/docs/development/extension-hooks/model/channel-entry.md index 67ba9e427..c4549a94c 100755 --- a/docs/development/extension-hooks/model/channel-entry.md +++ b/docs/development/extension-hooks/model/channel-entry.md @@ -13,9 +13,9 @@ lang: php # Channel Entry Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_channel_entry_insert($entry, $values)` +## `before_channel_entry_insert($entry, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_channel_entry_insert', $this, $this->getValues()); -### `after_channel_entry_insert($entry, $values)` +## `after_channel_entry_insert($entry, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_channel_entry_insert', $this, $this->getValues()); -### `before_channel_entry_update($entry, $values, $modified)` +## `before_channel_entry_update($entry, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_channel_entry_update', $this, $this->getValues(), $modified); -### `after_channel_entry_update($entry, $values, $modified)` +## `after_channel_entry_update($entry, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_channel_entry_update', $this, $this->getValues(), $modified); -### `before_channel_entry_save($entry, $values)` +## `before_channel_entry_save($entry, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_channel_entry_save', $this, $this->getValues()); -### `after_channel_entry_save($entry, $values)` +## `after_channel_entry_save($entry, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_channel_entry_save', $this, $this->getValues()); -### `before_channel_entry_delete($entry, $values)` +## `before_channel_entry_delete($entry, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_channel_entry_delete', $this, $this->getValues()); -### `after_channel_entry_delete($entry, $values)` +## `after_channel_entry_delete($entry, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_channel_entry_delete', $this, $this->getValues()); -### `before_channel_entry_bulk_delete($delete_ids)` +## `before_channel_entry_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_channel_entry_bulk_delete($delete_ids)` +## `after_channel_entry_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/channel-field-group.md b/docs/development/extension-hooks/model/channel-field-group.md index e4426c11a..4ac006f78 100755 --- a/docs/development/extension-hooks/model/channel-field-group.md +++ b/docs/development/extension-hooks/model/channel-field-group.md @@ -13,9 +13,9 @@ lang: php # ChannelFieldGroup Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_channel_field_group_insert($channel_field_group, $values)` +## `before_channel_field_group_insert($channel_field_group, $values)` | Parameter | Type | Description | | --------------------- | -------- | --------------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_channel_field_group_insert', $this, $this->getValues()); -### `after_channel_field_group_insert($channel_field_group, $values)` +## `after_channel_field_group_insert($channel_field_group, $values)` | Parameter | Type | Description | | --------------------- | -------- | --------------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_channel_field_group_insert', $this, $this->getValues()); -### `before_channel_field_group_update($channel_field_group, $values, $modified)` +## `before_channel_field_group_update($channel_field_group, $values, $modified)` | Parameter | Type | Description | | --------------------- | -------- | --------------------------------------------------- | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_channel_field_group_update', $this, $this->getValues(), $modified); -### `after_channel_field_group_update($channel_field_group, $values, $modified)` +## `after_channel_field_group_update($channel_field_group, $values, $modified)` | Parameter | Type | Description | | --------------------- | -------- | --------------------------------------------------- | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_channel_field_group_update', $this, $this->getValues(), $modified); -### `before_channel_field_group_save($channel_field_group, $values)` +## `before_channel_field_group_save($channel_field_group, $values)` | Parameter | Type | Description | | --------------------- | -------- | --------------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_channel_field_group_save', $this, $this->getValues()); -### `after_channel_field_group_save($channel_field_group, $values)` +## `after_channel_field_group_save($channel_field_group, $values)` | Parameter | Type | Description | | --------------------- | -------- | --------------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_channel_field_group_save', $this, $this->getValues()); -### `before_channel_field_group_delete($channel_field_group, $values)` +## `before_channel_field_group_delete($channel_field_group, $values)` | Parameter | Type | Description | | --------------------- | -------- | --------------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_channel_field_group_delete', $this, $this->getValues()); -### `after_channel_field_group_delete($channel_field_group, $values)` +## `after_channel_field_group_delete($channel_field_group, $values)` | Parameter | Type | Description | | --------------------- | -------- | --------------------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_channel_field_group_delete', $this, $this->getValues()); -### `before_channel_field_group_bulk_delete($delete_ids)` +## `before_channel_field_group_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_channel_field_group_bulk_delete($delete_ids)` +## `after_channel_field_group_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/channel-field.md b/docs/development/extension-hooks/model/channel-field.md index 1782e3f29..df43907a5 100755 --- a/docs/development/extension-hooks/model/channel-field.md +++ b/docs/development/extension-hooks/model/channel-field.md @@ -13,9 +13,9 @@ lang: php # ChannelField Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_channel_field_insert($channel_field, $values)` +## `before_channel_field_insert($channel_field, $values)` | Parameter | Type | Description | | --------------- | -------- | ---------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_channel_field_insert', $this, $this->getValues()); -### `after_channel_field_insert($channel_field, $values)` +## `after_channel_field_insert($channel_field, $values)` | Parameter | Type | Description | | --------------- | -------- | ---------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_channel_field_insert', $this, $this->getValues()); -### `before_channel_field_update($channel_field, $values, $modified)` +## `before_channel_field_update($channel_field, $values, $modified)` | Parameter | Type | Description | | --------------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_channel_field_update', $this, $this->getValues(), $modified); -### `after_channel_field_update($channel_field, $values, $modified)` +## `after_channel_field_update($channel_field, $values, $modified)` | Parameter | Type | Description | | --------------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_channel_field_update', $this, $this->getValues(), $modified); -### `before_channel_field_save($channel_field, $values)` +## `before_channel_field_save($channel_field, $values)` | Parameter | Type | Description | | --------------- | -------- | ---------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_channel_field_save', $this, $this->getValues()); -### `after_channel_field_save($channel_field, $values)` +## `after_channel_field_save($channel_field, $values)` | Parameter | Type | Description | | --------------- | -------- | ---------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_channel_field_save', $this, $this->getValues()); -### `before_channel_field_delete($channel_field, $values)` +## `before_channel_field_delete($channel_field, $values)` | Parameter | Type | Description | | --------------- | -------- | ---------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_channel_field_delete', $this, $this->getValues()); -### `after_channel_field_delete($channel_field, $values)` +## `after_channel_field_delete($channel_field, $values)` | Parameter | Type | Description | | --------------- | -------- | ---------------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_channel_field_delete', $this, $this->getValues()); -### `before_channel_field_bulk_delete($delete_ids)` +## `before_channel_field_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_channel_field_bulk_delete($delete_ids)` +## `after_channel_field_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/channel-form-settings.md b/docs/development/extension-hooks/model/channel-form-settings.md index 466301040..3ee9d7aad 100644 --- a/docs/development/extension-hooks/model/channel-form-settings.md +++ b/docs/development/extension-hooks/model/channel-form-settings.md @@ -13,9 +13,9 @@ lang: php # ChannelFormSettings Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_channel_form_settings_insert($channel, $values)` +## `before_channel_form_settings_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------------| @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_channel_form_settings_insert', $this, $this->getValues()); -### `after_channel_form_settings_insert($channel, $values)` +## `after_channel_form_settings_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------------| @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_channel_form_settings_insert', $this, $this->getValues()); -### `before_channel_form_settings_update($channel, $values, $modified)` +## `before_channel_form_settings_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ----------------------------------------------------- | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_channel_form_settings_update', $this, $this->getValues(), $modified); -### `after_channel_form_settings_update($channel, $values, $modified)` +## `after_channel_form_settings_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ----------------------------------------------------- | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_channel_form_settings_update', $this, $this->getValues(), $modified); -### `before_channel_form_settings_save($channel, $values)` +## `before_channel_form_settings_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_channel_form_settings_save', $this, $this->getValues()); -### `after_channel_form_settings_save($channel, $values)` +## `after_channel_form_settings_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_channel_form_settings_save', $this, $this->getValues()); -### `before_channel_form_settings_delete($channel, $values)` +## `before_channel_form_settings_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_channel_form_settings_delete', $this, $this->getValues()); -### `after_channel_form_settings_delete($channel, $values)` +## `after_channel_form_settings_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------- | diff --git a/docs/development/extension-hooks/model/channel-layout.md b/docs/development/extension-hooks/model/channel-layout.md index 30c23e944..d45684034 100644 --- a/docs/development/extension-hooks/model/channel-layout.md +++ b/docs/development/extension-hooks/model/channel-layout.md @@ -13,9 +13,9 @@ lang: php # ChannelLayout Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_channel_layout_insert($channel, $values)` +## `before_channel_layout_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------| @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_channel_layout_insert', $this, $this->getValues()); -### `after_channel_layout_insert($channel, $values)` +## `after_channel_layout_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------| @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_channel_layout_insert', $this, $this->getValues()); -### `before_channel_layout_update($channel, $values, $modified)` +## `before_channel_layout_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_channel_layout_update', $this, $this->getValues(), $modified); -### `after_channel_layout_update($channel, $values, $modified)` +## `after_channel_layout_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_channel_layout_update', $this, $this->getValues(), $modified); -### `before_channel_layout_save($channel, $values)` +## `before_channel_layout_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------| @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_channel_layout_save', $this, $this->getValues()); -### `after_channel_layout_save($channel, $values)` +## `after_channel_layout_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------| @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_channel_layout_save', $this, $this->getValues()); -### `before_channel_layout_delete($channel, $values)` +## `before_channel_layout_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------| @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_channel_layout_delete', $this, $this->getValues()); -### `after_channel_layout_delete($channel, $values)` +## `after_channel_layout_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------| diff --git a/docs/development/extension-hooks/model/channel.md b/docs/development/extension-hooks/model/channel.md index 450388905..ec6eefcdc 100644 --- a/docs/development/extension-hooks/model/channel.md +++ b/docs/development/extension-hooks/model/channel.md @@ -13,9 +13,9 @@ lang: php # Channel Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_channel_insert($channel, $values)` +## `before_channel_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_channel_insert', $this, $this->getValues()); -### `after_channel_insert($channel, $values)` +## `after_channel_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_channel_insert', $this, $this->getValues()); -### `before_channel_update($channel, $values, $modified)` +## `before_channel_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_channel_update', $this, $this->getValues(), $modified); -### `after_channel_update($channel, $values, $modified)` +## `after_channel_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_channel_update', $this, $this->getValues(), $modified); -### `before_channel_save($channel, $values)` +## `before_channel_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_channel_save', $this, $this->getValues()); -### `after_channel_save($channel, $values)` +## `after_channel_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_channel_save', $this, $this->getValues()); -### `before_channel_delete($channel, $values)` +## `before_channel_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_channel_delete', $this, $this->getValues()); -### `after_channel_delete($channel, $values)` +## `after_channel_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | diff --git a/docs/development/extension-hooks/model/comment.md b/docs/development/extension-hooks/model/comment.md index b6b9cccc6..dd52cc7b1 100755 --- a/docs/development/extension-hooks/model/comment.md +++ b/docs/development/extension-hooks/model/comment.md @@ -13,7 +13,9 @@ lang: php # Comment Model Extension Hooks -### `before_comment_insert($comment, $values)` +[TOC=2] + +## `before_comment_insert($comment, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------- | @@ -27,7 +29,7 @@ How it's called: ee()->extensions->call('before_comment_insert', $this, $this->getValues()); -### `after_comment_insert($comment, $values)` +## `after_comment_insert($comment, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------- | @@ -41,7 +43,7 @@ How it's called: ee()->extensions->call('after_comment_insert', $this, $this->getValues()); -### `before_comment_update($comment, $values, $modified)` +## `before_comment_update($comment, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -56,7 +58,7 @@ How it's called: ee()->extensions->call('before_comment_update', $this, $this->getValues(), $modified); -### `after_comment_update($comment, $values, $modified)` +## `after_comment_update($comment, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -71,7 +73,7 @@ How it's called: ee()->extensions->call('after_comment_update', $this, $this->getValues(), $modified); -### `before_comment_save($comment, $values)` +## `before_comment_save($comment, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------- | @@ -85,7 +87,7 @@ How it's called: ee()->extensions->call('before_comment_save', $this, $this->getValues()); -### `after_comment_save($comment, $values)` +## `after_comment_save($comment, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------- | @@ -99,7 +101,7 @@ How it's called: ee()->extensions->call('after_comment_save', $this, $this->getValues()); -### `before_comment_delete($comment, $values)` +## `before_comment_delete($comment, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------- | @@ -113,7 +115,7 @@ How it's called: ee()->extensions->call('before_comment_delete', $this, $this->getValues()); -### `after_comment_delete($comment, $values)` +## `after_comment_delete($comment, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------- | @@ -127,7 +129,7 @@ How it's called: ee()->extensions->call('after_comment_delete', $this, $this->getValues()); -### `before_comment_bulk_delete($delete_ids)` +## `before_comment_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -142,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_comment_bulk_delete($delete_ids)` +## `after_comment_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/file.md b/docs/development/extension-hooks/model/file.md index 8928dfe7a..95c071bab 100755 --- a/docs/development/extension-hooks/model/file.md +++ b/docs/development/extension-hooks/model/file.md @@ -13,9 +13,9 @@ lang: php # File Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_file_insert($file, $values)` +## `before_file_insert($file, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_file_insert', $this, $this->getValues()); -### `after_file_insert($file, $values)` +## `after_file_insert($file, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_file_insert', $this, $this->getValues()); -### `before_file_update($file, $values, $modified)` +## `before_file_update($file, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_file_update', $this, $this->getValues(), $modified); -### `after_file_update($file, $values, $modified)` +## `after_file_update($file, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_file_update', $this, $this->getValues(), $modified); -### `before_file_save($file, $values)` +## `before_file_save($file, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_file_save', $this, $this->getValues()); -### `after_file_save($file, $values)` +## `after_file_save($file, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_file_save', $this, $this->getValues()); -### `before_file_delete($file, $values)` +## `before_file_delete($file, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_file_delete', $this, $this->getValues()); -### `after_file_delete($file, $values)` +## `after_file_delete($file, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_file_delete', $this, $this->getValues()); -### `before_file_bulk_delete($delete_ids)` +## `before_file_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_file_bulk_delete($delete_ids)` +## `after_file_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/fluid-field.md b/docs/development/extension-hooks/model/fluid-field.md index 315274ff7..29195f7be 100644 --- a/docs/development/extension-hooks/model/fluid-field.md +++ b/docs/development/extension-hooks/model/fluid-field.md @@ -13,9 +13,9 @@ lang: php # FluidField Model Extension Hooks -[TOC=3] +[TOC=2] -### `fluid_field_get_all_data($data, $fluid_field_id)` +## `fluid_field_get_all_data($data, $fluid_field_id)` | Parameter | Type | Description | | ---------------- | ------------ | ----------------------------------------------------------------------- | @@ -31,7 +31,7 @@ How it's called: TIP: **New in version 6.1.0.** -### `fluid_field_add_field($field_table_name, $values)` +## `fluid_field_add_field($field_table_name, $values)` | Parameter | Type | Description | | ------------------ | ------------ | ----------------------------- | @@ -47,7 +47,7 @@ How it's called: TIP: **New in version 6.1.0.** -### `fluid_field_update_field($fluid_field, $field_table_name, $values)` +## `fluid_field_update_field($fluid_field, $field_table_name, $values)` | Parameter | Type | Description | | ------------------ | ------------ | ----------------------------------------------------------------------- | @@ -64,7 +64,7 @@ How it's called: TIP: **New in version 6.1.0.** -### `fluid_field_remove_field($fluid_field)` +## `fluid_field_remove_field($fluid_field)` | Parameter | Type | Description | | ------------------ | ------------ | ----------------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/model/member-field.md b/docs/development/extension-hooks/model/member-field.md index 47fdcd141..935e5ab05 100755 --- a/docs/development/extension-hooks/model/member-field.md +++ b/docs/development/extension-hooks/model/member-field.md @@ -13,9 +13,9 @@ lang: php # MemberField Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_member_field_insert($member_field, $values)` +## `before_member_field_insert($member_field, $values)` | Parameter | Type | Description | | -------------- | -------- | --------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_member_field_insert', $this, $this->getValues()); -### `after_member_field_insert($member_field, $values)` +## `after_member_field_insert($member_field, $values)` | Parameter | Type | Description | | -------------- | -------- | --------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_member_field_insert', $this, $this->getValues()); -### `before_member_field_update($member_field, $values, $modified)` +## `before_member_field_update($member_field, $values, $modified)` | Parameter | Type | Description | | -------------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_member_field_update', $this, $this->getValues(), $modified); -### `after_member_field_update($member_field, $values, $modified)` +## `after_member_field_update($member_field, $values, $modified)` | Parameter | Type | Description | | -------------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_member_field_update', $this, $this->getValues(), $modified); -### `before_member_field_save($member_field, $values)` +## `before_member_field_save($member_field, $values)` | Parameter | Type | Description | | -------------- | -------- | --------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_member_field_save', $this, $this->getValues()); -### `after_member_field_save($member_field, $values)` +## `after_member_field_save($member_field, $values)` | Parameter | Type | Description | | -------------- | -------- | --------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_member_field_save', $this, $this->getValues()); -### `before_member_field_delete($member_field, $values)` +## `before_member_field_delete($member_field, $values)` | Parameter | Type | Description | | -------------- | -------- | --------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_member_field_delete', $this, $this->getValues()); -### `after_member_field_delete($member_field, $values)` +## `after_member_field_delete($member_field, $values)` | Parameter | Type | Description | | -------------- | -------- | --------------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_member_field_delete', $this, $this->getValues()); -### `before_member_field_bulk_delete($delete_ids)` +## `before_member_field_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_member_field_bulk_delete($delete_ids)` +## `after_member_field_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/member.md b/docs/development/extension-hooks/model/member.md index 5f2124619..82830a8bb 100755 --- a/docs/development/extension-hooks/model/member.md +++ b/docs/development/extension-hooks/model/member.md @@ -13,9 +13,9 @@ lang: php # Member Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_member_insert($member, $values)` +## `before_member_insert($member, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_member_insert', $this, $this->getValues()); -### `after_member_insert($member, $values)` +## `after_member_insert($member, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_member_insert', $this, $this->getValues()); -### `before_member_update($member, $values, $modified)` +## `before_member_update($member, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_member_update', $this, $this->getValues(), $modified); -### `after_member_update($member, $values, $modified)` +## `after_member_update($member, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_member_update', $this, $this->getValues(), $modified); -### `before_member_save($member, $values)` +## `before_member_save($member, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_member_save', $this, $this->getValues()); -### `after_member_save($member, $values)` +## `after_member_save($member, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_member_save', $this, $this->getValues()); -### `before_member_delete($member, $values)` +## `before_member_delete($member, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_member_delete', $this, $this->getValues()); -### `after_member_delete($member, $values)` +## `after_member_delete($member, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_member_delete', $this, $this->getValues()); -### `before_member_bulk_delete($delete_ids)` +## `before_member_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_member_bulk_delete($delete_ids)` +## `after_member_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -159,7 +159,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `member_anonymize($member)` +## `member_anonymize($member)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------ | diff --git a/docs/development/extension-hooks/model/role.md b/docs/development/extension-hooks/model/role.md index c173a81c3..9f67030c6 100755 --- a/docs/development/extension-hooks/model/role.md +++ b/docs/development/extension-hooks/model/role.md @@ -13,9 +13,9 @@ lang: php # Role Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_role_insert($role, $values)` +## `before_role_insert($role, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_role_insert', $this, $this->getValues()); -### `after_role_insert($role, $values)` +## `after_role_insert($role, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_role_insert', $this, $this->getValues()); -### `before_role_update($role, $values, $modified)` +## `before_role_update($role, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_role_update', $this, $this->getValues(), $modified); -### `after_role_update($role, $values, $modified)` +## `after_role_update($role, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_role_update', $this, $this->getValues(), $modified); -### `before_role_save($role, $values)` +## `before_role_save($role, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_role_save', $this, $this->getValues()); -### `after_role_save($role, $values)` +## `after_role_save($role, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_role_save', $this, $this->getValues()); -### `before_role_delete($role, $values)` +## `before_role_delete($role, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_role_delete', $this, $this->getValues()); -### `after_role_delete($role, $values)` +## `after_role_delete($role, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_role_delete', $this, $this->getValues()); -### `before_role_bulk_delete($delete_ids)` +## `before_role_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -143,7 +143,7 @@ How it's called: ee()->extensions->call('before_role_bulk_delete', $delete_ids); -### `after_role_bulk_delete($delete_ids)` +## `after_role_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/site.md b/docs/development/extension-hooks/model/site.md index 214d3bf17..bc63f8e2b 100644 --- a/docs/development/extension-hooks/model/site.md +++ b/docs/development/extension-hooks/model/site.md @@ -13,9 +13,9 @@ lang: php # Site Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_site_insert($channel, $values)` +## `before_site_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------| @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_site_insert', $this, $this->getValues()); -### `after_site_insert($channel, $values)` +## `after_site_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------| @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_site_insert', $this, $this->getValues()); -### `before_site_update($channel, $values, $modified)` +## `before_site_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_site_update', $this, $this->getValues(), $modified); -### `after_site_update($channel, $values, $modified)` +## `after_site_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_site_update', $this, $this->getValues(), $modified); -### `before_site_save($channel, $values)` +## `before_site_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------| @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_site_save', $this, $this->getValues()); -### `after_site_save($channel, $values)` +## `after_site_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------| @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_site_save', $this, $this->getValues()); -### `before_site_delete($channel, $values)` +## `before_site_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------| @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_site_delete', $this, $this->getValues()); -### `after_site_delete($channel, $values)` +## `after_site_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------| diff --git a/docs/development/extension-hooks/model/status.md b/docs/development/extension-hooks/model/status.md index b637b7975..6c25de5b6 100644 --- a/docs/development/extension-hooks/model/status.md +++ b/docs/development/extension-hooks/model/status.md @@ -13,9 +13,9 @@ lang: php # Status Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_status_insert($channel, $values)` +## `before_status_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -----------------------------------------| @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_status_insert', $this, $this->getValues()); -### `after_status_insert($channel, $values)` +## `after_status_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -----------------------------------------| @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_status_insert', $this, $this->getValues()); -### `before_status_update($channel, $values, $modified)` +## `before_status_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_status_update', $this, $this->getValues(), $modified); -### `after_status_update($channel, $values, $modified)` +## `after_status_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_status_update', $this, $this->getValues(), $modified); -### `before_status_save($channel, $values)` +## `before_status_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -----------------------------------------| @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_status_save', $this, $this->getValues()); -### `after_status_save($channel, $values)` +## `after_status_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -----------------------------------------| @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_status_save', $this, $this->getValues()); -### `before_status_delete($channel, $values)` +## `before_status_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -----------------------------------------| @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_status_delete', $this, $this->getValues()); -### `after_status_delete($channel, $values)` +## `after_status_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -----------------------------------------| diff --git a/docs/development/extension-hooks/model/template-global-variable.md b/docs/development/extension-hooks/model/template-global-variable.md index f0cf3be6b..a32b9af97 100644 --- a/docs/development/extension-hooks/model/template-global-variable.md +++ b/docs/development/extension-hooks/model/template-global-variable.md @@ -13,9 +13,9 @@ lang: php # GlobalVariable Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_global_variable_insert($channel, $values)` +## `before_global_variable_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------| @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_global_variable_insert', $this, $this->getValues()); -### `after_global_variable_insert($channel, $values)` +## `after_global_variable_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------| @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_global_variable_insert', $this, $this->getValues()); -### `before_global_variable_update($channel, $values, $modified)` +## `before_global_variable_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_global_variable_update', $this, $this->getValues(), $modified); -### `after_global_variable_update($channel, $values, $modified)` +## `after_global_variable_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_global_variable_update', $this, $this->getValues(), $modified); -### `before_global_variable_save($channel, $values)` +## `before_global_variable_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------| @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_global_variable_save', $this, $this->getValues()); -### `after_global_variable_save($channel, $values)` +## `after_global_variable_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------| @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_global_variable_save', $this, $this->getValues()); -### `before_global_variable_delete($channel, $values)` +## `before_global_variable_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------| @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_global_variable_delete', $this, $this->getValues()); -### `after_global_variable_delete($channel, $values)` +## `after_global_variable_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------| diff --git a/docs/development/extension-hooks/model/template-group.md b/docs/development/extension-hooks/model/template-group.md index ff0b99e99..6cc8a362d 100755 --- a/docs/development/extension-hooks/model/template-group.md +++ b/docs/development/extension-hooks/model/template-group.md @@ -13,9 +13,9 @@ lang: php # TemplateGroup Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_template_group_insert($template_group, $values)` +## `before_template_group_insert($template_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_template_group_insert', $this, $this->getValues()); -### `after_template_group_insert($template_group, $values)` +## `after_template_group_insert($template_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_template_group_insert', $this, $this->getValues()); -### `before_template_group_update($template_group, $values, $modified)` +## `before_template_group_update($template_group, $values, $modified)` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_template_group_update', $this, $this->getValues(), $modified); -### `after_template_group_update($template_group, $values, $modified)` +## `after_template_group_update($template_group, $values, $modified)` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_template_group_update', $this, $this->getValues(), $modified); -### `before_template_group_save($template_group, $values)` +## `before_template_group_save($template_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_template_group_save', $this, $this->getValues()); -### `after_template_group_save($template_group, $values)` +## `after_template_group_save($template_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_template_group_save', $this, $this->getValues()); -### `before_template_group_delete($template_group, $values)` +## `before_template_group_delete($template_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_template_group_delete', $this, $this->getValues()); -### `after_template_group_delete($template_group, $values)` +## `after_template_group_delete($template_group, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_template_group_delete', $this, $this->getValues()); -### `before_template_group_bulk_delete($delete_ids)` +## `before_template_group_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_template_group_bulk_delete($delete_ids)` +## `after_template_group_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/template-route.md b/docs/development/extension-hooks/model/template-route.md index 5a2268580..3699cafa7 100755 --- a/docs/development/extension-hooks/model/template-route.md +++ b/docs/development/extension-hooks/model/template-route.md @@ -13,9 +13,9 @@ lang: php # TemplateRoute Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_template_route_insert($template_route, $values)` +## `before_template_route_insert($template_route, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_template_route_insert', $this, $this->getValues()); -### `after_template_route_insert($template_route, $values)` +## `after_template_route_insert($template_route, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_template_route_insert', $this, $this->getValues()); -### `before_template_route_update($template_route, $values, $modified)` +## `before_template_route_update($template_route, $values, $modified)` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_template_route_update', $this, $this->getValues(), $modified); -### `after_template_route_update($template_route, $values, $modified)` +## `after_template_route_update($template_route, $values, $modified)` | Parameter | Type | Description | | ---------------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_template_route_update', $this, $this->getValues(), $modified); -### `before_template_route_save($template_route, $values)` +## `before_template_route_save($template_route, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_template_route_save', $this, $this->getValues()); -### `after_template_route_save($template_route, $values)` +## `after_template_route_save($template_route, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_template_route_save', $this, $this->getValues()); -### `before_template_route_delete($template_route, $values)` +## `before_template_route_delete($template_route, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_template_route_delete', $this, $this->getValues()); -### `after_template_route_delete($template_route, $values)` +## `after_template_route_delete($template_route, $values)` | Parameter | Type | Description | | ---------------- | -------- | ----------------------------------------------- | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_template_route_delete', $this, $this->getValues()); -### `before_template_route_bulk_delete($delete_ids)` +## `before_template_route_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_template_route_bulk_delete($delete_ids)` +## `after_template_route_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/model/template-snippet.md b/docs/development/extension-hooks/model/template-snippet.md index 2684b7db3..b0eb7c5e0 100644 --- a/docs/development/extension-hooks/model/template-snippet.md +++ b/docs/development/extension-hooks/model/template-snippet.md @@ -13,9 +13,9 @@ lang: php # Snippet Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_template_snippet_insert($channel, $values)` +## `before_template_snippet_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------| @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_template_snippet_insert', $this, $this->getValues()); -### `after_template_snippet_insert($channel, $values)` +## `after_template_snippet_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------| @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_template_snippet_insert', $this, $this->getValues()); -### `before_template_snippet_update($channel, $values, $modified)` +## `before_template_snippet_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_template_snippet_update', $this, $this->getValues(), $modified); -### `after_template_snippet_update($channel, $values, $modified)` +## `after_template_snippet_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | -------------------------------------------------| @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_template_snippet_update', $this, $this->getValues(), $modified); -### `before_template_snippet_save($channel, $values)` +## `before_template_snippet_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------| @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_template_snippet_save', $this, $this->getValues()); -### `after_template_snippet_save($channel, $values)` +## `after_template_snippet_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------| @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_template_snippet_save', $this, $this->getValues()); -### `before_template_snippet_delete($channel, $values)` +## `before_template_snippet_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------| @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_template_snippet_delete', $this, $this->getValues()); -### `after_template_snippet_delete($channel, $values)` +## `after_template_snippet_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------| diff --git a/docs/development/extension-hooks/model/template-specialty-template.md b/docs/development/extension-hooks/model/template-specialty-template.md index b76dc48f0..97ab74d7f 100644 --- a/docs/development/extension-hooks/model/template-specialty-template.md +++ b/docs/development/extension-hooks/model/template-specialty-template.md @@ -13,9 +13,9 @@ lang: php # SpecialtyTemplate Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_specialty_template_insert($channel, $values)` +## `before_specialty_template_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------| @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_specialty_template_insert', $this, $this->getValues()); -### `after_specialty_template_insert($channel, $values)` +## `after_specialty_template_insert($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------| @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_specialty_template_insert', $this, $this->getValues()); -### `before_specialty_template_update($channel, $values, $modified)` +## `before_specialty_template_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ----------------------------------------------------| @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_specialty_template_update', $this, $this->getValues(), $modified); -### `after_specialty_template_update($channel, $values, $modified)` +## `after_specialty_template_update($channel, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ----------------------------------------------------| @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_specialty_template_update', $this, $this->getValues(), $modified); -### `before_specialty_template_save($channel, $values)` +## `before_specialty_template_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------| @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_specialty_template_save', $this, $this->getValues()); -### `after_specialty_template_save($channel, $values)` +## `after_specialty_template_save($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------| @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_specialty_template_save', $this, $this->getValues()); -### `before_specialty_template_delete($channel, $values)` +## `before_specialty_template_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------| @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_specialty_template_delete', $this, $this->getValues()); -### `after_specialty_template_delete($channel, $values)` +## `after_specialty_template_delete($channel, $values)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------------| diff --git a/docs/development/extension-hooks/model/template.md b/docs/development/extension-hooks/model/template.md index cade99cfc..84d798a1a 100755 --- a/docs/development/extension-hooks/model/template.md +++ b/docs/development/extension-hooks/model/template.md @@ -13,9 +13,9 @@ lang: php # Template Model Extension Hooks -[TOC=3] +[TOC=2] -### `before_template_insert($template, $values)` +## `before_template_insert($template, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('before_template_insert', $this, $this->getValues()); -### `after_template_insert($template, $values)` +## `after_template_insert($template, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('after_template_insert', $this, $this->getValues()); -### `before_template_update($template, $values, $modified)` +## `before_template_update($template, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -58,7 +58,7 @@ How it's called: ee()->extensions->call('before_template_update', $this, $this->getValues(), $modified); -### `after_template_update($template, $values, $modified)` +## `after_template_update($template, $values, $modified)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------ | @@ -73,7 +73,7 @@ How it's called: ee()->extensions->call('after_template_update', $this, $this->getValues(), $modified); -### `before_template_save($template, $values)` +## `before_template_save($template, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -87,7 +87,7 @@ How it's called: ee()->extensions->call('before_template_save', $this, $this->getValues()); -### `after_template_save($template, $values)` +## `after_template_save($template, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -101,7 +101,7 @@ How it's called: ee()->extensions->call('after_template_save', $this, $this->getValues()); -### `before_template_delete($template, $values)` +## `before_template_delete($template, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -115,7 +115,7 @@ How it's called: ee()->extensions->call('before_template_delete', $this, $this->getValues()); -### `after_template_delete($template, $values)` +## `after_template_delete($template, $values)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------ | @@ -129,7 +129,7 @@ How it's called: ee()->extensions->call('after_template_delete', $this, $this->getValues()); -### `before_template_bulk_delete($delete_ids)` +## `before_template_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | @@ -144,7 +144,7 @@ How it's called: TIP: **New in version 4.3.0.** -### `after_template_bulk_delete($delete_ids)` +## `after_template_bulk_delete($delete_ids)` | Parameter | Type | Description | | ------------ | ------- | ----------------------------------------------- | diff --git a/docs/development/extension-hooks/module/channel-form.md b/docs/development/extension-hooks/module/channel-form.md index 992d5a16c..0835aa299 100755 --- a/docs/development/extension-hooks/module/channel-form.md +++ b/docs/development/extension-hooks/module/channel-form.md @@ -13,9 +13,9 @@ lang: php # Channel Form Extension Hooks -[TOC=3] +[TOC=2] -### `channel_form_entry_form_absolute_start($channel_form_obj)` +## `channel_form_entry_form_absolute_start($channel_form_obj)` | Parameter | Type | Description | | ------------------ | -------- | -------------------------- | @@ -27,7 +27,7 @@ How it's called: ee()->extensions->call('channel_form_entry_form_absolute_start', $this); if (ee()->extensions->end_script === TRUE) return; -### `channel_form_entry_form_tagdata_start($tagdata, $channel_form_obj)` +## `channel_form_entry_form_tagdata_start($tagdata, $channel_form_obj)` | Parameter | Type | Description | | ------------------ | -------- | -------------------------- | @@ -40,7 +40,7 @@ How it's called: ee()->TMPL->tagdata = ee()->extensions->call('channel_form_entry_form_tagdata_start', ee()->TMPL->tagdata, $this); if (ee()->extensions->end_script === TRUE) return; -### `channel_form_entry_form_tagdata_end($return_tagdata, $channel_form_obj)` +## `channel_form_entry_form_tagdata_end($return_tagdata, $channel_form_obj)` | Parameter | Type | Description | | ------------------ | -------- | -------------------------------- | @@ -53,7 +53,7 @@ How it's called: $return = ee()->extensions->call('channel_form_entry_form_tagdata_end', $return, $this); if (ee()->extensions->end_script === TRUE) return; -### `channel_form_submit_entry_start($channel_form_obj)` +## `channel_form_submit_entry_start($channel_form_obj)` | Parameter | Type | Description | | ------------------ | -------- | -------------------------- | @@ -64,7 +64,7 @@ How it's called: ee()->extensions->call('channel_form_submit_entry_start', $this); if (ee()->extensions->end_script === TRUE) return; -### `channel_form_submit_entry_end($channel_form_obj)` +## `channel_form_submit_entry_end($channel_form_obj)` | Parameter | Type | Description | | ------------------ | -------- | -------------------------- | diff --git a/docs/development/extension-hooks/module/channel.md b/docs/development/extension-hooks/module/channel.md index c71651b13..1395e208e 100755 --- a/docs/development/extension-hooks/module/channel.md +++ b/docs/development/extension-hooks/module/channel.md @@ -13,9 +13,9 @@ lang: php # Channel Module Extension Hooks -[TOC=3] +[TOC=2] -### `channel_entries_query_result($this, $query_result)` +## `channel_entries_query_result($this, $query_result)` | Parameter | Type | Description | | -------------- | -------- | ---------------------------------- | @@ -30,7 +30,7 @@ How it's called: $query_result = $this->extensions->call('channel_entries_query_result', $this, $query_result); if ($this->extensions->end_script === TRUE) return $this->TMPL->tagdata; -### `channel_entries_tagdata($tagdata, $row, $this)` +## `channel_entries_tagdata($tagdata, $row, $this)` | Parameter | Type | Description | | --------- | -------- | ----------------------- | @@ -46,7 +46,7 @@ How it's called: $tagdata = $this->extensions->call('channel_entries_tagdata', $tagdata, $row, $this); if ($this->extensions->end_script === TRUE) return $tagdata; -### `channel_entries_row($this, $row)` +## `channel_entries_row($this, $row)` | Parameter | Type | Description | | --------- | -------- | ---------------------- | @@ -61,7 +61,7 @@ How it's called: $row = $this->extensions->call('channel_entries_row', $this, $row); if ($this->extensions->end_script === TRUE) return $tagdata; -### `channel_entries_tagdata_end($tagdata, $row, $this)` +## `channel_entries_tagdata_end($tagdata, $row, $this)` | Parameter | Type | Description | | --------- | -------- | ----------------------- | @@ -77,7 +77,7 @@ How it's called: $tagdata = $this->extensions->call('channel_entries_tagdata_end', $tagdata, $row, $this); if ($this->extensions->end_script === TRUE) return $tagdata; -### `channel_module_calendar_start()` +## `channel_module_calendar_start()` | Parameter | Type | Description | | --------- | -------- | ---------------------- | @@ -90,7 +90,7 @@ How it's called: $edata = $this->extensions->call('channel_module_calendar_start'); if ($this->extensions->end_script === TRUE) return $edata; -### `channel_module_categories_start()` +## `channel_module_categories_start()` | Parameter | Type | Description | | --------- | -------- | ------------------------- | @@ -102,7 +102,7 @@ How it's called: return $this->extensions->call('channel_module_categories_start'); -### `channel_module_category_heading_start()` +## `channel_module_category_heading_start()` | Parameter | Type | Description | | --------- | -------- | --------------------------------- | diff --git a/docs/development/extension-hooks/module/comment.md b/docs/development/extension-hooks/module/comment.md index dca6bd0fd..7c0b0befa 100755 --- a/docs/development/extension-hooks/module/comment.md +++ b/docs/development/extension-hooks/module/comment.md @@ -17,7 +17,7 @@ lang: php ## Control Panel Hooks (mcp.comment.php) -### `delete_comment_additional($comment_ids)` +## `delete_comment_additional($comment_ids)` | Parameter | Type | Description | | ------------- | ------- | ------------------------- | @@ -31,7 +31,7 @@ How it's called: ee()->extensions->call('delete_comment_additional', $comment_ids); if (ee()->extensions->end_script === TRUE) return; -### `update_comment_additional($comment_id, $data)` +## `update_comment_additional($comment_id, $data)` | Parameter | Type | Description | | ------------ | ------- | -------------------------------- | @@ -48,7 +48,7 @@ How it's called: ## Frontend Comment Hooks (mod.comment.php) -### `comment_entries_query_result($results)` +## `comment_entries_query_result($results)` | Parameter | Type | Description | | --------- | ------- | --------------------- | @@ -62,7 +62,7 @@ How it's called: $results = ee()->extensions->call('comment_entries_query_result', $results); if (ee()->extensions->end_script === TRUE) return ee()->TMPL->tagdata; -### `comment_entries_comment_ids_query($db)` +## `comment_entries_comment_ids_query($db)` | Parameter | Type | Description | | ----------- | ---------- | ------------------------------------------------ | @@ -76,7 +76,7 @@ How it's called: ee()->extensions->call('comment_entries_comment_ids_query', ee()->db); if (ee()->extensions->end_script === TRUE) return ee()->TMPL->tagdata; -### `comment_entries_comment_format($row)` +## `comment_entries_comment_format($row)` | Parameter | Type | Description | | --------- | -------- | ------------------------ | @@ -90,7 +90,7 @@ How it's called: $comment = ee()->extensions->call('comment_entries_comment_format', $row); if (ee()->extensions->end_script === TRUE) return; -### `comment_entries_tagdata($tagdata, $row)` +## `comment_entries_tagdata($tagdata, $row)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------- | @@ -105,7 +105,7 @@ How it's called: $tagdata = ee()->extensions->call('comment_entries_tagdata', $tagdata, $row); if (ee()->extensions->end_script === TRUE) return $tagdata; -### `comment_form_end($res)` +## `comment_form_end($res)` | Parameter | Type | Description | | --------- | -------- | ------------------------- | @@ -119,7 +119,7 @@ How it's called: $res = ee()->extensions->call('comment_form_end', $res); if (ee()->extensions->end_script === TRUE) return $res; -### `comment_form_hidden_fields($hidden_fields)` +## `comment_form_hidden_fields($hidden_fields)` | Parameter | Type | Description | | --------------- | ------- | ------------------------------------------ | @@ -133,7 +133,7 @@ How it's called: $hidden_fields = ee()->extensions->call('comment_form_hidden_fields', $hidden_fields); if (ee()->extensions->end_script === TRUE) return; -### `comment_form_tagdata($tagdata)` +## `comment_form_tagdata($tagdata)` | Parameter | Type | Description | | --------- | -------- | -------------------- | @@ -147,7 +147,7 @@ How it's called: $tagdata = ee()->extensions->call('comment_form_tagdata', $tagdata); if (ee()->extensions->end_script === TRUE) return; -### `comment_preview_comment_format($row)` +## `comment_preview_comment_format($row)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------ | @@ -161,7 +161,7 @@ How it's called: $data = ee()->extensions->call('comment_preview_comment_format', $query->row()); if (ee()->extensions->end_script === TRUE) return; -### `comment_preview_tagdata($tagdata)` +## `comment_preview_tagdata($tagdata)` | Parameter | Type | Description | | --------- | -------- | ----------------------- | @@ -175,7 +175,7 @@ How it's called: $tagdata = ee()->extensions->call('comment_preview_tagdata', $tagdata); if (ee()->extensions->end_script === TRUE) return; -### `insert_comment_start()` +## `insert_comment_start()` | Parameter | Type | | --------- | ------ | @@ -188,7 +188,7 @@ How it's called: ee()->extensions->call('insert_comment_start'); if (ee()->extensions->end_script === TRUE) return; -### `insert_comment_end($data, $comment_moderate, $comment_id)` +## `insert_comment_end($data, $comment_moderate, $comment_id)` | Parameter | Type | Description | | ------------------ | --------- | ---------------------------------------------- | @@ -204,7 +204,7 @@ How it's called: ee()->extensions->call('insert_comment_end', $data, $comment_moderate, $comment_id); if (ee()->extensions->end_script === TRUE) return; -### `insert_comment_insert_array($data)` +## `insert_comment_insert_array($data)` | Parameter | Type | Description | | --------- | ------- | ------------------------ | @@ -218,7 +218,7 @@ How it's called: $data = ee()->extensions->call('insert_comment_insert_array', $data); if (ee()->extensions->end_script === TRUE) return; -### `insert_comment_preferences_sql($sql)` +## `insert_comment_preferences_sql($sql)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------------- | diff --git a/docs/development/extension-hooks/module/email.md b/docs/development/extension-hooks/module/email.md index c0b992af4..33fd6b476 100755 --- a/docs/development/extension-hooks/module/email.md +++ b/docs/development/extension-hooks/module/email.md @@ -13,9 +13,9 @@ lang: php # Email Module Extension Hooks -[TOC=3] +[TOC=2] -### `email_module_send_email_end($subject, $message, $approved_tos, $approved_recipients)` +## `email_module_send_email_end($subject, $message, $approved_tos, $approved_recipients)` | Parameter | Type | Description | | --------------------- | -------- | -------------------------------------------------- | @@ -32,7 +32,7 @@ How it's called: ee()->extensions->call('email_module_send_email_end', $subject, $message, $approved_tos, $approved_recipients); if (ee()->extensions->end_script === TRUE) return; -### `email_module_tellafriend_override($qstring, $this)` +## `email_module_tellafriend_override($qstring, $this)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------------- | diff --git a/docs/development/extension-hooks/module/forum.md b/docs/development/extension-hooks/module/forum.md index 336f5aa2a..897d65368 100755 --- a/docs/development/extension-hooks/module/forum.md +++ b/docs/development/extension-hooks/module/forum.md @@ -13,9 +13,9 @@ lang: php # Forum Module Extension Hooks -[TOC=3] +[TOC=2] -### `forum_add_template($which, $classname)` +## `forum_add_template($which, $classname)` | Parameter | Type | Description | | ----------- | -------- | ----------------------------------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: $classname = ee()->extensions->call('forum_add_template', $which, $classname); -### `forum_include_extras($this, $function, $element)` +## `forum_include_extras($this, $function, $element)` | Parameter | Type | Description | | ---------- | -------- | ------------------------------------------------- | @@ -44,7 +44,7 @@ How it's called: $element = ee()->extensions->call('forum_include_extras', $this, $function, $element); -### `forum_submission_form_start($this, $str)` +## `forum_submission_form_start($this, $str)` | Parameter | Type | Description | | --------- | -------- | -------------------------------- | @@ -59,7 +59,7 @@ How it's called: $str = ee()->extensions->universal_call('forum_submission_form_start', $this, $str); if (ee()->extensions->end_script === TRUE) return $str; -### `forum_submission_form_end($this, $str)` +## `forum_submission_form_end($this, $str)` | Parameter | Type | Description | | --------- | -------- | ------------------------------- | @@ -74,7 +74,7 @@ How it's called: $str = ee()->extensions->universal_call('forum_submission_form_end', $this, $str); if (ee()->extensions->end_script === TRUE) return $str; -### `forum_submission_page($this, $type)` +## `forum_submission_page($this, $type)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------------- | @@ -89,7 +89,7 @@ How it's called: $edata = $this->extensions->universal_call('forum_submission_page', $this, $type); if ($this->extensions->end_script === TRUE) return $edata; -### `forum_submit_post_start($this)` +## `forum_submit_post_start($this)` | Parameter | Type | Description | | --------- | -------- | ----------------------------- | @@ -103,7 +103,7 @@ How it's called: $edata = ee()->extensions->universal_call('forum_submit_post_start', $this); if (ee()->extensions->end_script === TRUE) return $edata; -### `forum_submit_post_end($this, $data)` +## `forum_submit_post_end($this, $data)` | Parameter | Type | Description | | --------- | -------- | ----------------------------- | @@ -120,7 +120,7 @@ How it's called: NOTE: **Note:** User notifications have not been sent at this point. -### `forum_threads_template($this, $str, $tquery)` +## `forum_threads_template($this, $str, $tquery)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------------- | @@ -136,7 +136,7 @@ How it's called: $str = ee()->extensions->universal_call('forum_threads_template', $this, $str, $tquery); if (ee()->extensions->end_script === TRUE) return $str; -### `forum_thread_rows_absolute_end($this, $data, $thread_rows)` +## `forum_thread_rows_absolute_end($this, $data, $thread_rows)` | Parameter | Type | Description | | ------------- | -------- | ----------------------------------------------------------------- | @@ -152,7 +152,7 @@ How it's called: $thread_rows = ee()->extensions->universal_call('forum_thread_rows_absolute_end', $this, $data, $thread_rows); if (ee()->extensions->end_script === TRUE) return $thread_rows; -### `forum_thread_rows_loop_start($this, $data, $row, $temp)` +## `forum_thread_rows_loop_start($this, $data, $row, $temp)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------- | @@ -169,7 +169,7 @@ How it's called: $temp = ee()->extensions->universal_call('forum_thread_rows_loop_start', $this, $data, $row, $temp); if (ee()->extensions->end_script === TRUE) return; -### `forum_thread_rows_loop_end($this, $data, $row, $temp)` +## `forum_thread_rows_loop_end($this, $data, $row, $temp)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------- | @@ -186,7 +186,7 @@ How it's called: $temp = ee()->extensions->universal_call('forum_thread_rows_loop_end', $this, $data, $row, $temp); if (ee()->extensions->end_script === TRUE) return; -### `forum_thread_rows_start($this, $template, $data, $is_announcement, $thread_review)` +## `forum_thread_rows_start($this, $template, $data, $is_announcement, $thread_review)` | Parameter | Type | Description | | ----------------- | --------- | ------------------------------------------- | @@ -204,7 +204,7 @@ How it's called: $template = ee()->extensions->universal_call('forum_thread_rows_start', $this, $template, $data, $is_announcement, $thread_review); if (ee()->extensions->end_script === TRUE) return $template; -### `forum_topics_absolute_end($this, $result, $str)` +## `forum_topics_absolute_end($this, $result, $str)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------ | @@ -220,7 +220,7 @@ How it's called: $str = ee()->extensions->universal_call('forum_topics_absolute_end', $this, $query->result(), $str); if (ee()->extensions->end_script === TRUE) return $str; -### `forum_topics_loop_start($this, $result, $row, $temp)` +## `forum_topics_loop_start($this, $result, $row, $temp)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------- | @@ -237,7 +237,7 @@ How it's called: $temp = ee()->extensions->universal_call('forum_topics_loop_start', $this, $query->result(), $row, $temp); if (ee()->extensions->end_script === TRUE) return; -### `forum_topics_loop_end($this, $result, $row, $temp)` +## `forum_topics_loop_end($this, $result, $row, $temp)` | Parameter | Type | Description | | --------- | -------- | -------------------------------- | @@ -254,7 +254,7 @@ How it's called: $temp = ee()->extensions->universal_call('forum_topics_loop_end', $this, $query->result(), $row, $temp); if (ee()->extensions->end_script === TRUE) return; -### `forum_topics_start($this, $str)` +## `forum_topics_start($this, $str)` | Parameter | Type | Description | | --------- | -------- | --------------------------------- | @@ -269,7 +269,7 @@ How it's called: $str = ee()->extensions->universal_call('forum_topics_start', $this, $str); if (ee()->extensions->end_script === TRUE) return $str; -### `main_forum_table_rows_template()` +## `main_forum_table_rows_template()` | Parameter | Type | Description | | ------------- | -------- | ------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/module/member-auth.md b/docs/development/extension-hooks/module/member-auth.md index 0bd4fdcc1..08fca9d76 100755 --- a/docs/development/extension-hooks/module/member-auth.md +++ b/docs/development/extension-hooks/module/member-auth.md @@ -13,9 +13,9 @@ lang: php # Member Module Authorization Extension Hooks -[TOC=3] +[TOC=2] -### `member_member_login_multi($hook_data)` +## `member_member_login_multi($hook_data)` | Parameter | Type | Description | | ----------- | -------- | ---------------------------------------------------------------------------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: ee()->extensions->call('member_member_login_multi', $this->_hook_data()); if (ee()->extensions->end_script === TRUE) return; -### `member_member_login_single($hook_data)` +## `member_member_login_single($hook_data)` | Parameter | Type | Description | | ----------- | -------- | ---------------------------------------------------------------------------------------------------------------- | @@ -43,7 +43,7 @@ How it's called: ee()->extensions->call('member_member_login_single', $this->_hook_data()); if (ee()->extensions->end_script === TRUE) return; -### `member_member_login_start()` +## `member_member_login_start()` | Parameter | Type | | --------- | ------ | @@ -56,7 +56,7 @@ How it's called: ee()->extensions->call('member_member_login_start'); if (ee()->extensions->end_script === TRUE) return; -### `member_member_logout()` +## `member_member_logout()` | Parameter | Type | | --------- | ------ | @@ -69,7 +69,7 @@ How it's called: $edata = ee()->extensions->call('member_member_logout'); if (ee()->extensions->end_script === TRUE) return; -### `member_process_reset_password()` +## `member_process_reset_password()` | Parameter | Type | Description | | --------- | ------- | ------------------------------------------ | diff --git a/docs/development/extension-hooks/module/member-register.md b/docs/development/extension-hooks/module/member-register.md index 29f0d7ace..f4ad28fc7 100755 --- a/docs/development/extension-hooks/module/member-register.md +++ b/docs/development/extension-hooks/module/member-register.md @@ -13,9 +13,9 @@ lang: php # Member Module Registration Extension Hooks -[TOC=3] +[TOC=2] -### `member_member_register($data, $member_id)` +## `member_member_register($data, $member_id)` | Parameter | Type | Description | | ----------- | ------- | -------------------------------------------------------------------- | @@ -30,7 +30,7 @@ How it's called: ee()->extensions->call('member_member_register', $data, $member_id); if (ee()->extensions->end_script === TRUE) return; -### `member_member_register_errors($this)` +## `member_member_register_errors($this)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------- | @@ -44,7 +44,7 @@ How it's called: ee()->extensions->call('member_member_register_errors', $this); if (ee()->extensions->end_script === TRUE) return; -### `member_member_register_start()` +## `member_member_register_start()` | Parameter | Type | | --------- | ------ | @@ -57,7 +57,7 @@ How it's called: ee()->extensions->call('member_member_register_start'); if (ee()->extensions->end_script === TRUE) return; -### `member_register_validate_members($member_id)` +## `member_register_validate_members($member_id)` | Parameter | Type | Description | | ----------- | ------ | -------------------- | diff --git a/docs/development/extension-hooks/module/member-settings.md b/docs/development/extension-hooks/module/member-settings.md index efff437b8..cabb85185 100755 --- a/docs/development/extension-hooks/module/member-settings.md +++ b/docs/development/extension-hooks/module/member-settings.md @@ -13,7 +13,7 @@ lang: php # Member Module Settings Extension Hooks -### `member_edit_preferences($element)` +## `member_edit_preferences($element)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------- | @@ -26,7 +26,7 @@ How it's called: $element = ee()->extensions->call('member_edit_preferences', $element); -### `member_update_preferences($data)` +## `member_update_preferences($data)` | Parameter | Type | Description | | --------- | ------- | -------------------------------- | diff --git a/docs/development/extension-hooks/module/member.md b/docs/development/extension-hooks/module/member.md index b00f0883d..e2e587c0d 100755 --- a/docs/development/extension-hooks/module/member.md +++ b/docs/development/extension-hooks/module/member.md @@ -13,7 +13,7 @@ lang: php # Member Module Extension Hooks -### `member_manager($this)` +## `member_manager($this)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------------- | diff --git a/docs/development/extension-hooks/module/search.md b/docs/development/extension-hooks/module/search.md index 1b1082a2e..17c6ba788 100755 --- a/docs/development/extension-hooks/module/search.md +++ b/docs/development/extension-hooks/module/search.md @@ -13,7 +13,7 @@ lang: php # Search Module Extension Hooks -### `channel_search_modify_search_query($sql, $hash)` +## `channel_search_modify_search_query($sql, $hash)` | Parameter | Type | Description | | --------- | -------- | ------------------------------------------------ | @@ -29,7 +29,7 @@ How it's called: ... if (ee()->extensions->end_script === TRUE) return $sql -### `channel_search_modify_result_query($sql, $hash)` +## `channel_search_modify_result_query($sql, $hash)` | Parameter | Type | Description | | ----------- | -------- | ------------------------------------------------ | diff --git a/docs/development/extension-hooks/module/simple-commerce.md b/docs/development/extension-hooks/module/simple-commerce.md index 00e010959..b41555765 100755 --- a/docs/development/extension-hooks/module/simple-commerce.md +++ b/docs/development/extension-hooks/module/simple-commerce.md @@ -13,9 +13,9 @@ lang: php # Simple Commerce Module Extension Hooks -[TOC=3] +[TOC=2] -### `simple_commerce_evaluate_ipn_response($this, $result)` +## `simple_commerce_evaluate_ipn_response($this, $result)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------------------------------------------------------- | @@ -30,7 +30,7 @@ How it's called: $result = ee()->extensions->universal_call('simple_commerce_evaluate_ipn_response', $this, $result); if (ee()->extensions->end_script === TRUE) return; -### `simple_commerce_perform_actions_end($this, $row)` +## `simple_commerce_perform_actions_end($this, $row)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------------------------------------------------------- | @@ -50,7 +50,7 @@ Useful object variables: - `$this->post` - array of information about the purchase - `$this->debug` - whether or not debug mode is enabled -### `simple_commerce_perform_actions_start($this, $row)` +## `simple_commerce_perform_actions_start($this, $row)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------------------------------------------------------------- | diff --git a/docs/development/extension-hooks/module/wiki.md b/docs/development/extension-hooks/module/wiki.md index 3335b8a5e..1f340b4b9 100755 --- a/docs/development/extension-hooks/module/wiki.md +++ b/docs/development/extension-hooks/module/wiki.md @@ -13,9 +13,9 @@ lang: php # Wiki Module Extension Hooks -[TOC=3] +[TOC=2] -### `wiki_start($this)` +## `wiki_start($this)` | Parameter | Type | Description | | --------- | -------- | --------------------------------------------- | @@ -29,7 +29,7 @@ How it's called: $this->return_data = ee()->extensions->universal_call('wiki_start', $this); if (ee()->extensions->end_script === TRUE) return; -### `wiki_article_start($this, $title, $query)` +## `wiki_article_start($this, $title, $query)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------- | @@ -45,7 +45,7 @@ How it's called: ee()->extensions->universal_call('wiki_article_start', $this, $title, $query); if (ee()->extensions->end_script === TRUE) return; -### `wiki_article_end($this, $query)` +## `wiki_article_end($this, $query)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------------- | @@ -60,7 +60,7 @@ How it's called: $this->return_data = ee()->extensions->universal_call('wiki_article_end', $this, $query); if (ee()->extensions->end_script === TRUE) return; -### `wiki_special_page($this, $topic)` +## `wiki_special_page($this, $topic)` | Parameter | Type | Description | | --------- | -------- | -------------------------------------------------- | @@ -75,7 +75,7 @@ How it's called: ee()->extensions->universal_call('wiki_special_page', $this, $topic); if (ee()->extensions->end_script === TRUE) return; -### `edit_wiki_article_end($this, $query)` +## `edit_wiki_article_end($this, $query)` | Parameter | Type | Description | | --------- | -------- | -------------------------------- | @@ -90,7 +90,7 @@ How it's called: $edata = ee()->extensions->universal_call('edit_wiki_article_end', $this, $query); if (ee()->extensions->end_script === TRUE) return; -### `edit_wiki_article_form_start($this, $title, $query)` +## `edit_wiki_article_form_start($this, $title, $query)` | Parameter | Type | Description | | --------- | -------- | ---------------------------------------- | @@ -106,7 +106,7 @@ How it's called: ee()->extensions->universal_call('edit_wiki_article_form_start', $this, $title, $query); if (ee()->extensions->end_script === TRUE) return; -### `edit_wiki_article_form_end($this, $query)` +## `edit_wiki_article_form_end($this, $query)` | Parameter | Type | Description | | --------- | -------- | ----------------------------------------- | diff --git a/docs/general/system-configuration-overrides.md b/docs/general/system-configuration-overrides.md index 528d13dff..bc3821aa6 100755 --- a/docs/general/system-configuration-overrides.md +++ b/docs/general/system-configuration-overrides.md @@ -13,8 +13,6 @@ lang: php # System Configuration Overrides -[TOC] - WARN: **Warning:** This article covers advanced topics. By default, ExpressionEngine's system settings are managed in the Control Panel and stored in the database, but these settings can be overridden with one of 3 configuration files: the main configuration file, the site index file, and the CP index file. @@ -44,13 +42,13 @@ ExpressionEngine's settings are loaded in this order at runtime: 3. If a front-end page is being served, a limited array of settings in `index.php` are loaded and override any settings loaded from the database and the main configuration file. 4. If a CP page is being served, a limited array of settings in `admin.php` are loaded and override any settings loaded from the database and the main configuration file. -## Overrides +**Overrides** Click "Show List" below to list all available overrides, or scroll through the list of overrides and their descriptions further below. -[TOC=3 hide] +[TOC=2 hide] -### `allow_dictionary_pw` +## `allow_dictionary_pw` Set whether words commonly found in the dictionary can be used as passwords. Must be used in combination with [name_of_dictionary_file](#name_of_dictionary_file). @@ -65,7 +63,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Allow Dictionary Words as Passwords](control-panel/settings/security-privacy.md#allow-dictionary-words-in-passwords) -### `allow_extensions` +## `allow_extensions` Set whether extensions are enabled in the system. Disabling extensions will _not_ uninstall extensions. @@ -78,7 +76,7 @@ Example Usage: $config['allow_extensions'] = 'y'; -### `allow_member_localization` +## `allow_member_localization` Set whether dates and times are localized to each members' own localization preferences. @@ -93,7 +91,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Allow members to set their own localization preferences](control-panel/settings/members.md#allow-members-to-set-time-preferences) -### `allow_member_registration` +## `allow_member_registration` Set whether site visitors are allowed to register for accounts. @@ -108,7 +106,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Allow New Member Registrations](control-panel/settings/members.md#allow-registrations) -### `allow_multi_logins` +## `allow_multi_logins` Set whether an account can have multiple active sessions at one time. @@ -125,7 +123,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Allow multiple log-ins from a single account](control-panel/settings/security-privacy.md#allow-multiple-logins) -### `allow_pending_login` +## `allow_pending_login` Set whether members of the Pending member role can log in or not. By default, Pending members cannot log in. @@ -138,7 +136,7 @@ Example Usage: $config['allow_pending_login'] = 'y'; -### `allow_php` +## `allow_php` Set whether the toggle to enable/disable PHP in templates is displayed. @@ -151,7 +149,7 @@ Example Usage: $config['allow_php'] = 'y'; -### `allow_signatures` +## `allow_signatures` Set whether member signatures are enabled when using Discussion Forum. @@ -164,7 +162,7 @@ Example Usage: $config['allow_signatures'] = 'y'; -### `allow_textarea_tabs` +## `allow_textarea_tabs` Set whether a tab keystroke produces a tab in Publish Page and Template Editor textareas. This is the default behavior. @@ -177,7 +175,7 @@ Example Usage: $config['allow_textarea_tabs'] = 'y'; -### `allow_url_redirects_from_site` +## `allow_url_redirects_from_site` Set whether `?URL=` query string is enabled on the front-end. | Value | Behavior | @@ -185,7 +183,7 @@ Set whether `?URL=` query string is enabled on the front-end. | n | Disables `?URL=` query string redirecting users on the front-end (default) | | y | Allows `?URL=` query string to be used to redirect users to external domains | -### `allow_username_change` +## `allow_username_change` Set whether members can change their own usernames after registration. @@ -200,7 +198,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Allow members to change their username](control-panel/settings/security-privacy.md#allow-members-to-change-username) -### `allowed_preview_domains` +## `allowed_preview_domains` List extra domains that can be used to show live preview. You will need this if your site or CP is using domain that is not configured as Site URL or CP URL. Can be array or comma-separated string. @@ -210,13 +208,13 @@ Example Usage: $config['allowed_preview_domains'] = ['example1.com', 'example2.com']; -### `app_version` +## `app_version` The installation's ExpressionEngine version. WARN: **Warning:** This configuration variable is automatically set by the system and **should not be modified**. -### `auto_assign_cat_parents` +## `auto_assign_cat_parents` Set whether to assign an entry to both the selected category and its parent category. @@ -231,7 +229,7 @@ Example Usage: **Also found in CP:** `Settings --> Content & Design`: [Auto-Assign Category Parents](control-panel/settings/content-design.md#assign-category-parents) -### `autosave_interval_seconds` +## `autosave_interval_seconds` Set the interval between autosaves on the Publish Page. @@ -243,7 +241,7 @@ Example Usage: $config['autosave_interval_seconds'] = '30'; -### `autosave_prune_hours` +## `autosave_prune_hours` Set the age at which Channel Entry autosaves are automatically deleted. @@ -255,7 +253,7 @@ Example Usage: $config['autosave_prune_hours'] = '4'; -### `avatar_max_height` +## `avatar_max_height` Set the maximum height (in pixels) allowed for user-uploaded avatars. @@ -269,7 +267,7 @@ Example Usage: **Also found in CP:** `Settings --> Avatars`: [Avatar Maximum Height](control-panel/settings/avatars.md#maximum-height) -### `avatar_max_kb` +## `avatar_max_kb` Set the maximum file size (in kilobytes) allowed for user-uploaded avatars. @@ -283,7 +281,7 @@ Example Usage: **Also found in CP:** `Settings --> Avatars`: [Avatar Maximum Size](control-panel/settings/avatars.md#maximum-file-size-kb) -### `avatar_max_width` +## `avatar_max_width` Set the maximum width (in pixels) allowed for user-uploaded avatars. @@ -297,7 +295,7 @@ Example Usage: **Also found in CP:** `Settings --> Avatars`: [Avatar Maximum Width](control-panel/settings/avatars.md#maximum-width) -### `avatar_path` +## `avatar_path` Set the server path to the avatar directory. @@ -311,7 +309,7 @@ Example Usage: **Also found in CP:** `Settings --> Avatars`: [Server Path to Avatar Folder](control-panel/settings/avatars.md#avatar-path) -### `avatar_url` +## `avatar_url` Set the URL to the avatar directory. @@ -325,7 +323,7 @@ Example Usage: **Also found in CP:** `Settings --> Avatars`: [URL to Avatar Folder](control-panel/settings/avatars.md#avatar-directory) -### `ban_action` +## `ban_action` Set the action to be taken when a visitor with a banned IP address attempts access. @@ -339,7 +337,7 @@ Example Usage: $config['ban_action'] = 'message'; -### `ban_destination` +## `ban_destination` Set the redirect destination for visitors with banned IP addresses. Must be used in conjunction with [ban_action](#ban_action) set to `bounce`. @@ -351,7 +349,7 @@ Example Usage: $config['ban_destination'] = 'https://www.example.com'; -### `ban_message` +## `ban_message` Set the message shown to visitors with banned IP addresses. Must be used in conjunction with [ban_action](#ban_action) set to `message`. @@ -363,7 +361,7 @@ Example Usage: $config['ban_message'] = 'This site is currently unavailable.'; -### `banish_masked_ips` +## `banish_masked_ips` Set the system to deny a visitor access if the user's IP address cannot be determined while [throttling is enabled](#enable_throttling). @@ -378,7 +376,7 @@ Example Usage: **Also found in CP:** `Settings --> Access Throttling`: [Deny Access if No IP Address is Present](control-panel/settings/throttling.md#require-ip) -### `banishment_message` +## `banishment_message` Set a custom message to show throttled visitors. [Throttling must be enabled](#enable_throttling) and [banishment_type](#banishment_type) must be set to `message`. @@ -392,7 +390,7 @@ Example Usage: **Also found in CP:** `Settings --> Access Throttling`: [Custom Message](control-panel/settings/throttling.md#message) -### `banishment_type` +## `banishment_type` Set the system's method for handling throttled web requests. @@ -408,7 +406,7 @@ Example Usage: **Also found in CP:** `Settings --> Access Throttling`: [Action to Take](control-panel/settings/throttling.md#lock-out-action) -### `banishment_url` +## `banishment_url` Set a URL to serve as the redirect destination for throttled visitors. [Throttling must be enabled](#enable_throttling) and [banishment_type](#banishment_type) must be set to `redirect`. @@ -422,7 +420,7 @@ Example Usage: **Also found in CP:** `Settings --> Access Throttling`: [URL for Redirect](control-panel/settings/throttling.md#redirect) -### `banned_emails` +## `banned_emails` Specify email addresses to ban from site registration and login. Use wildcards for partial email addresses. @@ -436,7 +434,7 @@ Example Usage: **Also found in CP:** `Members --> Ban Settings`: [Banned Email Addresses](control-panel/member-manager.md#ban-settings) -### `banned_ips` +## `banned_ips` Specify IP addresses to ban from site registration and login. Use wildcards to ban blocks of IP addresses. @@ -450,7 +448,7 @@ Example Usage: **Also found in CP:** `Members --> Ban Settings`: [Banned IP Address](control-panel/member-manager.md#ban-settings) -### `banned_screen_names` +## `banned_screen_names` Specify screen names that cannot be used for member accounts, which can be handy for reserving certain screen names for your own use. @@ -464,7 +462,7 @@ Example Usage: **Also found in CP:** `Members --> Ban Settings`: [Restricted Screen Names](control-panel/member-manager.md#ban-settings) -### `banned_usernames` +## `banned_usernames` Specify usernames that cannot be used for member accounts, which can be handy for reserving certain usernames for your own use. @@ -478,7 +476,7 @@ Example Usage: **Also found in CP:** `Members --> Ban Settings`: [Restricted Usernames](control-panel/member-manager.md#ban-settings) -### `base_path` +## `base_path` Set your site's base server path for use in other path configurations. Once set, this value is made available via a `{base_path}` variable that can be placed in server path fields in the control panel for easy environment management. @@ -492,7 +490,7 @@ Example Usage: **Also found in CP:** `Settings --> URL and Path Settings`: [Default base path](control-panel/settings/urls.md#default-base-path) -### `base_url` +## `base_url` Set your site's base URL for use in other URL configurations. Once set, this value is made available via a `{base_url}` variable that can be placed in other URL configuration fields in the control panel for easy environment management. @@ -506,7 +504,7 @@ Example Usage: **Also found in CP:** `Settings --> URL and Path Settings`: [Default base URL](control-panel/settings/urls.md#default-base-url) -### `cache_driver` +## `cache_driver` Specify a different [caching driver](optimization/caching.md#caching-drivers) to use. @@ -521,7 +519,7 @@ Example Usage: $config['cache_driver'] = 'memcached'; -### `cache_driver_backup` +## `cache_driver_backup` Specify a backup [caching driver](optimization/caching.md#caching-drivers) to use in case the one specified in [cache_driver](#cache_driver) isn't available. Same values accepted and same default as [cache_driver](#cache_driver). @@ -529,7 +527,7 @@ Example Usage: $config['cache_driver_backup'] = 'file'; -### `captcha_font` +## `captcha_font` Set whether TrueType fonts should be used for CAPTCHA images. @@ -544,7 +542,7 @@ Example Usage: **Also found in CP:** `Settings --> CAPTCHA`: [Use TrueType Font for CAPTCHA](control-panel/settings/captcha.md#use-truetype-font) -### `captcha_path` +## `captcha_path` Set the path to the directory containing CAPTCHA images. @@ -558,7 +556,7 @@ Example Usage: **Also found in CP:** `Settings --> CAPTCHA`: [Server Path to CAPTCHA Folder](control-panel/settings/captcha.md#captcha-path) -### `captcha_rand` +## `captcha_rand` Specify whether to add a random three-digit number to the end of each generated CAPTCHA word. This makes it more difficult for scripts to guess or brute-force the form submission. @@ -573,7 +571,7 @@ Example Usage: **Also found in CP:** `Settings --> CAPTCHA`: [Add Random Number to CAPTCHA Word](control-panel/settings/captcha.md#add-random-number) -### `captcha_require_members` +## `captcha_require_members` Specify whether to require logged-in members to pass CAPTCHA validation to submit front-end forms, such as Channel Form, comment forms and email forms. @@ -588,7 +586,7 @@ Example Usage: **Also found in CP:** `Settings --> CAPTCHA`: [Require CAPTCHA with logged-in members](control-panel/settings/captcha.md#require-captcha-while-logged-in) -### `captcha_url` +## `captcha_url` Set the full URL to the directory containing CAPTCHA images. @@ -602,7 +600,7 @@ Example Usage: **Also found in CP:** `Settings --> CAPTCHA`: [Full URL to CAPTCHA Folder](control-panel/settings/captcha.md#captcha-path) -### `censor_replacement` +## `censor_replacement` You may optionally specify a word or phrase to be used when replacing censored words. For example, if you set "tisk tisk" as your replacement word, and "shucks" is in your censored list, then anytime "shucks" is used it will be replaced with "tisk tisk". If you do not set this preference, a pound symbol will be used for each character that is censored, so "shucks" would be converted to "\#\#\#\#\#\#". @@ -616,7 +614,7 @@ Example Usage: **Also found in CP:** `Settings --> Word Censoring`: [Censoring Replacement Word](control-panel/settings/word-censor.md#replacement-characters) -### `censored_words` +## `censored_words` Specify a list of words to censor. Wildcards are allowed. For example, `test*` would censor the words "test", "testing", and "tester", while `*gress` would censor the words "progress" and "congress". @@ -630,7 +628,7 @@ Example Usage: **Also found in CP:** `Settings --> Word Censoring`: [Censored Words](control-panel/settings/word-censor.md#words-to-censor) -### `channel_form_overwrite` +## `channel_form_overwrite` Allows Channel Form authors to overwrite *their own files only* when uploading files named the same as files previously uploaded by that author. @@ -643,7 +641,7 @@ Example Usage: $config['channel_form_overwrite'] = 'y'; -### `charset` +## `charset` Specify which character set for the system to use by default. @@ -657,7 +655,7 @@ Example Usage: $config['charset'] = 'UTF-8'; -### `cli_enabled` +## `cli_enabled` Allows to disable or enable command line interface. @@ -672,7 +670,7 @@ Example Usage: WARN: **Important:** The CLI is available to every user that has SSH or terminal access to your site's webserver. It does not handle authorization inside ExpressionEngine and is relying on your server's authorization method instead. -### `code_block_pre` +## `code_block_pre` Custom markup to use wrap `[code]` blocks, works with `code_block_post` below to wrap the standard `
...
` with your custom markup. @@ -685,7 +683,7 @@ Example Usage: $config['code_block_pre'] = '
'; $config['code_block_post'] = '
'; -### `code_block_post` +## `code_block_post` Custom markup to use wrap `[code]` blocks, works with `code_block_pre` above to wrap the standard `
...
` with your custom markup. @@ -698,7 +696,7 @@ Example Usage: $config['code_block_pre'] = '
'; $config['code_block_post'] = '
'; -### `codemirror_height` +## `codemirror_height` Set the height of any CodeMirror textareas in the control panel, such as the Template Editor. @@ -710,7 +708,7 @@ Example Usage: $config['codemirror_height'] = '18em'; -### `codemirror_fontsize` +## `codemirror_fontsize` Set the font-size of any CodeMirror textareas in the control panel, such as the Template Editor. Default is `1rem`. @@ -722,7 +720,7 @@ Example Usage: $config['codemirror_fontsize'] = '0.9rem'; -### `comment_edit_time_limit` +## `comment_edit_time_limit` Set the length of time in seconds that members have to edit their comments on the front end of the site. Set to `0` for no limit. Members in the Super Admin group are exempt from this time limit. @@ -736,7 +734,7 @@ Example Usage: **Also found in CP:** `Settings --> Comment Settings`: [Comment Editing Time Limit](comment/control-panel.md#comment-editing-time-limit) -### `comment_moderation_override` +## `comment_moderation_override` By default, comments are no longer accepted for entries after their comment expiration date has passed. Set this preference to override that behavior and allow moderated comments on entries after comment expiration. @@ -751,7 +749,7 @@ Example Usage: **Also found in CP:** `Settings --> Comment Settings`: [Moderate expired entries](comment/control-panel.md#moderate-after-comments-expire) -### `comment_word_censoring` +## `comment_word_censoring` Apply word censoring to comments, even if censoring is not [enabled](general/system-configuration-overrides.md#enable_censoring) system-wide. @@ -766,7 +764,7 @@ Example Usage: **Also found in CP:** `Settings --> Comment Settings`: [Force word censoring for comments](comment/control-panel.md#enable-word-censoring) -### `cookie_domain` +## `cookie_domain` Optionally specify a domain the cookie is available to. By default, the exact hostname of the requested page is set as the cookie domain. For example, if the page at `https://www.example.com/blog/an-entry-title` is loaded and the cookie domain is left blank in ExpressionEngine's configuration, the browser will use `www.example.com` as the cookie domain. The browser will only make these cookies available when the page's hostname is _exactly_ `www.example.com`. @@ -788,7 +786,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Cookie Domain](control-panel/settings/security-privacy.md#domain) -### `cookie_httponly` +## `cookie_httponly` Set the HttpOnly flag when setting a cookie. The HttpOnly flag is a security feature for cookies that prevents a client side script from accessing or deleting the cookie (if the browser supports it, as most modern browsers do). [Learn more.](https://www.owasp.org/index.php/HttpOnly) @@ -801,7 +799,7 @@ Example Usage: $config['cookie_httponly'] = 'n'; -### `cookie_path` +## `cookie_path` Optionally specify a cookie path. When a cookie path is set, the browser will only share cookies with ExpressionEngine when the beginning of the URL path matches the cookie path. For example, if the cookie path is set to `/blog/`, a cookie for the domain `example.com` will only be sent by the browser if the URL begins with `https://example.com/blog/`. This can be useful if you have ExpressionEngine installed in a sub-directory and want to ensure that only that particular installation has access to the cookies it sets. @@ -815,7 +813,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Cookie Path](control-panel/settings/security-privacy.md#path) -### `cookie_prefix` +## `cookie_prefix` Specify a prefix for the cookie name set by ExpressionEngine. This protects against collisions from separate ExpressionEngine installations on the same [cookie domain](#cookie_domain). @@ -829,7 +827,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Cookie Prefix](control-panel/settings/security-privacy.md#prefix) -### `cookie_secure` +## `cookie_secure` Require a secure connection (HTTPS) for ExpressionEngine to set cookies. @@ -842,7 +840,7 @@ Example Usage: $config['cookie_secure'] = 'y'; -### `cookie_samesite` +## `cookie_samesite` Declare if your cookie should be restricted to a first-party or same-site context. To find out more about SameSite cookies visit https://web.dev/samesite-cookies-explained/ @@ -856,7 +854,7 @@ Example Usage: $config['cookie_samesite'] = 'Strict'; -### `cp_session_length` +## `cp_session_length` Set TTL for admin sessions. @@ -866,7 +864,7 @@ Set TTL for admin sessions. NOTE: **Note:** An idle state may still trigger the [Idle Check Modal](control-panel/access.md) regardless of the session length. -### `cp_session_type` +## `cp_session_type` Set the method for session handling in the Control Panel. @@ -884,7 +882,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Control Panel Session Type](control-panel/settings/security-privacy.md#cp-session-type) -### `cp_url` +## `cp_url` Set the full URL to your Control Panel. @@ -902,7 +900,7 @@ Also available for use in the [site index file](#site-index-file), `index.php`, **Also found in CP:** `Settings --> URL and Path Settings`: [URL to your Control Panel index page](control-panel/settings/urls.md#control-panel-directory) -### `date_format` +## `date_format` Set the default format for displaying dates. If [allow_member_localization](#allow_member_localization) is enabled and a member has their own localization preference set, that will override this setting. @@ -914,7 +912,7 @@ Example Usage: $config['date_format'] = '%F %d %Y'; -### `db_backup_row_limit` +## `db_backup_row_limit` When using the [Database Backup Utility](control-panel/utilities/database.md#database-backup-utility), some databases and PHP configurations may cause the backup utility to run out of memory while creating the backup. This config sets the maximum number of rows that will be queried and written to the backup file at a time. If you run into an out-of-memory error, try setting this to a lower number than the default to have the utility work in smaller batches. @@ -926,7 +924,7 @@ Example Usage: $config['db_backup_row_limit'] = 2000; -### `debug` +## `debug` Set display preferences for PHP and database error messages. @@ -944,7 +942,7 @@ Example Usage: **Also found in CP:** `Settings --> Debugging & Output`: [Debug Preference](control-panel/settings/debug-output.md#enable-error-reporting) -### `default_member_group` +## `default_member_group` Set the primary member role to which new users will be assigned. @@ -958,7 +956,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Default Member Role Assigned to New Members](control-panel/settings/members.md#default-primary-role) -### `default_site_timezone` +## `default_site_timezone` Set the default timezone. All dates and times displayed by ExpressionEngine will be localized to this timezone unless overridden by a member's own localization preferences. @@ -972,7 +970,7 @@ Example Usage: **Also found in CP:** `Settings --> General Settings`: [Site Timezone](control-panel/settings/general.md#timezone) -### `deft_lang` +## `deft_lang` Set the default language. ExpressionEngine ships with English, and additional [language packs](localization/languages.md) are available for download. @@ -984,7 +982,7 @@ Example Usage: $config['deft_lang'] = 'french'; -### `deny_duplicate_data` +## `deny_duplicate_data` Set whether to reject duplicate data submissions. This feature blocks a comment if an identical one already exists on the site. @@ -999,7 +997,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Deny Duplicate Data](security/spam-protection.md#deny-duplicate-data) -### `disable_all_tracking` +## `disable_all_tracking` This is an emergency override which will disable all tracking when enabled. This is useful for server administrators who need a way to respond immediately to a traffic spike to help keep the site running smoothly. @@ -1013,7 +1011,7 @@ Example Usage: $config['disable_all_tracking'] = 'y'; -### `disable_csrf_protection` +## `disable_csrf_protection` CSRF protection prevents automated scripts (the most common way spam is generated) from repeatedly submitting comments or other form data. A submission is only allowed when a user manually loads a page and submits the form from your site. @@ -1026,7 +1024,7 @@ Example Usage: $config['disable_csrf_protection'] = 'y'; -### `disable_emoji_shorthand` +## `disable_emoji_shorthand` Disables parsing of Emoji "shorthand", e.g. parsing `:rocket:` as 🚀. @@ -1039,7 +1037,7 @@ Example Usage: $config['disable_emoji_shorthand'] = 'y'; -### `disable_tag_caching` +## `disable_tag_caching` WARN: **Warning:** Use only under extreme circumstances. @@ -1054,7 +1052,7 @@ Example Usage: $config['disable_tag_caching'] = 'y'; -### `dynamic_tracking_disabling` +## `dynamic_tracking_disabling` Set a value for the maximum number of online visitors to track. Once this value is exceeded, all of the tracking features will be temporarily disabled until the number of online visitors drops below the indicated value. Recommended values for this feature will vary based on your hosting environment. Check with your server administrator to discuss reasonable limits for your site. @@ -1070,7 +1068,7 @@ Example Usage: **Also found in CP:** `Settings --> Tracking`: [Suspend ALL tracking when number of online visitors exceeds](control-panel/settings/hit-tracking.md#suspend-threshold): -### `email_batch_size` +## `email_batch_size` Set the number of emails to be sent in each batch. The batch size you should use depend on many things; among them the email protocol you have chosen, the server configuration, and the server power, so you may need to experiment a little to get it right. @@ -1088,7 +1086,7 @@ Example Usage: $config['email_batch_size'] = '300'; -### `email_batchmode` +## `email_batchmode` Set whether to send email via the Communicate section of the Control Panel in batches. @@ -1103,7 +1101,7 @@ Example Usage: $config['email_batchmode'] = 'y'; -### `email_charset` +## `email_charset` Set the character encoding used on the content of outgoing messages. @@ -1117,7 +1115,7 @@ Example Usage: **Also found in CP:** `Settings --> Outgoing Email`: [Email Character Encoding](control-panel/settings/email.md#character-encoding) -### `email_console_timelock` +## `email_console_timelock` Set the number of minutes that must lapse before a member is allowed to send another email. @@ -1131,7 +1129,7 @@ Example Usage: $config['email_console_timelock'] = '300'; -### `email_crlf` +## `email_crlf` If set, this overrides the core Email class setting for crlf characters in quoted-printable encoded emails (Email class \$crlf property). @@ -1145,7 +1143,7 @@ Example Usage: NOTE: **Note:** Double quotes must be used around this value, as per example. -### `email_newline` +## `email_newline` If set, overrides the core Email class setting for newline characters (Email class \$newline property). @@ -1159,7 +1157,7 @@ Example Usage: NOTE: **Note:** Double quotes must be used around this value, as per example. -### `email_smtp_crypto` +## `email_smtp_crypto` Cryptographic protocol for SMTP, when a secure connection is required. @@ -1173,7 +1171,7 @@ Example Usage: $config['email_smtp_crypto'] = 'tls'; -### `emoticon_url` +## `emoticon_url` Set the URL to the base folder where smiley graphics are stored. @@ -1187,7 +1185,7 @@ Example Usage: **Also found in CP:** `Settings --> Content & Design`: [URL to the folder containing your smileys](control-panel/settings/content-design.md#url) -### `enable_censoring` +## `enable_censoring` If enabled, the system will censor any [specified words](#censored_words) in channel entries, comments, forum posts, etc. Censored words will be replaced with the [censoring replacement word](#censor_replacement). @@ -1202,9 +1200,9 @@ Example Usage: **Also found in CP:** `Settings --> Word Censorship`: [Enable Word Censoring](control-panel/settings/word-censor.md#enable-censorship) -### `enable_entry_cloning` +## `enable_entry_cloning` -When set to `n`, disables "Clone to New Entry" option and entry cloning globally. +When set to `n`, disables "Clone to New Entry" option and entry cloning globally. | Value | Behavior | | ----- | ---------------------------------------------- | @@ -1215,7 +1213,7 @@ Example Usage: $config['enable_entry_cloning'] = 'y'; -### `enable_dock` +## `enable_dock` Allows turning off [front-end editing](advanced-usage/front-end/frontend.md) and Prolets completely. When set to `n`, Dock will not be shown and front-end field editing will not be enabled. @@ -1228,7 +1226,7 @@ Example Usage: $config['enable_dock'] = 'n'; -### `enable_emoticons` +## `enable_emoticons` If enabled, smileys entered as text will be replaced by emoji. @@ -1243,7 +1241,7 @@ Example Usage: **Also found in CP:** `Settings --> Content & Design`: [Enable emoticons?](control-panel/settings/content-design.md#enable-emoticons) -### `enable_entry_view_tracking` +## `enable_entry_view_tracking` If enabled, the [Entry "Views" Tracking Tag](channels/entry-tracking.md) feature of the Channel module is available for use. @@ -1258,7 +1256,7 @@ Example Usage: **Also found in CP:** `Settings --> Hit Tracking`: [Enable Channel Entry View Tracking](control-panel/settings/hit-tracking.md#enable-entry-view-tracking) -### `enable_frontedit` +## `enable_frontedit` When set to `n`, completely disables [front-end editing](advanced-usage/front-end/frontend.md) while keeping Dock visible and Prolets functional. @@ -1272,7 +1270,7 @@ Example Usage: $config['enable_frontedit'] = 'n'; -### `enable_frontedit_links` +## `enable_frontedit_links` When set to `n`, disables automatic creation of content management links on front-end. The links can still be [added manually](advanced-usage/front-end/frontend.md#customizing-the-link-location). @@ -1285,7 +1283,7 @@ Example Usage: $config['enable_frontedit_links'] = 'y'; -### `enable_hit_tracking` +## `enable_hit_tracking` If enabled, the hit will be tracked each time a template is loaded. @@ -1300,7 +1298,7 @@ Example Usage: **Also found in CP:** `Settings --> Tracking`: [Enable Template Hit Tracking](control-panel/settings/hit-tracking.md#enable-template-hit-tracking) -### `enable_online_user_tracking` +## `enable_online_user_tracking` If enabled, online user statistics are tracked and the user-based variables in the [Statistics](add-ons/statistics.md) module are available for use. @@ -1315,7 +1313,7 @@ Example Usage: **Also found in CP:** `Settings --> Tracking`: [Enable Online User Tracking](control-panel/settings/hit-tracking.md#enable-online-user-tracking) -### `enable_tracking_cookie` +## `enable_tracking_cookie` When enabled, ExpressionEngine will set `exp_tracker` cookie on each page visit, allowing navigation through browsing history. Disabling it might influence redirect behavior of some forms on front-end. @@ -1330,7 +1328,7 @@ Example Usage: **Also found in CP:** `Settings --> Tracking`: [Enable tracker cookie?](control-panel/settings/hit-tracking.md#enable-tracker-cookie) -### `enable_search_log` +## `enable_search_log` If enabled, each searched term will be logged and can be viewed in the [Search Log](control-panel/system-logs.md#search-logs). @@ -1343,7 +1341,7 @@ Example Usage: $config['enable_search_log'] = 'n'; -### `enable_sql_caching` +## `enable_sql_caching` Improves the speed at which the Channel Entries tag is rendered by caching queries that are normally executed dynamically. @@ -1358,7 +1356,7 @@ Example Usage: **Also found in CP:** `Settings --> Content & Design`: [Cache Dynamic Channel Queries](optimization/caching.md#dynamic-channel-query-caching) -### `enable_template_routes` +## `enable_template_routes` This setting toggles whether or not Template Routes are used. If this is set to no, templates will not be accessible by their routes. When disabled the Template Route options will not appear in the Template Manager. @@ -1371,7 +1369,7 @@ Example Usage: $config['enable_template_routes'] = 'y'; -### `enable_throttling` +## `enable_throttling` If enabled, the system will throttle excessive web requests from potentially malicious users. @@ -1386,7 +1384,7 @@ Example Usage: **Also found in CP:** `Settings --> Access Throttling`: [Enable Throttling](control-panel/settings/throttling.md#enable-throttling) -### `encode_removed_text` +## `encode_removed_text` If set and `$this->encode_email` is set to `FALSE` in the Template class---which is not the default---this text will replace all instances of the [encode](templates/globals/single-variables.md#encode) global variable. @@ -1398,7 +1396,7 @@ Example Usage: $config['encode_removed_text'] = 'Encoded emails not allowed'; -### `encryption_key` +## `encryption_key` May be used by third parties as part of encoding and decoding encrypted data. The recommended length of the key is 32 characters (128 bits). The key should include numbers and uppercase and lowercase letters. @@ -1410,7 +1408,7 @@ Example Usage: $config['encryption_key'] = 'sy22k6QK6JzH38u4nLZ65bHOdK6VL89d'; -### `expire_session_on_browser_close` +## `expire_session_on_browser_close` Set the system to end a user's session when the browser is closed. (In the case of Mac OS X, this means quitting the browser application.) @@ -1423,16 +1421,16 @@ Example Usage: $config['expire_session_on_browser_close'] = 'y'; -### `favicon` +## `favicon` -URL to file used as favicon in Control Panel. +URL to file used as favicon in Control Panel. Example Usage: $config['favicon'] = '/url/to/icon.png'; -### `filename_increment` +## `filename_increment` Forces filenames of uploaded files to be unique. Secondary uploads of existing files or uploads that share a filename with an existing file will have an incrementing number appended to the filename. @@ -1445,7 +1443,7 @@ Example Usage: $config['filename_increment'] = 'y'; -### `force_query_string` +## `force_query_string` If enabled, ExpressionEngine will render URLs with a question mark following `index.php` in order to pass along segment information as a standard query string: @@ -1468,7 +1466,7 @@ Example Usage: **Also found in CP:** `Settings --> Debugging & Output`: [Force URL query strings](control-panel/settings/debug-output.md#force-url-query-strings) -### `force_redirect` +## `force_redirect` If `redirect_submitted_links` is set to `y`, this setting can be used to show an interstitial message to the user to confirm they want to visit the link they clicked. This can prevent issues where a link looks like it leads to one place, but actually leads to another. @@ -1483,7 +1481,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Force redirect confirmation on submitted links? ](control-panel/settings/security-privacy.md#enable-rank-denial-to-submitted-links) -### `forum_is_installed` +## `forum_is_installed` Automatically enabled when the [Discussion Forum](https://github.com/ExpressionEngine/Forum) module is installed. @@ -1496,7 +1494,7 @@ Example Usage: $config['forum_is_installed'] = 'y'; -### `forum_trigger` +## `forum_trigger` Sets the forum triggering word if the [Discussion Forum module is installed](https://github.com/ExpressionEngine/Forum). @@ -1510,7 +1508,7 @@ Example Usage: **Also found in CP:** `Developer --> Add-Ons --> Discussion Forum Settings --> Edit`: [Forum Triggering Word](https://github.com/ExpressionEngine/Forum/blob/main/docs/boards.md#forum-triggering-word) -### `gmail_duplication_prevention` +## `gmail_duplication_prevention` Gmail email addresses can optionally include any number of `.`'s and they're equivalent to the same address without `.`'s. For example `example@gmail.com` is the same as `e.x.a.m.p.l.e@gmail.com`. By default, ExpressionEngine prevents duplicate registration from the same address, but you can disable the prevention. @@ -1523,7 +1521,7 @@ Example Usage: $config['gmail_duplication_prevention'] = 'n'; -### `gzip_output` +## `gzip_output` Set the system to serve compressed front-end pages for faster load times as long as the requesting browser supports gzip compression, PHP's zlib extension is loaded, and the web server is not already serving compressed pages. It's a good idea to enable this setting in most production environments. @@ -1540,7 +1538,7 @@ Example Usage: **Also found in CP:** `Settings --> Debugging & Output`: [Enable GZIP Output](control-panel/settings/debug-output.md#enable-gzip-compression) -### `hidden_template_indicator` +## `hidden_template_indicator` Specify the character(s) that denote a [hidden template](templates/overview.md#hidden-templates) when used to prefix a template name. The default is an underscore, e.g. `_my_hidden_template`. @@ -1552,7 +1550,7 @@ Example Usage: $config['hidden_template_indicator'] = '.'; -### `hidden_template_404` +## `hidden_template_404` Set the system to show either a 404 page or the template group's index page when a hidden template is directly loaded in a browser. @@ -1560,7 +1558,7 @@ Example Usage: $config['hidden_template_404'] = 'y'; -### `htaccess_path` +## `htaccess_path` Set the server path used by the [Block/Allow](add-ons/blocklist.md) module to [write rules to your .htaccess file](add-ons/blocklist.md#writing-the-block-list-to-htaccess-file). @@ -1572,7 +1570,7 @@ Example Usage: $config['htaccess_path'] = '/server/path/to/your/.htaccess'; -### `ignore_entry_stats` +## `ignore_entry_stats` Disable entry stats and analytics being saved during creating/updating of entries when using models. Disabling entry stats can lead to improved performance when using models | Value | Behavior | @@ -1584,7 +1582,7 @@ Example Usage: $config['ignore_entry_stats'] = 'y'; -### `ignore_member_stats` +## `ignore_member_stats` Disable member role count being saved during creating/updating of members when using models. Disabling member stats can lead to improved performance when using models | Value | Behavior | @@ -1596,7 +1594,7 @@ Example Usage: $config['ignore_member_stats'] = 'y'; -### `image_library_path` +## `image_library_path` Set the path to the selected image library. @@ -1612,7 +1610,7 @@ Example Usage: **Also found in CP:** `Settings --> Content & Design`: [Image Converter Path](control-panel/settings/content-design.md#converter-path) -### `image_resize_protocol` +## `image_resize_protocol` Specify the image manipulation library to use. You may need to contact your web host or sysadmin to determine which protocols are installed and available on your server. @@ -1631,7 +1629,7 @@ Example Usage: **Also found in CP:** `Settings --> Content & Design`: [Image Resizing Protocol](control-panel/settings/content-design.md#protocol) -### `include_seconds` +## `include_seconds` Set the system to include seconds when time is displayed in the interface. @@ -1657,7 +1655,7 @@ Example Usage: $config['ip2nation'] = 'n'; -### `is_site_on` +## `is_site_on` Specify whether the site should be viewable by the general public or taken offline. This can be helpful when performing maintenance on only one of several MSM sites. @@ -1680,7 +1678,7 @@ Also available for use in the [site index file](#site-index-file), `index.php`. **Also found in CP:** `Settings --> General Settings`: Is site on? -### `is_system_on` +## `is_system_on` Specify whether the system's front-end should be viewable by the general public or taken offline. This can be helpful when performing maintenance. @@ -1695,7 +1693,7 @@ Example Usage: **Also found in CP:** `Settings --> General Settings`: [Is system on? ](control-panel/settings/general.md#website-online) -### `legacy_member_templates` +## `legacy_member_templates` Enables legacy member templates @@ -1708,7 +1706,7 @@ Example Usage: $config['legacy_member_templates'] = 'y'; -### `lockout_time` +## `lockout_time` Set the length of time a throttled visitor will be locked out of the site. @@ -1722,7 +1720,7 @@ Example Usage: **Also found in CP:** `Settings --> Access Throttling`: [Lockout Time](control-panel/settings/throttling.md#lockout-time) -### `log_date_format` +## `log_date_format` Set the timestamp format for all items added to the log file. @@ -1734,7 +1732,7 @@ Example Usage: $config['log_date_format'] = 'Y-m-d H:i:s'; -### `log_email_console_msgs` +## `log_email_console_msgs` Enable logging of all messages sent via the email console in the member profile pages. @@ -1747,7 +1745,7 @@ Example Usage: $config['log_email_console_msgs'] = 'n'; -### `log_referrers` +## `log_referrers` Enable referrer tracking. When enabled, one additional database access query will be performed for each page load so that the statistics can be generated. @@ -1760,11 +1758,11 @@ Example Usage: $config['log_referrers'] = 'n'; -### `log_search_terms` +## `log_search_terms` Unused in first party files, this configuration item exists to allow backwards compatibility for any third party add-ons using it. -### `log_threshold` +## `log_threshold` NOTE: **Note:** In order to save anything to log files, you'll need to create the `/system/user/logs/` directory and ensure it's writable. @@ -1782,7 +1780,7 @@ Example Usage: $config['log_threshold'] = '1'; -### `login_logo` +## `login_logo` URL to file used as branded logo on login page. @@ -1790,7 +1788,7 @@ Example Usage: $config['login_logo'] = '/url/to/file.jpg'; -### `mail_format` +## `mail_format` Set the default mail format selection for emails sent via the Communicate section. @@ -1805,7 +1803,7 @@ Example Usage: **Also found in CP:** `Settings --> Outgoing Email`: [Default Mail Format](control-panel/settings/email.md#mail-format) -### `mail_protocol` +## `mail_protocol` Set the system's method for sending email. @@ -1821,7 +1819,7 @@ Example Usage: **Also found in CP:** `Settings --> Outgoing Email`: [Email Protocol](control-panel/settings/email.md#protocol) -### `max_logged_searches` +## `max_logged_searches` Set the maximum number of most recent search terms to save in the [search log](#enable_search_log). @@ -1833,7 +1831,7 @@ Example Usage: $config['max_logged_searches'] = '500'; -### `max_page_loads` +## `max_page_loads` Set the maximum number of times a visitor is allowed to load your web pages within a given [time interval](#time_interval) before being locked out. If you set this preference to 5 page loads within 10 seconds, a user can not browse more than 5 pages within a 10 second interval or the throttling feature will be triggered, locking them out for the given [lockout time](#lockout_time). @@ -1847,7 +1845,7 @@ Example Usage: **Also found in CP:** `Settings --> Access Throttling`: [Maximum Number of Page Loads](control-panel/settings/throttling.md#maximum-page-loads) -### `max_tmpl_revisions` +## `max_tmpl_revisions` Set the maximum number of template revisions to save if [template revisions are enabled](#save_tmpl_revisions). @@ -1861,7 +1859,7 @@ Example Usage: **Also found in CP:** `Settings --> Template Settings`: [Maximum Number of Revisions to Keep](control-panel/settings/template.md#maximum-revisions) -### `max_url_segments` +## `max_url_segments` Set the maximum number of URL segments allows in requests made to your site. @@ -1873,7 +1871,7 @@ Example Usage: $config['max_url_segments'] = '12'; -### `mbr_notification_emails` +## `mbr_notification_emails` List of email addresses to notify if [notification is enabled](#new_member_notification) for new member registrations. @@ -1906,7 +1904,7 @@ Example Usage: ) ); -### `member_theme` +## `member_theme` Set the default member profile theme. @@ -1920,7 +1918,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Default Member Profile Theme](control-panel/settings/members.md#member-profile-theme) -### `memberlist_order_by` +## `memberlist_order_by` Set the default sorting criteria for the member list. @@ -1938,7 +1936,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Member List - Sort By](control-panel/settings/members.md#sort-by) -### `mime_whitelist_additions` +## `mime_whitelist_additions` With an array, add Mime Types to the whitelist. @@ -1948,7 +1946,7 @@ Example Usage: 'image/vnd.adobe.photoshop' ); -### `mime_whitelist_member_exception` +## `mime_whitelist_member_exception` Specify member IDs to exclude from Mime Type whitelist restrictions. @@ -1960,7 +1958,7 @@ Example Usage: $config['mime_whitelist_member_exception'] = '3, 14, 83'; -### `mime_whitelist_member_group_exception` +## `mime_whitelist_member_group_exception` Specify member role IDs to exclude from Mime Type whitelist restrictions. @@ -1972,7 +1970,7 @@ Example Usage: $config['mime_whitelist_member_group_exception'] = '2, 5'; -### `moblog_allow_nontextareas` +## `moblog_allow_nontextareas` Remove Moblog's textarea-only restriction for Channel Fields. @@ -1985,7 +1983,7 @@ Example Usage: $config['moblog_allow_nontextareas'] = 'y'; -### `memberlist_row_limit` +## `memberlist_row_limit` Set the default number of rows for the member list to display. @@ -1999,7 +1997,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Member List - Rows](control-panel/settings/members.md#total-results) -### `memberlist_sort_order` +## `memberlist_sort_order` Set the default member list sort order. @@ -2014,7 +2012,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Member List - Order](control-panel/settings/members.md#order-by) -### `multi_login_sites` +## `multi_login_sites` Sets the frontend login to apply to multiple sites. @@ -2028,7 +2026,7 @@ Example Usage: For more information, see [MSM multi site login](msm/overview.md#multi-site-login) -### `multiple_sites_enabled` +## `multiple_sites_enabled` Enable Multiple Site Manager. @@ -2043,7 +2041,7 @@ Example Usage: **Also found in CP:** `Settings --> General Settings`: -### `name_of_dictionary_file` +## `name_of_dictionary_file` Filename for the dictionary file. The official dictionary file is [available for download](https://ellislab.com/asset/file/dictionary.zip). Must be used in combination with [allow_dictionary_pw](#allow_dictionary_pw). @@ -2057,7 +2055,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Name of Dictionary File](control-panel/settings/security-privacy.md#dictionary-file) -### `new_member_notification` +## `new_member_notification` Enables notification of a [given notification list](#mbr_notification_emails) for new member registrations. @@ -2072,7 +2070,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Send new member notifications](control-panel/settings/members.md#enable-new-member-notifications) -### `new_posts_clear_caches` +## `new_posts_clear_caches` Set caches to clear when new entries are posted. @@ -2089,7 +2087,7 @@ Example Usage: **Also found in CP:** `Settings --> Content & Design`: [Clear all caches when new entries are posted](control-panel/settings/content-design.md#clear-cache-for-new-entries) -### `new_version_check` +## `new_version_check` Set ExpressionEngine to periodically check for available updates. @@ -2104,7 +2102,7 @@ Example Usage: **Also found in CP:** `Settings --> General Settings`: [New Version Auto Check](control-panel/settings/general.md#new-version-auto-check) -### `newrelic_app_name` +## `newrelic_app_name` Sets the application name that is reported in the New Relic dashboard. If you're using New Relic to monitor the performance of multiple ExpressionEngine installations, you'll likely want those installations to show up separately in your New Relic dashboard. @@ -2120,7 +2118,7 @@ Also available for use in the [site index file](#site-index-file), `index.php`, $assign_to_config['newrelic_app_name'] = 'My Second Site'; -### `newrelic_include_version_number` +## `newrelic_include_version_number` Whether or not to append the version number to the Application name in the New Relic dashboard. @@ -2133,7 +2131,7 @@ Example Usage: $config['newrelic_include_version_number'] = 'y'; -### `parse_variables_query_results_by_default` +## `parse_variables_query_results_by_default` In case you select a table which stores files, the returned value will look like `{file:XX:url}` or have `{filedir_` in front of the file names (when File Manager is in Compatibility mode). In case you select a table which stores site settings, the returned value may have `{base_` variables. To parse both cases by default, enable the following config: @@ -2142,7 +2140,7 @@ In case you select a table which stores files, the returned value will look like | y | Parse variables by default | | n | Do not parse variables by default (default) | -### `password_lockout` +## `password_lockout` If enabled, the system will lock a member account if more than four invalid login attempts are made within a [specified time period](#password_lockout_interval). This is designed to deter hackers from using collision attacks to guess poorly chosen passwords. The account remains locked for the duration of the password lockout time period. @@ -2157,7 +2155,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Enable Password Lockout](control-panel/settings/security-privacy.md#enable-password-lock-out) -### `password_lockout_interval` +## `password_lockout_interval` Set the time period for measuring [invalid login attempts](#password_lockout) and locking accounts. @@ -2171,7 +2169,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Time Interval for Lockout](control-panel/settings/security-privacy.md#password-lock-out-interval) -### `popup_link` +## `popup_link` Specify whether links created by the [Typography class](development/legacy/libraries/typography.md) open in a new window. @@ -2184,7 +2182,7 @@ Example Usage: $config['popup_link'] = 'y'; -### `profile_trigger` +## `profile_trigger` Set the triggering word for the front-end members section. The default is "member", and the word you set cannot be the name of an existing template group. @@ -2198,7 +2196,7 @@ Example Usage: **Also found in CP:** `Settings --> URL and Path Settings`: [Profile Triggering Word](control-panel/settings/urls.md#profile-url-segment) -### `proxy_ips` +## `proxy_ips` Allow list of reverse proxy servers that may forward the visitor's IP address. DEPRECATED. Use [`proxy.php` config file](config/config-files.md#reverse-proxy-ip-addresses) instead. @@ -2211,7 +2209,7 @@ Example Usage: $config['proxy_ips'] = '10.0.1.25, 10.0.1.26'; -### `prv_msg_throttling_period` +## `prv_msg_throttling_period` Set the length of time users must wait between sending private messages. @@ -2225,7 +2223,7 @@ Example Usage: $config['prv_msg_throttling_period'] = '60'; -### `prv_msg_upload_path` +## `prv_msg_upload_path` Set the server path to the private messages uploads directory. @@ -2239,7 +2237,7 @@ Example Usage: **Also found in CP:** `Settings --> Messages`: [Server Path for Attachment Upload Directory](control-panel/settings/messages.md#upload-path) -### `prv_msg_waiting_period` +## `prv_msg_waiting_period` Set the length of time members must wait after registration before being allowed to send private messages. @@ -2253,7 +2251,7 @@ Example Usage: $config['prv_msg_waiting_period'] = '4'; -### `publish_page_title_focus` +## `publish_page_title_focus` Specify whether the title field should gain focus when the publish page is loaded. @@ -2266,7 +2264,7 @@ Example Usage: $config['publish_page_title_focus'] = 'n'; -### `pw_min_len` +## `pw_min_len` Set the minimum number of characters allowed for member passwords. @@ -2280,7 +2278,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Minimum Password Length](control-panel/settings/urls.md#profile-url-segment) -### `recount_batch_total` +## `recount_batch_total` Set the batch size for recounting statistics. @@ -2294,7 +2292,7 @@ Example Usage: $config['recount_batch_total'] = '200'; -### `redirect_method` +## `redirect_method` Set the method the system uses for page redirection. @@ -2309,7 +2307,7 @@ Example Usage: **Also found in CP:** `Settings --> Debugging & Output`: [Redirection Method](control-panel/settings/debug-output.md#redirection-type) -### `redirect_submitted_links` +## `redirect_submitted_links` Apply rank denial to user-submitted links. This feature rewrites links submitted in comments so they first point to an intermediate redirect page, helping deter comment spammers by preventing linked sites from gaining a search engine page rank advantage. @@ -2337,7 +2335,7 @@ Example Usage: 'timeout' => 0 ); -### `relaxed_track_views` +## `relaxed_track_views` Allow [Entry Views Tracking](channels/entry-tracking.md) to work for ANY combination that results in only one entry being returned by the tag, including Channel query caching. @@ -2350,7 +2348,7 @@ Example Usage: $config['relaxed_track_views'] = 'y'; -### `remove_close_all_button` +## `remove_close_all_button` Remove the button to close all HTML tags from the publish page and user-side HTML formatting buttons. Most browsers no longer need it. @@ -2363,7 +2361,7 @@ Example Usage: $config['remove_close_all_button'] = 'y'; -### `remove_unparsed_vars` +## `remove_unparsed_vars` Remove unparsed ExpressionEngine variables upon output when the [debug](#debug) has been set to `0`. @@ -2376,7 +2374,7 @@ Example Usage: $config['remove_unparsed_vars'] = 'y'; -### `req_mbr_activation` +## `req_mbr_activation` Specify whether new member activation is automatic, requires email verification, or requires an administrator's approval. @@ -2392,7 +2390,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Require Member Account Activation](control-panel/settings/members.md#account-activation-type) -### `require_captcha` +## `require_captcha` When enabled, site visitors will be required to pass a CAPTCHA to submit any front-end form, including Channel Form, comment forms, and member registrations. @@ -2403,7 +2401,7 @@ When enabled, site visitors will be required to pass a CAPTCHA to submit any fro **Also found in CP:** `Settings --> CAPTCHA`: [Require CAPTCHA](control-panel/settings/captcha.md#require-captcha) -### `require_ip_for_login` +## `require_ip_for_login` Require users have a valid IP address and browser user agent when logging in. This helps prevent hackers from logging in using direct socket connections or trying to access the system with a masked IP address. @@ -2418,7 +2416,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Require IP Address and User Agent for Login](control-panel/settings/security-privacy.md#require-user-agent-and-ip-for-login) -### `require_ip_for_posting` +## `require_ip_for_posting` Require users have a valid IP address and browser user agent when posting comments or Channel Form entries. @@ -2433,7 +2431,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Require IP Address and User Agent for posting](control-panel/settings/security-privacy.md#require-user-agent-and-ip-for-posting) -### `require_secure_passwords` +## `require_secure_passwords` Require users' passwords to adhere to certain password security policy as implemented by ExpressionEngine. Description of each policy can be found in [Password Security Policy](control-panel/settings/security-privacy.md#password-security-policy) @@ -2450,7 +2448,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Require Secure Passwords](control-panel/settings/security-privacy.md#password-security-policy) -### `require_terms_of_service` +## `require_terms_of_service` Require new members to agree to your terms of service upon registration. @@ -2465,7 +2463,7 @@ Example Usage: **Also found in CP:** `Settings --> Members`: [Require Terms of Service](control-panel/settings/members.md#require-terms-of-service) -### `reserved_category_word` +## `reserved_category_word` If [use_category_name](#use_category_name) is enabled, specify a word to use in category URLs to indicate to the system that the following segment is the category URL title. For example, if the indicator is set to "category" and the category URL title is "blogging": @@ -2483,7 +2481,7 @@ Example Usage: **Also found in CP:** `Settings --> URL and Path Settings`: [Category URL Indicator](control-panel/settings/urls.md#category-url-segment) -### `save_tmpl_files` +## `save_tmpl_files` Enable the saving of templates as files. @@ -2496,7 +2494,7 @@ Example Usage: $config['save_tmpl_files'] = 'y'; -### `save_tmpl_globals` +## `save_tmpl_globals` Enable the saving of template global variables as files. @@ -2509,7 +2507,7 @@ Example Usage: $config['save_tmpl_globals'] = 'y'; -### `save_tmpl_revisions` +## `save_tmpl_revisions` Enable template revisions. Template history is saved when changes are made within the [template editor](control-panel/template-manager.md#edit-template). @@ -2524,7 +2522,7 @@ Example Usage: **Also found in CP:** `Settings --> Template Settings`: [Save Template Revisions](control-panel/settings/template.md#save-template-revisions) -### `sc_certificate_id` +## `sc_certificate_id` Specify the unique ID that is supplied by PayPal after providing them with a [public certificate](https://github.com/ExpressionEngine/Simple-Commerce/blob/main/docs/paypal-settings.md#public-certificate-path). @@ -2538,7 +2536,7 @@ Example Usage: **Also found in CP:** `Developer --> Add-Ons --> Simple Commerce Settings`: [ID Given to Public Certificate by PayPal](https://github.com/ExpressionEngine/Simple-Commerce/blob/main/docs/paypal-settings.md#public-certification-id) -### `sc_encrypt_buttons` +## `sc_encrypt_buttons` Enable encryption for PayPal purchase links and buttons created by Simple Commerce. @@ -2557,7 +2555,7 @@ Example Usage: **Also found in CP:** `Developer --> Add-Ons --> Simple Commerce Settings`: [Encrypt PayPal Buttons and Links? ](https://github.com/ExpressionEngine/Simple-Commerce/blob/main/docs/paypal-settings.md#encrypt-paypal-buttons-and-links) -### `sc_paypal_account` +## `sc_paypal_account` Specify the primary email address associated with the PayPal account processing payments for store purchases. @@ -2571,7 +2569,7 @@ Example Usage: **Also found in CP:** `Developer --> Add-Ons --> Simple Commerce Settings`: [PayPal Account](https://github.com/ExpressionEngine/Simple-Commerce/blob/main/docs/paypal-settings.md#paypal-account-email) -### `sc_paypal_certificate` +## `sc_paypal_certificate` Specify the path to the PayPal-provided certificate file. Please read the section on `simple_commerce_encrypted_payments` for full details. @@ -2587,7 +2585,7 @@ Example Usage: **Also found in CP:** `Developer --> Add-Ons --> Simple Commerce Settings`: [PayPal Certificate Path](https://github.com/ExpressionEngine/Simple-Commerce/blob/main/docs/paypal-settings.md#paypal-certificate-path) -### `sc_private_key` +## `sc_private_key` Specify the path to the private key file. Please read the section on `simple_commerce_encrypted_payments` for full details. @@ -2603,7 +2601,7 @@ Example Usage: **Also found in CP:** `Developer --> Add-Ons --> Simple Commerce Settings`: [Private Key Path](https://github.com/ExpressionEngine/Simple-Commerce/blob/main/docs/paypal-settings.md#private-key-path) -### `sc_public_certificate` +## `sc_public_certificate` Specify the path to the public certificate file. Please read the section on `simple_commerce_encrypted_payments` for full details. @@ -2619,7 +2617,7 @@ Example Usage: **Also found in CP:** `Developer --> Add-Ons --> Simple Commerce Settings`: [Public Certificate Path](https://github.com/ExpressionEngine/Simple-Commerce/blob/main/docs/paypal-settings.md#public-certificate-path) -### `sc_temp_path` +## `sc_temp_path` Specify the path to the temporarily stored encrypted files. Please read the section on `simple_commerce_encrypted_payments` for full details. @@ -2635,7 +2633,7 @@ Example Usage: **Also found in CP:** `Developer --> Add-Ons --> Simple Commerce Settings`: [Temporary Encrypted Files Path](https://github.com/ExpressionEngine/Simple-Commerce/blob/main/docs/paypal-settings.md#temporary-encrypted-files-path) -### `send_headers` +## `send_headers` Specify whether the system should automatically send HTTP page headers when it serves pages to a visitor. @@ -2650,7 +2648,7 @@ Example Usage: **Also found in CP:** `Settings --> Debugging & Output`: [Generate HTTP Page Headers](control-panel/settings/debug-output.md#use-http-page-headers) -### `server_offset` +## `server_offset` When a server's clock is off and you are unable to correct it at the server level, use this preference to correct the disparity. Use a positive integer to correct a server clock that is too slow, and a negative integer to correct a server clock that is too fast. @@ -2664,7 +2662,7 @@ Example Usage: $config['server_offset'] = '-15'; -### `show_profiler` +## `show_profiler` Enable Output Profiler. When enabled, Super Admins will see benchmark results, SQL queries, and submitted form data displayed at the bottom of the browser window. Template debugging is included on the front end. @@ -2679,7 +2677,7 @@ Example Usage: **Also found in CP:** `Settings --> Debugging & Output`: [Display Output Profiler](control-panel/settings/debug-output.md#enable-debugging) -### `sig_allow_img_hotlink` +## `sig_allow_img_hotlink` Specify whether members can link to images hosted on other websites as their signature image for Discussion Forum. @@ -2692,7 +2690,7 @@ Example Usage: $config['sig_allow_img_hotlink'] = 'n'; -### `sig_allow_img_upload` +## `sig_allow_img_upload` Set whether members can upload their own signature image for Discussion Forum. @@ -2705,7 +2703,7 @@ Example Usage: $config['sig_allow_img_upload'] = 'y'; -### `sig_img_max_height` +## `sig_img_max_height` Set the maximum height (in pixels) allowed for user-uploaded signature images in Discussion Forum. @@ -2717,7 +2715,7 @@ Example Usage: $config['sig_img_max_height'] = '150'; -### `sig_img_max_kb` +## `sig_img_max_kb` Set the maximum file size (in kilobytes) allowed for user-uploaded signature images in Discussion Forum. @@ -2729,7 +2727,7 @@ Example Usage: $config['sig_img_max_kb'] = '50'; -### `sig_img_max_width` +## `sig_img_max_width` Set the maximum width (in pixels) allowed for user-uploaded signature images in Discussion Forum. @@ -2741,7 +2739,7 @@ Example Usage: $config['sig_img_max_width'] = '150'; -### `sig_img_path` +## `sig_img_path` Set the server path to the signature images directory. The default path is `{base_path}/images/signature_attachments/` when no override is set. @@ -2753,7 +2751,7 @@ Example Usage: $config['sig_img_path'] = '/path/image/folder/'; -### `sig_img_url` +## `sig_img_url` Set the URL to the signature images directory. The default path is `{base_url}/images/signature_attachments/` when no override is set. @@ -2765,7 +2763,7 @@ Example Usage: $config['sig_img_url'] = 'https://example.com/images/signatures/'; -### `sig_maxlength` +## `sig_maxlength` Set the maximum number of characters allowed in a member's signature for Discussion Forum. @@ -2777,7 +2775,7 @@ Example Usage: $config['sig_maxlength'] = '500'; -### `site_404` +## `site_404` Set which template should be displayed when a visitor tries to access an invalid URL. @@ -2795,7 +2793,7 @@ Also available for use in the [site index file](#site-index-file), `index.php`. **Also found in CP:** `Settings --> Template Settings`: [404 Page](control-panel/settings/template.md#404-page) -### `site_index` +## `site_index` Set the filename of the [site index file](#site-index-file). By default, this will be `index.php`, which is located in the base folder. You will only need to alter this setting if you have changed the filename or you want to [remove index.php from your site's URLs](installation/best-practices.md#removing-indexphp-from-your-urls). @@ -2813,7 +2811,7 @@ Also available for use in the [site index file](#site-index-file), `index.php`. **Also found in CP:** `Settings --> URL and Path Settings`: [Name of your site's index page](control-panel/settings/urls.md#website-index-page) -### `site_name` +## `site_name` Set the short name of the site. The site created upon installation is named `default_site`, so this is typically only helpful for additional sites in [MSM-enabled installations](msm/overview.md). @@ -2827,7 +2825,7 @@ Available for use only in the [site index file](#site-index-file), `index.php`, **Also found in CP:** `Developer --> Site Manager --> Edit` -### `site_url` +## `site_url` Set the full URL to the site's web root. @@ -2845,7 +2843,7 @@ Also available for use in the [site index file](#site-index-file), `index.php`. **Also found in CP:** `Settings --> URL and Path Settings`: [URL to the root directory of your site](control-panel/settings/urls.md#website-root-directory) -### `smart_static_parsing` +## `smart_static_parsing` When enabled, parsing of embedded templates that are not saved as [static templates](control-panel/template-manager.md#create-template) will still be parsed as if they were, if at all possible (i.e. they contain no PHP or ExpressionEngine tags). This setting is enabled by default. @@ -2858,7 +2856,7 @@ Example Usage: $config['smart_static_parsing'] = 'n'; -### `smtp_password` +## `smtp_password` If [mail protocol](#mail_protocol) is set to `smtp`, this sets the password the system will use to authenticate with the SMTP server. This information can be obtained from your email provider. @@ -2872,7 +2870,7 @@ Example Usage: **Also found in CP:** `Settings --> Outgoing Email`: [SMTP Password](control-panel/settings/email.md#password) -### `smtp_port` +## `smtp_port` If [mail protocol](#mail_protocol) is set to `smtp`, this sets the mail server port. This information can be obtained from your email provider. @@ -2884,7 +2882,7 @@ Example Usage: $config['smtp_port'] = '2525'; -### `smtp_server` +## `smtp_server` If [mail protocol](#mail_protocol) is set to `smtp`, this sets the mail server hostname. This information can be obtained from your email provider. @@ -2900,7 +2898,7 @@ Example Usage: **Also found in CP:** `Settings --> Outgoing Email`: [SMTP Server Address](control-panel/settings/email.md#server-address) -### `smtp_username` +## `smtp_username` If [mail protocol](#mail_protocol) is set to `smtp`, this sets the username the system will use to authenticate with the SMTP server. This information can be obtained from your email provider. @@ -2914,7 +2912,7 @@ Example Usage: **Also found in CP:** `Settings --> Outgoing Email`: [SMTP Username](control-panel/settings/email.md#username) -### `spellcheck_language_code` +## `spellcheck_language_code` Set the language used by spell check. @@ -2926,7 +2924,7 @@ Example Usage: $config['spellcheck_language_code'] = 'en'; -### `strict_urls` +## `strict_urls` Set whether the system will allow templates from your default template group to be directly accessed in the first URL segment. If enabled, the system will require that the first URL segment be a valid template group only or a 404 page will be shown. @@ -2941,7 +2939,7 @@ Example Usage: **Also found in CP:** `Settings --> Template Settings`: [Enable Strict URLs](control-panel/settings/template.md#enable-strict-urls) -### `template` +## `template` Sets the default template. Must be used with [template_group](#template_group), and the two overrides together set the template group and template shown on the front-end when the site is loaded without anything in the [URL segments](templates/globals/url-segments.md). @@ -2959,7 +2957,7 @@ Also available for use in the [site index file](#site-index-file), `index.php`. **Also found in CP:** `Developer --> Templates --> New/Edit`: Make the index template in this group your site's home page? -### `template_group` +## `template_group` Sets the default template group. Must be used with [template](#template), and the two overrides together set the template group and template shown on the front-end when the site is loaded without anything in the [URL segments](templates/globals/url-segments.md). @@ -2977,7 +2975,7 @@ Also available for use in the [site index file](#site-index-file), `index.php`. **Also found in CP:** `Developer --> Templates --> New/Edit`: Make the index template in this group your site's home page? -### `theme_folder_path` +## `theme_folder_path` Set the server path to the `themes` directory. @@ -2991,7 +2989,7 @@ Example Usage: **Also found in CP:** `Settings --> URL and Path Settings`: [Theme Folder Path](control-panel/settings/urls.md#themes-path) -### `theme_folder_url` +## `theme_folder_url` Set the URL to the `themes` directory. @@ -3005,7 +3003,7 @@ Example Usage: **Also found in CP:** `Settings --> URL and Path Settings`: [URL to your "themes" folder](control-panel/settings/urls.md#themes-directory) -### `time_format` +## `time_format` Set default time format to either 12- or 24-hour time format. @@ -3018,7 +3016,7 @@ Example Usage: $config['time_format'] = '24'; -### `time_interval` +## `time_interval` Set the time interval for measuring the [number of page loads](#max_page_loads) that will trigger throttling. If you set this preference to 5 page loads within 10 seconds, a user can not browse more than 5 pages within a 10 second interval or the throttling feature will be triggered, locking them out for the given [lockout time](#lockout_time). @@ -3032,7 +3030,7 @@ Example Usage: **Also found in CP:** `Settings --> Access Throttling`: [Time Interval](control-panel/settings/throttling.md#time-interval) -### `tls_crypto_method` +## `tls_crypto_method` Stream encryption method, when using TLS for sending emails over SMTP. @@ -3043,12 +3041,12 @@ Stream encryption method, when using TLS for sending emails over SMTP. | STREAM_CRYPTO_METHOD_TLSv1_2_CLIENT | TLS v1.2 (default) | | STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT | TLS v1.3 (as of PHP 7.4.0) | - + Example Usage: $config['tls_crypto_method'] = STREAM_CRYPTO_METHOD_TLSv1_3_CLIENT; -### `un_min_len` +## `un_min_len` Set the minimum number of characters allowed for member usernames. @@ -3062,7 +3060,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Minimum Username Length](control-panel/settings/security-privacy.md#minimum-username-length) -### `updater_allow_advanced` +## `updater_allow_advanced` Allow advanced options to be displayed during the ExpressionEngine update process. @@ -3076,7 +3074,7 @@ Example Usage: $config['updater_allow_advanced'] = 'y'; -### `upload_blocked_file_names` +## `upload_blocked_file_names` With an array, add a case insensitive list of file names that cannot be uploaded. @@ -3086,7 +3084,7 @@ Example Usage: 'logo.png', ); -### `upload_preferences` +## `upload_preferences` With an associative array, specify upload destination paths, URLs, and titles. @@ -3104,7 +3102,7 @@ Example Usage: **Also found in CP:** `Files`: [Edit Upload Destination](control-panel/file-manager/upload-directories.md#createedit-upload-directory) -### `uri_protocol` +## `uri_protocol` Specify which server global should be used to retrieve the URI string. The default setting of `AUTO` works for most servers. [Learn more](https://www.php.net/manual/en/reserved.variables.server.php) about these server globals. @@ -3120,7 +3118,7 @@ Example Usage: $config['uri_protocol'] = 'PATH_INFO'; -### `use_category_name` +## `use_category_name` Set the system to generate category links with category URL titles rather than the numeric category indicator (e.g. `/C12/`). @@ -3135,7 +3133,7 @@ Example Usage: **Also found in CP:** `Settings --> URL and Path Settings`: [Use Category URL Titles In Links? ](control-panel/settings/urls.md#category-url) -### `use_forum_url` +## `use_forum_url` Set the system to use the forum URL specified in the [forum board preferences](https://github.com/ExpressionEngine/Forum/blob/main/docs/boards.md#forum-url) rather than the [the main site URL](#site_url) to form the forum's URL. @@ -3148,7 +3146,7 @@ Example Usage: $config['use_forum_url'] = 'y'; -### `use_newrelic` +## `use_newrelic` When enabled, New Relic will add [Real User Monitoring JavaScript](https://docs.newrelic.com/docs/browser/browser-monitoring/getting-started/introduction-browser-monitoring) to all ExpressionEngine-powered pages on both the front-end and in the CP. @@ -3161,7 +3159,7 @@ Example Usage: $config['use_newrelic'] = 'y'; -### `webmaster_email` +## `webmaster_email` Set the site's return email address for auto-generated emails. @@ -3175,7 +3173,7 @@ Example Usage: **Also found in CP:** `Settings --> Outgoing Email`: [Return email address for auto-generated emails](control-panel/settings/email.md#address) -### `webmaster_name` +## `webmaster_name` Set the _From_ name for auto-generated emails. @@ -3198,7 +3196,7 @@ Set TTL for frontend sessions. | integer | Session TTL in seconds (default is 7200 - 2 hours) | -### `website_session_type` +## `website_session_type` Specify how sessions are handled on the front-end of the site. @@ -3214,7 +3212,7 @@ Example Usage: **Also found in CP:** `Settings --> Security & Privacy`: [Website Session Type](control-panel/settings/security-privacy.md#website-session-type) -### `week_start` +## `week_start` Set the day on which the new week starts. If [allow_member_localization](#allow_member_localization) is enabled and a member has their own localization preference set, that will override this setting. @@ -3229,7 +3227,7 @@ Example Usage: $config['week_start'] = 'monday'; -### `word_separator` +## `word_separator` Specify the character the system will use to replace spaces when auto-generating a URL title based on the entry's title. @@ -3244,7 +3242,7 @@ Example Usage: **Also found in CP:** `Settings --> URL and Path Settings`: [Word Separator for URL Titles](control-panel/settings/urls.md#url-title-separator) -### `x_frame_options` +## `x_frame_options` Set the `X-Frame-Options` header to control where your site can be included in frames or iframes. This setting only affects the frontend of the site. The control panel will always use the default "SAMEORIGIN". @@ -3254,7 +3252,7 @@ Set the `X-Frame-Options` header to control where your site can be included in f | SAMEORIGIN | Only allow framing from the site itself (default) | | DENY | Do not allow framing of any sort | -### `xml_lang` +## `xml_lang` Set the default XML language, typically used when outputting RSS feeds. Feeds will identify themselves as having the language specified here. @@ -3266,7 +3264,7 @@ Example Usage: $config['xml_lang'] = 'en'; -### `xss_clean_member_exception` +## `xss_clean_member_exception` Specify member IDs to exclude from XSS cleaning. @@ -3278,7 +3276,7 @@ Example Usage: $config['xss_clean_member_exception'] = '3, 14, 83'; -### `xss_clean_member_group_exception` +## `xss_clean_member_group_exception` Specify member role IDs to exclude from XSS cleaning. diff --git a/docs/installation/changelog.md b/docs/installation/changelog.md index 86627a8e4..1b83c6821 100755 --- a/docs/installation/changelog.md +++ b/docs/installation/changelog.md @@ -8,7 +8,7 @@ --> # ExpressionEngine v7 Change Log -# Version 7.5.6 +## Version 7.5.6 (Release: December 10th, 2024)
@@ -43,7 +43,7 @@ - Resolved an issue where the tmpfile fallback is called - Resolved an issue with false positives in file upload checks -# Version 7.5.5 +## Version 7.5.5 (Release: November 20th, 2024)
@@ -72,7 +72,7 @@ - Resolved [#4588](https://github.com/ExpressionEngine/ExpressionEngine/issues/4588) where copying field code would not work when CP session type was set to session only - Resolved an issue with deleting a member through modal window -# Version 7.5.4 +## Version 7.5.4 (Release: November 14th, 2024) NOTE: **Important:** This version includes important security updates. @@ -97,7 +97,7 @@ NOTE: **Important:** This version includes important security updates. - Resolved [#4500](https://github.com/ExpressionEngine/ExpressionEngine/issues/4500) where the "New entry" dropdown was shown even when the limit of entries was reached - Fix PHP deprecation in the file module -# Version 7.5.3 +## Version 7.5.3 (Release: November 6th, 2024) NOTE: **Important:** This version includes important security updates. @@ -132,7 +132,7 @@ NOTE: **Important:** This version includes important security updates. - Fixed [icon position](https://github.com/ExpressionEngine/ExpressionEngine/pull/4541) for required field in grid field body - Fixed frontedit js error (contentWindow is undefined) -# Version 7.5.2 +## Version 7.5.2 (Release: October 29, 2024) - **Contributors** 🙌 @@ -165,7 +165,7 @@ NOTE: **Important:** This version includes important security updates. - Resolved [#4512](https://github.com/ExpressionEngine/ExpressionEngine/issues/4512) where there was an issue with multiple MiniGridInputs - Resolved [#4493](https://github.com/ExpressionEngine/ExpressionEngine/issues/4493) where PHP Deprecation was shown when using `show_overview` parameter in Structure -# Version 7.5.1 +## Version 7.5.1 (Release: October 15, 2024) - **Contributors** 🙌 @@ -188,7 +188,7 @@ NOTE: **Important:** This version includes important security updates. - Restore field_name_badge view that may be used by Third Party Add-ons - Fixed [#4490](https://github.com/ExpressionEngine/ExpressionEngine/issues/4490) Typo -# Version 7.5.0 +## Version 7.5.0 (Release: October 15, 2024) - **Contributors** 🙌 @@ -229,7 +229,7 @@ NOTE: **Important:** This version includes important security updates. - Fix bug where adding new fields to field group in fluid would not allow existing entries to accept content for that field [#3741](https://github.com/ExpressionEngine/ExpressionEngine/issues/3741) - Fixed possible PHP warnings in Pro Search keyword handling -# Version 7.4.11 +## Version 7.4.11 (Release: June 13, 2024) NOTE: **Important:** This version includes important security updates. @@ -261,7 +261,7 @@ NOTE: **Important:** This version includes important security updates. - Resolved [#4298](https://github.com/ExpressionEngine/ExpressionEngine/issues/4298) error backing up table with set type column - Resolved PHP warnings in Pro Search -# Version 7.4.10 +## Version 7.4.10 (Release: May 21, 2024) - **Contributors** 🙌 @@ -299,7 +299,7 @@ NOTE: **Important:** This version includes important security updates. - Resolved [#4201](https://github.com/ExpressionEngine/ExpressionEngine/issues/4201) where limit was not applied to memberlist tag when pagination variables not present - Resolved [#4217](https://github.com/ExpressionEngine/ExpressionEngine/issues/4217) where image thumbnails were cached after replacement -# Version 7.4.9 +## Version 7.4.9 (Release: April 23, 2024) - **Contributors** 🙌 @@ -308,7 +308,6 @@ NOTE: **Important:** This version includes important security updates.
@@ -323,7 +322,7 @@ NOTE: **Important:** This version includes important security updates. - Resolved [#4246](https://github.com/ExpressionEngine/ExpressionEngine/issues/4246) where using `*` could result in invalid URL Title being generated programmatically - Resolved [#4197](https://github.com/ExpressionEngine/ExpressionEngine/issues/4197) sql error from saving invalid entry with member -# Version 7.4.8 +## Version 7.4.8 (Release: April 18, 2024) - **Contributors** 🙌 @@ -345,7 +344,7 @@ NOTE: **Important:** This version includes important security updates. - Resolved [#4187](https://github.com/ExpressionEngine/ExpressionEngine/issues/4187) where Pro Variables tag was causing a warning - Resolved issue where an entry without structure parent fails validation -# Version 7.4.7 +## Version 7.4.7 (Release: April 15, 2024) - **Contributors** 🙌 @@ -694,8 +693,7 @@ NOTE: **Important:** This version includes important security updates.

  • Yulyaswan

    @Yulyaswan

  • Yuri Salimovskiy

    @intoeetive

  • swierczek

    @swierczek

    • - - +
    @@ -725,8 +723,7 @@ NOTE: **Important:** This version includes important security updates.

  • Yuri Salimovskiy

    @intoeetive

  • robinsowell

    @robinsowell

  • Brad Akin

    @bakin1999

    • - - + @@ -756,8 +753,7 @@ NOTE: **Important:** This version includes important security updates.

  • Yuri Salimovskiy

    @intoeetive

  • robinsowell

    @robinsowell

  • Yulya Lebed

    @Yulyaswan

    • - - + @@ -1459,7 +1455,7 @@ NOTE: **Important:** This version includes important security updates.
    - - **Enhancements** 🚀 - Added ability to set template engine in template manager @@ -1544,7 +1539,6 @@ NOTE: **Important:** This version includes important security updates. - Added per-channel setting for entry title instructions; [#1790](https://github.com/ExpressionEngine/ExpressionEngine/issues/1790) - Updated custom add-on development methodology. (See [Add-on Development Overview](/development/addon-development-overview.md) ) - - **Bug Fixes** 💃🐛 - Resolved [#2500](https://github.com/ExpressionEngine/ExpressionEngine/issues/2500) where reordering Grid with images had some issues - Resolved [#791](https://github.com/ExpressionEngine/ExpressionEngine/issues/791) where deleting tab when editing publish layout could cause page reload @@ -1583,8 +1577,6 @@ NOTE: **Important:** This version includes important security updates. - Increased performance of File Manager when attempting to load thousands of files. ([#2564](https://github.com/ExpressionEngine/ExpressionEngine/issues/2564)) - Added confirmation toggle to keep or remove files when removing upload directory. ([#2623](https://github.com/ExpressionEngine/ExpressionEngine/issues/2623)) - - - **Bug Fixes** 💃🐛 - Resolved [#2577](https://github.com/ExpressionEngine/ExpressionEngine/issues/2577) where Control Panel entry pages have missing .map files. - Resolved [#1541](https://github.com/ExpressionEngine/ExpressionEngine/issues/1541) where permission check for editing categories was not sufficient. @@ -1594,12 +1586,9 @@ NOTE: **Important:** This version includes important security updates. - Resolved [#2621](https://github.com/ExpressionEngine/ExpressionEngine/issues/2621) where `{exp:channel:entries orderby="view_count_one"}` when used on category page could throw error on MySQL 5.7. - Resolved [#2500](https://github.com/ExpressionEngine/ExpressionEngine/issues/2500) Where grid reordering with images is buggy. - - **Developers** 💻 - Them template type hook is now called only when EE is fully loaded. - - ## Version 7.2.3 (Release: December 6, 2022) @@ -1622,7 +1611,6 @@ NOTE: **Important:** This version includes important security updates. - Resolved [#2553](https://github.com/ExpressionEngine/ExpressionEngine/issues/2553) where `{exp:channel:entries}` output could miss some results on MSM installations with duplicate channel names. - Resolved form validation bug in the CLI. - ## Version 7.2.2 (Release: November 28, 2022) @@ -1666,11 +1654,9 @@ NOTE: **Important:** This version includes important security updates. - - **Developers** 💻 - Allow raw data to be set on template library. - ## Version 7.2.0 (Release: October 26, 2022) diff --git a/search.config.json b/search.config.json index eff5cfacf..68aeec7c4 100644 --- a/search.config.json +++ b/search.config.json @@ -16,7 +16,7 @@ }, { "url": "https://docs.expressionengine.com/latest/control-panel", - "page_rank": 5 + "page_rank": 50 }, { "url": "https://docs.expressionengine.com/latest/channels", @@ -98,19 +98,13 @@ "lvl3": "#docsearch-content h4", "lvl4": "#docsearch-content h5", "lvl5": "#docsearch-content h6", - "text": "#docsearch-content > article > *:not(section), #docsearch-content > article > section > *:not(pre)" + "content": "#docsearch-content > article > *:not(section), #docsearch-content > article > section > *:not(pre)" }, "custom_settings": { "displayedAttributes": [ "*" ], "searchableAttributes": [ - "hierarchy_radio_lvl0", - "hierarchy_radio_lvl1", - "hierarchy_radio_lvl2", - "hierarchy_radio_lvl3", - "hierarchy_radio_lvl4", - "hierarchy_radio_lvl5", "hierarchy_lvl0", "hierarchy_lvl1", "hierarchy_lvl2", diff --git a/theme/doc-page-template.html b/theme/doc-page-template.html index 732a99ec5..661fd4e5a 100755 --- a/theme/doc-page-template.html +++ b/theme/doc-page-template.html @@ -137,7 +137,6 @@

    Community

    indexUid: "{{docsearch_index}}", searchParams: { distinct: "hierarchy_lvl1", - attributesToSearchOn: ["content","hierarchy_lvl1"], } }); From 6f28f0457e8a0786b33b67db071eecad2e32e2d7 Mon Sep 17 00:00:00 2001 From: Bryan Nielsen Date: Thu, 9 Jan 2025 09:17:02 -0500 Subject: [PATCH 4/6] Cleanup github workflows --- .github/workflows/build.yml | 50 +-------------------------- .github/workflows/publish-prod.yml | 40 --------------------- .github/workflows/publish-staging.yml | 40 --------------------- .github/workflows/search.yml | 2 +- 4 files changed, 2 insertions(+), 130 deletions(-) delete mode 100644 .github/workflows/publish-prod.yml delete mode 100644 .github/workflows/publish-staging.yml diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml index 8fbb73855..538b1b856 100644 --- a/.github/workflows/build.yml +++ b/.github/workflows/build.yml @@ -3,7 +3,6 @@ name: Build Docs on: push: branches: - - feature/docsearch - 7.x - 7.dev @@ -43,51 +42,4 @@ jobs: uses: actions/upload-artifact@v4 with: name: EEDocs7.latest - path: build - - - name: Zip the docs - uses: montudor/action-zip@v1 - with: - args: zip -qq -r EEDocs7.latest.zip build - -# search: -# name: Build Search Index -# needs: build -# runs-on: ubuntu-latest -# steps: -# - name: Checkout code -# uses: actions/checkout@v2 - -# - name: Setup Variables -# run: | -# if [[ "${{github.base_ref}}" == "7.x" || "${{github.ref}}" == "refs/heads/7.x" ]]; then -# echo "DOCS_URL=https://docs.expressionengine.com/latest" >> "$GITHUB_ENV" -# else -# echo "::add-mask::${{secrets.STAGING_DOCS_DOMAIN}}" -# echo "DOCS_URL=${{secrets.STAGING_DOCS_URL}}" >> "$GITHUB_ENV" -# fi - -# - name: Configure Docsearch Index -# uses: richardrigutins/replace-in-files@v2 -# with: -# search-text: "\"index_uid\": \"expressionengine\"" -# replacement-text: "\"index_uid\": \"${{ needs.build.outputs.DOCSEARCH_INDEX }}\"" -# files: ./search.config.json - -# - name: Configure Docs Url -# uses: richardrigutins/replace-in-files@v2 -# with: -# search-text: "https://docs.expressionengine.com/latest" -# replacement-text: ${{ env.DOCS_URL }} -# files: ./search.config.json - -# - name: Scrape Docs -# env: -# HOST_URL: ${{ secrets.MEILISEARCH_HOST_URL }} -# API_KEY: ${{ secrets.MEILISEARCH_API_KEY }} -# run: | -# docker run -t --rm \ -# -e MEILISEARCH_HOST_URL=$HOST_URL \ -# -e MEILISEARCH_API_KEY=$API_KEY \ -# -v ./search.config.json:/docs-scraper/search.config.json \ -# getmeili/docs-scraper:latest pipenv run ./docs_scraper search.config.json + path: build \ No newline at end of file diff --git a/.github/workflows/publish-prod.yml b/.github/workflows/publish-prod.yml deleted file mode 100644 index afe4ad2d3..000000000 --- a/.github/workflows/publish-prod.yml +++ /dev/null @@ -1,40 +0,0 @@ -name: Publish to Staging - -on: - push: - branches: - - 6.x - -jobs: - build: - name: Build the HTML - runs-on: ubuntu-latest - steps: - - - name: Checkout code - uses: actions/checkout@v2 - - - name: Install NPM and build - run: | - npm install - npm run build - - - name: Zip the docs - uses: montudor/action-zip@v1 - with: - args: zip -qq -r EEDocs6.latest.zip build - - - name: Move the zip - run: | - mkdir build/downloads - mv EEDocs6.latest.zip build/downloads/EEDocs6.latest.zip - - - name: Rsync to Staging - uses: Burnett01/rsync-deployments@5.1 - with: - switches: -avz - path: build/ - remote_path: ${{ secrets.DOCS_PATH }} - remote_host: ${{ secrets.DOCS_HOST }} - remote_user: ${{ secrets.DOCS_USER }} - remote_key: ${{ secrets.DOCS_USER_ID_RSA }} diff --git a/.github/workflows/publish-staging.yml b/.github/workflows/publish-staging.yml deleted file mode 100644 index c8634ccc2..000000000 --- a/.github/workflows/publish-staging.yml +++ /dev/null @@ -1,40 +0,0 @@ -name: Publish to Staging - -on: - push: - branches: - - 6.dev - -jobs: - build: - name: Build the HTML - runs-on: ubuntu-latest - steps: - - - name: Checkout code - uses: actions/checkout@v2 - - - name: Install NPM and build - run: | - npm install - npm run build - - - name: Zip the docs - uses: montudor/action-zip@v1 - with: - args: zip -qq -r EEDocs6.latest.zip build - - - name: Move the zip - run: | - mkdir build/downloads - mv EEDocs6.latest.zip build/downloads/EEDocs6.latest.zip - - - name: Rsync to Staging - uses: Burnett01/rsync-deployments@5.1 - with: - switches: -avz - path: build/ - remote_path: ${{ secrets.DOCS_PATH_STAGING }} - remote_host: ${{ secrets.DOCS_HOST_STAGING }} - remote_user: ${{ secrets.DOCS_USER }} - remote_key: ${{ secrets.DOCS_USER_ID_RSA }} diff --git a/.github/workflows/search.yml b/.github/workflows/search.yml index c11de52a9..314856d97 100644 --- a/.github/workflows/search.yml +++ b/.github/workflows/search.yml @@ -1,4 +1,4 @@ -name: search +name: Update Search on: workflow_dispatch: From 1c316e68b3ab1b99e6da26a2ed4045f650f30f2b Mon Sep 17 00:00:00 2001 From: Matt Johnson Date: Mon, 13 Jan 2025 10:31:39 -0800 Subject: [PATCH 5/6] Split up superadmins into two words --- docs/comment/form.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/comment/form.md b/docs/comment/form.md index 73b8d11c8..ec8c696a9 100755 --- a/docs/comment/form.md +++ b/docs/comment/form.md @@ -248,7 +248,7 @@ For members without administrative access, in order to edit a comment they must Comment moderators may close the comment. The edit time limit does not apply to moderators. -Superadmins will always have {editable} and {can_moderate_comment} permissions on any comment. +Super admins will always have {editable} and {can_moderate_comment} permissions on any comment. ### Customizing Client-Side Code From b1db1d9bb2d9fb718124c34e7a7a221f08759e67 Mon Sep 17 00:00:00 2001 From: Matt Johnson Date: Mon, 13 Jan 2025 10:36:11 -0800 Subject: [PATCH 6/6] Fix spelling mistake --- docs/config/config-files.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/docs/config/config-files.md b/docs/config/config-files.md index 0bbc83e6a..7c17cdc5f 100644 --- a/docs/config/config-files.md +++ b/docs/config/config-files.md @@ -47,7 +47,7 @@ The mime types are grouped by file type. You can add the allowed mime types dire `proxy.php` -If the server is behind a reverse proxy or load balancer the system will need special configuration to discover a user's real IP address. If the IP address passed along by the server matches a value or range specificed in this configuration file the system will look at the request headers to determine the real IP address. +If the server is behind a reverse proxy or load balancer the system will need special configuration to discover a user's real IP address. If the IP address passed along by the server matches a value or range specified in this configuration file the system will look at the request headers to determine the real IP address. Please consult with the provider of your reverse proxy or load balancing solutions for the IP addresses or ranges to use. Some providers will let you know the exact IP address of the load balancer, while others will give you a range. Here are the links with information for some common providers: [CloudFlare](https://www.cloudflare.com/ips/), [Google Cloud](https://cloud.google.com/load-balancing/docs/https/#firewall_rules), [AWS Elastic](https://docs.aws.amazon.com/elasticloadbalancing/latest/network/network-load-balancers.html)