Title: Commentcode API
Author: miunosoft
Published: <strong>17 de diciembre de 2016</strong>
Last modified: 21 de diciembre de 2016

---

Buscar plugins

![](https://ps.w.org/commentcode-api/assets/banner-772x250.jpg?rev=1559034)

Este plugin **no se ha probado con las últimas 3 versiones mayores de WordPress**.
Puede que ya no tenga soporte ni lo mantenga nadie, o puede que tenga problemas 
de compatibilidad cuando se usa con las versiones más recientes de WordPress.

![](https://ps.w.org/commentcode-api/assets/icon-256x256.png?rev=1559066)

# Commentcode API

 Por [miunosoft](https://profiles.wordpress.org/miunosoft/)

[Descargar](https://downloads.wordpress.org/plugin/commentcode-api.1.0.0.zip)

 * [Detalles](https://es-ec.wordpress.org/plugins/commentcode-api/#description)
 * [Valoraciones](https://es-ec.wordpress.org/plugins/commentcode-api/#reviews)
 *  [Instalación](https://es-ec.wordpress.org/plugins/commentcode-api/#installation)
 * [Desarrollo](https://es-ec.wordpress.org/plugins/commentcode-api/#developers)

 [Soporte](https://wordpress.org/support/plugin/commentcode-api/)

## Descripción

#### Generate Custom Outputs with HTML Comments

Commentcode API lets you generate custom outputs with HTML comment-like codes.

It is similar to the [Shortcode API](https://codex.wordpress.org/Shortcode_API) 
except it takes a form of HTML comments and some few features.

Since it takes a form of HTML comments, even the user disables your plugin, the 
embedded code will not be visible, on contrary to shortcodes that remain in posts
when their plugins are deactivated.

#### Does not leave a mess in posts

Say, you have been using a plugin that converts a plugin specific shortcode into
custom outputs. Later you found something else that is more useful and uninstalled
it.

But the shortcodes used by that plugin remained in hundreds of posts and it was 
too much work to manually delete them so you have to ask somebody to run SQL commands.

That’s a problem. What if the shortcode takes a form of an HTML comment? It won’t
leave such a mess.

#### Syntax

It looks like this.

    ```
    <!--- tag foo="bar" --->



    <!--- tag color="#333" ---><p>Some outputs.</p><!--- /tag --->
    ```

Notice that tripe dashes are used in the both opening and closing part. So it won’t
hardly conflict with generic HTML comments.

#### Supports Multi-dimensional Array Arguments

The shortcode cannot pass multi-dimensional arguments to the callback function.

The below attributes won’t be parsed.

    ```
    [my_shortcode foo[1]="one" foo[2]="two"]
    ```

However, commentcode can handle it.

    ```
    <!---my_shortcode foo[1]="one" foo[2]="two" --->
    ```

The attributes are interpreted as

    ```
    array(
        'foo'   => array(
            1 => 'one',
            2 => 'two',
        )
    )
    ```

#### Preserved Letter Cases

The shortcode does not allow capitalized attribute names.

    ```
    [my_shortcode CapitalName="I need it to be capitalized"]
    ```

The attribute is interpreted as

    ```
    array(
        'capitalname' => 'I need it to be capitalized',
    )
    ```

This is not useful when you need to perform remote API requests which require argument
names with capital letters.

However, the commentcode API preserves those argument names.

    ```
    <!--- my_shortcode CapitalName="Please keep capitalization!" --->
    ```

will be

    ```
    array(
        'CapitalName'   => 'Please keep capitalization!',
    )
    ```

#### Register a Commentcode

Use the `add_commentcode()` function. It accepts two parameters.
 1. (string) the
commentcode tag. 2. (callable) a callback function which gets called when the commentcode
of the specified tag is processed.

The callback function receives three parameters.
 1. (string) The filtered text,
usually an empty string. 2. (array) The attributes set in the commentcode. 3. (string)
The commentcode tag name.

    ```
    function get_my_commentcode( $text, $arguments, $tag ) {
        return "<pre>" . htmlspecialchars( print_r( $arguments, true ) ) . "</pre>";
    }
    add_commentcode( 'my_commentcode', 'get_my_commentcode' );
    ```

For a test, while running the above code, try inserting `<!---my_commentcode Foo
="bar" numbers[ 1 ]="one" numbers[ 2 ]="two"--->` in a post.

It will produce this output,

    ```
    Array
    (
        [Foo] => bar
        [numbers] => Array
            (
                [1] => one
                [2] => two
            )

    )
    ```

## Instalación

 1. Upload **`commentcode-api.php`** and other files compressed in the zip folder to
    the **`/wp-content/plugins/`** directory.
 2. Activate the plugin through the ‘Plugins’ menu in WordPress.

## FAQ

#### The commentcode inserted in a post does not get converted. What’s the problem?

Double check you insert it in the `View` panel of the editor.

## Reseñas

No hay reseñas para este plugin.

## Colaboradores y desarrolladores

«Commentcode API» es un software de código abierto. Las siguientes personas han 
colaborado con este plugin.

Colaboradores

 *   [ miunosoft ](https://profiles.wordpress.org/miunosoft/)
 *   [ Michael Uno ](https://profiles.wordpress.org/michael-uno/)

[Traduce «Commentcode API» a tu idioma.](https://translate.wordpress.org/projects/wp-plugins/commentcode-api)

### ¿Interesado en el desarrollo?

[Revisa el código](https://plugins.trac.wordpress.org/browser/commentcode-api/) ,
echa un vistazo al [repositorio SVN](https://plugins.svn.wordpress.org/commentcode-api/)
o suscríbete al [registro de desarrollo](https://plugins.trac.wordpress.org/log/commentcode-api/)
por [RSS](https://plugins.trac.wordpress.org/log/commentcode-api/?limit=100&mode=stop_on_copy&format=rss).

## Registro de cambios

#### 1.0.0

 * Released.

## Meta

 *  Version **1.0.0**
 *  Last updated **hace 10 años**
 *  Active installations **Menos de 10**
 *  WordPress version ** 3.4 o superior **
 *  Tested up to **4.7.0**
 *  Language
 * [English (US)](https://wordpress.org/plugins/commentcode-api/)
 * Tags
 * [api](https://es-ec.wordpress.org/plugins/tags/api/)[shortcode](https://es-ec.wordpress.org/plugins/tags/shortcode/)
 *  [Vista avanzada](https://es-ec.wordpress.org/plugins/commentcode-api/advanced/)

## Valoraciones

No reviews have been submitted yet.

[Your review](https://wordpress.org/support/plugin/commentcode-api/reviews/#new-post)

[See all reviews](https://wordpress.org/support/plugin/commentcode-api/reviews/)

## Colaboradores

 *   [ miunosoft ](https://profiles.wordpress.org/miunosoft/)
 *   [ Michael Uno ](https://profiles.wordpress.org/michael-uno/)

## Soporte

¿Tienes algo que decir? ¿Necesitas ayuda?

 [Ver el foro de soporte](https://wordpress.org/support/plugin/commentcode-api/)

## Donar

¿Te gustaría apoyar el progreso de este plugin?

 [ Dona a este plugin ](http://en.michaeluno.jp/donate)