@package＆@subpackage：子テーマでの使用方法

8

私の問題は@packageと@subpackageです。

提案されたリンクに移動しました（パッケージとサブパッケージのコメントは何ですか？）。そこで私は自分の問題に適用できるものは何も見つけられませんでしたが、代わりにこの答え：「これらはPHPDocタグです-意味のある（そして自動化された）コードドキュメントを生成するために使用されます」。これは私が今持っているものです：

/**

* Contains a list of all custom action hooks and corresponding functions defined for abc.

* This file is included in functions.php:

*

* @package theme-name

* @subpackage Functions

*/

これは20の子テーマではありません。テーマ名フォルダーにフォルダーがあります：functions。子テーマは別のフォルダにあります。functions.php子テーマフォルダーにファイルを保存しました。フォルダー名を変更したり、Functions単語をそのままにしたりしても、何も起こりません（コンテンツが変更されます）。

ここに何を入れればいいの？

/**

* Contains a list of all custom action hooks and corresponding functions defined for abc.

* This file is included in functions.php:

*

* @package theme-name

* @subpackage ???

*/

child-theme

— マリー
ソース

4

あなたが見つけた元のドキュメントが言うように、これらはPHPDocumenterタグです。コードに影響を与えることはないため、コードを変更しても何も起こりません。

ただし、これらはコードを解析して人間が読めるドキュメントを作成する自動ツールには役立ちます。このPHPXrefは、解析されたバージョンのWordPressの例です。

WordPressでは、@package通常はWordPressです。@subpackageあなたが見ているものは何でもモジュールです。したがって、たとえば、WP_Httpクラスの上部には以下が含まれます。

/**
 * Simple and uniform HTTP request API.
 *
 * Standardizes the HTTP requests for WordPress. Handles cookies, gzip encoding and decoding, chunk
 * decoding, if HTTP 1.1 and various other difficult HTTP protocol implementations.
 *
 * @link http://trac.wordpress.org/ticket/4779 HTTP API Proposal
 *
 * @package WordPress
 * @subpackage HTTP
 * @since 2.7.0
 */

あなたの場合、@packageあなたのテーマの名前になります。 @subpackageはオプションであり、テーマ内に他のモジュールがある場合にのみ関連します- functions.phpファイルは実際にはテーマのサブパッケージではないため、その場合はタグを省略します。

子テーマも、親の@package/ @subpackage構造を継承する必要はありません。実際のところ、これらのコメントとメモは、他の人がプロジェクトの構造を理解するのに役立つため、プロジェクトにとって意味のあるものを使用してください。

— EAMann
ソース

こんにちは、すべての回答ありがとうございます。私はパッケージ名を自分の名前のままにしました（うまくいけば私は正しく理解できたでしょう）。私の.phpファイルは、親テーマと同じように、子テーマのfunctionフォルダーにあります。動作させることができなかったので、パッケージとサブパッケージが他のアイテムを参照する方法に問題があると思いました。あなたが言ったことやそれがいかに機能していないかは当てはまりません。.phpファイルを機能させるにはどうすればよいですか？（または、これは新しいスレッドにする必要がありますか？）

— Marie

あなたは、使用しているinclude()か、require()あなたのメインの中にfunctions.php新しいPHPファイルをインクルードするファイル？そうでない場合は、読み込まれません。新しいスレッドを開くと思いますが、PHPファイルを含めることはWP固有の問題ではありません。あなたがあればそう行う新しいスレッドを開いた私は、スタックオーバーフローにそうすることをお勧めします。

— EAMann 2013年

4

経験則：あなたのコードは、で示されるコードにバンドル（つまり、パッケージ化）されてい@packageますか？いいえの場合、に誤った値を使用しています@package。

ほとんどのテーマの場合、これは簡単です。

コアバンドルされたテーマは@package: WordPressおよびを使用します。@subpackage Theme-Nameこれらは、WordPress自体と一緒にパッケージ化および配布されるためです。
他のすべてのテーマは@package: Theme-Name、WordPress とは別にパッケージ化および配布されるため、を使用します。

すべてのテーマはWordPress自体の抽象化レイヤーであり、WordPressに依存して出力されます。しかし、その依存関係はそれら@subpackageをWordPressのようにしません。

このルールをチャイルドテーマにも適用します。これらはスタンドアロンパッケージであり、依存する親/テンプレートテーマとは別にパッケージ化および配布されます。

— チップベネット
ソース

1

それらはドキュメンテーションタグです。これらを使用して、コードのドキュメント化を目的として、関連するコードをグループ化します。ウィキペディアには、さまざまなタグを使用できる優れたグラフがあります。公式ドキュメントはhttp://www.phpdoc.org/にあります。

サブパッケージのフォルダー名を変更しても、「機能」という単語をそのままにしても、何も起こりません（コンテンツが変更されます）。

正しい。何も起こりません。これはコードドキュメンテーション専用です。PHPDocスクリプトを使用してコードを実行するまで、何もわかりません。これにより、ドキュメントが生成されますが、コードの動作は変更されません。

@packageテーマを識別するために使用します。@subpackage必要に応じてを使用して、テーマ内の機能をグループ化します。たとえば、テーマ固有のウィジェットまたは何かでいっぱいのファイルを言います。

@packageアノテーションを含めて、どのような違いがありますか？

http://codex.wordpress.org/Inline_Documentation

— s_ha_dum
ソース

1

@packageWordPressのテーマも、にグループクラスや関数と定義するパッケージを指定します。A @subpackageは、特定の要件の機能や子テーマであるサブパッケージのように、テーマの子です。

phpdocタグのドキュメントへの小さなヒント：http : //manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_tags.pkg.html

— ブエルジ
ソース