* @property int $id The database ID.
* @property string $name The snippet title.
* @property string $desc The formatted description.
* @property string $code The executable code.
* @property array<string> $tags An array of the tags.
* @property string $scope The scope name.
* @property int $condition_id ID of the condition this snippet is linked to.
* @property int $priority Execution priority.
* @property bool $active The active status.
* @property bool $network true if is multisite-wide snippet, false if site-wide.
* @property bool $shared_network Whether the snippet is a shared network snippet.
* @property string $modified The date and time when the snippet data was most recently saved to the database.
* @property array{string,int}|null $code_error Code error encountered when last testing snippet code.
* @property int $revision Revision or version number of snippet.
* @property string $cloud_id Cloud ID and ownership status of snippet.
* @property-read string $display_name The snippet name if it exists or a placeholder if it does not.
* @property-read string $tags_list The tags in string list format.
* @property-read string $scope_icon The dashicon used to represent the current scope.
* @property-read string $scope_name Human-readable description of the snippet type.
* @property-read string $type The type of snippet.
* @property-read string $lang The language that the snippet code is written in.
* @property-read int $modified_timestamp The last modification date in Unix timestamp format.
* @property-read DateTime $modified_local The last modification date in the local timezone.
* @property-read boolean $is_pro Whether the snippet type is pro-only.
class Snippet extends Data_Item {
* MySQL datetime format (YYYY-MM-DD hh:mm:ss).
public const DATE_FORMAT = 'Y-m-d H:i:s';
* Default value used for a datetime variable.
public const DEFAULT_DATE = '0000-00-00 00:00:00';
* Raw active value from database before processing.
private $raw_active_value;
* @param array<string, mixed>|object $initial_data Initial snippet data.
public function __construct( $initial_data = null ) {
if ( is_array( $initial_data ) && isset( $initial_data['active'] ) ) {
$this->raw_active_value = $initial_data['active'];
} elseif ( is_object( $initial_data ) && isset( $initial_data->active ) ) {
$this->raw_active_value = $initial_data->active;
'shared_network' => null,
'conditionId' => 'condition_id',
parent::__construct( $default_values, $initial_data, $field_aliases );
* @param string $tag Tag content to add to list.
public function add_tag( string $tag ) {
$this->fields['tags'][] = $tag;
* Determine if the snippet is a condition.
public function is_condition(): bool {
return 'condition' === $this->scope;
* Determine if the snippet is trashed (soft deleted).
public function is_trashed(): bool {
return -1 === (int) $this->raw_active_value;
* Prepare a value before it is stored.
* @param mixed $value Value to prepare.
* @param string $field Field name.
* @return mixed Value in the correct format.
protected function prepare_field( $value, string $field ) {
return code_snippets_build_tags_array( $value );
return ( is_bool( $value ) ? $value : (bool) $value ) && ! $this->is_condition() && (int) $value != -1;
* Prepare the scope by ensuring that it is a valid choice
* @param int|string $scope The field as provided.
* @return string The field in the correct format.
protected function prepare_scope( $scope ) {
$scopes = self::get_all_scopes();
if ( in_array( $scope, $scopes, true ) ) {
if ( is_numeric( $scope ) && isset( $scopes[ $scope ] ) ) {
return $scopes[ $scope ];
return $this->fields['scope'];
* If $network is anything other than true, set it to false
* @param bool $network The field as provided.
* @return bool The field in the correct format.
protected function prepare_network( bool $network ): bool {
if ( null === $network && function_exists( 'is_network_admin' ) ) {
return is_network_admin();
return true === $network;
* Determine the type of code a given scope will produce.
* @param string $scope Scope name.
* @return string The snippet type – will be a filename extension.
public static function get_type_from_scope( string $scope ): string {
if ( '-css' === substr( $scope, -4 ) ) {
} elseif ( '-js' === substr( $scope, -3 ) ) {
} elseif ( 'content' === substr( $scope, -7 ) ) {
} elseif ( 'condition' === $scope ) {
* Determine the type of code this snippet is, based on its scope
* @return string The snippet type – will be a filename extension.
public function get_type(): string {
return self::get_type_from_scope( $this->scope );
* Retrieve a list of all valid types.
public static function get_types(): array {
return [ 'php', 'html', 'css', 'js', 'cond' ];
* Determine the language that the snippet code is written in, based on the scope
* @return string The name of a language filename extension.
protected function get_lang(): string {
return 'cond' === $this->type ? 'json' : $this->type;
* Prepare the modification field by ensuring it is in the correct format.
* @param DateTime|string $modified Snippet modification date.
protected function prepare_modified( $modified ): ?string {
// If the supplied value is a DateTime object, convert it to string representation.
if ( $modified instanceof DateTime ) {
return $modified->format( self::DATE_FORMAT );
// If the supplied value is probably a timestamp, attempt to convert it to a string.
if ( is_numeric( $modified ) ) {
return gmdate( self::DATE_FORMAT, $modified );
// If the supplied value is a string, check it is not just the default value.
if ( is_string( $modified ) && self::DEFAULT_DATE !== $modified ) {
// Otherwise, discard the supplied value.
* Update the last modification date to the current date and time.
public function update_modified() {
$this->modified = gmdate( self::DATE_FORMAT );
* Retrieve the snippet title if set or a placeholder title if not.
protected function get_display_name(): string {
// translators: %s: snippet identifier.
return empty( $this->name ) ? sprintf( esc_html__( 'Snippet #%d', 'code-snippets' ), $this->id ) : $this->name;
* Retrieve the tags in list format
* @return string The tags separated by a comma and a space.
protected function get_tags_list(): string {
return implode( ', ', $this->tags );
* Retrieve a list of all available scopes
* @return array<string> List of scope names.
* @phpcs:disable WordPress.Arrays.ArrayDeclarationSpacing.ArrayItemNoNewLine
public static function get_all_scopes(): array {
'global', 'admin', 'front-end', 'single-use',
'content', 'head-content', 'footer-content',
'site-head-js', 'site-footer-js',
* Retrieve a list of all scope icons
* @return array<string, string> Scope name keyed to the class name of a dashicon.
public static function get_scope_icons(): array {
'global' => 'admin-site',
'admin' => 'admin-tools',
'front-end' => 'admin-appearance',
'content' => 'shortcode',
'head-content' => 'editor-code',
'footer-content' => 'editor-code',
'admin-css' => 'dashboard',
'site-css' => 'admin-customizer',
'site-head-js' => 'media-code',
'site-footer-js' => 'media-code',
'condition' => 'randomize',
* Retrieve the string representation of the scope
* @return string The name of the scope.
protected function get_scope_name(): string {
switch ( $this->scope ) {
return __( 'Global function', 'code-snippets' );
return __( 'Admin function', 'code-snippets' );
return __( 'Front-end function', 'code-snippets' );
return __( 'Single-use function', 'code-snippets' );
return __( 'Content', 'code-snippets' );
return __( 'Head content', 'code-snippets' );
return __( 'Footer content', 'code-snippets' );
return __( 'Admin styles', 'code-snippets' );
return __( 'Front-end styles', 'code-snippets' );
return __( 'Head scripts', 'code-snippets' );
return __( 'Footer scripts', 'code-snippets' );
* Retrieve the icon used for the current scope
* @return string A dashicon name.
protected function get_scope_icon(): string {
$icons = self::get_scope_icons();
return $icons[ $this->scope ];
* Determine if the snippet is a shared network snippet
* @return bool Whether the snippet is a shared network snippet.
protected function get_shared_network(): bool {
if ( isset( $this->fields['shared_network'] ) ) {
return $this->fields['shared_network'];
if ( ! is_multisite() || ! $this->fields['network'] ) {
$this->fields['shared_network'] = false;
$shared_network_snippets = get_site_option( 'shared_network_snippets', array() );
$this->fields['shared_network'] = in_array( $this->fields['id'], $shared_network_snippets, true );
return $this->fields['shared_network'];
* Retrieve the snippet modification date as a timestamp.
* @return integer Timestamp value.
protected function get_modified_timestamp(): int {
$datetime = DateTime::createFromFormat( self::DATE_FORMAT, $this->modified, new DateTimeZone( 'UTC' ) );
return $datetime ? $datetime->getTimestamp() : 0;
* Retrieve the modification time in the local timezone.
protected function get_modified_local(): DateTime {
$datetime = DateTime::createFromFormat( self::DATE_FORMAT, $this->modified, new DateTimeZone( 'UTC' ) );
if ( function_exists( 'wp_timezone' ) ) {
$timezone = wp_timezone();
$timezone = get_option( 'timezone_string' );
// Calculate the timezone manually if it is not available.
$offset = (float) get_option( 'gmt_offset' );
$minutes = ( $offset - $hours ) * 60;
$sign = ( $offset < 0 ) ? '-' : '+';
$timezone = sprintf( '%s%02d:%02d', $sign, abs( $hours ), abs( $minutes ) );
$timezone = new DateTimeZone( $timezone );
} catch ( Exception $exception ) {
$datetime->setTimezone( $timezone );
* Retrieve the last modified time, nicely formatted for readability.
* @param boolean $include_html Whether to include HTML in the output.
public function format_modified( bool $include_html = true ): string {
if ( ! $this->modified ) {
$timestamp = $this->modified_timestamp;
$time_diff = time() - $timestamp;
$local_time = $this->modified_local;
if ( $time_diff >= 0 && $time_diff < YEAR_IN_SECONDS ) {
// translators: %s: Human-readable time difference.
$human_time = sprintf( __( '%s ago', 'code-snippets' ), human_time_diff( $timestamp ) );
$human_time = $local_time->format( __( 'Y/m/d', 'code-snippets' ) );
// translators: 1: date format, 2: time format.
$date_format = _x( '%1$s at %2$s', 'date and time format', 'code-snippets' );
$date_format = sprintf( $date_format, get_option( 'date_format' ), get_option( 'time_format' ) );
return sprintf( '<span title="%s">%s</span>', $local_time->format( $date_format ), $human_time );
* Determine whether the current snippet type is pro-only.
private function get_is_pro(): bool {
return 'css' === $this->type || 'js' === $this->type || 'cond' === $this->type;
* Increment the revision number by one.
public function increment_revision() {
It is recommended that you Edit text format, this type of Fix handles quite a lot in one request
