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

---

Szukaj wtyczek

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

Wtyczka **nie została przetestowana z trzema ostatnimi głównymi wydaniami WordPressa**.
Może nie być już utrzymywana lub obsługiwana, co może skutkować problemem ze zgodnością
z nowszymi wersjami WordPressa.

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

# Commentcode API

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

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

 * [Szczegóły](https://pl.wordpress.org/plugins/commentcode-api/#description)
 * [Recenzje](https://pl.wordpress.org/plugins/commentcode-api/#reviews)
 *  [Instalacja](https://pl.wordpress.org/plugins/commentcode-api/#installation)
 * [Rozwój](https://pl.wordpress.org/plugins/commentcode-api/#developers)

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

## Opis

#### 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
            )

    )
    ```

## Instalacja

 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.

## Najczęściej zadawane pytania

#### 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.

## Recenzje

Wtyczka nie ma jeszcze żadnej recenzji.

## Kontrybutorzy i deweloperzy

„Commentcode API” jest oprogramowaniem open source. Poniższe osoby miały wkład w
rozwój wtyczki.

Zaangażowani

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

[Przetłumacz wtyczkę “Commentcode API” na swój język.](https://translate.wordpress.org/projects/wp-plugins/commentcode-api)

### Interesuje cię rozwój wtyczki?

[Przeglądaj kod](https://plugins.trac.wordpress.org/browser/commentcode-api/), sprawdź
[repozytorium SVN](https://plugins.svn.wordpress.org/commentcode-api/) lub czytaj
[dziennik rozwoju](https://plugins.trac.wordpress.org/log/commentcode-api/) przez
[RSS](https://plugins.trac.wordpress.org/log/commentcode-api/?limit=100&mode=stop_on_copy&format=rss).

## Rejestr zmian

#### 1.0.0

 * Released.

## Meta

 *  Wersja **1.0.0**
 *  Ostatnia aktualizacja **10 lat temu**
 *  Włączone instalacje **Mniej niż 10**
 *  Wersja WordPressa ** 3.4 lub nowszej **
 *  Testowano do **4.7.0**
 *  Język
 * [English (US)](https://wordpress.org/plugins/commentcode-api/)
 * Tagi
 * [api](https://pl.wordpress.org/plugins/tags/api/)[shortcode](https://pl.wordpress.org/plugins/tags/shortcode/)
 *  [Widok zaawansowany](https://pl.wordpress.org/plugins/commentcode-api/advanced/)

## Oceny

Nie przesłano jeszcze żadnych recenzji.

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

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

## Zaangażowani

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

## Wsparcie

Masz coś do dodania? Potrzebujesz pomocy?

 [Zobacz forum wsparcia](https://wordpress.org/support/plugin/commentcode-api/)

## Złóż datek

Czy chcesz wesprzeć rozwój wtyczki?

 [ Wspomóż wtyczkę ](http://en.michaeluno.jp/donate)