- |
+ |
default_args(),
- [
- 'label' => __( 'Portfolio', 'elementary-theme' ),
- 'labels' => [
- 'name' => __( 'Portfolio', 'elementary-theme' ),
- 'singular_name' => __( 'Portfolio Item', 'elementary-theme' ),
- 'add_new' => __( 'Add New', 'elementary-theme' ),
- 'add_new_item' => __( 'Add New Portfolio Item', 'elementary-theme' ),
- 'edit_item' => __( 'Edit Portfolio Item', 'elementary-theme' ),
- 'new_item' => __( 'New Portfolio Item', 'elementary-theme' ),
- 'view_item' => __( 'View Portfolio Item', 'elementary-theme' ),
- 'search_items' => __( 'Search Portfolio', 'elementary-theme' ),
- 'not_found' => __( 'No portfolio items found', 'elementary-theme' ),
- 'not_found_in_trash' => __( 'No portfolio items found in Trash', 'elementary-theme' ),
- ],
- 'menu_icon' => 'dashicons-portfolio',
- 'rewrite' => [ 'slug' => 'portfolio' ],
- 'supports' => [ 'title', 'editor', 'thumbnail', 'excerpt' ],
- ]
- );
-
- register_post_type( static::get_slug(), $args );
- }
-}
diff --git a/inc/Shortcodes/Current_Year.php b/inc/Shortcodes/Current_Year.php
deleted file mode 100644
index 02fda7f3..00000000
--- a/inc/Shortcodes/Current_Year.php
+++ /dev/null
@@ -1,44 +0,0 @@
- 'Y',
- ];
- }
-
- /**
- * {@inheritDoc}
- */
- protected function render( array $atts, ?string $content ): string {
- return esc_html( gmdate( $atts['format'] ) );
- }
-}
diff --git a/inc/Taxonomies/Project_Type.php b/inc/Taxonomies/Project_Type.php
deleted file mode 100644
index 4bb25894..00000000
--- a/inc/Taxonomies/Project_Type.php
+++ /dev/null
@@ -1,59 +0,0 @@
-default_args(),
- [
- 'hierarchical' => true,
- 'labels' => [
- 'name' => __( 'Project Types', 'elementary-theme' ),
- 'singular_name' => __( 'Project Type', 'elementary-theme' ),
- 'search_items' => __( 'Search Project Types', 'elementary-theme' ),
- 'all_items' => __( 'All Project Types', 'elementary-theme' ),
- 'edit_item' => __( 'Edit Project Type', 'elementary-theme' ),
- 'add_new_item' => __( 'Add New Project Type', 'elementary-theme' ),
- ],
- 'rewrite' => [ 'slug' => 'project-type' ],
- ]
- );
-
- register_taxonomy( static::get_slug(), static::get_object_types(), $args );
- }
-}
From 35e70162801eaeffc759ae7571c8c22dfa6128f9 Mon Sep 17 00:00:00 2001
From: pratik-londhe4
Date: Fri, 22 May 2026 02:57:30 +0530
Subject: [PATCH 08/13] Refactor to use Pascal case instead of snake case
---
composer.lock | 16 ++++++++--------
inc/Main.php | 4 ++--
.../{Theme_Options.php => ThemeOptions.php} | 12 +++++-------
3 files changed, 15 insertions(+), 17 deletions(-)
rename inc/Modules/Settings/{Theme_Options.php => ThemeOptions.php} (89%)
diff --git a/composer.lock b/composer.lock
index 2bc4bf1d..2765f852 100644
--- a/composer.lock
+++ b/composer.lock
@@ -12,12 +12,12 @@
"source": {
"type": "git",
"url": "git@github.com:rtCamp/wp-framework.git",
- "reference": "a9c8cefe967f8f05bf87560bc15a53501bec5c41"
+ "reference": "f90373b867266e4e12959b487b600c383b4c3328"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/rtCamp/wp-framework/zipball/a9c8cefe967f8f05bf87560bc15a53501bec5c41",
- "reference": "a9c8cefe967f8f05bf87560bc15a53501bec5c41",
+ "url": "https://api.github.com/repos/rtCamp/wp-framework/zipball/f90373b867266e4e12959b487b600c383b4c3328",
+ "reference": "f90373b867266e4e12959b487b600c383b4c3328",
"shasum": ""
},
"require": {
@@ -72,7 +72,7 @@
"source": "https://github.com/rtCamp/wp-framework/tree/framework",
"issues": "https://github.com/rtCamp/wp-framework/issues"
},
- "time": "2026-05-21T18:00:59+00:00"
+ "time": "2026-05-21T20:47:25+00:00"
}
],
"packages-dev": [
@@ -3192,12 +3192,12 @@
"source": {
"type": "git",
"url": "https://github.com/wp-cli/wp-cli.git",
- "reference": "2ed4a7115b847de6f87c4bb06d22b2db693a4e09"
+ "reference": "4177cb58ca649407e390a264aa19577a4125fdfe"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/wp-cli/wp-cli/zipball/2ed4a7115b847de6f87c4bb06d22b2db693a4e09",
- "reference": "2ed4a7115b847de6f87c4bb06d22b2db693a4e09",
+ "url": "https://api.github.com/repos/wp-cli/wp-cli/zipball/4177cb58ca649407e390a264aa19577a4125fdfe",
+ "reference": "4177cb58ca649407e390a264aa19577a4125fdfe",
"shasum": ""
},
"require": {
@@ -3268,7 +3268,7 @@
"issues": "https://github.com/wp-cli/wp-cli/issues",
"source": "https://github.com/wp-cli/wp-cli"
},
- "time": "2026-05-19T10:12:33+00:00"
+ "time": "2026-05-21T20:19:24+00:00"
},
{
"name": "wp-coding-standards/wpcs",
diff --git a/inc/Main.php b/inc/Main.php
index e1916a5f..1eade930 100644
--- a/inc/Main.php
+++ b/inc/Main.php
@@ -12,7 +12,7 @@
use rtCamp\WPFramework\Contracts\Traits\{Singleton, Loader};
use rtCamp\Theme\Elementary\Core\Assets;
use rtCamp\Theme\Elementary\Modules\BlockExtensions\MediaTextInteractive;
-use rtCamp\Theme\Elementary\Modules\Settings\Theme_Options;
+use rtCamp\Theme\Elementary\Modules\Settings\ThemeOptions;
/**
* Class Main
@@ -32,7 +32,7 @@ protected function __construct() {
[
Assets::class,
MediaTextInteractive::class,
- Theme_Options::class,
+ ThemeOptions::class,
]
);
diff --git a/inc/Modules/Settings/Theme_Options.php b/inc/Modules/Settings/ThemeOptions.php
similarity index 89%
rename from inc/Modules/Settings/Theme_Options.php
rename to inc/Modules/Settings/ThemeOptions.php
index 2fcdb6fd..691ade37 100644
--- a/inc/Modules/Settings/Theme_Options.php
+++ b/inc/Modules/Settings/ThemeOptions.php
@@ -2,7 +2,7 @@
/**
* Example Settings Page: Theme Options.
*
- * Demonstrates how to use Abstract_Settings_Page from wp-framework.
+ * Demonstrates how to use AbstractSettingsPage from wp-framework.
* Registers a settings page under Settings → Elementary with a few options.
*
* @package rtCamp\Theme\Elementary\Modules\Settings
@@ -13,12 +13,12 @@
namespace rtCamp\Theme\Elementary\Modules\Settings;
use Override;
-use rtCamp\WPFramework\Contracts\Abstracts\Abstract_Settings_Page;
+use rtCamp\WPFramework\Contracts\Abstracts\AbstractSettingsPage;
/**
- * Class Theme_Options
+ * Class ThemeOptions
*/
-class Theme_Options extends Abstract_Settings_Page {
+class ThemeOptions extends AbstractSettingsPage {
/**
* Option key prefix.
@@ -69,9 +69,7 @@ protected function get_settings(): array {
/**
* {@inheritDoc}
*/
- protected function get_parent_slug(): ?string {
- return null;
- }
+
/**
* {@inheritDoc}
From b927bfa0bdf78a065220c518d106acc900faebee Mon Sep 17 00:00:00 2001
From: pratik-londhe4
Date: Fri, 22 May 2026 04:54:59 +0530
Subject: [PATCH 09/13] Enhance ThemeOptions class with detailed documentation
and improved settings registration
---
composer.lock | 24 ++---
inc/Modules/Settings/ThemeOptions.php | 150 +++++++++++++++++++-------
2 files changed, 123 insertions(+), 51 deletions(-)
diff --git a/composer.lock b/composer.lock
index 2765f852..dd49ad42 100644
--- a/composer.lock
+++ b/composer.lock
@@ -12,12 +12,12 @@
"source": {
"type": "git",
"url": "git@github.com:rtCamp/wp-framework.git",
- "reference": "f90373b867266e4e12959b487b600c383b4c3328"
+ "reference": "de18dff78d39b4a4cc5a6aaef39251db19751c32"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/rtCamp/wp-framework/zipball/f90373b867266e4e12959b487b600c383b4c3328",
- "reference": "f90373b867266e4e12959b487b600c383b4c3328",
+ "url": "https://api.github.com/repos/rtCamp/wp-framework/zipball/de18dff78d39b4a4cc5a6aaef39251db19751c32",
+ "reference": "de18dff78d39b4a4cc5a6aaef39251db19751c32",
"shasum": ""
},
"require": {
@@ -53,7 +53,7 @@
"phpcbf"
],
"analyse": [
- "phpstan analyse"
+ "phpstan analyse --memory-limit=1G"
],
"test": [
"phpunit"
@@ -72,7 +72,7 @@
"source": "https://github.com/rtCamp/wp-framework/tree/framework",
"issues": "https://github.com/rtCamp/wp-framework/issues"
},
- "time": "2026-05-21T20:47:25+00:00"
+ "time": "2026-05-21T23:13:32+00:00"
}
],
"packages-dev": [
@@ -849,16 +849,16 @@
},
{
"name": "php-stubs/wordpress-stubs",
- "version": "v6.9.1",
+ "version": "v6.9.4",
"source": {
"type": "git",
"url": "https://github.com/php-stubs/wordpress-stubs.git",
- "reference": "f12220f303e0d7c0844c0e5e957b0c3cee48d2f7"
+ "reference": "90a9412826b9944f93b10bf41d795b5fe68abcd5"
},
"dist": {
"type": "zip",
- "url": "https://api.github.com/repos/php-stubs/wordpress-stubs/zipball/f12220f303e0d7c0844c0e5e957b0c3cee48d2f7",
- "reference": "f12220f303e0d7c0844c0e5e957b0c3cee48d2f7",
+ "url": "https://api.github.com/repos/php-stubs/wordpress-stubs/zipball/90a9412826b9944f93b10bf41d795b5fe68abcd5",
+ "reference": "90a9412826b9944f93b10bf41d795b5fe68abcd5",
"shasum": ""
},
"conflict": {
@@ -868,7 +868,7 @@
"dealerdirect/phpcodesniffer-composer-installer": "^1.0",
"nikic/php-parser": "^5.5",
"php": "^7.4 || ^8.0",
- "php-stubs/generator": "^0.8.3",
+ "php-stubs/generator": "^0.8.6",
"phpdocumentor/reflection-docblock": "^6.0",
"phpstan/phpstan": "^2.1",
"phpunit/phpunit": "^9.5",
@@ -895,9 +895,9 @@
],
"support": {
"issues": "https://github.com/php-stubs/wordpress-stubs/issues",
- "source": "https://github.com/php-stubs/wordpress-stubs/tree/v6.9.1"
+ "source": "https://github.com/php-stubs/wordpress-stubs/tree/v6.9.4"
},
- "time": "2026-02-03T19:29:21+00:00"
+ "time": "2026-05-01T20:36:01+00:00"
},
{
"name": "php-stubs/wp-cli-stubs",
diff --git a/inc/Modules/Settings/ThemeOptions.php b/inc/Modules/Settings/ThemeOptions.php
index 691ade37..4a5e8d55 100644
--- a/inc/Modules/Settings/ThemeOptions.php
+++ b/inc/Modules/Settings/ThemeOptions.php
@@ -2,8 +2,18 @@
/**
* Example Settings Page: Theme Options.
*
- * Demonstrates how to use AbstractSettingsPage from wp-framework.
- * Registers a settings page under Settings → Elementary with a few options.
+ * Demonstrates a clean, declarative settings page built on AbstractSettingsPage
+ * and the WordPress Settings API:
+ *
+ * - get_fields() is the single source of truth for every option on the
+ * page: option name, type, default, sanitize callback, REST exposure,
+ * plus the UI metadata (label, description).
+ * - register_settings() registers the options via the parent, then attaches
+ * a section + one field per entry via the Settings API.
+ * - render_field() is a generic input renderer — adding another field is a
+ * one-entry change in get_fields(), no HTML to touch.
+ *
+ * Copy this class as a starting point for any backend-driven settings page.
*
* @package rtCamp\Theme\Elementary\Modules\Settings
*/
@@ -12,7 +22,6 @@
namespace rtCamp\Theme\Elementary\Modules\Settings;
-use Override;
use rtCamp\WPFramework\Contracts\Abstracts\AbstractSettingsPage;
/**
@@ -21,10 +30,15 @@
class ThemeOptions extends AbstractSettingsPage {
/**
- * Option key prefix.
+ * Option key prefix — every option name on this page starts with it.
*/
private const PREFIX = 'elementary_';
+ /**
+ * Settings section ID. Sections group fields visually on the page.
+ */
+ private const SECTION = 'elementary_main_section';
+
/**
* {@inheritDoc}
*/
@@ -47,17 +61,26 @@ protected function get_menu_title(): string {
}
/**
- * {@inheritDoc}
+ * Single source of truth for every field on this page.
+ *
+ * Combines register_setting() args (type, default, sanitize_callback,
+ * show_in_rest) with UI metadata (label, description) consumed by the
+ * Settings API field registration in register_settings().
+ *
+ * @return array,
+ * }>
*/
- protected function get_settings(): array {
+ protected function get_fields(): array {
return [
- self::PREFIX . 'enable_portfolio' => [
- 'type' => 'boolean',
- 'default' => true,
- 'sanitize_callback' => 'rest_sanitize_boolean',
- 'show_in_rest' => true,
- ],
- self::PREFIX . 'footer_text' => [
+ self::PREFIX . 'example_text' => [
+ 'label' => __( 'Example Text', 'elementary-theme' ),
+ 'description' => __( 'A demo text field saved as a WordPress option.', 'elementary-theme' ),
'type' => 'string',
'default' => '',
'sanitize_callback' => 'sanitize_text_field',
@@ -68,8 +91,81 @@ protected function get_settings(): array {
/**
* {@inheritDoc}
+ *
+ * Derives the register_setting() args from get_fields() by stripping
+ * the UI-only keys.
+ */
+ protected function get_settings(): array {
+ $settings = [];
+
+ foreach ( $this->get_fields() as $name => $field ) {
+ unset( $field['label'], $field['description'] );
+ $settings[ $name ] = $field;
+ }
+
+ return $settings;
+ }
+
+ /**
+ * {@inheritDoc}
+ *
+ * Lets the parent register the options, then registers a settings
+ * section and one field per option for the UI.
+ */
+ public function register_settings(): void {
+ parent::register_settings();
+
+ add_settings_section(
+ self::SECTION,
+ __( 'Theme Options', 'elementary-theme' ),
+ [ $this, 'render_section' ],
+ static::get_slug()
+ );
+
+ foreach ( $this->get_fields() as $name => $field ) {
+ add_settings_field(
+ $name,
+ $field['label'],
+ [ $this, 'render_field' ],
+ static::get_slug(),
+ self::SECTION,
+ [
+ 'name' => $name,
+ 'default' => $field['default'] ?? '',
+ 'description' => $field['description'] ?? '',
+ 'label_for' => $name,
+ ]
+ );
+ }
+ }
+
+ /**
+ * Optional section blurb shown above the fields.
*/
-
+ public function render_section(): void {
+ echo ' ' . esc_html__( 'Theme-wide options exposed to the editor and front-end.', 'elementary-theme' ) . ' ';
+ }
+
+ /**
+ * Render a single text input. To support additional input types
+ * (checkbox, select, …), branch on a `type` arg here.
+ *
+ * @param array $args Field args passed via add_settings_field().
+ */
+ public function render_field( array $args ): void {
+ $name = $args['name'];
+ $value = get_option( $name, $args['default'] );
+
+ printf(
+ '',
+ esc_attr( $name ),
+ esc_attr( (string) $value )
+ );
+
+ if ( '' !== $args['description'] ) {
+ printf( ' %s ', esc_html( $args['description'] ) );
+ }
+ }
/**
* {@inheritDoc}
@@ -82,32 +178,8 @@ public function render(): void {
-
-
Date: Fri, 22 May 2026 18:10:23 +0530
Subject: [PATCH 10/13] Refactor documentation for the theme
---
DEVELOPMENT.md | 151 ++++++++++++++++++++-----------
README.md | 29 ++++--
composer.json | 8 +-
composer.lock | 8 +-
inc/Helpers/Util.php | 30 ++++++
inc/helpers/custom-functions.php | 10 --
6 files changed, 153 insertions(+), 83 deletions(-)
create mode 100644 inc/Helpers/Util.php
delete mode 100644 inc/helpers/custom-functions.php
diff --git a/DEVELOPMENT.md b/DEVELOPMENT.md
index 076d4819..846a6079 100644
--- a/DEVELOPMENT.md
+++ b/DEVELOPMENT.md
@@ -1,86 +1,133 @@
# Development Guide
-## PSR-4 Namespace Convention
+## Architecture overview
-All namespaced PHP classes live under `inc/` using the `rtCamp\Theme\Elementary\` root namespace.
-The file path must map to the namespace and class name.
+The theme is split into two layers:
-Examples:
+- **`vendor/rtcamp/wp-framework/`** — The upstream framework, installed as a Composer dependency. Provides reusable scaffolding (`Singleton`, `Loader`, `Container`, `AssetLoaderTrait`, `TemplateLoaderTrait`) and abstract base classes (`AbstractSettingsPage`, `AbstractPostType`, etc.). **Do not modify.** Changes belong in the framework repository.
+- **`inc/`** — All theme-specific code. Extends framework abstracts, registers theme services, and bootstraps the theme.
-- `inc/Main.php` → `rtCamp\Theme\Elementary\Main`
-- `inc/Core/Assets.php` → `rtCamp\Theme\Elementary\Core\Assets`
-- `inc/BlockExtensions/MediaTextInteractive.php` → `rtCamp\Theme\Elementary\Modules\BlockExtensions\MediaTextInteractive`
-- `inc/Framework/Traits/Singleton.php` → `rtCamp\Theme\Elementary\Framework\Traits\Singleton`
+The `vendor/` boundary enforces the rule by convention: editing files there gets blown away on every `composer install`.
-## Directory tree
+## PSR-4 namespace convention
-The `inc/` directory follows a PSR-4 structure and is split into meaningful areas:
+Single PSR-4 root, declared in `composer.json`:
-- `inc/Framework/`
- - Upstream-owned framework code.
- - Base traits, contracts, and utilities.
- - Do not modify in downstream themes unless there is no other option.
-- `inc/Main.php`
- - Theme bootstrap entry point.
- - Defines the primary theme class under `rtCamp\Theme\Elementary`.
-- `inc/Core/`
- - Project-specific core classes.
- - Example: asset loading, theme setup, shared services.
-- `inc/BlockExtensions/`
- - Project-specific block extension classes.
- - Example: block render filters, block-specific integrations.
-- `inc/helpers/`
- - Non-namespaced helper files.
- - Loaded via Composer `files` autoload and not subject to PSR-4 class name rules.
+```json
+"autoload": {
+ "psr-4": {
+ "rtCamp\\Theme\\Elementary\\": "inc/"
+ }
+}
+```
+
+Directory segments map 1:1 to namespace segments. Files are PascalCase.
-## Two-layer model
+| Namespace | File |
+|------------------------------------------------------------------------|-------------------------------------------------------|
+| `rtCamp\Theme\Elementary\Main` | `inc/Main.php` |
+| `rtCamp\Theme\Elementary\Autoloader` | `inc/Autoloader.php` |
+| `rtCamp\Theme\Elementary\Core\Assets` | `inc/Core/Assets.php` |
+| `rtCamp\Theme\Elementary\Modules\BlockExtensions\MediaTextInteractive` | `inc/Modules/BlockExtensions/MediaTextInteractive.php`|
+| `rtCamp\Theme\Elementary\Modules\Settings\ThemeOptions` | `inc/Modules/Settings/ThemeOptions.php` |
+| `rtCamp\Theme\Elementary\Helpers\Util` | `inc/Helpers/Util.php` |
-The repository is split into two layers:
+## Directory layout
-- `inc/Framework/` — upstream-owned framework code. Do not modify in downstream projects.
-- `inc/` (outside `Framework/`) — project-specific implementation and customizations.
+```
+inc/
+├── Autoloader.php # Wraps vendor/autoload.php with graceful failure
+├── Main.php # Theme bootstrap — loads services
+├── Helpers/ # Stateless static utility classes (final, private __construct)
+│ └── Util.php # General-purpose helpers (add static methods as needed)
+├── Core/ # Theme-wide infrastructure
+│ └── Assets.php # Asset registration (uses AssetLoaderTrait)
+└── Modules/ # Feature areas
+ ├── BlockExtensions/ # Block render filters and integrations
+ │ └── MediaTextInteractive.php
+ └── Settings/ # Admin settings pages (extend AbstractSettingsPage)
+ └── ThemeOptions.php
+```
-### `inc/Framework/`
+## Helpers
-This is the base layer. It should contain only reusable traits, interfaces, and low-level utilities.
-Treat it like vendored code. If you need to change behavior, extend the framework class in `inc/` instead.
+`inc/Helpers/` is the home for stateless utility classes — `final`, `private __construct()`, static methods only. Today it holds one class, `Util`, kept as a placeholder for theme-wide helpers that don't earn their own dedicated class. Add siblings (e.g. `Str`, `Cache`, `Url`) as cross-cutting helpers accumulate, rather than letting `Util` grow into a grab-bag.
-### `inc/`
+## Picking a base
-This is the application layer for this theme. Add new feature classes, hooks, and theme-specific behavior here.
+| Feature | Extends / implements |
+|------------------------------------------|-------------------------------------|
+| Settings page | `AbstractSettingsPage` |
+| Admin (non-settings) page | `AbstractAdminPage` |
+| Dynamic block (server-side render) | `AbstractBlock` |
+| REST controller | `AbstractRESTController` |
+| Shortcode | `AbstractShortcode` |
+| Anything else that just wires hooks | `Registrable` interface |
+| Same, but registration is conditional | `ConditionallyRegistrable` interface|
## Adding a new class
-1. Create a new PHP file under `inc/` using PascalCase file names.
-2. Use the matching namespace path.
-3. Define the class name to match the filename exactly.
-4. If the class belongs to a feature group, create a subdirectory and namespace that group.
+1. Pick the right abstract or interface from the table above.
+2. Drop the file in the matching `inc/Modules//` directory (or `inc/Core/` if it's theme-wide infrastructure).
+3. Register it in `Main::__construct()`'s `$this->load( [ … ] )` call.
+4. Run `composer dump-autoload`.
Example:
-`inc/Example/Feature.php`
-
```php
-namespace rtCamp\Theme\Elementary\Example;
+// inc/Modules/Example/Feature.php
+namespace rtCamp\Theme\Elementary\Modules\Example;
+
+use rtCamp\WPFramework\Contracts\Interfaces\Registrable;
-class Feature {
- // ...
+final class Feature implements Registrable {
+ public function register_hooks(): void {
+ add_action( 'init', [ $this, 'do_something' ] );
+ }
+
+ public function do_something(): void {
+ // ...
+ }
}
```
-## Existing non-namespaced file
+Then in `Main::__construct()`:
+
+```php
+$this->load( [
+ Assets::class,
+ MediaTextInteractive::class,
+ ThemeOptions::class,
+ \rtCamp\Theme\Elementary\Modules\Example\Feature::class,
+] );
+```
+
+## Conditional registration
-`inc/helpers/custom-functions.php` is intentionally not namespaced and remains loaded through Composer `files` autoload.
+A class can opt out of registration at runtime by implementing `ConditionallyRegistrable` instead of `Registrable`:
-## Running autoload generation
+```php
+final class DevToolbarExtension implements ConditionallyRegistrable {
+ public function can_register(): bool {
+ return defined( 'WP_DEBUG' ) && WP_DEBUG;
+ }
+
+ public function register_hooks(): void {
+ // Wire dev-only hooks here.
+ }
+}
+```
+
+The `Loader` calls `can_register()` first and skips `register_hooks()` when it returns false.
-After moving or adding namespaced classes, regenerate Composer autoload files:
+## Running Composer
```bash
+# First-time setup
+composer install
+
+# After adding, renaming, or moving a class
composer dump-autoload
```
-## Notes
-
-- Do not use `classmap` autoloading for namespaced classes.
-- Keep the `rtCamp\Theme\Elementary\` PSR-4 root aligned with `inc/`.
+If `vendor/autoload.php` is missing at runtime, the theme shows an admin notice instead of fataling — see `inc/Autoloader.php` and `AutoloaderTrait` in the framework.
diff --git a/README.md b/README.md
index 1311e193..5e761bb2 100644
--- a/README.md
+++ b/README.md
@@ -4,13 +4,17 @@
A starter theme that facilitates a quick head start for developing new [block-based themes](https://developer.wordpress.org/block-editor/how-to-guides/themes/block-theme-overview/) along with a bunch of developer-friendly features.
-- [Understand the Folder Structure](https://github.com/rtCamp/theme-elementary#understand-the-folder-structure-open_file_folder)
-- [Get Started](https://github.com/rtCamp/theme-elementary#get-started-rocket)
-- [Development](https://github.com/rtCamp/theme-elementary#development-computer)
+Reusable scaffolding (singleton, autoloader, asset loader, template loader, and abstract base classes) ships separately as the `rtcamp/wp-framework` Composer package and is loaded from `vendor/`.
+
+> **Working on this theme?** See [DEVELOPMENT.md](DEVELOPMENT.md) for the architecture overview, the module pattern, and how to add new classes.
+
+- [Understand the Folder Structure](#understand-the-folder-structure-open_file_folder)
+- [Get Started](#get-started-rocket)
+- [Development](#development-computer)
## Understand the Folder Structure :open_file_folder:
```
- .
+.
├── src (Frontend source)
│ ├── css
│ │ ├── frontend/
@@ -30,11 +34,14 @@ A starter theme that facilitates a quick head start for developing new [block-ba
│ └── build (Compiled output)
├── bin (Holds scripts)
├── functions.php (PHP entry point)
-├── inc
-│ ├── Core/ (Project-specific core classes)
-│ ├── BlockExtensions/ (Block extension classes)
-│ ├── Framework/ (Upstream framework code)
-│ └── helpers/ (Non-namespaced helpers)
+├── inc (All project-specific PHP — PSR-4 root)
+│ ├── Autoloader.php (Wraps vendor/autoload.php with graceful failure)
+│ ├── Main.php (Theme bootstrap — loads services)
+│ ├── Helpers/ (Stateless static utility classes)
+│ ├── Core/ (Theme-wide infrastructure — assets, etc.)
+│ └── Modules/ (Feature areas)
+│ ├── BlockExtensions/ (Block render filters and integrations)
+│ └── Settings/ (Admin settings pages — extend AbstractSettingsPage)
├── parts (Block Template Parts)
├── patterns (Block Patterns)
├── style.css
@@ -42,8 +49,10 @@ A starter theme that facilitates a quick head start for developing new [block-ba
├── tests (Holds JS & PHP tests)
│ ├── js/
│ └── php/
+├── vendor
+│ └── rtcamp/wp-framework/ (Framework — do not modify; Composer-managed)
+├── DEVELOPMENT.md
└── theme.json
-
```
## Get Started :rocket:
diff --git a/composer.json b/composer.json
index 8c8f0960..c724b4d5 100644
--- a/composer.json
+++ b/composer.json
@@ -7,7 +7,8 @@
"repositories": [
{
"type": "vcs",
- "url": "https://github.com/rtCamp/wp-framework.git"
+ "url": "https://github.com/rtCamp/wp-framework.git",
+ "no-api": true
}
],
"require": {
@@ -41,10 +42,7 @@
"autoload": {
"psr-4": {
"rtCamp\\Theme\\Elementary\\": "inc/"
- },
- "files": [
- "inc/helpers/custom-functions.php"
- ]
+ }
},
"autoload-dev": {
"psr-4": {
diff --git a/composer.lock b/composer.lock
index dd49ad42..776e4b5e 100644
--- a/composer.lock
+++ b/composer.lock
@@ -4,14 +4,14 @@
"Read more about it at https://getcomposer.org/doc/01-basic-usage.md#installing-dependencies",
"This file is @generated automatically"
],
- "content-hash": "c06d2133e4ca5db89754e6392a00aa00",
+ "content-hash": "5c9d115741ba03076111d8506b4f0895",
"packages": [
{
"name": "rtcamp/wp-framework",
"version": "dev-framework",
"source": {
"type": "git",
- "url": "git@github.com:rtCamp/wp-framework.git",
+ "url": "https://github.com/rtCamp/wp-framework.git",
"reference": "de18dff78d39b4a4cc5a6aaef39251db19751c32"
},
"dist": {
@@ -68,10 +68,6 @@
"GPL-2.0-or-later"
],
"description": "A reusable WordPress framework providing composable traits, abstract classes, and interfaces for plugins and themes.",
- "support": {
- "source": "https://github.com/rtCamp/wp-framework/tree/framework",
- "issues": "https://github.com/rtCamp/wp-framework/issues"
- },
"time": "2026-05-21T23:13:32+00:00"
}
],
diff --git a/inc/Helpers/Util.php b/inc/Helpers/Util.php
new file mode 100644
index 00000000..cd8b2924
--- /dev/null
+++ b/inc/Helpers/Util.php
@@ -0,0 +1,30 @@
+
Date: Fri, 22 May 2026 18:44:11 +0530
Subject: [PATCH 11/13] Add check for git in CI
---
.github/workflows/test-measure.yml | 3 +++
1 file changed, 3 insertions(+)
diff --git a/.github/workflows/test-measure.yml b/.github/workflows/test-measure.yml
index 4c2c5a22..36dae896 100644
--- a/.github/workflows/test-measure.yml
+++ b/.github/workflows/test-measure.yml
@@ -175,6 +175,9 @@ jobs:
restore-keys: |
${{ runner.os }}-composer-
+ - name: Ensure git is installed
+ run: which git || (sudo apt-get update && sudo apt-get install -y git)
+
- name: Install Composer dependencies
run: composer install --prefer-dist --optimize-autoloader --no-progress --no-interaction --no-scripts
From 4caa7cc66f1ef8409d14adc182d15f664d8e2b18 Mon Sep 17 00:00:00 2001
From: pratik-londhe4
Date: Fri, 22 May 2026 18:53:23 +0530
Subject: [PATCH 12/13] Update workflow to provide container access to token
for Framework package
---
.github/workflows/test-measure.yml | 8 ++++++++
1 file changed, 8 insertions(+)
diff --git a/.github/workflows/test-measure.yml b/.github/workflows/test-measure.yml
index 36dae896..81dcd42a 100644
--- a/.github/workflows/test-measure.yml
+++ b/.github/workflows/test-measure.yml
@@ -202,6 +202,14 @@ jobs:
- name: Start WP environment
run: npm run wp-env start
+ # The tests-cli container runs its own `composer install` before tests
+ # (via the pretest:php npm hook), so it needs the GitHub PAT configured
+ # inside the container — the host's auth isn't inherited.
+ - name: Configure Composer GitHub auth inside wp-env container
+ run: npx wp-env run tests-cli composer config --global --no-interaction github-oauth.github.com "$WP_FRAMEWORK_REPO_TOKEN"
+ env:
+ WP_FRAMEWORK_REPO_TOKEN: ${{ secrets.WP_FRAMEWORK_REPO_TEMP_TOKEN }}
+
- name: Run tests
run: npm run test:php
From 57f2c63fc9e3c87093d8ab1ce56aff6c0df01f3b Mon Sep 17 00:00:00 2001
From: pratik-londhe4
Date: Fri, 22 May 2026 19:00:46 +0530
Subject: [PATCH 13/13] Bring same workflow for theme as skeleton plugin
---
.github/workflows/test-measure.yml | 28 +---------------------------
1 file changed, 1 insertion(+), 27 deletions(-)
diff --git a/.github/workflows/test-measure.yml b/.github/workflows/test-measure.yml
index 81dcd42a..5f6e4f81 100644
--- a/.github/workflows/test-measure.yml
+++ b/.github/workflows/test-measure.yml
@@ -88,7 +88,7 @@ jobs:
[[ "${{ steps.determine-file-counts.outputs.css-count }}" -le 0 ]] && SKIPPED+=("lint-css")
[[ "${{ steps.determine-file-counts.outputs.js-count }}" -le 0 ]] && SKIPPED+=("lint-js" "unit-tests-js" "build-prod")
- [[ "${{ steps.determine-file-counts.outputs.php-count }}" -le 0 ]] && SKIPPED+=("lint-php" "unit-test-php")
+ [[ "${{ steps.determine-file-counts.outputs.php-count }}" -le 0 ]] && SKIPPED+=("lint-php")
if [[ ${#SKIPPED[@]} -gt 0 ]]; then
echo "The following jobs will be skipped as no relevant files were changed:"
@@ -187,32 +187,6 @@ jobs:
- name: Detect coding standard violations (PHPCS)
run: vendor/bin/phpcs -q --report=checkstyle --runtime-set ignore_errors_on_exit 1 --runtime-set ignore_warnings_on_exit 1 | cs2pr --graceful-warnings
- unit-test-php:
- needs: pre-run
- if: needs.pre-run.outputs.changed-php-count > 0
- name: "PHP Unit test"
- runs-on: ubuntu-latest
- steps:
- - name: Checkout
- uses: actions/checkout@v6
-
- - name: Setup Node with cache
- uses: ./.github/actions/setup-node-with-cache
-
- - name: Start WP environment
- run: npm run wp-env start
-
- # The tests-cli container runs its own `composer install` before tests
- # (via the pretest:php npm hook), so it needs the GitHub PAT configured
- # inside the container — the host's auth isn't inherited.
- - name: Configure Composer GitHub auth inside wp-env container
- run: npx wp-env run tests-cli composer config --global --no-interaction github-oauth.github.com "$WP_FRAMEWORK_REPO_TOKEN"
- env:
- WP_FRAMEWORK_REPO_TOKEN: ${{ secrets.WP_FRAMEWORK_REPO_TEMP_TOKEN }}
-
- - name: Run tests
- run: npm run test:php
-
build-prod:
needs: pre-run
if: needs.pre-run.outputs.changed-js-count > 0 || needs.pre-run.outputs.changed-css-count > 0
|