code-style
/code-style
PHP coding standards and WordPress patterns for ActivityPub plugin. Use when writing PHP code, creating classes, implementing WordPress hooks, or structuring plugin files.
- Author
- automattic ↗
- Repository
- wordpress-activitypub ↗
- Licence
- MIT
- Last repository change
- 27.10.2026
Assessment and security
- Files in this package
- 1
- Scripts
- 0
- HTML comments
- 0
- URLs in SKILL.md
- 0
No signals detected. Repository changed on 27.10.2026, without references to retired models or APIs.
MIT, open: use and modify while retaining author attribution.
What it does and when to use it
PHP coding standards and WordPress patterns for ActivityPub plugin. Use when writing PHP code, creating classes, implementing WordPress hooks, or structuring plugin files.
Original author description
PHP coding standards and WordPress patterns for ActivityPub plugin. Use when writing PHP code, creating classes, implementing WordPress hooks, or structuring plugin files.
How it works
- Quick Reference
- Comprehensive Standards
- Directory Structure
- ActivityPub Architectural Patterns
- Plugin-Specific Helper Functions
- Real Codebase Examples
- Common Initialization Patterns
- Custom Hook Patterns
- Version Numbers
SKILL.md preview
---
name: code-style
description: PHP coding standards and WordPress patterns for ActivityPub plugin. Use when writing PHP code, creating classes, implementing WordPress hooks, or structuring plugin files.
---
# ActivityPub PHP Conventions
Plugin-specific conventions and architectural patterns for the ActivityPub plugin.
**First rule: reuse before writing.** Prefer WordPress core functions, then existing plugin helpers (`includes/functions*.php`, `Sanitize`, `src/shared/`), over any new implementation — and never swap a core-function-based check for bespoke logic. See "Reuse Core Functionality First" in `docs/php-coding-standards.md`.
## Quick Reference
### File Naming
```
class-{name}.php # Regular classes.
trait-{name}.php # Traits.
interface-{name}.php # Interfaces.
```
### Namespace Pattern
```php
namespace Activitypub;
namespace Activitypub\Transformer;
namespace Activitypub\Collection;
namespace Activitypub\Handler;
namespace Activitypub\Activity;
namespace Activitypub\Rest;
```
### Text Domain
Always use `'activitypub'` for translations:
```php
\__( 'Text', 'activitypub' );
\_e( 'Text', 'activitypub' );
```
### WordPress Global Functions
When in a namespace, always escape WordPress functions with backslash: `\get_option()`, `\add_action()`, etc.
### Imports and Class References
Two symmetric rules, both enforced in review:
```php
// Plugin classes: import with `use`, never reference inline.
use Activitypub\Collection\Outbox;
Outbox::add( $activity ); // ✅
\Activitypub\Collection\Outbox::add( $activity ); // ❌ no inline namespaces
// Global (WordPress/PHP) classes: reference inline with a backslash, never import.
$query = new \WP_Query( $args ); // ✅
class Command extends \WP_CLI_Command {} // ✅
use WP_Query; // ❌ no `use` for global classes
```
### Comments
- `/* */` for multi-line comments, `//` for single-line — not stacked `//` lines.
- Place each comment at the line it documents, not as one block above a block of code. Detail is fine; split it per statement.
- Explain the non-obvious mechanic that makes a line necessary, never the bug or ticket behind it. A line that speaks for itself gets no comment.
### Plugin Idioms
- No `try`/`catch` or `try`/`finally`. Hook a filter around a call as `add_filter` → call → `remove_filter`, and report failures through return values (`WP_Error`, `false`).
- "C2S" stays out of identifiers, file names and code comments; the official name is "ActivityPub API", and "client" is fine for the consuming side.
- Anything that leaves the server (REST responses, deliveries) is rendered with `$activity->to_array( false, false )`: no per-item `@context`, no `bto`/`bcc`. Storage keeps `to_array( true, true )` for the round trip.
- A few duplicated lines at two call sites beat a new helper; a whole duplicated method body across sibling classes does not.
## Comprehensive Standards
See `docs/php-coding-standards.md` for complete WordPress coding standards.
See `docs/php-class-structure.md` for detailed directory organization.
## Directory Structure
```
includes/
├── class-*.php # Core classes.
├── activity/ # Activity type classes.
├── collection/ # Collection classes.
├── handler/ # Activity handlers.
├── rest/ # REST API endpoints.
├── transformer/ # Content transformers.
└── wp-admin/ # Admin functionality.
integration/ # Third-party integrations (root level).
```
## ActivityPub Architectural Patterns
### Transformers
Convert WordPress content into ActivityPub objects.
**When to use:** Converting posts, comments, users, or custom content types into ActivityPub format.
**Base class:** `includes/transformer/class-base.php`
**Pattern:**
```php
namespace Activitypub\Transformer;
class Custom extends Base {
/**
* Transform object to ActivityPub format.
*
* @return array The ActivityPub representation.
*/
public function transform() {
$object = parent::transform();
// Custom transformation logic.
return $object;
}
}
```
**Examples:**
- `includes/transformer/class-post.php` - Post transformation.
- `includes/transformer/class-comment.php` - Comment transformation.
- `includes/transformer/class-user.php` - User/actor transformation.
### Handlers
Process incoming ActivityPub activities from remote servers.
**When to use:** Processing incoming Follow, Like, Create, Delete, Update, etc. activities.
**Pattern:** Each handler processes one activity type from the inbox.
**Examples:**
- `includes/handler/class-follow.php` - Process Follow activities.
- `includes/handler/class-create.php` - Process Create activities.
- `includes/handler/class-delete.php` - Process Delete activities.
- `includes/handler/class-like.php` - Process Like activities.
### Collections
Implement ActivityPub collections (Followers, Following, etc.).
**When to use:** Exposing lists of actors, activities, or objects via ActivityPub.
**Examples:**
- `includes/collection/class-followers.php` - Followers collection.
- `includes/collection/class-following.php` - Following collection.
### REST API Controllers
Expose ActivityPub endpoints.
**Namespace:** `ACTIVITYPUB_REST_NAMESPACE`
**Examples:**
- `includes/rest/class-actors-controller.php` - Actor endpoint.
- `includes/rest/class-inbox-controller.php` - Inbox endpoint.
- `includes/rest/class-outbox-controller.php` - Outbox endpoint.
- `includes/rest/class-followers-controller.php` - Followers collection endpoint.
## Plugin-Specific Helper Functions
```php
// Get remote actor metadata.
$metadata = get_remote_metadata_by_actor( $actor_url );
// Convert ActivityPub object to URI string.
$uri = object_to_uri( $object );
// Enrich content with callbacks.
$content = enrich_content_data( $content, $pattern, $callback );
// Resolve WebFinger handle to actor URL.
$resource = Webfinger::resolve( $handle );
// Check whether a post is disabled for ActivityPub (the federation pipeline gate).
$disabled = is_post_disabled( $post );
```
## Real Codebase Examples
**Core Classes:**
- `includes/class-activitypub.php` - Main plugin initialization.
- `includes/class-dispatcher.php` - Activity dispatching to followers.
- `includes/class-scheduler.php` - WP-Cron integration for async tasks.
- `includes/class-signature.php` - HTTP Signatures for federation.
**Activity Types:**
- `includes/activity/class-activity.php` - Activity class (Create, Follow, Undo, etc. are built from this).
- `includes/activity/class-base-object.php` - Base object class.
- `includes/activity/extended-object/` - Extended object types (e.g. Event).
**Integrations (see [Integration Patterns](../integrations/SKILL.md)):**
- `integration/class-buddypress.php` - BuddyPress integration.
- `integration/class-jetpack.php` - Jetpack integration.
- `integration/class-opengraph.php` - OpenGraph integration.
## Common Initialization Patterns
### Static Initialization
```php
class Feature {
/**
* Initialize the class.
*/
public static function init() {
\add_action( 'init', array( self::class, 'register' ) );
\add_filter( 'activitypub_the_content', array( self::class, 'filter' ) );
}
}
```
### Singleton Pattern
```php
class Manager {
private static $instance = null;
public static function get_instance() {
if ( null === self::$instance ) {
self::$instance = new self();
}
return self::$instance;
}
private function __construct() {
$this->init();
}
}
```
## Custom Hook Patterns
**Actions:**
```php
\do_action( 'activitypub_handled_create', $activity, $user_ids, $success, $result );
\do_action( 'activitypub_followers_pre_remove_follower', $follower, $user_id, $actor );
```
**Filters:**
```php
$array = \apply_filters( 'activitypub_activity_object_array', $array, $class, $id, $object );
$content = \apply_filters( 'activitypub_the_content', $content, $post );
$types = \apply_filters( 'activitypub_actor_types', $types );
```
## Version Numbers
**Always use `'unreleased'`** for version strings in new code. The release script automatically replaces these with the actual version number during the release process.
**PHPDoc tags:**
```php
/**
* New function description.
*
* @since unreleased
*/
function new_feature() {}
/**
* Old function.
*
* @deprecated unreleased Use new_feature() instead.
*/
function old_feature() {}
```
**Deprecation functions:**
```php
\_deprecated_function( __METHOD__, 'unreleased', 'New_Class::new_method' );
\_deprecated_argument( __METHOD__, 'unreleased', \esc_html__( 'Message', 'activitypub' ) );
\_doing_it_wrong( __METHOD__, \esc_html__( 'Message', 'activitypub' ), 'unreleased' );
```
**Never hardcode version numbers** like `'5.1.0'` — always use `'unreleased'`.
Versions
| Repository | Score | Licence |
|---|---|---|
| This page · automattic/wordpress-activitypub | 100 | MIT |
| bastidood/skills | 100 | MPL-2.0 |
| fubits1/svelte-skills | 100 | MIT |
| microsoft/semantic-link-labs | 100 | MIT |
| Casper-Studios/casper-marketplace | 100 | MPL-2.0 |
| avsm/ocaml-claude-marketplace | 100 | ISC |
| railtownai/railtracks | 96 | MIT |
| LemurDaniel/claude-code-storyline-style | 95 | MIT |
Database snapshot: 13.11.2026 · package version 99a258e467c2 (SHA-256 digest of the entire package)
Downloads in the last 30 days: 0 · ranking
Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.
Similar skills
- 100dev
Development workflows for WordPress ActivityPub plugin including wp-env setup, testing commands, linting, and build processes. Use when setting up development environment, running tests, checking code quality, building assets, or working with wp-env. - 100php-quality
PHP code quality: static analysis, coding standards and best-practice enforcement for PHP codebases. USE WHEN: working with PHP codebases requiring code quality analysis, static analysis, or best practices enforcement DO NOT USE FOR: security-specific issues (use… - 100php-coding-standards
Invoke BEFORE writing or modifying any PHP code. Provides coding standards and naming conventions for Nette repos: TABs, single quotes, strict_types, PER Coding Style modifications, use statement ordering. Use this whenever creating, modifying, or refactoring any PHP code - even… - 100wordpress
Coding, security, and testing rules for WordPress plugins and themes Triggers on: wp-content/plugins/**,wp-content/themes/**,**/*.php,**/*.inc,**/*.js,**/*.jsx,**/*.ts,**/*.tsx,**/*.css,**/*.scss,**/*.json - 90php-testing-patterns
Use when writing or reviewing PHP tests - PHPUnit assertions, WordPress test utilities (WP_UnitTestCase, factories), WooCommerce test patterns, and Brain Monkey isolation. - 92write-script-php
MUST use when writing PHP scripts.