Как зарегистрировать shortcode для функции в плагине?

Question

[foxayb]

Как я понял, по средствам этой функции:

public static function getTableOfContentsContent()
	{
		global $cmtoc_FoundItems;

		$tableOfContentsContent = '';

		$tableOfContentDisplayHeaders = CMTOC_Pro::__(get_option('cmtoc_table_of_contentsHeaderDescription', 'Table Of Contents'));

		if( !empty($cmtoc_FoundItems) )
		{
			$tableOfContentsContent .= '<div class="cmtoc_table_of_contents_wrapper">';
			if( !empty($tableOfContentDisplayHeaders) )
			{
				$tableOfContentsContent .= '<div class="cmtoc_table_of_contents_description">' . $tableOfContentDisplayHeaders . '</div>';
			}

			$tableOfContentsContent .= '<ul class="cmtoc_table_of_contents_table">';

			foreach($cmtoc_FoundItems as $tableOfContentKey => $tableOfContentArr)
			{
				$levelClass = 'cmtoc_level_' . esc_attr($tableOfContentArr['level']);

				$tableOfContentIndexHref = esc_attr($tableOfContentArr['href']);
				$tableOfContentItemContent = apply_filters('cmtoc_term_table_of_content_content', esc_attr($tableOfContentArr['text']));
				$tableOfContentId = 'cmtoc_table_of_contents_' . esc_attr($tableOfContentArr['index']);

				$tableOfContentsContent .= '<li id="' . $tableOfContentId . '" class="cmtoc_table_of_contents_row ' . $levelClass . '">';
				$tableOfContentsContent .= '<a href="#' . $tableOfContentIndexHref . '">';
				$tableOfContentsContent .= $tableOfContentItemContent;
				$tableOfContentsContent .= '</a>';
				$tableOfContentsContent .= '</li>';
			}
			$tableOfContentsContent .= '</ul>';
			$tableOfContentsContent .= '</div>';
		}

		return $tableOfContentsContent;
	}

плагин вставляет в начало контента содержимое.

Но суть там такая, что он это вставит если проставить галочку: "Search for Table Of Contents items on this post/page."

Мне неудобна область куда он вставляет, как вариант сделать для этой функции шорткод, подскажите, как это правильно реализовать?

Answer 1

[Stargot]

add_shortcode( 'get-table', 'getTableOfContentsContent' );

Comments

[foxayb]

У функции "getTableOfContentsContent" аргумент "$tableOfContentsContent" - выводит маркированный список со всем вытекающим, но как сделать чтобы при вставке шорткода всё это выводило?

Добавить в функцию echo $tableOfContentsContent; ?

[Stargot]

foxayb, Для срабатывания add_shortcode будет достаточным вывод через return и более правильным чем echo в данной ситуации.

[foxayb]

Stargot, попробовал

add_shortcode( 'get-table', 'getTableOfContentsContent' );

добавить в functions.php - не работает. Также пробовал добавить в php плагина, где расположена данная функция результат аналогичный - шорткод не работает.

[Stargot]

foxayb, если это функция внутри класса, попробуйте.

class MyPlugin {
	public static function baztag_func( $atts, $content = "" ) {
		return "content = $content";
	}
 }
 add_shortcode( 'baztag', array( 'MyPlugin', 'baztag_func' ) );

[foxayb]

Stargot, Спасибо за ответ! Вы правильно поняли, это функция внутри класса.
Сам класс обзывается CMTOC_Pro. В итоге получилось так:

add_shortcode( 'get-table', array( 'CMTOC_Pro', 'getTableOfContentsContent' ) );

шорткод пропал, но результат из функции не вывел. Перепробовал по разному. Вставлял добавление нового шорткода в functions.php, в функцию геттейбл и в сам php-файл содержащий эту функцию. Результат - вместо шорткода пустота.

После функции 'getTableOfContentsContent' идут ещё функции в которых что-то про шорткоды, может они блокируют?

/**
	 * Returns TRUE if the shortcode was found
	 * @staticvar boolean $found
	 * @param type $setFound
	 * @return type
	 */
	public static function wasShortcodeFound($setFound = FALSE)
	{
		static $found = FALSE;
		if( $setFound )
		{
			$found = $setFound;
		}
		return $found;
	}

	/**
	 * Display the table-of-contents
	 * @param type $atts
	 * @param type $text
	 * @return type
	 */
	public static function displayTableOfContentsShortcode($atts = array(), $text = '')
	{
		$tableOfContentsContent = '';

		/*
		 * Only show once
		 */
		if( !self::wasShortcodeFound() )
		{
			$tableOfContentsContent = self::getTableOfContentsContent();
			self::wasShortcodeFound(TRUE);
		}

		return $tableOfContentsContent;
	}

	/**
	 * Outputs the table of content
	 * @param type $content
	 * @return string
	 */
	public static function outputTableOfContents($content)
	{
		$contentWithTableOfContents = do_shortcode($content);

		$shortcodeWasFound = self::wasShortcodeFound();
		if( !$shortcodeWasFound )
		{
			$tableOfContentsContent = self::getTableOfContentsContent();
			self::wasShortcodeFound(TRUE);

			$contentWithTableOfContents = $tableOfContentsContent . $contentWithTableOfContents;
		}

		return $contentWithTableOfContents;
	}

[Stargot]

Другие функции с шорткодами не могут блокировать, они же все завязаны на определенную функцию.

[Stargot]

Может помочь:
var_dump($contentWithTableOfContents);

[foxayb]

Stargot, попробовал по разному. Результат Null :sad: