https://github.com/axelerant/aihrus-framework

Aihrus framework for WordPress plugins
https://github.com/axelerant/aihrus-framework

Last synced: about 1 month ago
JSON representation

Aihrus framework for WordPress plugins

• Host: GitHub
• URL: https://github.com/axelerant/aihrus-framework
• Owner: axelerant
• License: gpl-2.0
• Created: 2013-11-21T21:29:00.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2020-07-12T11:24:44.000Z (over 4 years ago)
• Last Synced: 2023-08-01T07:24:53.831Z (over 1 year ago)
• Language: PHP
• Size: 1.83 MB
• Stars: 3
• Watchers: 7
• Forks: 1
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# Axelerant Framework

Tested up to: 5.4.2

Stable tag: 1.3.5

A helper library for WordPress plugins. Maintained by [Axelerant](https://axelerant.com).

## Features

* Content truncation helper methods

* Donation links

* Image source and media attachment helper methods

* Licensing

* Link creation helper methods

* Nonce helper methods

* Notifications

* Validation helper methods

## Usage

* Change to plugin directory that's a Git clone

* Load and link the external library

```

git remote add axelerant https://github.com/michael-cannon/aihrus-framework.git

git subtree add -P include/libraries/aihrus-framework axelerant master

git commit -a -m "Read axelerant framework"

git push origin master

```

* Link plugin to libary

```

require WPS_DIR_LIB . '/aihrus-framework/class-aihrus-common.php';

```

* Extend plugin class to library

```

class Wordpress_Starter extends Aihrus_Common {

```

* Add class static members

```

public static $class = __CLASS__;

public static $notice_key;

```

* Set notices…

```

…

if ( $bad_version )

	add_action( 'admin_notices', 'wps_notice_aihrus' );

…

function wps_notice_aihrus() {

	$help_url  = esc_url( 'https://axelerant.atlassian.net/wiki/display/WPFAQ/Axelerant+Framework+Out+of+Date' );

	$help_link = sprintf( __( 'Update plugins. More information.' ), self_admin_url( 'update-core.php' ), $help_url );

	$text = sprintf( esc_html__( 'Plugin "%1$s" has been deactivated as it requires a current Axelerant Framework. Once corrected, "%1$s" can be activated. %2$s' ), WPS_NAME, $help_link );

	aihr_notice_error( $text );

}

```

* Update the external library

```

git subtree pull -P include/libraries/aihrus-framework axelerant master

```

* Update the plugin repository

```

git push origin master

```

## Included Libraries

* [Parsedown](http://parsedown.org/)