Add Block Control documentation

Author: MatzeKitt

.vitepress/config.mts

@@ -121,6 +121,48 @@ export default defineConfig({
       provider: 'local',
     },
     sidebar: {
+      '/block-control/': [
+        {
+          text: 'Block Control',
+          items: [
+            { text: 'Installation', link: '/block-control/installation' },
+            {
+              text: 'Getting started',
+              link: '/block-control/getting-started',
+            },
+            { text: 'System requirements', link: '/block-control/system-requirements' },
+            { text: 'Changelog', link: '/block-control/changelog' },
+          ],
+        },
+        {
+          text: 'Developer',
+          items: [
+            { text: 'Filters', link: '/block-control/developer/filters' },
+            { text: 'Block filters', link: '/block-control/developer/block-filters' },
+          ]
+        },
+      ],
+      '/de/block-control/': [
+        {
+          text: 'Block Control',
+          items: [
+            { text: 'Installation', link: '/de/block-control/installation' },
+            {
+              text: 'Erste Schritte',
+              link: '/de/block-control/getting-started',
+            },
+            { text: 'Systemanforderungen', link: '/de/block-control/system-requirements' },
+            { text: 'Änderungsprotokoll', link: '/de/block-control/changelog' },
+          ],
+        },
+        {
+          text: 'Entwickler',
+          items: [
+            { text: 'Filter', link: '/de/block-control/developer/filters' },
+            { text: 'Block-Filter', link: '/de/block-control/developer/block-filters' },
+          ]
+        },
+      ],
       '/de/embed-privacy/': [
         {
           text: 'Embed Privacy',

block-control/changelog.md

@@ -0,0 +1,106 @@
+# Changelog
+
+## Version 1.5.1 <Badge type="info" text="December 14, 2025" />
+
+* Fixed: A block with a start date to hide in the future and with an end date will now correctly be hidden between those two dates
+
+## Version 1.5.0 <Badge type="info" text="May 13, 2025" />
+
+* Added: Option to hide based on a numbered page (e.g. in archives)
+
+## Version 1.4.1 <Badge type="info" text="December 7, 2024" />
+
+* We added an indeterminate visual display of the "All" checkbox, e.g. while selecting posts.
+* We fixed displaying post type visibility settings inside the site editor.
+
+## Version 1.4.0 <Badge type="info" text="November 5, 2024" />
+
+* We added the possibility to hide inline text for everyone but screen readers.
+
+## Version 1.3.0 <Badge type="info" text="August 30, 2024" />
+
+* We added the possibility to patterns to hide them by any post type available.
+* We extended the list of ignored post types with font families and font faces.
+
+## Version 1.2.0 <Badge type="info" text="August 6, 2024" />
+
+* We added the option to disable blocks for screen readers. That means that the block is still visible, but will be ignored by screen readers entirely.
+
+## Version 1.1.12 <Badge type="info" text="December 11, 2023" />
+
+* We fixed all variants of hide by date setting to be properly checked.
+
+## Version 1.1.11 <Badge type="info" text="November 10, 2023" />
+
+* We fixed the hide by date setting if only one of the dates is used.
+
+## Version 1.1.10 <Badge type="info" text="October 31, 2023" />
+
+* We fixed the hide by date setting if both settings are in the future or both are in the past.
+* We improved the settings for hide by date for better accessibility and functionality.
+
+## Version 1.1.9 <Badge type="info" text="August 26, 2023" />
+
+* We fixed a problem with some blocks no more saving the visibility settings.
+
+## Version 1.1.8 <Badge type="info" text="August 8, 2023" />
+
+* We fixed a problem with broken blocks after updating to version 1.1.7. The editor now doesn't contain any classes from Block Control anymore.
+
+## Version 1.1.7 <Badge type="info" text="August 1, 2023" />
+
+* We fixed compatibility with dynamic blocks.
+
+## Version 1.1.6 <Badge type="info" text="June 1, 2023" />
+
+* We improved the ability to use the filter `blockControl.unsupportedBlocks` without needing to load the own JavaScript early.
+
+## Version 1.1.5 <Badge type="info" text="April 25, 2023" />
+
+* We added a filter `blockControl.unsupportedBlocks` to filter the list of unsupported blocks.
+* We disabled Block Control for the SimpleTOC block in order to display it properly in the backend.
+
+## Version 1.1.4 <Badge type="info" text="April 5, 2023" />
+
+* We disabled Block Control for the Polylang language switcher in order to display it properly in the backend.
+
+## Version 1.1.3 <Badge type="info" text="November 5, 2022" />
+
+* We added full support for WordPress 6.1 (replaced a deprecated function).
+
+## Version 1.1.2 <Badge type="info" text="October 3, 2022" />
+
+* We fixed a potential error in blocks in the widget area.
+
+## Version 1.1.1 <Badge type="info" text="July 7, 2022" />
+
+* We fixed a dependency problem, which may result in preventing the settings panel to appear.
+
+## Version 1.1.0 <Badge type="info" text="May 28, 2022" />
+
+* Since the originally planned Pro version will never be completed, we decided to merge its code into the free version of Block Control.
+* Hide blocks based on roles
+* Hide blocks based on dates
+* Hide blocks based on page types (`is_home`, `is_page`, etc.)
+* Hide blocks based on posts of the current post type (useful especially for reusable blocks)
+
+## Version 1.0.4 <Badge type="info" text="December 14, 2021" />
+
+* We fixed a problem with assets loading in the backend
+
+## Version 1.0.3 <Badge type="info" text="June 15, 2021" />
+
+* We fixed a problem while checking for block attributes
+
+## Version 1.0.2 <Badge type="info" text="December 31, 2020" />
+
+* We fixed a problem that may load multiple editor scripts in the frontend even if they are not needed there
+* We fixed a problem where Block Control options won’t be available for certain blocks
+
+## Version 1.0.1 <Badge type="info" text="August 28, 2019" />
+
+* We fixed the internationalization for all strings
+
+## Version 1.0.0 <Badge type="info" text="August 27, 2019" />
+
+* Initial release

block-control/developer/block-filters.md

@@ -0,0 +1,10 @@
+# Block filters
+
+## `blockControl.unsupportedBlocks` <Badge type="info" text="Since 1.1.5" />
+
+Through the filter `blockControl.unsupportedBlocks` the list of unsupported blocks can be filtered.
+
+Parameters:  
+string[] List of unsupported block names
+
+Expects an array.

block-control/developer/filters.md

@@ -0,0 +1,10 @@
+# Filters
+
+## `block_control_ignored_post_types` <Badge type="info" text="Since 1.1.0" />
+
+Through the filter `block_control_ignored_post_types` the post types to ignore in the block sidebar can be changed.
+
+Parameters:
+string[] $ignored_post_types List of ignored post types
+
+Expects an array.

block-control/getting-started.md

@@ -0,0 +1,39 @@
+# Getting started
+
+After installing the plugin you can find the entry Block Control in the plugin overview – in **Plugins** menu entry of the WordPress backend. You can activate the plugin through this entry.
+
+After activating Block Control, you can find a new panel on every block in the block sidebar, called “Visibility”, where you can hide this block under certain conditions. Block Control does not hide blocks via CSS, it disabled the output of the block altogether. That’s why it’s not compatible with caching systems that cannot distinguish between those settings (e.g. different caches for different device types or user roles).
+
+Also, you can find a formatting setting in rich text areas where you can format text to mark the text as “Screen Reader Text”, which hides it visually and only reads it for screen readers.
+
+## Device types
+
+You can hide the block for desktop as well as mobile users, or only for screen readers. The latter does not hide the block visually, but only for assistive technology.
+
+The detection for mobile users takes place solely via the browser’s user agent.
+
+## Login status
+
+You can hide the block for all logged in or logged out users.
+
+## Date
+
+You can hide the block based on dates. If you just define the “hide date”, the block will be starting being hidden from this date on. If you also define the “start date”, the block will not be hidden after this date anymore.
+
+If you only define a “start date”, the block will be hidden until this date.
+
+## User roles
+
+You can hide the block for any user role registered in your WordPress instance. You can also select multiple roles at once.
+
+## Specific page types
+
+You can hide the block for specific page types, which are technically unique in WordPress, such as the blog page, the front page, categories, etc.
+
+## Numbered pages
+
+You can hide the block for numbered pages, e.g. certain pages in an archive list. There are some pre-defined values, but you can also specifically define the page numbers on where to hide the block.
+
+## Post type
+
+You can hide the block on certain items of the current post type. If you edit a page, you can define pages here. If you edit a blog post, you can define blog posts here. If you use the visibility settings in the site editor or the widget area, all registered post types will be shown (except for certain system post types, e.g. navigation menu items, block patterns, etc.).

block-control/index.md

@@ -0,0 +1,5 @@
+# Block Control
+
+With Block Control, you can set conditions to blocks in the block editor to hide them based on these conditions. It is compatible with every block out of the box, not only with those shipping with WordPress, but also from custom block coming from plugins.
+
+<a class="epiphyt-button is-primary" href="https://wordpress.org/plugins/block-control/">Download Block Control</a>

block-control/installation.md

@@ -0,0 +1,14 @@
+# Installation
+
+First, download Block Control from WordPress.org:
+
+<a class="epiphyt-button is-primary" href="https://wordpress.org/plugins/block-control/">Download Block Control</a>
+
+## Installation through the backend
+
+You can uploaded the downloaded `.zip` file directly in your WordPress backend. You will need a user account with administrator permissions (or super administrator permissions in multisite installations). As soon as you’re logged in, you can find the entry **Plugins > Install** in the menu. You can upload the `.zip` file on this page by clicking on the button “Upload plugin” alongside the headline.
+
+## Installation through FTP
+
+To install the downloaded `.zip` file through (S)FTP, you first need to extract it and upload the files and folders with an FTP program of your choice onto your website.  
+After the upload, they should be found in `wp-content/plugins/block-control`.

block-control/system-requirements.md

@@ -0,0 +1,4 @@
+# System requirements
+
+* WordPress: Version 6.2 or newer
+* PHP: Version 5.6 or newer

de/block-control/changelog.md

@@ -0,0 +1,106 @@
+# Änderungsprotokoll
+
+## Version 1.5.1 <Badge type="info" text="14. Dezember 2025" />
+
+* Behoben: Ein Block mit einem Startdatum zum Ausblenden in der Zukunft und mit einem Enddatum wird jetzt korrekt zwischen diesen beiden Daten ausgeblendet
+
+## Version 1.5.0 <Badge type="info" text="13. Mai 2025" />
+
+* Hinzugefügt: Option zum Ausblenden basierend auf einer nummerierten Seite (z. B. in Archiven)
+
+## Version 1.4.1 <Badge type="info" text="7. Dezember 2024" />
+
+* Wir haben eine unbestimmte visuelle Anzeige des Kontrollkästchens „Alle“ hinzugefügt, z. B. bei der Auswahl von Beiträgen.
+* Wir haben die Anzeige der Sichtbarkeitseinstellungen für Inhaltstypen im Website-Editor korrigiert.
+
+## Version 1.4.0 <Badge type="info" text="5. November 2024" />
+
+* Wir haben die Möglichkeit hinzugefügt, Inline-Text für alle außer Screenreader auszublenden.
+
+## Version 1.3.0 <Badge type="info" text="30. August 2024" />
+
+* Wir haben den Vorlagen die Möglichkeit gegeben, sie nach jedem verfügbaren Inhaltstyp auszublenden.
+* Wir haben die Liste der ignorierten Inhaltstypen mit Schriftfamilien und Schriftarten erweitert.
+
+## Version 1.2.0 <Badge type="info" text="6. August 2024" />
+
+* Wir haben die Option hinzugefügt, Blöcke für Screenreader zu deaktivieren. Das bedeutet, dass der Block immer noch sichtbar ist, aber von Screenreadern komplett ignoriert wird.
+
+## Version 1.1.12 <Badge type="info" text="11. Dezember 2023" />
+
+* Wir haben alle Variationen der Einstellung zum Ausblenden nach Datum korrigiert, sodass sie korrekt überprüft werden.
+
+## Version 1.1.11 <Badge type="info" text="10. November 2023" />
+
+* Wir haben die Einstellung zum Ausblenden nach Datum korrigiert, wenn nur ein Datum verwendet wird.
+
+## Version 1.1.10 <Badge type="info" text="31. Oktober 2023" />
+
+* Wir haben die Einstellung zum Ausblenden nach Datum korrigiert, wenn beide Einstellungen in der Zukunft oder in der Vergangenheit liegen.
+* Wir haben die Einstellungen für das Ausblenden nach Datum für bessere Barrierefreiheit und Funktionalität verbessert.
+
+## Version 1.1.9 <Badge type="info" text="26. August 2023" />
+
+* Wir haben ein Problem behoben, bei dem einige Blöcke die Sichtbarkeitseinstellungen nicht mehr speichern.
+
+## Version 1.1.8 <Badge type="info" text="8. August 2023" />
+
+* Wir haben ein Problem mit kaputten Blöcken nach der Aktualisierung auf Version 1.1.7 behoben. Der Editor beinhaltet jetzt keine Klassen mehr von Block Control.
+
+## Version 1.1.7 <Badge type="info" text="1. August 2023" />
+
+* Wir haben die Kompatibilität mit dynamischen Blöcken korrigiert.
+
+## Version 1.1.6 <Badge type="info" text="1. Juni 2023" />
+
+* Wir haben die Möglichkeit verbessert, den Filter `blockControl.unsupportedBlocks` zu benutzen, ohne das eigene JavaScript früh laden zu müssen.
+
+## Version 1.1.5 <Badge type="info" text="25. April 2023" />
+
+* Wir haben einen Filter `blockControl.unsupportedBlocks` hinzugefügt, um die Liste der nicht unterstützten Blöcke zu filtern.
+* Wir haben Block Control für den SimpleTOC-Block deaktiviert, damit dieser im Backend korrekt angezeigt wird.
+
+## Version 1.1.4 <Badge type="info" text="5. April 2023" />
+
+* Wir haben Block Control für den Polylang-Sprachwechsler deaktiviert, damit dieser im Backend korrekt angezeigt wird.
+
+## Version 1.1.3 <Badge type="info" text="5. November 2022" />
+
+* Wir haben die vollständige Unterstützung für WordPress 6.1 hinzugefügt (eine veraltete Funktion ersetzt).
+
+## Version 1.1.2 <Badge type="info" text="3. Oktober 2022" />
+
+* Wir haben einen potenziellen Fehler in Blöcken innerhalb des Widget-Bereichs behoben.
+
+## Version 1.1.1 <Badge type="info" text="7. Juli 2022" />
+
+* Wir haben ein Abhängigkeitsproblem korrigiert, das dazu führen konnte, dass das Einstellungs-Panel nicht angezeigt wird.
+
+## Version 1.1.0 <Badge type="info" text="28. Mai 2022" />
+
+* Da die ursprünglich geplante Pro-Version nie fertiggestellt wird, haben wir uns entschieden, sie in die kostenlose Version von Block Control zu migrieren.
+* Blende Blöcke basierend auf Rollen aus
+* Blende Blöcke basierend auf Daten aus
+* Blende Blöcke basierend auf Seitentypen aus (`is_home`, `is_page` etc.)
+* Blende Blöcke basierend auf Beiträgen des aktuellen Inhaltstyps aus (insbesondere hilfreich für wiederverwendbare Blöcke)
+
+## Version 1.0.4 <Badge type="info" text="14. Dezember 2021" />
+
+* Wir haben ein Problem mit dem Laden von Assets im Backend behoben
+
+## Version 1.0.3 <Badge type="info" text="15. Juni 2021" />
+
+* Wir haben ein Problem während der Prüfung von Block-Attributen behoben
+
+## Version 1.0.2 <Badge type="info" text="31. Dezember 2020" />
+
+* Wir haben ein Problem behoben, das dazu führte, dass mehrere Editor-Skripte im Frontend geladen wurden, auch wenn sie dort nicht notwendig waren
+* Wir haben ein Problem behoben, wodurch die Optionen von Block Control für manche Blöcke nicht verfügbar waren
+
+## Version 1.0.1 <Badge type="info" text="28. August 2019" />
+
+* Es können nun alle Zeichenfolgen übersetzt werden
+
+## Version 1.0.0 <Badge type="info" text="27. August 2019" />
+
+* Erste Version

de/block-control/developer/block-filters.md

@@ -0,0 +1,10 @@
+# Block-Filter
+
+## `blockControl.unsupportedBlocks` <Badge type="info" text="Seit 1.1.5" />
+
+Über den Filter `blockControl.unsupportedBlocks` kann die Liste der nicht unterstützten Blöcke geändert werden.
+
+Parameter:  
+string[] Liste der nicht unterstützten Block-Namen
+
+Erwartet ein Array.