Namespacing

We use namespacing to keep our plugin code distinct from other plugins, libraries, and themes.

Namespaces

Our plugins utilize a couple of namespaces. The PHP namespace is the namespacing that our new architecture uses. These namespaces are a relatively new development and we still have a lot of code using our legacy namespaces. Here are both namespacing approaches you will find within our codebase. The first can be found in src/TEC while the legacy can be found in src/Tribe.

Top ↑

Prefixes

Each plugin and major product area has its own prefix for hooks, container slugs, and PHP namespaces. The prefixes are as follows:

Despite being embedded within the-events-calendar, Event Aggregator deserves (and gets) its own prefix.

Top ↑

Hook examples

<?php
// hook in tribe common for firing the bacon action
do_action( 'tec_bacon' );

// hook in TEC for firing the potato action
do_action( 'tec_events_potato' );

// hook in the Event Aggregator section of TEC for firing the squid action
do_action( 'tec_aggregator_squid' );

Top ↑

Container slug examples

<?php
// declare singleton for the panda class in tribe-common, then call it
tribe_singleton( 'common.panda', 'TEC\\Common\\Panda' );
tribe( 'common.panda' );

// declare singleton for the squirrel admin class in TEC, then call it
tribe_singleton( 'tec.admin.squirrel', 'TEC\\Events\\Admin\\Squirrel' );
tribe( 'tec.admin.squirrel' );

// declare singleton for the baboon class in the Event Aggregator code within TEC, then call it
tribe_singleton( 'aggregator.baboon', 'TEC\\Events\\Aggregator\\Baboon' );
tribe( 'aggregator.baboon' );

Top ↑

Style and script slugs

When registering and enqueuing scripts and styles, we should append -css in the case of stylesheets. Example:

Note that in this instance we prefer hyphens over underscores.

Top ↑

Shortnames

Each plugin has a specific short-name that should be used for URL references and abbreviation when handling internal communication.